From 98d3c7a6b54a7474950403086357259c90b94542 Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Wed, 13 May 2026 14:44:02 +0200 Subject: [PATCH 1/8] pre-onboarding requirements --- example/src/ReviewOnboardingStep.tsx | 133 ++++++++++++++++++ src/common/api/fixtures/pre-onboarding.ts | 38 +++++ src/flows/Onboarding/OnboardingFlow.tsx | 2 + src/flows/Onboarding/api.ts | 79 +++++++++++ .../components/PreOnboardingRequirements.tsx | 74 ++++++++++ src/flows/Onboarding/types.ts | 26 ++++ 6 files changed, 352 insertions(+) create mode 100644 src/common/api/fixtures/pre-onboarding.ts create mode 100644 src/flows/Onboarding/components/PreOnboardingRequirements.tsx diff --git a/example/src/ReviewOnboardingStep.tsx b/example/src/ReviewOnboardingStep.tsx index 3a803a18d..b07fc1836 100644 --- a/example/src/ReviewOnboardingStep.tsx +++ b/example/src/ReviewOnboardingStep.tsx @@ -230,6 +230,7 @@ export const ReviewOnboardingStep = ({ OnboardingInvite, BackButton, ReviewStep: ReviewStepCreditRisk, + PreOnboardingRequirements, } = components; return ( @@ -279,6 +280,138 @@ export const ReviewOnboardingStep = ({ > Edit Benefits + +

Pre-Onboarding Requirements

+ {PreOnboardingRequirements && ( + + | undefined; + isLoadingRequirements: boolean; + documentPreview: + | { + id: string; + employment_id: string; + document_type: string; + status: string; + pdf_url?: string; + created_at: string; + } + | undefined; + onCreateDocument: () => Promise; + onSignDocument: (signature: string) => Promise; + isCreatingDocument: boolean; + isSigning: boolean; + }) => ( +
+ {isLoadingRequirements ? ( +

Loading requirements...

+ ) : ( + <> +

Requirements List

+ {requirements?.map( + (req: { + id: string; + title: string; + description: string; + status: string; + }) => ( +
+ {req.title} +

{req.description}

+ + Status: {req.status} + +
+ ), + )} + + {!documentPreview && ( + + )} + + {documentPreview && ( +
+

Document Preview

+

Document ID: {documentPreview.id}

+

Status: {documentPreview.status}

+ {documentPreview.pdf_url && ( +

+ PDF URL:{' '} + + {documentPreview.pdf_url} + +

+ )} + +
+ )} + + )} +
+ )} + /> + )} +

Review

diff --git a/src/flows/Onboarding/api.ts b/src/flows/Onboarding/api.ts index b4c322774..d78255abe 100644 --- a/src/flows/Onboarding/api.ts +++ b/src/flows/Onboarding/api.ts @@ -557,3 +557,82 @@ export const useEngagementAgreementDetailsSchema = ( }, }); }; + +/** + * Get pre-onboarding requirements for an employment + */ +export const useGetPreOnboardingRequirements = ( + employmentId: string, + options?: { queryOptions?: { enabled?: boolean } }, +) => { + return useQuery({ + queryKey: ['pre-onboarding-requirements', employmentId], + queryFn: async () => { + const { mockPreOnboardingRequirements } = + await import('@/src/common/api/fixtures/pre-onboarding'); + // Simulated delay + await new Promise((resolve) => setTimeout(resolve, 500)); + return mockPreOnboardingRequirements; + }, + enabled: options?.queryOptions?.enabled ?? true, + select: (data) => data.data, + }); +}; + +/** + * Create a pre-onboarding document + */ +export const useCreatePreOnboardingDocument = () => { + return useMutation({ + mutationFn: async ({ + employmentId: _employmentId, + }: { + employmentId: string; + }) => { + const { mockCreatedDocument } = + await import('@/src/common/api/fixtures/pre-onboarding'); + await new Promise((resolve) => setTimeout(resolve, 800)); + return mockCreatedDocument; + }, + }); +}; + +/** + * Get pre-onboarding document preview + */ +export const useGetPreOnboardingDocument = ( + documentId: string | undefined, + options?: { queryOptions?: { enabled?: boolean } }, +) => { + return useQuery({ + queryKey: ['pre-onboarding-document', documentId], + queryFn: async () => { + const { mockCreatedDocument } = + await import('@/src/common/api/fixtures/pre-onboarding'); + await new Promise((resolve) => setTimeout(resolve, 300)); + return mockCreatedDocument; + }, + enabled: options?.queryOptions?.enabled && !!documentId, + select: (data) => data.data, + }); +}; + +/** + * Sign a pre-onboarding document + */ +export const useSignPreOnboardingDocument = () => { + return useMutation({ + mutationFn: async ({ + documentId: _documentId, + signature: _signature, + }: { + documentId: string; + signature: string; + }) => { + const { mockSignedDocument } = + await import('@/src/common/api/fixtures/pre-onboarding'); + await new Promise((resolve) => setTimeout(resolve, 1000)); + return mockSignedDocument; + }, + }); +}; diff --git a/src/flows/Onboarding/components/PreOnboardingRequirements.tsx b/src/flows/Onboarding/components/PreOnboardingRequirements.tsx new file mode 100644 index 000000000..52a06d24e --- /dev/null +++ b/src/flows/Onboarding/components/PreOnboardingRequirements.tsx @@ -0,0 +1,74 @@ +import { useState } from 'react'; +import { useOnboardingContext } from '@/src/flows/Onboarding/context'; +import { + useGetPreOnboardingRequirements, + useCreatePreOnboardingDocument, + useGetPreOnboardingDocument, + useSignPreOnboardingDocument, +} from '@/src/flows/Onboarding/api'; + +const usePreOnboardingRequirements = ({ + employmentId, +}: { + employmentId: string; +}) => { + const [documentId, setDocumentId] = useState(); + + const { data: requirements, isLoading: isLoadingRequirements } = + useGetPreOnboardingRequirements(employmentId, { + queryOptions: { enabled: !!employmentId }, + }); + + const { data: documentPreview, isLoading: isLoadingDocumentPreview } = + useGetPreOnboardingDocument(documentId, { + queryOptions: { enabled: !!documentId }, + }); + + const createDocumentMutation = useCreatePreOnboardingDocument(); + const signDocumentMutation = useSignPreOnboardingDocument(); + + const onCreateDocument = async () => { + const result = await createDocumentMutation.mutateAsync({ + employmentId, + }); + setDocumentId(result.data.id); + return result; + }; + + const onSignDocument = async (signature: string) => { + if (!documentId) { + throw new Error('No document to sign'); + } + return await signDocumentMutation.mutateAsync({ + documentId, + signature, + }); + }; + + return { + requirements, + isLoadingRequirements, + documentPreview, + isLoadingDocumentPreview, + isCreatingDocument: createDocumentMutation.isPending, + isSigning: signDocumentMutation.isPending, + onCreateDocument, + onSignDocument, + }; +}; + +export const PreOnboardingRequirements = ({ + render, +}: { + render: ( + bag: ReturnType, + ) => React.ReactNode; +}) => { + const { onboardingBag } = useOnboardingContext(); + + const bag = usePreOnboardingRequirements({ + employmentId: onboardingBag.employmentId as string, + }); + + return render(bag); +}; diff --git a/src/flows/Onboarding/types.ts b/src/flows/Onboarding/types.ts index b4a80dbc6..c61fc3aec 100644 --- a/src/flows/Onboarding/types.ts +++ b/src/flows/Onboarding/types.ts @@ -15,6 +15,7 @@ import { SelectCountryStep } from '@/src/flows/Onboarding/components/SelectCount import { ReviewStep } from '@/src/flows/Onboarding/components/ReviewStep'; import { SaveDraftButton } from '@/src/flows/Onboarding/components/SaveDraftButton'; import { EngagementAgreementDetailsStep } from '@/src/flows/Onboarding/components/EngagementAgreementDetailsStep'; +import { PreOnboardingRequirements } from '@/src/flows/Onboarding/components/PreOnboardingRequirements'; export type OnboardingRenderProps = { /** @@ -38,6 +39,7 @@ export type OnboardingRenderProps = { * @see {@link SelectCountryStep} * @see {@link ReviewStep} * @see {@link SaveDraftButton} + * @see {@link PreOnboardingRequirements} */ components: { SubmitButton: typeof OnboardingSubmit; @@ -50,6 +52,7 @@ export type OnboardingRenderProps = { SelectCountryStep: typeof SelectCountryStep; ReviewStep: typeof ReviewStep; SaveDraftButton: typeof SaveDraftButton; + PreOnboardingRequirements: typeof PreOnboardingRequirements; }; }; @@ -225,3 +228,26 @@ export type CreditRiskState = | 'invite_successful' | 'referred' | null; + +// TODO: Provisional, we'll modify later +export type PreOnboardingRequirement = { + id: string; + title: string; + description: string; + status: 'pending' | 'completed'; + required: boolean; +}; + +export type PreOnboardingDocument = { + id: string; + employment_id: string; + document_type: string; + status: 'draft' | 'pending_signature' | 'signed'; + pdf_url?: string; + created_at: string; +}; + +export type SignDocumentPayload = { + signature: string; + signed_at?: string; +}; From b7282c8ed7ab5a251e9570bfb7d5e17179716d6c Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Thu, 14 May 2026 11:10:42 +0200 Subject: [PATCH 2/8] log things out --- src/common/api/fixtures/pre-onboarding.ts | 32 ++++++++++++++++------- src/components/form/validationResolver.ts | 1 + 2 files changed, 23 insertions(+), 10 deletions(-) diff --git a/src/common/api/fixtures/pre-onboarding.ts b/src/common/api/fixtures/pre-onboarding.ts index 0de5bc390..eb40e80b2 100644 --- a/src/common/api/fixtures/pre-onboarding.ts +++ b/src/common/api/fixtures/pre-onboarding.ts @@ -2,18 +2,30 @@ export const mockPreOnboardingRequirements = { data: [ { - id: 'req_1', - title: 'Employment Agreement', - description: 'Review and sign the employment agreement', - status: 'pending', - required: true, + name: 'Individual Labor Agreement', + status: 'awaiting_signatures', + description: + 'Individual Labor Agreement required for each German AUG employment', + slug: '5e39159e-96ef-40ea-82bc-b054917fc82f', + needs_constraints_ack: true, + document_constraints_ack_at: null, + freeze_employment_data: false, + redlining_help_email: null, + supports_redlining: false, + depends_on_requirement: null, }, { - id: 'req_2', - title: 'Tax Forms', - description: 'Complete required tax documentation', - status: 'pending', - required: true, + name: 'Master Service Agreement', + status: 'awaiting_signatures', + description: + 'Master Service Agreement required for the first hire on this German legal entity', + slug: 'dc3b954c-9d6c-4ddd-b8dc-531f9be773fb', + needs_constraints_ack: true, + document_constraints_ack_at: '2026-05-08T17:17:47Z', + freeze_employment_data: false, + redlining_help_email: null, + supports_redlining: false, + depends_on_requirement: null, }, ], }; diff --git a/src/components/form/validationResolver.ts b/src/components/form/validationResolver.ts index 843bb7ed3..33b1a48c5 100644 --- a/src/components/form/validationResolver.ts +++ b/src/components/form/validationResolver.ts @@ -74,6 +74,7 @@ export const useJsonSchemasValidationFormResolver = < ): Resolver => { return async (data: T) => { const result = await handleValidation(data); + console.log('result', result); // Handle null case - return no errors if (!result) { From cb106d4be5083f5164364815786db1118f160477 Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Thu, 14 May 2026 18:23:42 +0200 Subject: [PATCH 3/8] types generated --- openapi-ts.config.ts | 1 + src/client/client.gen.ts | 4 +- src/client/index.ts | 2802 +++++---- src/client/sdk.gen.ts | 9089 ++++++++++++++------------- src/client/types.gen.ts | 12170 ++++++++++++++++++++++--------------- 5 files changed, 13513 insertions(+), 10553 deletions(-) diff --git a/openapi-ts.config.ts b/openapi-ts.config.ts index 987798b39..2ec3f1e51 100644 --- a/openapi-ts.config.ts +++ b/openapi-ts.config.ts @@ -1,6 +1,7 @@ import { defineConfig, defaultPlugins } from '@hey-api/openapi-ts'; export default defineConfig({ + // local gateway http://localhost:4000/api/eor/openapi input: 'https://gateway.remote.com/v1/docs/openapi.json', output: 'src/client', plugins: defaultPlugins, diff --git a/src/client/client.gen.ts b/src/client/client.gen.ts index 5f44e28fd..0e7e8e27a 100644 --- a/src/client/client.gen.ts +++ b/src/client/client.gen.ts @@ -20,6 +20,4 @@ export type CreateClientConfig = ( override?: Config, ) => Config & T>; -export const client = createClient( - createConfig({ baseUrl: 'https://gateway.remote.com/' }), -); +export const client = createClient(createConfig()); diff --git a/src/client/index.ts b/src/client/index.ts index 716f6ed24..3b067e362 100644 --- a/src/client/index.ts +++ b/src/client/index.ts @@ -1,222 +1,258 @@ // This file is auto-generated by @hey-api/openapi-ts export { - deleteDeleteCompanyManager, - deleteDeleteContractorCorSubscriptionSubscription, - deleteDeleteIncentive, - deleteDeleteRecurringIncentive, - deleteDeleteWebhookCallback, - getCategoriesExpense, - getContractorEligibilityCompanyLegalEntities, - getCurrentIdentity, - getDetailsSsoConfiguration, - getDownloadByIdExpenseReceipt, - getDownloadExpenseReceipt, - getDownloadPayslipPayslip, - getDownloadPdfBillingDocument, - getDownloadResignationLetter, - getEmployeeDetailsPayrollRun, - getGetBreakdownBillingDocument, - getGetGroupScim, - getGetIdentityVerificationDataIdentityVerification, - getGetUserScim, - getIndexBenefitOffer, - getIndexBenefitOffersByEmployment, - getIndexBenefitOffersCountrySummary, - getIndexBenefitRenewalRequest, - getIndexBillingDocument, - getIndexBulkEmploymentRow, - getIndexCompany, - getIndexCompanyCurrency, - getIndexCompanyDepartment, - getIndexCompanyLegalEntities, - getIndexCompanyManager, - getIndexCompanyPricingPlan, - getIndexCompanyProductPrice, - getIndexContractAmendment, - getIndexContractorCurrency, - getIndexContractorInvoice, - getIndexCountry, - getIndexDataSync, - getIndexEmployeeDocument, - getIndexEmployment, - getIndexEmploymentCompanyStructureNode, - getIndexEmploymentContract, - getIndexEmploymentContractDocument, - getIndexEmploymentCustomField, - getIndexEmploymentCustomFieldValue, - getIndexEmploymentFile, - getIndexEmploymentJob, - getIndexEorPayrollCalendar, - getIndexExpense, - getIndexHoliday, - getIndexIncentive, - getIndexLeavePoliciesDetails, - getIndexLeavePoliciesSummary, - getIndexOffboarding, - getIndexPayItems, - getIndexPayrollCalendar, - getIndexPayrollRun, - getIndexPayslip, - getIndexPricingPlanPartnerTemplate, - getIndexRecurringIncentive, - getIndexScheduledContractorInvoice, - getIndexSubscription, - getIndexTimeoff, - getIndexTimesheet, - getIndexTravelLetterRequest, - getIndexWebhookCallback, - getIndexWebhookEvent, - getIndexWorkAuthorizationRequest, - getListGroupsScim, - getListUsersScim, - getPendingChangesEmploymentContract, - getSchemaBenefitRenewalRequest, - getShowAdministrativeDetails, - getShowBackgroundCheck, - getShowBenefitRenewalRequest, - getShowBillingDocument, - getShowBulkEmployment, - getShowCompany, - getShowCompanyComplianceProfile, - getShowCompanyEmploymentOnboardingReservesStatus, - getShowCompanyManager, - getShowCompanySchema, - getShowContractAmendment, - getShowContractAmendmentSchema, - getShowContractDocument, - getShowContractorContractDetailsCountry, - getShowContractorInvoice, - getShowCorTerminationRequestSubscription, - getShowEligibilityQuestionnaire, - getShowEmployeeDocument, - getShowEmployment, - getShowEmploymentCustomFieldValue, - getShowEmploymentEngagementAgreementDetails, - getShowEmploymentOnboardingSteps, - getShowEngagementAgreementDetailsCountry, - getShowExpense, - getShowFile, - getShowFormCountry, - getShowHelpCenterArticle, - getShowIncentive, - getShowLegalEntityFormCountry, - getShowOffboarding, - getShowPayrollRun, - getShowPayslip, - getShowProbationCompletionLetter, - getShowProbationExtension, - getShowRegionField, - getShowResignation, - getShowScheduledContractorInvoice, - getShowSchema, - getShowSsoConfiguration, - getShowTestSchema, - getShowTimeoff, - getShowTimeoffBalance, - getShowTimesheet, - getShowTravelLetterRequest, - getShowWorkAuthorizationRequest, - getSupportedCountry, - getTimeoffTypesTimeoff, + deleteV1CompanyManagersUserId, + deleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscription, + deleteV1IncentivesId, + deleteV1IncentivesRecurringId, + deleteV1WebhookCallbacksId, + getV1BenefitOffers, + getV1BenefitOffersCountrySummaries, + getV1BenefitRenewalRequests, + getV1BenefitRenewalRequestsBenefitRenewalRequestId, + getV1BenefitRenewalRequestsBenefitRenewalRequestIdSchema, + getV1BillingDocuments, + getV1BillingDocumentsBillingDocumentId, + getV1BillingDocumentsBillingDocumentIdBreakdown, + getV1BillingDocumentsBillingDocumentIdPdf, + getV1BulkEmploymentJobsJobId, + getV1BulkEmploymentJobsJobIdRows, + getV1Companies, + getV1CompaniesCompanyId, + getV1CompaniesCompanyIdComplianceProfile, + getV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatus, + getV1CompaniesCompanyIdLegalEntities, + getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails, + getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibility, + getV1CompaniesCompanyIdPricingPlans, + getV1CompaniesCompanyIdProductPrices, + getV1CompaniesCompanyIdWebhookCallbacks, + getV1CompaniesSchema, + getV1CompanyCurrencies, + getV1CompanyDepartments, + getV1CompanyManagers, + getV1CompanyManagersUserId, + getV1ContractAmendments, + getV1ContractAmendmentsId, + getV1ContractAmendmentsSchema, + getV1ContractorInvoices, + getV1ContractorInvoiceSchedules, + getV1ContractorInvoiceSchedulesId, + getV1ContractorInvoicesId, + getV1ContractorsEmploymentsEmploymentIdContractDocumentsId, + getV1ContractorsEmploymentsEmploymentIdContractorCurrencies, + getV1ContractorsEmploymentsEmploymentIdContractorSubscriptions, + getV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestId, + getV1ContractorsSchemasEligibilityQuestionnaire, + getV1CostCalculatorCountries, + getV1CostCalculatorRegionsSlugFields, + getV1Countries, + getV1CountriesCountryCodeContractorContractDetails, + getV1CountriesCountryCodeEngagementAgreementDetails, + getV1CountriesCountryCodeForm, + getV1CountriesCountryCodeHolidaysYear, + getV1CountriesCountryCodeLegalEntityFormsForm, + getV1CustomFields, + getV1CustomFieldsCustomFieldIdValuesEmploymentId, + getV1DataSync, + getV1EmployeeDocuments, + getV1EmployeeDocumentsId, + getV1EmployeeExpenseCategories, + getV1EmployeeExpenses, + getV1EmployeeIncentives, + getV1EmployeeLeavePolicies, + getV1EmployeePayslipFiles, + getV1EmployeePayslips, + getV1EmployeePersonalInformation, + getV1EmployeeTimeoff, + getV1EmployeeTimesheets, + getV1EmploymentContracts, + getV1EmploymentContractsEmploymentIdPendingChanges, + getV1Employments, + getV1EmploymentsEmploymentId, + getV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckId, + getV1EmploymentsEmploymentIdBenefitOffers, + getV1EmploymentsEmploymentIdBenefitOffersSchema, + getV1EmploymentsEmploymentIdCompanyStructureNodes, + getV1EmploymentsEmploymentIdContractDocuments, + getV1EmploymentsEmploymentIdCustomFields, + getV1EmploymentsEmploymentIdEngagementAgreementDetails, + getV1EmploymentsEmploymentIdFiles, + getV1EmploymentsEmploymentIdJob, + getV1EmploymentsEmploymentIdOnboardingSteps, + getV1Expenses, + getV1ExpensesCategories, + getV1ExpensesExpenseIdReceipt, + getV1ExpensesExpenseIdReceiptsReceiptId, + getV1ExpensesId, + getV1FilesId, + getV1HelpCenterArticlesId, + getV1IdentityCurrent, + getV1IdentityVerificationEmploymentId, + getV1Incentives, + getV1IncentivesId, + getV1IncentivesRecurring, + getV1LeavePoliciesDetailsEmploymentId, + getV1LeavePoliciesSummaryEmploymentId, + getV1Offboardings, + getV1OffboardingsId, + getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsId, + getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirements, + getV1PayItems, + getV1PayrollCalendars, + getV1PayrollCalendarsCycle, + getV1PayrollRuns, + getV1PayrollRunsPayrollRunId, + getV1PayrollRunsPayrollRunIdEmployeeDetails, + getV1Payslips, + getV1PayslipsId, + getV1PayslipsPayslipIdPdf, + getV1PricingPlanPartnerTemplates, + getV1ProbationCompletionLetterId, + getV1ProbationExtensionsId, + getV1ResignationsOffboardingRequestId, + getV1ResignationsOffboardingRequestIdResignationLetter, + getV1ScimV2Groups, + getV1ScimV2GroupsId, + getV1ScimV2Users, + getV1ScimV2UsersId, + getV1SsoConfiguration, + getV1SsoConfigurationDetails, + getV1TestSchema, + getV1Timeoff, + getV1TimeoffBalancesEmploymentId, + getV1TimeoffId, + getV1TimeoffTypes, + getV1Timesheets, + getV1TimesheetsId, + getV1TravelLetterRequests, + getV1TravelLetterRequestsId, + getV1WdGphPayDetail, + getV1WdGphPayDetailData, + getV1WdGphPayProcessingFeature, + getV1WdGphPayProgress, + getV1WdGphPaySummary, + getV1WdGphPayVariance, + getV1WebhookEvents, + getV1WorkAuthorizationRequests, + getV1WorkAuthorizationRequestsId, + getV2EmploymentsEmploymentIdEngagementAgreementDetails, type Options, - patchUpdateCompany, - patchUpdateCompany2, - patchUpdateEmployeeTimeoff, - patchUpdateEmployeeTimeoff2, - patchUpdateEmployment, - patchUpdateEmployment2, - patchUpdateEmployment3, - patchUpdateEmployment4, - patchUpdateEmploymentCustomFieldValue, - patchUpdateEmploymentCustomFieldValue2, - patchUpdateExpense, - patchUpdateExpense2, - patchUpdateIncentive, - patchUpdateIncentive2, - patchUpdateScheduledContractorInvoice, - patchUpdateScheduledContractorInvoice2, - patchUpdateTimeoff, - patchUpdateTimeoff2, - patchUpdateTravelLetterRequest, - patchUpdateTravelLetterRequest2, - patchUpdateWebhookCallback, - patchUpdateWorkAuthorizationRequest, - patchUpdateWorkAuthorizationRequest2, - postApproveCancellationRequest, - postApproveRiskReserveProofOfPayment, - postApproveTimesheet, - postAutomatableContractAmendment, - postBulkCreatePayItems, - postBulkCreateScheduledContractorInvoice, - postBypassEligibilityChecksCompany, - postCancelEmployeeTimeoff, - postCompleteOnboardingEmployment, - postConvertRawCurrencyConverter, - postConvertWithSpreadCurrencyConverter, - postConvertWithSpreadCurrencyConverter2, - postCreateApproval, - postCreateBenefitRenewalRequest, - postCreateBulkEmployment, - postCreateCancellation, - postCreateCompany, - postCreateCompanyDepartment, - postCreateCompanyManager, - postCreateCompanyPricingPlan, - postCreateContractAmendment, - postCreateContractDocument, - postCreateContractEligibility, - postCreateCorTerminationRequestSubscription, - postCreateDataSync, - postCreateDecline, - postCreateEligibilityQuestionnaire, - postCreateEmployeeTimeoff, - postCreateEmployment, - postCreateEmployment2, - postCreateEmploymentCustomField, - postCreateEstimation, - postCreateEstimationCsv, - postCreateEstimationPdf, - postCreateExpense, - postCreateIncentive, - postCreateLegalEntityCompany, - postCreateOffboarding, - postCreateProbationCompletionLetter, - postCreateProbationExtension, - postCreateRecurringIncentive, - postCreateRiskReserve, - postCreateSsoConfiguration, - postCreateTimeoff, - postCreateTokenCompanyToken, - postCreateWebhookCallback, - postDeclineCancellationRequest, - postDeclineIdentityVerification, - postGenerateMagicLink, - postInviteEmploymentInvitation, - postManageContractorCorSubscriptionSubscription, - postManageContractorPlusSubscriptionSubscription, - postReplayWebhookEvent, - postReportErrorsTelemetry, - postSendBackTimesheet, - postSignContractDocument, - postSubmitRiskReserveProofOfPayment, - postTerminateContractorOfRecordEmploymentSubscription, - postTokenOAuth2Token, - postTriggerWebhookCallback, - postUpdateBenefitRenewalRequest, - postUpdateCancelOnboarding, - postUpdateEmploymentEngagementAgreementDetails, - postUploadEmployeeFileFile, - postVerifyIdentityVerification, - putApproveContractAmendment, - putCancelContractAmendment, - putReassignDefaultEntityCompany, - putUpdateAdministrativeDetails, - putUpdateBenefitOffer, - putUpdateEmploymentBasicInformation, - putUpdateEmploymentFederalTaxes, - putUpdateEmploymentPersonalDetails, - putValidateResignation, + patchV1CompaniesCompanyId, + patchV1CompaniesCompanyId2, + patchV1ContractorInvoiceSchedulesId, + patchV1ContractorInvoiceSchedulesId2, + patchV1CustomFieldsCustomFieldIdValuesEmploymentId, + patchV1CustomFieldsCustomFieldIdValuesEmploymentId2, + patchV1EmployeeTimeoffId, + patchV1EmployeeTimeoffId2, + patchV1EmploymentsEmploymentId, + patchV1EmploymentsEmploymentId2, + patchV1ExpensesId, + patchV1ExpensesId2, + patchV1IncentivesId, + patchV1IncentivesId2, + patchV1SandboxEmploymentsEmploymentId, + patchV1SandboxEmploymentsEmploymentId2, + patchV1TimeoffId, + patchV1TimeoffId2, + patchV1TravelLetterRequestsId, + patchV1TravelLetterRequestsId2, + patchV1WebhookCallbacksId, + patchV1WorkAuthorizationRequestsId, + patchV1WorkAuthorizationRequestsId2, + patchV2EmploymentsEmploymentId, + patchV2EmploymentsEmploymentId2, + postAuthOauth2Token, + postAuthOauth2Token2, + postV1BenefitRenewalRequestsBenefitRenewalRequestId, + postV1BulkEmploymentJobs, + postV1CancelOnboardingEmploymentId, + postV1Companies, + postV1CompaniesCompanyIdCreateToken, + postV1CompaniesCompanyIdPricingPlans, + postV1CompanyDepartments, + postV1CompanyManagers, + postV1ContractAmendments, + postV1ContractAmendmentsAutomatable, + postV1ContractorInvoiceSchedules, + postV1ContractorsEligibilityQuestionnaire, + postV1ContractorsEmploymentsEmploymentIdContractDocuments, + postV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSign, + postV1ContractorsEmploymentsEmploymentIdContractorCorSubscription, + postV1ContractorsEmploymentsEmploymentIdContractorPlusSubscription, + postV1ContractorsEmploymentsEmploymentIdCorTerminationRequests, + postV1ContractorsEmploymentsEmploymentIdTerminateCorEmployment, + postV1CostCalculatorEstimation, + postV1CostCalculatorEstimationCsv, + postV1CostCalculatorEstimationPdf, + postV1CurrencyConverterEffective, + postV1CurrencyConverterEffective2, + postV1CurrencyConverterRaw, + postV1CustomFields, + postV1DataSync, + postV1Documents, + postV1EmployeeExpenses, + postV1EmployeeTimeoff, + postV1EmployeeTimeoffIdCancel, + postV1Employments, + postV1EmploymentsEmploymentIdContractEligibility, + postV1EmploymentsEmploymentIdEngagementAgreementDetails, + postV1EmploymentsEmploymentIdInvite, + postV1EmploymentsEmploymentIdRiskReserveProofOfPayments, + postV1Expenses, + postV1IdentityVerificationEmploymentIdDecline, + postV1IdentityVerificationEmploymentIdVerify, + postV1Incentives, + postV1IncentivesRecurring, + postV1MagicLink, + postV1Offboardings, + postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocuments, + postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSign, + postV1PayItemsBulk, + postV1ProbationCompletionLetter, + postV1ProbationExtensions, + postV1Ready, + postV1RiskReserve, + postV1SandboxBenefitRenewalRequests, + postV1SandboxCompaniesCompanyIdBypassEligibilityChecks, + postV1SandboxCompaniesCompanyIdLegalEntities, + postV1SandboxEmployments, + postV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApprove, + postV1SandboxWebhookCallbacksTrigger, + postV1SdkTelemetryErrors, + postV1SsoConfiguration, + postV1Timeoff, + postV1TimeoffTimeoffIdApprove, + postV1TimeoffTimeoffIdCancel, + postV1TimeoffTimeoffIdCancelRequestApprove, + postV1TimeoffTimeoffIdCancelRequestDecline, + postV1TimeoffTimeoffIdDecline, + postV1Timesheets, + postV1TimesheetsTimesheetIdApprove, + postV1TimesheetsTimesheetIdSendBack, + postV1WebhookCallbacks, + postV1WebhookEventsReplay, + postV2EmploymentsEmploymentIdEngagementAgreementDetails, + putV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails, + putV1EmploymentsEmploymentIdBasicInformation, + putV1EmploymentsEmploymentIdBenefitOffers, + putV1EmploymentsEmploymentIdFederalTaxes, + putV1EmploymentsEmploymentIdPersonalDetails, + putV1ResignationsOffboardingRequestIdValidate, + putV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityId, + putV1SandboxContractAmendmentsContractAmendmentRequestIdApprove, + putV1SandboxContractAmendmentsContractAmendmentRequestIdCancel, + putV2EmploymentsEmploymentIdAddressDetails, + putV2EmploymentsEmploymentIdAdministrativeDetails, + putV2EmploymentsEmploymentIdBankAccountDetails, + putV2EmploymentsEmploymentIdBasicInformation, + putV2EmploymentsEmploymentIdBillingAddressDetails, + putV2EmploymentsEmploymentIdContractDetails, + putV2EmploymentsEmploymentIdEmergencyContact, + putV2EmploymentsEmploymentIdFederalTaxes, + putV2EmploymentsEmploymentIdPersonalDetails, + putV2EmploymentsEmploymentIdPricingPlanDetails, } from './sdk.gen'; export type { AccountsAccount, @@ -383,6 +419,7 @@ export type { CreateGeneralCustomFieldDefinitionParams, CreateOffboardingParams, CreateOneTimeIncentiveParams, + CreatePreOnboardingDocumentResponse, CreatePricingPlanParams, CreatePricingPlanResponse, CreatePricingPlanWithoutPartnerTemplateParams, @@ -422,31 +459,31 @@ export type { DeclinedWorkAuthozation, DeclineExpenseParams, DeclineTimeoffParams, - DeleteDeleteCompanyManagerData, - DeleteDeleteCompanyManagerError, - DeleteDeleteCompanyManagerErrors, - DeleteDeleteCompanyManagerResponse, - DeleteDeleteCompanyManagerResponses, - DeleteDeleteContractorCorSubscriptionSubscriptionData, - DeleteDeleteContractorCorSubscriptionSubscriptionError, - DeleteDeleteContractorCorSubscriptionSubscriptionErrors, - DeleteDeleteContractorCorSubscriptionSubscriptionResponses, - DeleteDeleteIncentiveData, - DeleteDeleteIncentiveError, - DeleteDeleteIncentiveErrors, - DeleteDeleteIncentiveResponse, - DeleteDeleteIncentiveResponses, - DeleteDeleteRecurringIncentiveData, - DeleteDeleteRecurringIncentiveError, - DeleteDeleteRecurringIncentiveErrors, - DeleteDeleteRecurringIncentiveResponse, - DeleteDeleteRecurringIncentiveResponses, - DeleteDeleteWebhookCallbackData, - DeleteDeleteWebhookCallbackError, - DeleteDeleteWebhookCallbackErrors, - DeleteDeleteWebhookCallbackResponse, - DeleteDeleteWebhookCallbackResponses, DeleteRecurringIncentiveResponse, + DeleteV1CompanyManagersUserIdData, + DeleteV1CompanyManagersUserIdError, + DeleteV1CompanyManagersUserIdErrors, + DeleteV1CompanyManagersUserIdResponse, + DeleteV1CompanyManagersUserIdResponses, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + DeleteV1IncentivesIdData, + DeleteV1IncentivesIdError, + DeleteV1IncentivesIdErrors, + DeleteV1IncentivesIdResponse, + DeleteV1IncentivesIdResponses, + DeleteV1IncentivesRecurringIdData, + DeleteV1IncentivesRecurringIdError, + DeleteV1IncentivesRecurringIdErrors, + DeleteV1IncentivesRecurringIdResponse, + DeleteV1IncentivesRecurringIdResponses, + DeleteV1WebhookCallbacksIdData, + DeleteV1WebhookCallbacksIdError, + DeleteV1WebhookCallbacksIdErrors, + DeleteV1WebhookCallbacksIdResponse, + DeleteV1WebhookCallbacksIdResponses, DepartmentId, DownloadDocumentResponse, DownloadFileResponse, @@ -461,9 +498,14 @@ export type { EmployeesProcessed, EmployeeStats, Employment, + EmploymentAddressDetailsParams, + EmploymentAdministrativeDetailsParams, + EmploymentBankAccountDetailsParams, EmploymentBasicInformationParams, EmploymentBasicResponse, + EmploymentBillingAddressDetailsParams, EmploymentContract, + EmploymentContractDetailsParams, EmploymentContractPendingChangesResponse, EmploymentContractStatus, EmploymentCreateParams, @@ -473,6 +515,7 @@ export type { EmploymentCustomFieldValueJsonValue, EmploymentCustomFieldValueResponse, EmploymentDocument, + EmploymentEmergencyContactParams, EmploymentEngagementAgreementDetailsParams, EmploymentEngagementAgreementDetailsResponse, EmploymentFederalTaxesParams, @@ -483,6 +526,7 @@ export type { EmploymentLifecycleStage, EmploymentOnboardingStepsResponse, EmploymentPersonalDetailsParams, + EmploymentPricingPlanDetailsParams, EmploymentResponse, EmploymentsBenefitOffersListBenefitOffers, EmploymentSeniorityDate, @@ -490,6 +534,7 @@ export type { EmploymentStatus, EmploymentTermType, EmploymentUpdateParams, + EmploymentV2UpdateParams, EngagementAgreementDetailsParamsDeu, EngagementAgreementDetailsResponse, ErrorResponse, @@ -499,569 +544,660 @@ export type { ExpenseResponse, File, FileParams, + FindOrCreatePreOnboardingDocumentParams, ForbiddenResponse, GenericFile, - GetCategoriesExpenseData, - GetCategoriesExpenseError, - GetCategoriesExpenseErrors, - GetCategoriesExpenseResponse, - GetCategoriesExpenseResponses, - GetContractorEligibilityCompanyLegalEntitiesData, - GetContractorEligibilityCompanyLegalEntitiesError, - GetContractorEligibilityCompanyLegalEntitiesErrors, - GetContractorEligibilityCompanyLegalEntitiesResponse, - GetContractorEligibilityCompanyLegalEntitiesResponses, - GetCurrentIdentityData, - GetCurrentIdentityError, - GetCurrentIdentityErrors, - GetCurrentIdentityResponse, - GetCurrentIdentityResponses, - GetDetailsSsoConfigurationData, - GetDetailsSsoConfigurationError, - GetDetailsSsoConfigurationErrors, - GetDetailsSsoConfigurationResponse, - GetDetailsSsoConfigurationResponses, - GetDownloadByIdExpenseReceiptData, - GetDownloadByIdExpenseReceiptError, - GetDownloadByIdExpenseReceiptErrors, - GetDownloadByIdExpenseReceiptResponse, - GetDownloadByIdExpenseReceiptResponses, - GetDownloadExpenseReceiptData, - GetDownloadExpenseReceiptError, - GetDownloadExpenseReceiptErrors, - GetDownloadExpenseReceiptResponse, - GetDownloadExpenseReceiptResponses, - GetDownloadPayslipPayslipData, - GetDownloadPayslipPayslipError, - GetDownloadPayslipPayslipErrors, - GetDownloadPayslipPayslipResponse, - GetDownloadPayslipPayslipResponses, - GetDownloadPdfBillingDocumentData, - GetDownloadPdfBillingDocumentError, - GetDownloadPdfBillingDocumentErrors, - GetDownloadPdfBillingDocumentResponse, - GetDownloadPdfBillingDocumentResponses, - GetDownloadResignationLetterData, - GetDownloadResignationLetterError, - GetDownloadResignationLetterErrors, - GetDownloadResignationLetterResponse, - GetDownloadResignationLetterResponses, - GetEmployeeDetailsPayrollRunData, - GetEmployeeDetailsPayrollRunError, - GetEmployeeDetailsPayrollRunErrors, - GetEmployeeDetailsPayrollRunResponse, - GetEmployeeDetailsPayrollRunResponses, - GetGetBreakdownBillingDocumentData, - GetGetBreakdownBillingDocumentError, - GetGetBreakdownBillingDocumentErrors, - GetGetBreakdownBillingDocumentResponse, - GetGetBreakdownBillingDocumentResponses, - GetGetGroupScimData, - GetGetGroupScimError, - GetGetGroupScimErrors, - GetGetGroupScimResponse, - GetGetGroupScimResponses, - GetGetIdentityVerificationDataIdentityVerificationData, - GetGetIdentityVerificationDataIdentityVerificationError, - GetGetIdentityVerificationDataIdentityVerificationErrors, - GetGetIdentityVerificationDataIdentityVerificationResponse, - GetGetIdentityVerificationDataIdentityVerificationResponses, - GetGetUserScimData, - GetGetUserScimError, - GetGetUserScimErrors, - GetGetUserScimResponse, - GetGetUserScimResponses, - GetIndexBenefitOfferData, - GetIndexBenefitOfferError, - GetIndexBenefitOfferErrors, - GetIndexBenefitOfferResponse, - GetIndexBenefitOfferResponses, - GetIndexBenefitOffersByEmploymentData, - GetIndexBenefitOffersByEmploymentError, - GetIndexBenefitOffersByEmploymentErrors, - GetIndexBenefitOffersByEmploymentResponse, - GetIndexBenefitOffersByEmploymentResponses, - GetIndexBenefitOffersCountrySummaryData, - GetIndexBenefitOffersCountrySummaryError, - GetIndexBenefitOffersCountrySummaryErrors, - GetIndexBenefitOffersCountrySummaryResponse, - GetIndexBenefitOffersCountrySummaryResponses, - GetIndexBenefitRenewalRequestData, - GetIndexBenefitRenewalRequestError, - GetIndexBenefitRenewalRequestErrors, - GetIndexBenefitRenewalRequestResponse, - GetIndexBenefitRenewalRequestResponses, - GetIndexBillingDocumentData, - GetIndexBillingDocumentError, - GetIndexBillingDocumentErrors, - GetIndexBillingDocumentResponse, - GetIndexBillingDocumentResponses, - GetIndexBulkEmploymentRowData, - GetIndexBulkEmploymentRowError, - GetIndexBulkEmploymentRowErrors, - GetIndexBulkEmploymentRowResponse, - GetIndexBulkEmploymentRowResponses, - GetIndexCompanyCurrencyData, - GetIndexCompanyCurrencyError, - GetIndexCompanyCurrencyErrors, - GetIndexCompanyCurrencyResponse, - GetIndexCompanyCurrencyResponses, - GetIndexCompanyData, - GetIndexCompanyDepartmentData, - GetIndexCompanyDepartmentError, - GetIndexCompanyDepartmentErrors, - GetIndexCompanyDepartmentResponse, - GetIndexCompanyDepartmentResponses, - GetIndexCompanyError, - GetIndexCompanyErrors, - GetIndexCompanyLegalEntitiesData, - GetIndexCompanyLegalEntitiesError, - GetIndexCompanyLegalEntitiesErrors, - GetIndexCompanyLegalEntitiesResponse, - GetIndexCompanyLegalEntitiesResponses, - GetIndexCompanyManagerData, - GetIndexCompanyManagerError, - GetIndexCompanyManagerErrors, - GetIndexCompanyManagerResponse, - GetIndexCompanyManagerResponses, - GetIndexCompanyPricingPlanData, - GetIndexCompanyPricingPlanError, - GetIndexCompanyPricingPlanErrors, - GetIndexCompanyPricingPlanResponse, - GetIndexCompanyPricingPlanResponses, - GetIndexCompanyProductPriceData, - GetIndexCompanyProductPriceError, - GetIndexCompanyProductPriceErrors, - GetIndexCompanyProductPriceResponse, - GetIndexCompanyProductPriceResponses, - GetIndexCompanyResponse, - GetIndexCompanyResponses, - GetIndexContractAmendmentData, - GetIndexContractAmendmentError, - GetIndexContractAmendmentErrors, - GetIndexContractAmendmentResponse, - GetIndexContractAmendmentResponses, - GetIndexContractorCurrencyData, - GetIndexContractorCurrencyError, - GetIndexContractorCurrencyErrors, - GetIndexContractorCurrencyResponse, - GetIndexContractorCurrencyResponses, - GetIndexContractorInvoiceData, - GetIndexContractorInvoiceError, - GetIndexContractorInvoiceErrors, - GetIndexContractorInvoiceResponse, - GetIndexContractorInvoiceResponses, - GetIndexCountryData, - GetIndexCountryResponse, - GetIndexCountryResponses, - GetIndexDataSyncData, - GetIndexDataSyncError, - GetIndexDataSyncErrors, - GetIndexDataSyncResponse, - GetIndexDataSyncResponses, - GetIndexEmployeeDocumentData, - GetIndexEmployeeDocumentError, - GetIndexEmployeeDocumentErrors, - GetIndexEmployeeDocumentResponse, - GetIndexEmployeeDocumentResponses, - GetIndexEmploymentCompanyStructureNodeData, - GetIndexEmploymentCompanyStructureNodeError, - GetIndexEmploymentCompanyStructureNodeErrors, - GetIndexEmploymentCompanyStructureNodeResponse, - GetIndexEmploymentCompanyStructureNodeResponses, - GetIndexEmploymentContractData, - GetIndexEmploymentContractDocumentData, - GetIndexEmploymentContractDocumentError, - GetIndexEmploymentContractDocumentErrors, - GetIndexEmploymentContractDocumentResponse, - GetIndexEmploymentContractDocumentResponses, - GetIndexEmploymentContractError, - GetIndexEmploymentContractErrors, - GetIndexEmploymentContractResponse, - GetIndexEmploymentContractResponses, - GetIndexEmploymentCustomFieldData, - GetIndexEmploymentCustomFieldError, - GetIndexEmploymentCustomFieldErrors, - GetIndexEmploymentCustomFieldResponse, - GetIndexEmploymentCustomFieldResponses, - GetIndexEmploymentCustomFieldValueData, - GetIndexEmploymentCustomFieldValueError, - GetIndexEmploymentCustomFieldValueErrors, - GetIndexEmploymentCustomFieldValueResponse, - GetIndexEmploymentCustomFieldValueResponses, - GetIndexEmploymentData, - GetIndexEmploymentError, - GetIndexEmploymentErrors, - GetIndexEmploymentFileData, - GetIndexEmploymentFileError, - GetIndexEmploymentFileErrors, - GetIndexEmploymentFileResponse, - GetIndexEmploymentFileResponses, - GetIndexEmploymentJobData, - GetIndexEmploymentJobError, - GetIndexEmploymentJobErrors, - GetIndexEmploymentJobResponse, - GetIndexEmploymentJobResponses, - GetIndexEmploymentResponse, - GetIndexEmploymentResponses, - GetIndexEorPayrollCalendarData, - GetIndexEorPayrollCalendarError, - GetIndexEorPayrollCalendarErrors, - GetIndexEorPayrollCalendarResponse, - GetIndexEorPayrollCalendarResponses, - GetIndexExpenseData, - GetIndexExpenseError, - GetIndexExpenseErrors, - GetIndexExpenseResponse, - GetIndexExpenseResponses, - GetIndexHolidayData, - GetIndexHolidayError, - GetIndexHolidayErrors, - GetIndexHolidayResponse, - GetIndexHolidayResponses, - GetIndexIncentiveData, - GetIndexIncentiveError, - GetIndexIncentiveErrors, - GetIndexIncentiveResponse, - GetIndexIncentiveResponses, - GetIndexLeavePoliciesDetailsData, - GetIndexLeavePoliciesDetailsError, - GetIndexLeavePoliciesDetailsErrors, - GetIndexLeavePoliciesDetailsResponse, - GetIndexLeavePoliciesDetailsResponses, - GetIndexLeavePoliciesSummaryData, - GetIndexLeavePoliciesSummaryError, - GetIndexLeavePoliciesSummaryErrors, - GetIndexLeavePoliciesSummaryResponse, - GetIndexLeavePoliciesSummaryResponses, - GetIndexOffboardingData, - GetIndexOffboardingError, - GetIndexOffboardingErrors, - GetIndexOffboardingResponse, - GetIndexOffboardingResponses, - GetIndexPayItemsData, - GetIndexPayItemsError, - GetIndexPayItemsErrors, - GetIndexPayItemsResponse, - GetIndexPayItemsResponses, - GetIndexPayrollCalendarData, - GetIndexPayrollCalendarError, - GetIndexPayrollCalendarErrors, - GetIndexPayrollCalendarResponse, - GetIndexPayrollCalendarResponses, - GetIndexPayrollRunData, - GetIndexPayrollRunError, - GetIndexPayrollRunErrors, - GetIndexPayrollRunResponse, - GetIndexPayrollRunResponses, - GetIndexPayslipData, - GetIndexPayslipError, - GetIndexPayslipErrors, - GetIndexPayslipResponse, - GetIndexPayslipResponses, - GetIndexPricingPlanPartnerTemplateData, - GetIndexPricingPlanPartnerTemplateError, - GetIndexPricingPlanPartnerTemplateErrors, - GetIndexPricingPlanPartnerTemplateResponse, - GetIndexPricingPlanPartnerTemplateResponses, - GetIndexRecurringIncentiveData, - GetIndexRecurringIncentiveError, - GetIndexRecurringIncentiveErrors, - GetIndexRecurringIncentiveResponse, - GetIndexRecurringIncentiveResponses, - GetIndexScheduledContractorInvoiceData, - GetIndexScheduledContractorInvoiceError, - GetIndexScheduledContractorInvoiceErrors, - GetIndexScheduledContractorInvoiceResponse, - GetIndexScheduledContractorInvoiceResponses, - GetIndexSubscriptionData, - GetIndexSubscriptionError, - GetIndexSubscriptionErrors, - GetIndexSubscriptionResponse, - GetIndexSubscriptionResponses, - GetIndexTimeoffData, - GetIndexTimeoffError, - GetIndexTimeoffErrors, - GetIndexTimeoffResponse, - GetIndexTimeoffResponses, - GetIndexTimesheetData, - GetIndexTimesheetError, - GetIndexTimesheetErrors, - GetIndexTimesheetResponse, - GetIndexTimesheetResponses, - GetIndexTravelLetterRequestData, - GetIndexTravelLetterRequestError, - GetIndexTravelLetterRequestErrors, - GetIndexTravelLetterRequestResponse, - GetIndexTravelLetterRequestResponses, - GetIndexWebhookCallbackData, - GetIndexWebhookCallbackError, - GetIndexWebhookCallbackErrors, - GetIndexWebhookCallbackResponse, - GetIndexWebhookCallbackResponses, - GetIndexWebhookEventData, - GetIndexWebhookEventError, - GetIndexWebhookEventErrors, - GetIndexWebhookEventResponse, - GetIndexWebhookEventResponses, - GetIndexWorkAuthorizationRequestData, - GetIndexWorkAuthorizationRequestError, - GetIndexWorkAuthorizationRequestErrors, - GetIndexWorkAuthorizationRequestResponse, - GetIndexWorkAuthorizationRequestResponses, - GetListGroupsScimData, - GetListGroupsScimError, - GetListGroupsScimErrors, - GetListGroupsScimResponse, - GetListGroupsScimResponses, - GetListUsersScimData, - GetListUsersScimError, - GetListUsersScimErrors, - GetListUsersScimResponse, - GetListUsersScimResponses, - GetPendingChangesEmploymentContractData, - GetPendingChangesEmploymentContractError, - GetPendingChangesEmploymentContractErrors, - GetPendingChangesEmploymentContractResponse, - GetPendingChangesEmploymentContractResponses, - GetSchemaBenefitRenewalRequestData, - GetSchemaBenefitRenewalRequestError, - GetSchemaBenefitRenewalRequestErrors, - GetSchemaBenefitRenewalRequestResponse, - GetSchemaBenefitRenewalRequestResponses, - GetShowAdministrativeDetailsData, - GetShowAdministrativeDetailsError, - GetShowAdministrativeDetailsErrors, - GetShowAdministrativeDetailsResponse, - GetShowAdministrativeDetailsResponses, - GetShowBackgroundCheckData, - GetShowBackgroundCheckError, - GetShowBackgroundCheckErrors, - GetShowBackgroundCheckResponse, - GetShowBackgroundCheckResponses, - GetShowBenefitRenewalRequestData, - GetShowBenefitRenewalRequestError, - GetShowBenefitRenewalRequestErrors, - GetShowBenefitRenewalRequestResponse, - GetShowBenefitRenewalRequestResponses, - GetShowBillingDocumentData, - GetShowBillingDocumentError, - GetShowBillingDocumentErrors, - GetShowBillingDocumentResponse, - GetShowBillingDocumentResponses, - GetShowBulkEmploymentData, - GetShowBulkEmploymentError, - GetShowBulkEmploymentErrors, - GetShowBulkEmploymentResponse, - GetShowBulkEmploymentResponses, - GetShowCompanyComplianceProfileData, - GetShowCompanyComplianceProfileError, - GetShowCompanyComplianceProfileErrors, - GetShowCompanyComplianceProfileResponse, - GetShowCompanyComplianceProfileResponses, - GetShowCompanyData, - GetShowCompanyEmploymentOnboardingReservesStatusData, - GetShowCompanyEmploymentOnboardingReservesStatusError, - GetShowCompanyEmploymentOnboardingReservesStatusErrors, - GetShowCompanyEmploymentOnboardingReservesStatusResponse, - GetShowCompanyEmploymentOnboardingReservesStatusResponses, - GetShowCompanyError, - GetShowCompanyErrors, - GetShowCompanyManagerData, - GetShowCompanyManagerError, - GetShowCompanyManagerErrors, - GetShowCompanyManagerResponse, - GetShowCompanyManagerResponses, - GetShowCompanyResponse, - GetShowCompanyResponses, - GetShowCompanySchemaData, - GetShowCompanySchemaError, - GetShowCompanySchemaErrors, - GetShowCompanySchemaResponse, - GetShowCompanySchemaResponses, - GetShowContractAmendmentData, - GetShowContractAmendmentError, - GetShowContractAmendmentErrors, - GetShowContractAmendmentResponse, - GetShowContractAmendmentResponses, - GetShowContractAmendmentSchemaData, - GetShowContractAmendmentSchemaError, - GetShowContractAmendmentSchemaErrors, - GetShowContractAmendmentSchemaResponse, - GetShowContractAmendmentSchemaResponses, - GetShowContractDocumentData, - GetShowContractDocumentError, - GetShowContractDocumentErrors, - GetShowContractDocumentResponse, - GetShowContractDocumentResponses, - GetShowContractorContractDetailsCountryData, - GetShowContractorContractDetailsCountryError, - GetShowContractorContractDetailsCountryErrors, - GetShowContractorContractDetailsCountryResponse, - GetShowContractorContractDetailsCountryResponses, - GetShowContractorInvoiceData, - GetShowContractorInvoiceError, - GetShowContractorInvoiceErrors, - GetShowContractorInvoiceResponse, - GetShowContractorInvoiceResponses, - GetShowCorTerminationRequestSubscriptionData, - GetShowCorTerminationRequestSubscriptionError, - GetShowCorTerminationRequestSubscriptionErrors, - GetShowCorTerminationRequestSubscriptionResponse, - GetShowCorTerminationRequestSubscriptionResponses, - GetShowEligibilityQuestionnaireData, - GetShowEligibilityQuestionnaireError, - GetShowEligibilityQuestionnaireErrors, - GetShowEligibilityQuestionnaireResponse, - GetShowEligibilityQuestionnaireResponses, - GetShowEmployeeDocumentData, - GetShowEmployeeDocumentError, - GetShowEmployeeDocumentErrors, - GetShowEmployeeDocumentResponse, - GetShowEmployeeDocumentResponses, - GetShowEmploymentCustomFieldValueData, - GetShowEmploymentCustomFieldValueError, - GetShowEmploymentCustomFieldValueErrors, - GetShowEmploymentCustomFieldValueResponse, - GetShowEmploymentCustomFieldValueResponses, - GetShowEmploymentData, - GetShowEmploymentEngagementAgreementDetailsData, - GetShowEmploymentEngagementAgreementDetailsError, - GetShowEmploymentEngagementAgreementDetailsErrors, - GetShowEmploymentEngagementAgreementDetailsResponse, - GetShowEmploymentEngagementAgreementDetailsResponses, - GetShowEmploymentError, - GetShowEmploymentErrors, - GetShowEmploymentOnboardingStepsData, - GetShowEmploymentOnboardingStepsError, - GetShowEmploymentOnboardingStepsErrors, - GetShowEmploymentOnboardingStepsResponse, - GetShowEmploymentOnboardingStepsResponses, - GetShowEmploymentResponse, - GetShowEmploymentResponses, - GetShowEngagementAgreementDetailsCountryData, - GetShowEngagementAgreementDetailsCountryError, - GetShowEngagementAgreementDetailsCountryErrors, - GetShowEngagementAgreementDetailsCountryResponse, - GetShowEngagementAgreementDetailsCountryResponses, - GetShowExpenseData, - GetShowExpenseError, - GetShowExpenseErrors, - GetShowExpenseResponse, - GetShowExpenseResponses, - GetShowFileData, - GetShowFileError, - GetShowFileErrors, - GetShowFileResponse, - GetShowFileResponses, - GetShowFormCountryData, - GetShowFormCountryError, - GetShowFormCountryErrors, - GetShowFormCountryResponse, - GetShowFormCountryResponses, - GetShowHelpCenterArticleData, - GetShowHelpCenterArticleError, - GetShowHelpCenterArticleErrors, - GetShowHelpCenterArticleResponse, - GetShowHelpCenterArticleResponses, - GetShowIncentiveData, - GetShowIncentiveError, - GetShowIncentiveErrors, - GetShowIncentiveResponse, - GetShowIncentiveResponses, - GetShowLegalEntityFormCountryData, - GetShowLegalEntityFormCountryError, - GetShowLegalEntityFormCountryErrors, - GetShowLegalEntityFormCountryResponse, - GetShowLegalEntityFormCountryResponses, - GetShowOffboardingData, - GetShowOffboardingError, - GetShowOffboardingErrors, - GetShowOffboardingResponse, - GetShowOffboardingResponses, - GetShowPayrollRunData, - GetShowPayrollRunError, - GetShowPayrollRunErrors, - GetShowPayrollRunResponse, - GetShowPayrollRunResponses, - GetShowPayslipData, - GetShowPayslipError, - GetShowPayslipErrors, - GetShowPayslipResponse, - GetShowPayslipResponses, - GetShowProbationCompletionLetterData, - GetShowProbationCompletionLetterError, - GetShowProbationCompletionLetterErrors, - GetShowProbationCompletionLetterResponse, - GetShowProbationCompletionLetterResponses, - GetShowProbationExtensionData, - GetShowProbationExtensionError, - GetShowProbationExtensionErrors, - GetShowProbationExtensionResponse, - GetShowProbationExtensionResponses, - GetShowRegionFieldData, - GetShowRegionFieldError, - GetShowRegionFieldErrors, - GetShowRegionFieldResponse, - GetShowRegionFieldResponses, - GetShowResignationData, - GetShowResignationError, - GetShowResignationErrors, - GetShowResignationResponse, - GetShowResignationResponses, - GetShowScheduledContractorInvoiceData, - GetShowScheduledContractorInvoiceError, - GetShowScheduledContractorInvoiceErrors, - GetShowScheduledContractorInvoiceResponse, - GetShowScheduledContractorInvoiceResponses, - GetShowSchemaData, - GetShowSchemaError, - GetShowSchemaErrors, - GetShowSchemaResponse, - GetShowSchemaResponses, - GetShowSsoConfigurationData, - GetShowSsoConfigurationError, - GetShowSsoConfigurationErrors, - GetShowSsoConfigurationResponse, - GetShowSsoConfigurationResponses, - GetShowTestSchemaData, - GetShowTestSchemaResponse, - GetShowTestSchemaResponses, - GetShowTimeoffBalanceData, - GetShowTimeoffBalanceError, - GetShowTimeoffBalanceErrors, - GetShowTimeoffBalanceResponse, - GetShowTimeoffBalanceResponses, - GetShowTimeoffData, - GetShowTimeoffError, - GetShowTimeoffErrors, - GetShowTimeoffResponse, - GetShowTimeoffResponses, - GetShowTimesheetData, - GetShowTimesheetError, - GetShowTimesheetErrors, - GetShowTimesheetResponse, - GetShowTimesheetResponses, - GetShowTravelLetterRequestData, - GetShowTravelLetterRequestError, - GetShowTravelLetterRequestErrors, - GetShowTravelLetterRequestResponse, - GetShowTravelLetterRequestResponses, - GetShowWorkAuthorizationRequestData, - GetShowWorkAuthorizationRequestError, - GetShowWorkAuthorizationRequestErrors, - GetShowWorkAuthorizationRequestResponse, - GetShowWorkAuthorizationRequestResponses, - GetSupportedCountryData, - GetSupportedCountryError, - GetSupportedCountryErrors, - GetSupportedCountryResponse, - GetSupportedCountryResponses, - GetTimeoffTypesTimeoffData, - GetTimeoffTypesTimeoffError, - GetTimeoffTypesTimeoffErrors, - GetTimeoffTypesTimeoffResponse, - GetTimeoffTypesTimeoffResponses, + GetV1BenefitOffersCountrySummariesData, + GetV1BenefitOffersCountrySummariesError, + GetV1BenefitOffersCountrySummariesErrors, + GetV1BenefitOffersCountrySummariesResponse, + GetV1BenefitOffersCountrySummariesResponses, + GetV1BenefitOffersData, + GetV1BenefitOffersError, + GetV1BenefitOffersErrors, + GetV1BenefitOffersResponse, + GetV1BenefitOffersResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdError, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaError, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponse, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses, + GetV1BenefitRenewalRequestsData, + GetV1BenefitRenewalRequestsError, + GetV1BenefitRenewalRequestsErrors, + GetV1BenefitRenewalRequestsResponse, + GetV1BenefitRenewalRequestsResponses, + GetV1BillingDocumentsBillingDocumentIdBreakdownData, + GetV1BillingDocumentsBillingDocumentIdBreakdownError, + GetV1BillingDocumentsBillingDocumentIdBreakdownErrors, + GetV1BillingDocumentsBillingDocumentIdBreakdownResponse, + GetV1BillingDocumentsBillingDocumentIdBreakdownResponses, + GetV1BillingDocumentsBillingDocumentIdData, + GetV1BillingDocumentsBillingDocumentIdError, + GetV1BillingDocumentsBillingDocumentIdErrors, + GetV1BillingDocumentsBillingDocumentIdPdfData, + GetV1BillingDocumentsBillingDocumentIdPdfError, + GetV1BillingDocumentsBillingDocumentIdPdfErrors, + GetV1BillingDocumentsBillingDocumentIdPdfResponse, + GetV1BillingDocumentsBillingDocumentIdPdfResponses, + GetV1BillingDocumentsBillingDocumentIdResponse, + GetV1BillingDocumentsBillingDocumentIdResponses, + GetV1BillingDocumentsData, + GetV1BillingDocumentsError, + GetV1BillingDocumentsErrors, + GetV1BillingDocumentsResponse, + GetV1BillingDocumentsResponses, + GetV1BulkEmploymentJobsJobIdData, + GetV1BulkEmploymentJobsJobIdError, + GetV1BulkEmploymentJobsJobIdErrors, + GetV1BulkEmploymentJobsJobIdResponse, + GetV1BulkEmploymentJobsJobIdResponses, + GetV1BulkEmploymentJobsJobIdRowsData, + GetV1BulkEmploymentJobsJobIdRowsError, + GetV1BulkEmploymentJobsJobIdRowsErrors, + GetV1BulkEmploymentJobsJobIdRowsResponse, + GetV1BulkEmploymentJobsJobIdRowsResponses, + GetV1CompaniesCompanyIdComplianceProfileData, + GetV1CompaniesCompanyIdComplianceProfileError, + GetV1CompaniesCompanyIdComplianceProfileErrors, + GetV1CompaniesCompanyIdComplianceProfileResponse, + GetV1CompaniesCompanyIdComplianceProfileResponses, + GetV1CompaniesCompanyIdData, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusError, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponse, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses, + GetV1CompaniesCompanyIdError, + GetV1CompaniesCompanyIdErrors, + GetV1CompaniesCompanyIdLegalEntitiesData, + GetV1CompaniesCompanyIdLegalEntitiesError, + GetV1CompaniesCompanyIdLegalEntitiesErrors, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityError, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponse, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses, + GetV1CompaniesCompanyIdLegalEntitiesResponse, + GetV1CompaniesCompanyIdLegalEntitiesResponses, + GetV1CompaniesCompanyIdPricingPlansData, + GetV1CompaniesCompanyIdPricingPlansError, + GetV1CompaniesCompanyIdPricingPlansErrors, + GetV1CompaniesCompanyIdPricingPlansResponse, + GetV1CompaniesCompanyIdPricingPlansResponses, + GetV1CompaniesCompanyIdProductPricesData, + GetV1CompaniesCompanyIdProductPricesError, + GetV1CompaniesCompanyIdProductPricesErrors, + GetV1CompaniesCompanyIdProductPricesResponse, + GetV1CompaniesCompanyIdProductPricesResponses, + GetV1CompaniesCompanyIdResponse, + GetV1CompaniesCompanyIdResponses, + GetV1CompaniesCompanyIdWebhookCallbacksData, + GetV1CompaniesCompanyIdWebhookCallbacksError, + GetV1CompaniesCompanyIdWebhookCallbacksErrors, + GetV1CompaniesCompanyIdWebhookCallbacksResponse, + GetV1CompaniesCompanyIdWebhookCallbacksResponses, + GetV1CompaniesData, + GetV1CompaniesError, + GetV1CompaniesErrors, + GetV1CompaniesResponse, + GetV1CompaniesResponses, + GetV1CompaniesSchemaData, + GetV1CompaniesSchemaError, + GetV1CompaniesSchemaErrors, + GetV1CompaniesSchemaResponse, + GetV1CompaniesSchemaResponses, + GetV1CompanyCurrenciesData, + GetV1CompanyCurrenciesError, + GetV1CompanyCurrenciesErrors, + GetV1CompanyCurrenciesResponse, + GetV1CompanyCurrenciesResponses, + GetV1CompanyDepartmentsData, + GetV1CompanyDepartmentsError, + GetV1CompanyDepartmentsErrors, + GetV1CompanyDepartmentsResponse, + GetV1CompanyDepartmentsResponses, + GetV1CompanyManagersData, + GetV1CompanyManagersError, + GetV1CompanyManagersErrors, + GetV1CompanyManagersResponse, + GetV1CompanyManagersResponses, + GetV1CompanyManagersUserIdData, + GetV1CompanyManagersUserIdError, + GetV1CompanyManagersUserIdErrors, + GetV1CompanyManagersUserIdResponse, + GetV1CompanyManagersUserIdResponses, + GetV1ContractAmendmentsData, + GetV1ContractAmendmentsError, + GetV1ContractAmendmentsErrors, + GetV1ContractAmendmentsIdData, + GetV1ContractAmendmentsIdError, + GetV1ContractAmendmentsIdErrors, + GetV1ContractAmendmentsIdResponse, + GetV1ContractAmendmentsIdResponses, + GetV1ContractAmendmentsResponse, + GetV1ContractAmendmentsResponses, + GetV1ContractAmendmentsSchemaData, + GetV1ContractAmendmentsSchemaError, + GetV1ContractAmendmentsSchemaErrors, + GetV1ContractAmendmentsSchemaResponse, + GetV1ContractAmendmentsSchemaResponses, + GetV1ContractorInvoiceSchedulesData, + GetV1ContractorInvoiceSchedulesError, + GetV1ContractorInvoiceSchedulesErrors, + GetV1ContractorInvoiceSchedulesIdData, + GetV1ContractorInvoiceSchedulesIdError, + GetV1ContractorInvoiceSchedulesIdErrors, + GetV1ContractorInvoiceSchedulesIdResponse, + GetV1ContractorInvoiceSchedulesIdResponses, + GetV1ContractorInvoiceSchedulesResponse, + GetV1ContractorInvoiceSchedulesResponses, + GetV1ContractorInvoicesData, + GetV1ContractorInvoicesError, + GetV1ContractorInvoicesErrors, + GetV1ContractorInvoicesIdData, + GetV1ContractorInvoicesIdError, + GetV1ContractorInvoicesIdErrors, + GetV1ContractorInvoicesIdResponse, + GetV1ContractorInvoicesIdResponses, + GetV1ContractorInvoicesResponse, + GetV1ContractorInvoicesResponses, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdError, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponse, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesError, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponse, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsError, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponse, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdError, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponse, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses, + GetV1ContractorsSchemasEligibilityQuestionnaireData, + GetV1ContractorsSchemasEligibilityQuestionnaireError, + GetV1ContractorsSchemasEligibilityQuestionnaireErrors, + GetV1ContractorsSchemasEligibilityQuestionnaireResponse, + GetV1ContractorsSchemasEligibilityQuestionnaireResponses, + GetV1CostCalculatorCountriesData, + GetV1CostCalculatorCountriesResponse, + GetV1CostCalculatorCountriesResponses, + GetV1CostCalculatorRegionsSlugFieldsData, + GetV1CostCalculatorRegionsSlugFieldsError, + GetV1CostCalculatorRegionsSlugFieldsErrors, + GetV1CostCalculatorRegionsSlugFieldsResponse, + GetV1CostCalculatorRegionsSlugFieldsResponses, + GetV1CountriesCountryCodeContractorContractDetailsData, + GetV1CountriesCountryCodeContractorContractDetailsError, + GetV1CountriesCountryCodeContractorContractDetailsErrors, + GetV1CountriesCountryCodeContractorContractDetailsResponse, + GetV1CountriesCountryCodeContractorContractDetailsResponses, + GetV1CountriesCountryCodeEngagementAgreementDetailsData, + GetV1CountriesCountryCodeEngagementAgreementDetailsError, + GetV1CountriesCountryCodeEngagementAgreementDetailsErrors, + GetV1CountriesCountryCodeEngagementAgreementDetailsResponse, + GetV1CountriesCountryCodeEngagementAgreementDetailsResponses, + GetV1CountriesCountryCodeFormData, + GetV1CountriesCountryCodeFormError, + GetV1CountriesCountryCodeFormErrors, + GetV1CountriesCountryCodeFormResponse, + GetV1CountriesCountryCodeFormResponses, + GetV1CountriesCountryCodeHolidaysYearData, + GetV1CountriesCountryCodeHolidaysYearError, + GetV1CountriesCountryCodeHolidaysYearErrors, + GetV1CountriesCountryCodeHolidaysYearResponse, + GetV1CountriesCountryCodeHolidaysYearResponses, + GetV1CountriesCountryCodeLegalEntityFormsFormData, + GetV1CountriesCountryCodeLegalEntityFormsFormError, + GetV1CountriesCountryCodeLegalEntityFormsFormErrors, + GetV1CountriesCountryCodeLegalEntityFormsFormResponse, + GetV1CountriesCountryCodeLegalEntityFormsFormResponses, + GetV1CountriesData, + GetV1CountriesError, + GetV1CountriesErrors, + GetV1CountriesResponse, + GetV1CountriesResponses, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdError, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + GetV1CustomFieldsData, + GetV1CustomFieldsError, + GetV1CustomFieldsErrors, + GetV1CustomFieldsResponse, + GetV1CustomFieldsResponses, + GetV1DataSyncData, + GetV1DataSyncError, + GetV1DataSyncErrors, + GetV1DataSyncResponse, + GetV1DataSyncResponses, + GetV1EmployeeDocumentsData, + GetV1EmployeeDocumentsError, + GetV1EmployeeDocumentsErrors, + GetV1EmployeeDocumentsIdData, + GetV1EmployeeDocumentsIdError, + GetV1EmployeeDocumentsIdErrors, + GetV1EmployeeDocumentsIdResponse, + GetV1EmployeeDocumentsIdResponses, + GetV1EmployeeDocumentsResponse, + GetV1EmployeeDocumentsResponses, + GetV1EmployeeExpenseCategoriesData, + GetV1EmployeeExpenseCategoriesError, + GetV1EmployeeExpenseCategoriesErrors, + GetV1EmployeeExpenseCategoriesResponse, + GetV1EmployeeExpenseCategoriesResponses, + GetV1EmployeeExpensesData, + GetV1EmployeeExpensesError, + GetV1EmployeeExpensesErrors, + GetV1EmployeeExpensesResponse, + GetV1EmployeeExpensesResponses, + GetV1EmployeeIncentivesData, + GetV1EmployeeIncentivesError, + GetV1EmployeeIncentivesErrors, + GetV1EmployeeIncentivesResponse, + GetV1EmployeeIncentivesResponses, + GetV1EmployeeLeavePoliciesData, + GetV1EmployeeLeavePoliciesError, + GetV1EmployeeLeavePoliciesErrors, + GetV1EmployeeLeavePoliciesResponse, + GetV1EmployeeLeavePoliciesResponses, + GetV1EmployeePayslipFilesData, + GetV1EmployeePayslipFilesError, + GetV1EmployeePayslipFilesErrors, + GetV1EmployeePayslipFilesResponse, + GetV1EmployeePayslipFilesResponses, + GetV1EmployeePayslipsData, + GetV1EmployeePayslipsError, + GetV1EmployeePayslipsErrors, + GetV1EmployeePayslipsResponse, + GetV1EmployeePayslipsResponses, + GetV1EmployeePersonalInformationData, + GetV1EmployeePersonalInformationError, + GetV1EmployeePersonalInformationErrors, + GetV1EmployeePersonalInformationResponse, + GetV1EmployeePersonalInformationResponses, + GetV1EmployeeTimeoffData, + GetV1EmployeeTimeoffError, + GetV1EmployeeTimeoffErrors, + GetV1EmployeeTimeoffResponse, + GetV1EmployeeTimeoffResponses, + GetV1EmployeeTimesheetsData, + GetV1EmployeeTimesheetsError, + GetV1EmployeeTimesheetsErrors, + GetV1EmployeeTimesheetsResponse, + GetV1EmployeeTimesheetsResponses, + GetV1EmploymentContractsData, + GetV1EmploymentContractsEmploymentIdPendingChangesData, + GetV1EmploymentContractsEmploymentIdPendingChangesError, + GetV1EmploymentContractsEmploymentIdPendingChangesErrors, + GetV1EmploymentContractsEmploymentIdPendingChangesResponse, + GetV1EmploymentContractsEmploymentIdPendingChangesResponses, + GetV1EmploymentContractsError, + GetV1EmploymentContractsErrors, + GetV1EmploymentContractsResponse, + GetV1EmploymentContractsResponses, + GetV1EmploymentsData, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdError, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponse, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses, + GetV1EmploymentsEmploymentIdBenefitOffersData, + GetV1EmploymentsEmploymentIdBenefitOffersError, + GetV1EmploymentsEmploymentIdBenefitOffersErrors, + GetV1EmploymentsEmploymentIdBenefitOffersResponse, + GetV1EmploymentsEmploymentIdBenefitOffersResponses, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaData, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaError, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponse, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses, + GetV1EmploymentsEmploymentIdCompanyStructureNodesData, + GetV1EmploymentsEmploymentIdCompanyStructureNodesError, + GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors, + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponse, + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses, + GetV1EmploymentsEmploymentIdContractDocumentsData, + GetV1EmploymentsEmploymentIdContractDocumentsError, + GetV1EmploymentsEmploymentIdContractDocumentsErrors, + GetV1EmploymentsEmploymentIdContractDocumentsResponse, + GetV1EmploymentsEmploymentIdContractDocumentsResponses, + GetV1EmploymentsEmploymentIdCustomFieldsData, + GetV1EmploymentsEmploymentIdCustomFieldsError, + GetV1EmploymentsEmploymentIdCustomFieldsErrors, + GetV1EmploymentsEmploymentIdCustomFieldsResponse, + GetV1EmploymentsEmploymentIdCustomFieldsResponses, + GetV1EmploymentsEmploymentIdData, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsError, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + GetV1EmploymentsEmploymentIdError, + GetV1EmploymentsEmploymentIdErrors, + GetV1EmploymentsEmploymentIdFilesData, + GetV1EmploymentsEmploymentIdFilesError, + GetV1EmploymentsEmploymentIdFilesErrors, + GetV1EmploymentsEmploymentIdFilesResponse, + GetV1EmploymentsEmploymentIdFilesResponses, + GetV1EmploymentsEmploymentIdJobData, + GetV1EmploymentsEmploymentIdJobError, + GetV1EmploymentsEmploymentIdJobErrors, + GetV1EmploymentsEmploymentIdJobResponse, + GetV1EmploymentsEmploymentIdJobResponses, + GetV1EmploymentsEmploymentIdOnboardingStepsData, + GetV1EmploymentsEmploymentIdOnboardingStepsError, + GetV1EmploymentsEmploymentIdOnboardingStepsErrors, + GetV1EmploymentsEmploymentIdOnboardingStepsResponse, + GetV1EmploymentsEmploymentIdOnboardingStepsResponses, + GetV1EmploymentsEmploymentIdResponse, + GetV1EmploymentsEmploymentIdResponses, + GetV1EmploymentsError, + GetV1EmploymentsErrors, + GetV1EmploymentsResponse, + GetV1EmploymentsResponses, + GetV1ExpensesCategoriesData, + GetV1ExpensesCategoriesError, + GetV1ExpensesCategoriesErrors, + GetV1ExpensesCategoriesResponse, + GetV1ExpensesCategoriesResponses, + GetV1ExpensesData, + GetV1ExpensesError, + GetV1ExpensesErrors, + GetV1ExpensesExpenseIdReceiptData, + GetV1ExpensesExpenseIdReceiptError, + GetV1ExpensesExpenseIdReceiptErrors, + GetV1ExpensesExpenseIdReceiptResponse, + GetV1ExpensesExpenseIdReceiptResponses, + GetV1ExpensesExpenseIdReceiptsReceiptIdData, + GetV1ExpensesExpenseIdReceiptsReceiptIdError, + GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, + GetV1ExpensesExpenseIdReceiptsReceiptIdResponse, + GetV1ExpensesExpenseIdReceiptsReceiptIdResponses, + GetV1ExpensesIdData, + GetV1ExpensesIdError, + GetV1ExpensesIdErrors, + GetV1ExpensesIdResponse, + GetV1ExpensesIdResponses, + GetV1ExpensesResponse, + GetV1ExpensesResponses, + GetV1FilesIdData, + GetV1FilesIdError, + GetV1FilesIdErrors, + GetV1FilesIdResponse, + GetV1FilesIdResponses, + GetV1HelpCenterArticlesIdData, + GetV1HelpCenterArticlesIdError, + GetV1HelpCenterArticlesIdErrors, + GetV1HelpCenterArticlesIdResponse, + GetV1HelpCenterArticlesIdResponses, + GetV1IdentityCurrentData, + GetV1IdentityCurrentError, + GetV1IdentityCurrentErrors, + GetV1IdentityCurrentResponse, + GetV1IdentityCurrentResponses, + GetV1IdentityVerificationEmploymentIdData, + GetV1IdentityVerificationEmploymentIdError, + GetV1IdentityVerificationEmploymentIdErrors, + GetV1IdentityVerificationEmploymentIdResponse, + GetV1IdentityVerificationEmploymentIdResponses, + GetV1IncentivesData, + GetV1IncentivesError, + GetV1IncentivesErrors, + GetV1IncentivesIdData, + GetV1IncentivesIdError, + GetV1IncentivesIdErrors, + GetV1IncentivesIdResponse, + GetV1IncentivesIdResponses, + GetV1IncentivesRecurringData, + GetV1IncentivesRecurringError, + GetV1IncentivesRecurringErrors, + GetV1IncentivesRecurringResponse, + GetV1IncentivesRecurringResponses, + GetV1IncentivesResponse, + GetV1IncentivesResponses, + GetV1LeavePoliciesDetailsEmploymentIdData, + GetV1LeavePoliciesDetailsEmploymentIdError, + GetV1LeavePoliciesDetailsEmploymentIdErrors, + GetV1LeavePoliciesDetailsEmploymentIdResponse, + GetV1LeavePoliciesDetailsEmploymentIdResponses, + GetV1LeavePoliciesSummaryEmploymentIdData, + GetV1LeavePoliciesSummaryEmploymentIdError, + GetV1LeavePoliciesSummaryEmploymentIdErrors, + GetV1LeavePoliciesSummaryEmploymentIdResponse, + GetV1LeavePoliciesSummaryEmploymentIdResponses, + GetV1OffboardingsData, + GetV1OffboardingsError, + GetV1OffboardingsErrors, + GetV1OffboardingsIdData, + GetV1OffboardingsIdError, + GetV1OffboardingsIdErrors, + GetV1OffboardingsIdResponse, + GetV1OffboardingsIdResponses, + GetV1OffboardingsResponse, + GetV1OffboardingsResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdError, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponse, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsError, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponse, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses, + GetV1PayItemsData, + GetV1PayItemsError, + GetV1PayItemsErrors, + GetV1PayItemsResponse, + GetV1PayItemsResponses, + GetV1PayrollCalendarsCycleData, + GetV1PayrollCalendarsCycleError, + GetV1PayrollCalendarsCycleErrors, + GetV1PayrollCalendarsCycleResponse, + GetV1PayrollCalendarsCycleResponses, + GetV1PayrollCalendarsData, + GetV1PayrollCalendarsError, + GetV1PayrollCalendarsErrors, + GetV1PayrollCalendarsResponse, + GetV1PayrollCalendarsResponses, + GetV1PayrollRunsData, + GetV1PayrollRunsError, + GetV1PayrollRunsErrors, + GetV1PayrollRunsPayrollRunIdData, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsData, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsError, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponse, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses, + GetV1PayrollRunsPayrollRunIdError, + GetV1PayrollRunsPayrollRunIdErrors, + GetV1PayrollRunsPayrollRunIdResponse, + GetV1PayrollRunsPayrollRunIdResponses, + GetV1PayrollRunsResponse, + GetV1PayrollRunsResponses, + GetV1PayslipsData, + GetV1PayslipsError, + GetV1PayslipsErrors, + GetV1PayslipsIdData, + GetV1PayslipsIdError, + GetV1PayslipsIdErrors, + GetV1PayslipsIdResponse, + GetV1PayslipsIdResponses, + GetV1PayslipsPayslipIdPdfData, + GetV1PayslipsPayslipIdPdfError, + GetV1PayslipsPayslipIdPdfErrors, + GetV1PayslipsPayslipIdPdfResponse, + GetV1PayslipsPayslipIdPdfResponses, + GetV1PayslipsResponse, + GetV1PayslipsResponses, + GetV1PricingPlanPartnerTemplatesData, + GetV1PricingPlanPartnerTemplatesError, + GetV1PricingPlanPartnerTemplatesErrors, + GetV1PricingPlanPartnerTemplatesResponse, + GetV1PricingPlanPartnerTemplatesResponses, + GetV1ProbationCompletionLetterIdData, + GetV1ProbationCompletionLetterIdError, + GetV1ProbationCompletionLetterIdErrors, + GetV1ProbationCompletionLetterIdResponse, + GetV1ProbationCompletionLetterIdResponses, + GetV1ProbationExtensionsIdData, + GetV1ProbationExtensionsIdError, + GetV1ProbationExtensionsIdErrors, + GetV1ProbationExtensionsIdResponse, + GetV1ProbationExtensionsIdResponses, + GetV1ResignationsOffboardingRequestIdData, + GetV1ResignationsOffboardingRequestIdError, + GetV1ResignationsOffboardingRequestIdErrors, + GetV1ResignationsOffboardingRequestIdResignationLetterData, + GetV1ResignationsOffboardingRequestIdResignationLetterError, + GetV1ResignationsOffboardingRequestIdResignationLetterErrors, + GetV1ResignationsOffboardingRequestIdResignationLetterResponse, + GetV1ResignationsOffboardingRequestIdResignationLetterResponses, + GetV1ResignationsOffboardingRequestIdResponse, + GetV1ResignationsOffboardingRequestIdResponses, + GetV1ScimV2GroupsData, + GetV1ScimV2GroupsError, + GetV1ScimV2GroupsErrors, + GetV1ScimV2GroupsIdData, + GetV1ScimV2GroupsIdError, + GetV1ScimV2GroupsIdErrors, + GetV1ScimV2GroupsIdResponse, + GetV1ScimV2GroupsIdResponses, + GetV1ScimV2GroupsResponse, + GetV1ScimV2GroupsResponses, + GetV1ScimV2UsersData, + GetV1ScimV2UsersError, + GetV1ScimV2UsersErrors, + GetV1ScimV2UsersIdData, + GetV1ScimV2UsersIdError, + GetV1ScimV2UsersIdErrors, + GetV1ScimV2UsersIdResponse, + GetV1ScimV2UsersIdResponses, + GetV1ScimV2UsersResponse, + GetV1ScimV2UsersResponses, + GetV1SsoConfigurationData, + GetV1SsoConfigurationDetailsData, + GetV1SsoConfigurationDetailsError, + GetV1SsoConfigurationDetailsErrors, + GetV1SsoConfigurationDetailsResponse, + GetV1SsoConfigurationDetailsResponses, + GetV1SsoConfigurationError, + GetV1SsoConfigurationErrors, + GetV1SsoConfigurationResponse, + GetV1SsoConfigurationResponses, + GetV1TestSchemaData, + GetV1TestSchemaResponse, + GetV1TestSchemaResponses, + GetV1TimeoffBalancesEmploymentIdData, + GetV1TimeoffBalancesEmploymentIdError, + GetV1TimeoffBalancesEmploymentIdErrors, + GetV1TimeoffBalancesEmploymentIdResponse, + GetV1TimeoffBalancesEmploymentIdResponses, + GetV1TimeoffData, + GetV1TimeoffError, + GetV1TimeoffErrors, + GetV1TimeoffIdData, + GetV1TimeoffIdError, + GetV1TimeoffIdErrors, + GetV1TimeoffIdResponse, + GetV1TimeoffIdResponses, + GetV1TimeoffResponse, + GetV1TimeoffResponses, + GetV1TimeoffTypesData, + GetV1TimeoffTypesError, + GetV1TimeoffTypesErrors, + GetV1TimeoffTypesResponse, + GetV1TimeoffTypesResponses, + GetV1TimesheetsData, + GetV1TimesheetsError, + GetV1TimesheetsErrors, + GetV1TimesheetsIdData, + GetV1TimesheetsIdError, + GetV1TimesheetsIdErrors, + GetV1TimesheetsIdResponse, + GetV1TimesheetsIdResponses, + GetV1TimesheetsResponse, + GetV1TimesheetsResponses, + GetV1TravelLetterRequestsData, + GetV1TravelLetterRequestsError, + GetV1TravelLetterRequestsErrors, + GetV1TravelLetterRequestsIdData, + GetV1TravelLetterRequestsIdError, + GetV1TravelLetterRequestsIdErrors, + GetV1TravelLetterRequestsIdResponse, + GetV1TravelLetterRequestsIdResponses, + GetV1TravelLetterRequestsResponse, + GetV1TravelLetterRequestsResponses, + GetV1WdGphPayDetailData, + GetV1WdGphPayDetailDataData, + GetV1WdGphPayDetailDataError, + GetV1WdGphPayDetailDataErrors, + GetV1WdGphPayDetailDataResponse, + GetV1WdGphPayDetailDataResponses, + GetV1WdGphPayDetailError, + GetV1WdGphPayDetailErrors, + GetV1WdGphPayDetailResponse, + GetV1WdGphPayDetailResponses, + GetV1WdGphPayProcessingFeatureData, + GetV1WdGphPayProcessingFeatureError, + GetV1WdGphPayProcessingFeatureErrors, + GetV1WdGphPayProcessingFeatureResponse, + GetV1WdGphPayProcessingFeatureResponses, + GetV1WdGphPayProgressData, + GetV1WdGphPayProgressError, + GetV1WdGphPayProgressErrors, + GetV1WdGphPayProgressResponse, + GetV1WdGphPayProgressResponses, + GetV1WdGphPaySummaryData, + GetV1WdGphPaySummaryError, + GetV1WdGphPaySummaryErrors, + GetV1WdGphPaySummaryResponse, + GetV1WdGphPaySummaryResponses, + GetV1WdGphPayVarianceData, + GetV1WdGphPayVarianceError, + GetV1WdGphPayVarianceErrors, + GetV1WdGphPayVarianceResponse, + GetV1WdGphPayVarianceResponses, + GetV1WebhookEventsData, + GetV1WebhookEventsError, + GetV1WebhookEventsErrors, + GetV1WebhookEventsResponse, + GetV1WebhookEventsResponses, + GetV1WorkAuthorizationRequestsData, + GetV1WorkAuthorizationRequestsError, + GetV1WorkAuthorizationRequestsErrors, + GetV1WorkAuthorizationRequestsIdData, + GetV1WorkAuthorizationRequestsIdError, + GetV1WorkAuthorizationRequestsIdErrors, + GetV1WorkAuthorizationRequestsIdResponse, + GetV1WorkAuthorizationRequestsIdResponses, + GetV1WorkAuthorizationRequestsResponse, + GetV1WorkAuthorizationRequestsResponses, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsError, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, HelpCenterArticle, HelpCenterArticleResponse, Holiday, @@ -1089,6 +1225,7 @@ export type { IncentiveResponse, IndexContractDocuments, IndexContractDocumentsResponse, + IndexPreOnboardingDocumentRequirementsResponse, IntegrationsScimErrorResponse, IntegrationsScimGroup, IntegrationsScimGroupListResponse, @@ -1111,6 +1248,7 @@ export type { ListContractorInvoicesResponse, ListDataSyncEventsResponse, ListDocumentsResponse, + ListEmployeePayslipsResponse, ListEmploymentContractResponse, ListEmploymentCustomFieldsResponse, ListEmploymentCustomFieldValuePaginatedResponse, @@ -1125,6 +1263,7 @@ export type { ListOffboardingResponse, ListPayItemsResponse, ListPayrollRunResponse, + ListPayslipFilesResponse, ListPayslipsResponse, ListPricingPlanPartnerTemplatesResponse, ListProductPricesResponse, @@ -1178,122 +1317,133 @@ export type { OptionValue, ParameterError, ParameterErrors, + ParamsToCreateEmployeeExpense, ParamsToCreateExpense, - PatchUpdateCompany2Data, - PatchUpdateCompany2Error, - PatchUpdateCompany2Errors, - PatchUpdateCompany2Response, - PatchUpdateCompany2Responses, - PatchUpdateCompanyData, - PatchUpdateCompanyError, - PatchUpdateCompanyErrors, - PatchUpdateCompanyResponse, - PatchUpdateCompanyResponses, - PatchUpdateEmployeeTimeoff2Data, - PatchUpdateEmployeeTimeoff2Error, - PatchUpdateEmployeeTimeoff2Errors, - PatchUpdateEmployeeTimeoff2Response, - PatchUpdateEmployeeTimeoff2Responses, - PatchUpdateEmployeeTimeoffData, - PatchUpdateEmployeeTimeoffError, - PatchUpdateEmployeeTimeoffErrors, - PatchUpdateEmployeeTimeoffResponse, - PatchUpdateEmployeeTimeoffResponses, - PatchUpdateEmployment2Data, - PatchUpdateEmployment2Error, - PatchUpdateEmployment2Errors, - PatchUpdateEmployment2Response, - PatchUpdateEmployment2Responses, - PatchUpdateEmployment3Data, - PatchUpdateEmployment3Error, - PatchUpdateEmployment3Errors, - PatchUpdateEmployment3Response, - PatchUpdateEmployment3Responses, - PatchUpdateEmployment4Data, - PatchUpdateEmployment4Error, - PatchUpdateEmployment4Errors, - PatchUpdateEmployment4Response, - PatchUpdateEmployment4Responses, - PatchUpdateEmploymentCustomFieldValue2Data, - PatchUpdateEmploymentCustomFieldValue2Error, - PatchUpdateEmploymentCustomFieldValue2Errors, - PatchUpdateEmploymentCustomFieldValue2Response, - PatchUpdateEmploymentCustomFieldValue2Responses, - PatchUpdateEmploymentCustomFieldValueData, - PatchUpdateEmploymentCustomFieldValueError, - PatchUpdateEmploymentCustomFieldValueErrors, - PatchUpdateEmploymentCustomFieldValueResponse, - PatchUpdateEmploymentCustomFieldValueResponses, - PatchUpdateEmploymentData, - PatchUpdateEmploymentError, - PatchUpdateEmploymentErrors, - PatchUpdateEmploymentResponse, - PatchUpdateEmploymentResponses, - PatchUpdateExpense2Data, - PatchUpdateExpense2Error, - PatchUpdateExpense2Errors, - PatchUpdateExpense2Response, - PatchUpdateExpense2Responses, - PatchUpdateExpenseData, - PatchUpdateExpenseError, - PatchUpdateExpenseErrors, - PatchUpdateExpenseResponse, - PatchUpdateExpenseResponses, - PatchUpdateIncentive2Data, - PatchUpdateIncentive2Error, - PatchUpdateIncentive2Errors, - PatchUpdateIncentive2Response, - PatchUpdateIncentive2Responses, - PatchUpdateIncentiveData, - PatchUpdateIncentiveError, - PatchUpdateIncentiveErrors, - PatchUpdateIncentiveResponse, - PatchUpdateIncentiveResponses, - PatchUpdateScheduledContractorInvoice2Data, - PatchUpdateScheduledContractorInvoice2Error, - PatchUpdateScheduledContractorInvoice2Errors, - PatchUpdateScheduledContractorInvoice2Response, - PatchUpdateScheduledContractorInvoice2Responses, - PatchUpdateScheduledContractorInvoiceData, - PatchUpdateScheduledContractorInvoiceError, - PatchUpdateScheduledContractorInvoiceErrors, - PatchUpdateScheduledContractorInvoiceResponse, - PatchUpdateScheduledContractorInvoiceResponses, - PatchUpdateTimeoff2Data, - PatchUpdateTimeoff2Error, - PatchUpdateTimeoff2Errors, - PatchUpdateTimeoff2Response, - PatchUpdateTimeoff2Responses, - PatchUpdateTimeoffData, - PatchUpdateTimeoffError, - PatchUpdateTimeoffErrors, - PatchUpdateTimeoffResponse, - PatchUpdateTimeoffResponses, - PatchUpdateTravelLetterRequest2Data, - PatchUpdateTravelLetterRequest2Error, - PatchUpdateTravelLetterRequest2Errors, - PatchUpdateTravelLetterRequest2Response, - PatchUpdateTravelLetterRequest2Responses, - PatchUpdateTravelLetterRequestData, - PatchUpdateTravelLetterRequestError, - PatchUpdateTravelLetterRequestErrors, - PatchUpdateTravelLetterRequestResponse, - PatchUpdateTravelLetterRequestResponses, - PatchUpdateWebhookCallbackData, - PatchUpdateWebhookCallbackError, - PatchUpdateWebhookCallbackErrors, - PatchUpdateWebhookCallbackResponse, - PatchUpdateWebhookCallbackResponses, - PatchUpdateWorkAuthorizationRequest2Data, - PatchUpdateWorkAuthorizationRequest2Error, - PatchUpdateWorkAuthorizationRequest2Errors, - PatchUpdateWorkAuthorizationRequest2Response, - PatchUpdateWorkAuthorizationRequest2Responses, - PatchUpdateWorkAuthorizationRequestData, - PatchUpdateWorkAuthorizationRequestError, - PatchUpdateWorkAuthorizationRequestErrors, - PatchUpdateWorkAuthorizationRequestResponse, - PatchUpdateWorkAuthorizationRequestResponses, + PatchV1CompaniesCompanyId2Data, + PatchV1CompaniesCompanyId2Error, + PatchV1CompaniesCompanyId2Errors, + PatchV1CompaniesCompanyId2Response, + PatchV1CompaniesCompanyId2Responses, + PatchV1CompaniesCompanyIdData, + PatchV1CompaniesCompanyIdError, + PatchV1CompaniesCompanyIdErrors, + PatchV1CompaniesCompanyIdResponse, + PatchV1CompaniesCompanyIdResponses, + PatchV1ContractorInvoiceSchedulesId2Data, + PatchV1ContractorInvoiceSchedulesId2Error, + PatchV1ContractorInvoiceSchedulesId2Errors, + PatchV1ContractorInvoiceSchedulesId2Response, + PatchV1ContractorInvoiceSchedulesId2Responses, + PatchV1ContractorInvoiceSchedulesIdData, + PatchV1ContractorInvoiceSchedulesIdError, + PatchV1ContractorInvoiceSchedulesIdErrors, + PatchV1ContractorInvoiceSchedulesIdResponse, + PatchV1ContractorInvoiceSchedulesIdResponses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Error, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Response, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdError, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + PatchV1EmployeeTimeoffId2Data, + PatchV1EmployeeTimeoffId2Error, + PatchV1EmployeeTimeoffId2Errors, + PatchV1EmployeeTimeoffId2Response, + PatchV1EmployeeTimeoffId2Responses, + PatchV1EmployeeTimeoffIdData, + PatchV1EmployeeTimeoffIdError, + PatchV1EmployeeTimeoffIdErrors, + PatchV1EmployeeTimeoffIdResponse, + PatchV1EmployeeTimeoffIdResponses, + PatchV1EmploymentsEmploymentId2Data, + PatchV1EmploymentsEmploymentId2Error, + PatchV1EmploymentsEmploymentId2Errors, + PatchV1EmploymentsEmploymentId2Response, + PatchV1EmploymentsEmploymentId2Responses, + PatchV1EmploymentsEmploymentIdData, + PatchV1EmploymentsEmploymentIdError, + PatchV1EmploymentsEmploymentIdErrors, + PatchV1EmploymentsEmploymentIdResponse, + PatchV1EmploymentsEmploymentIdResponses, + PatchV1ExpensesId2Data, + PatchV1ExpensesId2Error, + PatchV1ExpensesId2Errors, + PatchV1ExpensesId2Response, + PatchV1ExpensesId2Responses, + PatchV1ExpensesIdData, + PatchV1ExpensesIdError, + PatchV1ExpensesIdErrors, + PatchV1ExpensesIdResponse, + PatchV1ExpensesIdResponses, + PatchV1IncentivesId2Data, + PatchV1IncentivesId2Error, + PatchV1IncentivesId2Errors, + PatchV1IncentivesId2Response, + PatchV1IncentivesId2Responses, + PatchV1IncentivesIdData, + PatchV1IncentivesIdError, + PatchV1IncentivesIdErrors, + PatchV1IncentivesIdResponse, + PatchV1IncentivesIdResponses, + PatchV1SandboxEmploymentsEmploymentId2Data, + PatchV1SandboxEmploymentsEmploymentId2Error, + PatchV1SandboxEmploymentsEmploymentId2Errors, + PatchV1SandboxEmploymentsEmploymentId2Response, + PatchV1SandboxEmploymentsEmploymentId2Responses, + PatchV1SandboxEmploymentsEmploymentIdData, + PatchV1SandboxEmploymentsEmploymentIdError, + PatchV1SandboxEmploymentsEmploymentIdErrors, + PatchV1SandboxEmploymentsEmploymentIdResponse, + PatchV1SandboxEmploymentsEmploymentIdResponses, + PatchV1TimeoffId2Data, + PatchV1TimeoffId2Error, + PatchV1TimeoffId2Errors, + PatchV1TimeoffId2Response, + PatchV1TimeoffId2Responses, + PatchV1TimeoffIdData, + PatchV1TimeoffIdError, + PatchV1TimeoffIdErrors, + PatchV1TimeoffIdResponse, + PatchV1TimeoffIdResponses, + PatchV1TravelLetterRequestsId2Data, + PatchV1TravelLetterRequestsId2Error, + PatchV1TravelLetterRequestsId2Errors, + PatchV1TravelLetterRequestsId2Response, + PatchV1TravelLetterRequestsId2Responses, + PatchV1TravelLetterRequestsIdData, + PatchV1TravelLetterRequestsIdError, + PatchV1TravelLetterRequestsIdErrors, + PatchV1TravelLetterRequestsIdResponse, + PatchV1TravelLetterRequestsIdResponses, + PatchV1WebhookCallbacksIdData, + PatchV1WebhookCallbacksIdError, + PatchV1WebhookCallbacksIdErrors, + PatchV1WebhookCallbacksIdResponse, + PatchV1WebhookCallbacksIdResponses, + PatchV1WorkAuthorizationRequestsId2Data, + PatchV1WorkAuthorizationRequestsId2Error, + PatchV1WorkAuthorizationRequestsId2Errors, + PatchV1WorkAuthorizationRequestsId2Response, + PatchV1WorkAuthorizationRequestsId2Responses, + PatchV1WorkAuthorizationRequestsIdData, + PatchV1WorkAuthorizationRequestsIdError, + PatchV1WorkAuthorizationRequestsIdErrors, + PatchV1WorkAuthorizationRequestsIdResponse, + PatchV1WorkAuthorizationRequestsIdResponses, + PatchV2EmploymentsEmploymentId2Data, + PatchV2EmploymentsEmploymentId2Error, + PatchV2EmploymentsEmploymentId2Errors, + PatchV2EmploymentsEmploymentId2Response, + PatchV2EmploymentsEmploymentId2Responses, + PatchV2EmploymentsEmploymentIdData, + PatchV2EmploymentsEmploymentIdError, + PatchV2EmploymentsEmploymentIdErrors, + PatchV2EmploymentsEmploymentIdResponse, + PatchV2EmploymentsEmploymentIdResponses, PayDetailDataResponse, PayDetailResponse, PayDifference, @@ -1314,335 +1464,370 @@ export type { PayrollRunResponse, Payslip, PayslipDownloadResponse, + PayslipFile, + PayslipFileCurrency, + PayslipFileNetSalary, + PayslipItem, PayslipResponse, PaySummaryResponse, PayValue, PayVarianceResponse, PeriodProperties, PersonalDetails, - PostApproveCancellationRequestData, - PostApproveCancellationRequestError, - PostApproveCancellationRequestErrors, - PostApproveCancellationRequestResponse, - PostApproveCancellationRequestResponses, - PostApproveRiskReserveProofOfPaymentData, - PostApproveRiskReserveProofOfPaymentError, - PostApproveRiskReserveProofOfPaymentErrors, - PostApproveRiskReserveProofOfPaymentResponse, - PostApproveRiskReserveProofOfPaymentResponses, - PostApproveTimesheetData, - PostApproveTimesheetError, - PostApproveTimesheetErrors, - PostApproveTimesheetResponse, - PostApproveTimesheetResponses, - PostAutomatableContractAmendmentData, - PostAutomatableContractAmendmentError, - PostAutomatableContractAmendmentErrors, - PostAutomatableContractAmendmentResponse, - PostAutomatableContractAmendmentResponses, - PostBulkCreatePayItemsData, - PostBulkCreatePayItemsError, - PostBulkCreatePayItemsErrors, - PostBulkCreatePayItemsResponse, - PostBulkCreatePayItemsResponses, - PostBulkCreateScheduledContractorInvoiceData, - PostBulkCreateScheduledContractorInvoiceError, - PostBulkCreateScheduledContractorInvoiceErrors, - PostBulkCreateScheduledContractorInvoiceResponse, - PostBulkCreateScheduledContractorInvoiceResponses, - PostBypassEligibilityChecksCompanyData, - PostBypassEligibilityChecksCompanyError, - PostBypassEligibilityChecksCompanyErrors, - PostBypassEligibilityChecksCompanyResponse, - PostBypassEligibilityChecksCompanyResponses, - PostCancelEmployeeTimeoffData, - PostCancelEmployeeTimeoffError, - PostCancelEmployeeTimeoffErrors, - PostCancelEmployeeTimeoffResponse, - PostCancelEmployeeTimeoffResponses, - PostCompleteOnboardingEmploymentData, - PostCompleteOnboardingEmploymentError, - PostCompleteOnboardingEmploymentErrors, - PostCompleteOnboardingEmploymentResponse, - PostCompleteOnboardingEmploymentResponses, - PostConvertRawCurrencyConverterData, - PostConvertRawCurrencyConverterError, - PostConvertRawCurrencyConverterErrors, - PostConvertRawCurrencyConverterResponse, - PostConvertRawCurrencyConverterResponses, - PostConvertWithSpreadCurrencyConverter2Data, - PostConvertWithSpreadCurrencyConverter2Error, - PostConvertWithSpreadCurrencyConverter2Errors, - PostConvertWithSpreadCurrencyConverter2Response, - PostConvertWithSpreadCurrencyConverter2Responses, - PostConvertWithSpreadCurrencyConverterData, - PostConvertWithSpreadCurrencyConverterError, - PostConvertWithSpreadCurrencyConverterErrors, - PostConvertWithSpreadCurrencyConverterResponse, - PostConvertWithSpreadCurrencyConverterResponses, - PostCreateApprovalData, - PostCreateApprovalError, - PostCreateApprovalErrors, - PostCreateApprovalResponse, - PostCreateApprovalResponses, - PostCreateBenefitRenewalRequestData, - PostCreateBenefitRenewalRequestError, - PostCreateBenefitRenewalRequestErrors, - PostCreateBenefitRenewalRequestResponse, - PostCreateBenefitRenewalRequestResponses, - PostCreateBulkEmploymentData, - PostCreateBulkEmploymentError, - PostCreateBulkEmploymentErrors, - PostCreateBulkEmploymentResponse, - PostCreateBulkEmploymentResponses, - PostCreateCancellationData, - PostCreateCancellationError, - PostCreateCancellationErrors, - PostCreateCancellationResponse, - PostCreateCancellationResponses, - PostCreateCompanyData, - PostCreateCompanyDepartmentData, - PostCreateCompanyDepartmentError, - PostCreateCompanyDepartmentErrors, - PostCreateCompanyDepartmentResponse, - PostCreateCompanyDepartmentResponses, - PostCreateCompanyError, - PostCreateCompanyErrors, - PostCreateCompanyManagerData, - PostCreateCompanyManagerError, - PostCreateCompanyManagerErrors, - PostCreateCompanyManagerResponse, - PostCreateCompanyManagerResponses, - PostCreateCompanyPricingPlanData, - PostCreateCompanyPricingPlanError, - PostCreateCompanyPricingPlanErrors, - PostCreateCompanyPricingPlanResponse, - PostCreateCompanyPricingPlanResponses, - PostCreateCompanyResponse, - PostCreateCompanyResponses, - PostCreateContractAmendmentData, - PostCreateContractAmendmentError, - PostCreateContractAmendmentErrors, - PostCreateContractAmendmentResponse, - PostCreateContractAmendmentResponses, - PostCreateContractDocumentData, - PostCreateContractDocumentError, - PostCreateContractDocumentErrors, - PostCreateContractDocumentResponse, - PostCreateContractDocumentResponses, - PostCreateContractEligibilityData, - PostCreateContractEligibilityError, - PostCreateContractEligibilityErrors, - PostCreateContractEligibilityResponse, - PostCreateContractEligibilityResponses, - PostCreateCorTerminationRequestSubscriptionData, - PostCreateCorTerminationRequestSubscriptionError, - PostCreateCorTerminationRequestSubscriptionErrors, - PostCreateCorTerminationRequestSubscriptionResponse, - PostCreateCorTerminationRequestSubscriptionResponses, - PostCreateDataSyncData, - PostCreateDataSyncError, - PostCreateDataSyncErrors, - PostCreateDataSyncResponses, - PostCreateDeclineData, - PostCreateDeclineError, - PostCreateDeclineErrors, - PostCreateDeclineResponse, - PostCreateDeclineResponses, - PostCreateEligibilityQuestionnaireData, - PostCreateEligibilityQuestionnaireError, - PostCreateEligibilityQuestionnaireErrors, - PostCreateEligibilityQuestionnaireResponse, - PostCreateEligibilityQuestionnaireResponses, - PostCreateEmployeeTimeoffData, - PostCreateEmployeeTimeoffError, - PostCreateEmployeeTimeoffErrors, - PostCreateEmployeeTimeoffResponse, - PostCreateEmployeeTimeoffResponses, - PostCreateEmployment2Data, - PostCreateEmployment2Error, - PostCreateEmployment2Errors, - PostCreateEmployment2Response, - PostCreateEmployment2Responses, - PostCreateEmploymentCustomFieldData, - PostCreateEmploymentCustomFieldError, - PostCreateEmploymentCustomFieldErrors, - PostCreateEmploymentCustomFieldResponse, - PostCreateEmploymentCustomFieldResponses, - PostCreateEmploymentData, - PostCreateEmploymentError, - PostCreateEmploymentErrors, - PostCreateEmploymentResponse, - PostCreateEmploymentResponses, - PostCreateEstimationCsvData, - PostCreateEstimationCsvError, - PostCreateEstimationCsvErrors, - PostCreateEstimationCsvResponse, - PostCreateEstimationCsvResponses, - PostCreateEstimationData, - PostCreateEstimationError, - PostCreateEstimationErrors, - PostCreateEstimationPdfData, - PostCreateEstimationPdfError, - PostCreateEstimationPdfErrors, - PostCreateEstimationPdfResponse, - PostCreateEstimationPdfResponses, - PostCreateEstimationResponse, - PostCreateEstimationResponses, - PostCreateExpenseData, - PostCreateExpenseError, - PostCreateExpenseErrors, - PostCreateExpenseResponse, - PostCreateExpenseResponses, - PostCreateIncentiveData, - PostCreateIncentiveError, - PostCreateIncentiveErrors, - PostCreateIncentiveResponse, - PostCreateIncentiveResponses, - PostCreateLegalEntityCompanyData, - PostCreateLegalEntityCompanyError, - PostCreateLegalEntityCompanyErrors, - PostCreateLegalEntityCompanyResponse, - PostCreateLegalEntityCompanyResponses, - PostCreateOffboardingData, - PostCreateOffboardingError, - PostCreateOffboardingErrors, - PostCreateOffboardingResponse, - PostCreateOffboardingResponses, - PostCreateProbationCompletionLetterData, - PostCreateProbationCompletionLetterError, - PostCreateProbationCompletionLetterErrors, - PostCreateProbationCompletionLetterResponse, - PostCreateProbationCompletionLetterResponses, - PostCreateProbationExtensionData, - PostCreateProbationExtensionError, - PostCreateProbationExtensionErrors, - PostCreateProbationExtensionResponse, - PostCreateProbationExtensionResponses, - PostCreateRecurringIncentiveData, - PostCreateRecurringIncentiveError, - PostCreateRecurringIncentiveErrors, - PostCreateRecurringIncentiveResponse, - PostCreateRecurringIncentiveResponses, - PostCreateRiskReserveData, - PostCreateRiskReserveError, - PostCreateRiskReserveErrors, - PostCreateRiskReserveResponse, - PostCreateRiskReserveResponses, - PostCreateSsoConfigurationData, - PostCreateSsoConfigurationError, - PostCreateSsoConfigurationErrors, - PostCreateSsoConfigurationResponse, - PostCreateSsoConfigurationResponses, - PostCreateTimeoffData, - PostCreateTimeoffError, - PostCreateTimeoffErrors, - PostCreateTimeoffResponse, - PostCreateTimeoffResponses, - PostCreateTokenCompanyTokenData, - PostCreateTokenCompanyTokenError, - PostCreateTokenCompanyTokenErrors, - PostCreateTokenCompanyTokenResponse, - PostCreateTokenCompanyTokenResponses, - PostCreateWebhookCallbackData, - PostCreateWebhookCallbackError, - PostCreateWebhookCallbackErrors, - PostCreateWebhookCallbackResponse, - PostCreateWebhookCallbackResponses, - PostDeclineCancellationRequestData, - PostDeclineCancellationRequestError, - PostDeclineCancellationRequestErrors, - PostDeclineCancellationRequestResponse, - PostDeclineCancellationRequestResponses, - PostDeclineIdentityVerificationData, - PostDeclineIdentityVerificationError, - PostDeclineIdentityVerificationErrors, - PostDeclineIdentityVerificationResponse, - PostDeclineIdentityVerificationResponses, - PostGenerateMagicLinkData, - PostGenerateMagicLinkError, - PostGenerateMagicLinkErrors, - PostGenerateMagicLinkResponse, - PostGenerateMagicLinkResponses, - PostInviteEmploymentInvitationData, - PostInviteEmploymentInvitationError, - PostInviteEmploymentInvitationErrors, - PostInviteEmploymentInvitationResponse, - PostInviteEmploymentInvitationResponses, - PostManageContractorCorSubscriptionSubscriptionData, - PostManageContractorCorSubscriptionSubscriptionError, - PostManageContractorCorSubscriptionSubscriptionErrors, - PostManageContractorCorSubscriptionSubscriptionResponse, - PostManageContractorCorSubscriptionSubscriptionResponses, - PostManageContractorPlusSubscriptionSubscriptionData, - PostManageContractorPlusSubscriptionSubscriptionError, - PostManageContractorPlusSubscriptionSubscriptionErrors, - PostManageContractorPlusSubscriptionSubscriptionResponse, - PostManageContractorPlusSubscriptionSubscriptionResponses, - PostReplayWebhookEventData, - PostReplayWebhookEventError, - PostReplayWebhookEventErrors, - PostReplayWebhookEventResponse, - PostReplayWebhookEventResponses, - PostReportErrorsTelemetryData, - PostReportErrorsTelemetryError, - PostReportErrorsTelemetryErrors, - PostReportErrorsTelemetryResponses, - PostSendBackTimesheetData, - PostSendBackTimesheetError, - PostSendBackTimesheetErrors, - PostSendBackTimesheetResponse, - PostSendBackTimesheetResponses, - PostSignContractDocumentData, - PostSignContractDocumentError, - PostSignContractDocumentErrors, - PostSignContractDocumentResponse, - PostSignContractDocumentResponses, - PostSubmitRiskReserveProofOfPaymentData, - PostSubmitRiskReserveProofOfPaymentError, - PostSubmitRiskReserveProofOfPaymentErrors, - PostSubmitRiskReserveProofOfPaymentResponse, - PostSubmitRiskReserveProofOfPaymentResponses, - PostTerminateContractorOfRecordEmploymentSubscriptionData, - PostTerminateContractorOfRecordEmploymentSubscriptionError, - PostTerminateContractorOfRecordEmploymentSubscriptionErrors, - PostTerminateContractorOfRecordEmploymentSubscriptionResponse, - PostTerminateContractorOfRecordEmploymentSubscriptionResponses, - PostTokenOAuth2TokenData, - PostTokenOAuth2TokenError, - PostTokenOAuth2TokenErrors, - PostTokenOAuth2TokenResponse, - PostTokenOAuth2TokenResponses, - PostTriggerWebhookCallbackData, - PostTriggerWebhookCallbackError, - PostTriggerWebhookCallbackErrors, - PostTriggerWebhookCallbackResponse, - PostTriggerWebhookCallbackResponses, - PostUpdateBenefitRenewalRequestData, - PostUpdateBenefitRenewalRequestError, - PostUpdateBenefitRenewalRequestErrors, - PostUpdateBenefitRenewalRequestResponse, - PostUpdateBenefitRenewalRequestResponses, - PostUpdateCancelOnboardingData, - PostUpdateCancelOnboardingError, - PostUpdateCancelOnboardingErrors, - PostUpdateCancelOnboardingResponse, - PostUpdateCancelOnboardingResponses, - PostUpdateEmploymentEngagementAgreementDetailsData, - PostUpdateEmploymentEngagementAgreementDetailsError, - PostUpdateEmploymentEngagementAgreementDetailsErrors, - PostUpdateEmploymentEngagementAgreementDetailsResponse, - PostUpdateEmploymentEngagementAgreementDetailsResponses, - PostUploadEmployeeFileFileData, - PostUploadEmployeeFileFileError, - PostUploadEmployeeFileFileErrors, - PostUploadEmployeeFileFileResponse, - PostUploadEmployeeFileFileResponses, - PostVerifyIdentityVerificationData, - PostVerifyIdentityVerificationError, - PostVerifyIdentityVerificationErrors, - PostVerifyIdentityVerificationResponse, - PostVerifyIdentityVerificationResponses, + PostAuthOauth2Token2Data, + PostAuthOauth2Token2Error, + PostAuthOauth2Token2Errors, + PostAuthOauth2Token2Response, + PostAuthOauth2Token2Responses, + PostAuthOauth2TokenData, + PostAuthOauth2TokenError, + PostAuthOauth2TokenErrors, + PostAuthOauth2TokenResponse, + PostAuthOauth2TokenResponses, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdError, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + PostV1BulkEmploymentJobsData, + PostV1BulkEmploymentJobsError, + PostV1BulkEmploymentJobsErrors, + PostV1BulkEmploymentJobsResponse, + PostV1BulkEmploymentJobsResponses, + PostV1CancelOnboardingEmploymentIdData, + PostV1CancelOnboardingEmploymentIdError, + PostV1CancelOnboardingEmploymentIdErrors, + PostV1CancelOnboardingEmploymentIdResponse, + PostV1CancelOnboardingEmploymentIdResponses, + PostV1CompaniesCompanyIdCreateTokenData, + PostV1CompaniesCompanyIdCreateTokenError, + PostV1CompaniesCompanyIdCreateTokenErrors, + PostV1CompaniesCompanyIdCreateTokenResponse, + PostV1CompaniesCompanyIdCreateTokenResponses, + PostV1CompaniesCompanyIdPricingPlansData, + PostV1CompaniesCompanyIdPricingPlansError, + PostV1CompaniesCompanyIdPricingPlansErrors, + PostV1CompaniesCompanyIdPricingPlansResponse, + PostV1CompaniesCompanyIdPricingPlansResponses, + PostV1CompaniesData, + PostV1CompaniesError, + PostV1CompaniesErrors, + PostV1CompaniesResponse, + PostV1CompaniesResponses, + PostV1CompanyDepartmentsData, + PostV1CompanyDepartmentsError, + PostV1CompanyDepartmentsErrors, + PostV1CompanyDepartmentsResponse, + PostV1CompanyDepartmentsResponses, + PostV1CompanyManagersData, + PostV1CompanyManagersError, + PostV1CompanyManagersErrors, + PostV1CompanyManagersResponse, + PostV1CompanyManagersResponses, + PostV1ContractAmendmentsAutomatableData, + PostV1ContractAmendmentsAutomatableError, + PostV1ContractAmendmentsAutomatableErrors, + PostV1ContractAmendmentsAutomatableResponse, + PostV1ContractAmendmentsAutomatableResponses, + PostV1ContractAmendmentsData, + PostV1ContractAmendmentsError, + PostV1ContractAmendmentsErrors, + PostV1ContractAmendmentsResponse, + PostV1ContractAmendmentsResponses, + PostV1ContractorInvoiceSchedulesData, + PostV1ContractorInvoiceSchedulesError, + PostV1ContractorInvoiceSchedulesErrors, + PostV1ContractorInvoiceSchedulesResponse, + PostV1ContractorInvoiceSchedulesResponses, + PostV1ContractorsEligibilityQuestionnaireData, + PostV1ContractorsEligibilityQuestionnaireError, + PostV1ContractorsEligibilityQuestionnaireErrors, + PostV1ContractorsEligibilityQuestionnaireResponse, + PostV1ContractorsEligibilityQuestionnaireResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignError, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponse, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsError, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponse, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponse, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionError, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponse, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsError, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponse, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentError, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponse, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses, + PostV1CostCalculatorEstimationCsvData, + PostV1CostCalculatorEstimationCsvError, + PostV1CostCalculatorEstimationCsvErrors, + PostV1CostCalculatorEstimationCsvResponse, + PostV1CostCalculatorEstimationCsvResponses, + PostV1CostCalculatorEstimationData, + PostV1CostCalculatorEstimationError, + PostV1CostCalculatorEstimationErrors, + PostV1CostCalculatorEstimationPdfData, + PostV1CostCalculatorEstimationPdfError, + PostV1CostCalculatorEstimationPdfErrors, + PostV1CostCalculatorEstimationPdfResponse, + PostV1CostCalculatorEstimationPdfResponses, + PostV1CostCalculatorEstimationResponse, + PostV1CostCalculatorEstimationResponses, + PostV1CurrencyConverterEffective2Data, + PostV1CurrencyConverterEffective2Error, + PostV1CurrencyConverterEffective2Errors, + PostV1CurrencyConverterEffective2Response, + PostV1CurrencyConverterEffective2Responses, + PostV1CurrencyConverterEffectiveData, + PostV1CurrencyConverterEffectiveError, + PostV1CurrencyConverterEffectiveErrors, + PostV1CurrencyConverterEffectiveResponse, + PostV1CurrencyConverterEffectiveResponses, + PostV1CurrencyConverterRawData, + PostV1CurrencyConverterRawError, + PostV1CurrencyConverterRawErrors, + PostV1CurrencyConverterRawResponse, + PostV1CurrencyConverterRawResponses, + PostV1CustomFieldsData, + PostV1CustomFieldsError, + PostV1CustomFieldsErrors, + PostV1CustomFieldsResponse, + PostV1CustomFieldsResponses, + PostV1DataSyncData, + PostV1DataSyncError, + PostV1DataSyncErrors, + PostV1DataSyncResponses, + PostV1DocumentsData, + PostV1DocumentsError, + PostV1DocumentsErrors, + PostV1DocumentsResponse, + PostV1DocumentsResponses, + PostV1EmployeeExpensesData, + PostV1EmployeeExpensesError, + PostV1EmployeeExpensesErrors, + PostV1EmployeeExpensesResponse, + PostV1EmployeeExpensesResponses, + PostV1EmployeeTimeoffData, + PostV1EmployeeTimeoffError, + PostV1EmployeeTimeoffErrors, + PostV1EmployeeTimeoffIdCancelData, + PostV1EmployeeTimeoffIdCancelError, + PostV1EmployeeTimeoffIdCancelErrors, + PostV1EmployeeTimeoffIdCancelResponse, + PostV1EmployeeTimeoffIdCancelResponses, + PostV1EmployeeTimeoffResponse, + PostV1EmployeeTimeoffResponses, + PostV1EmploymentsData, + PostV1EmploymentsEmploymentIdContractEligibilityData, + PostV1EmploymentsEmploymentIdContractEligibilityError, + PostV1EmploymentsEmploymentIdContractEligibilityErrors, + PostV1EmploymentsEmploymentIdContractEligibilityResponse, + PostV1EmploymentsEmploymentIdContractEligibilityResponses, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsError, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PostV1EmploymentsEmploymentIdInviteData, + PostV1EmploymentsEmploymentIdInviteError, + PostV1EmploymentsEmploymentIdInviteErrors, + PostV1EmploymentsEmploymentIdInviteResponse, + PostV1EmploymentsEmploymentIdInviteResponses, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsError, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponse, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses, + PostV1EmploymentsError, + PostV1EmploymentsErrors, + PostV1EmploymentsResponse, + PostV1EmploymentsResponses, + PostV1ExpensesData, + PostV1ExpensesError, + PostV1ExpensesErrors, + PostV1ExpensesResponse, + PostV1ExpensesResponses, + PostV1IdentityVerificationEmploymentIdDeclineData, + PostV1IdentityVerificationEmploymentIdDeclineError, + PostV1IdentityVerificationEmploymentIdDeclineErrors, + PostV1IdentityVerificationEmploymentIdDeclineResponse, + PostV1IdentityVerificationEmploymentIdDeclineResponses, + PostV1IdentityVerificationEmploymentIdVerifyData, + PostV1IdentityVerificationEmploymentIdVerifyError, + PostV1IdentityVerificationEmploymentIdVerifyErrors, + PostV1IdentityVerificationEmploymentIdVerifyResponse, + PostV1IdentityVerificationEmploymentIdVerifyResponses, + PostV1IncentivesData, + PostV1IncentivesError, + PostV1IncentivesErrors, + PostV1IncentivesRecurringData, + PostV1IncentivesRecurringError, + PostV1IncentivesRecurringErrors, + PostV1IncentivesRecurringResponse, + PostV1IncentivesRecurringResponses, + PostV1IncentivesResponse, + PostV1IncentivesResponses, + PostV1MagicLinkData, + PostV1MagicLinkError, + PostV1MagicLinkErrors, + PostV1MagicLinkResponse, + PostV1MagicLinkResponses, + PostV1OffboardingsData, + PostV1OffboardingsError, + PostV1OffboardingsErrors, + PostV1OffboardingsResponse, + PostV1OffboardingsResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsError, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignError, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponse, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponse, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses, + PostV1PayItemsBulkData, + PostV1PayItemsBulkError, + PostV1PayItemsBulkErrors, + PostV1PayItemsBulkResponse, + PostV1PayItemsBulkResponses, + PostV1ProbationCompletionLetterData, + PostV1ProbationCompletionLetterError, + PostV1ProbationCompletionLetterErrors, + PostV1ProbationCompletionLetterResponse, + PostV1ProbationCompletionLetterResponses, + PostV1ProbationExtensionsData, + PostV1ProbationExtensionsError, + PostV1ProbationExtensionsErrors, + PostV1ProbationExtensionsResponse, + PostV1ProbationExtensionsResponses, + PostV1ReadyData, + PostV1ReadyError, + PostV1ReadyErrors, + PostV1ReadyResponse, + PostV1ReadyResponses, + PostV1RiskReserveData, + PostV1RiskReserveError, + PostV1RiskReserveErrors, + PostV1RiskReserveResponse, + PostV1RiskReserveResponses, + PostV1SandboxBenefitRenewalRequestsData, + PostV1SandboxBenefitRenewalRequestsError, + PostV1SandboxBenefitRenewalRequestsErrors, + PostV1SandboxBenefitRenewalRequestsResponse, + PostV1SandboxBenefitRenewalRequestsResponses, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksError, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponse, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses, + PostV1SandboxCompaniesCompanyIdLegalEntitiesData, + PostV1SandboxCompaniesCompanyIdLegalEntitiesError, + PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors, + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponse, + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses, + PostV1SandboxEmploymentsData, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveError, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponse, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses, + PostV1SandboxEmploymentsError, + PostV1SandboxEmploymentsErrors, + PostV1SandboxEmploymentsResponse, + PostV1SandboxEmploymentsResponses, + PostV1SandboxWebhookCallbacksTriggerData, + PostV1SandboxWebhookCallbacksTriggerError, + PostV1SandboxWebhookCallbacksTriggerErrors, + PostV1SandboxWebhookCallbacksTriggerResponse, + PostV1SandboxWebhookCallbacksTriggerResponses, + PostV1SdkTelemetryErrorsData, + PostV1SdkTelemetryErrorsError, + PostV1SdkTelemetryErrorsErrors, + PostV1SdkTelemetryErrorsResponses, + PostV1SsoConfigurationData, + PostV1SsoConfigurationError, + PostV1SsoConfigurationErrors, + PostV1SsoConfigurationResponse, + PostV1SsoConfigurationResponses, + PostV1TimeoffData, + PostV1TimeoffError, + PostV1TimeoffErrors, + PostV1TimeoffResponse, + PostV1TimeoffResponses, + PostV1TimeoffTimeoffIdApproveData, + PostV1TimeoffTimeoffIdApproveError, + PostV1TimeoffTimeoffIdApproveErrors, + PostV1TimeoffTimeoffIdApproveResponse, + PostV1TimeoffTimeoffIdApproveResponses, + PostV1TimeoffTimeoffIdCancelData, + PostV1TimeoffTimeoffIdCancelError, + PostV1TimeoffTimeoffIdCancelErrors, + PostV1TimeoffTimeoffIdCancelRequestApproveData, + PostV1TimeoffTimeoffIdCancelRequestApproveError, + PostV1TimeoffTimeoffIdCancelRequestApproveErrors, + PostV1TimeoffTimeoffIdCancelRequestApproveResponse, + PostV1TimeoffTimeoffIdCancelRequestApproveResponses, + PostV1TimeoffTimeoffIdCancelRequestDeclineData, + PostV1TimeoffTimeoffIdCancelRequestDeclineError, + PostV1TimeoffTimeoffIdCancelRequestDeclineErrors, + PostV1TimeoffTimeoffIdCancelRequestDeclineResponse, + PostV1TimeoffTimeoffIdCancelRequestDeclineResponses, + PostV1TimeoffTimeoffIdCancelResponse, + PostV1TimeoffTimeoffIdCancelResponses, + PostV1TimeoffTimeoffIdDeclineData, + PostV1TimeoffTimeoffIdDeclineError, + PostV1TimeoffTimeoffIdDeclineErrors, + PostV1TimeoffTimeoffIdDeclineResponse, + PostV1TimeoffTimeoffIdDeclineResponses, + PostV1TimesheetsData, + PostV1TimesheetsError, + PostV1TimesheetsErrors, + PostV1TimesheetsResponse, + PostV1TimesheetsResponses, + PostV1TimesheetsTimesheetIdApproveData, + PostV1TimesheetsTimesheetIdApproveError, + PostV1TimesheetsTimesheetIdApproveErrors, + PostV1TimesheetsTimesheetIdApproveResponse, + PostV1TimesheetsTimesheetIdApproveResponses, + PostV1TimesheetsTimesheetIdSendBackData, + PostV1TimesheetsTimesheetIdSendBackError, + PostV1TimesheetsTimesheetIdSendBackErrors, + PostV1TimesheetsTimesheetIdSendBackResponse, + PostV1TimesheetsTimesheetIdSendBackResponses, + PostV1WebhookCallbacksData, + PostV1WebhookCallbacksError, + PostV1WebhookCallbacksErrors, + PostV1WebhookCallbacksResponse, + PostV1WebhookCallbacksResponses, + PostV1WebhookEventsReplayData, + PostV1WebhookEventsReplayError, + PostV1WebhookEventsReplayErrors, + PostV1WebhookEventsReplayResponse, + PostV1WebhookEventsReplayResponses, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsError, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PreOnboardingDocumentRequirement, Price, PricingPlan, PricingPlanDetails, @@ -1657,51 +1842,101 @@ export type { Product, ProductPrice, ProvisionalStartDate, - PutApproveContractAmendmentData, - PutApproveContractAmendmentError, - PutApproveContractAmendmentErrors, - PutApproveContractAmendmentResponse, - PutApproveContractAmendmentResponses, - PutCancelContractAmendmentData, - PutCancelContractAmendmentError, - PutCancelContractAmendmentErrors, - PutCancelContractAmendmentResponse, - PutCancelContractAmendmentResponses, - PutReassignDefaultEntityCompanyData, - PutReassignDefaultEntityCompanyError, - PutReassignDefaultEntityCompanyErrors, - PutReassignDefaultEntityCompanyResponse, - PutReassignDefaultEntityCompanyResponses, - PutUpdateAdministrativeDetailsData, - PutUpdateAdministrativeDetailsError, - PutUpdateAdministrativeDetailsErrors, - PutUpdateAdministrativeDetailsResponse, - PutUpdateAdministrativeDetailsResponses, - PutUpdateBenefitOfferData, - PutUpdateBenefitOfferError, - PutUpdateBenefitOfferErrors, - PutUpdateBenefitOfferResponse, - PutUpdateBenefitOfferResponses, - PutUpdateEmploymentBasicInformationData, - PutUpdateEmploymentBasicInformationError, - PutUpdateEmploymentBasicInformationErrors, - PutUpdateEmploymentBasicInformationResponse, - PutUpdateEmploymentBasicInformationResponses, - PutUpdateEmploymentFederalTaxesData, - PutUpdateEmploymentFederalTaxesError, - PutUpdateEmploymentFederalTaxesErrors, - PutUpdateEmploymentFederalTaxesResponse, - PutUpdateEmploymentFederalTaxesResponses, - PutUpdateEmploymentPersonalDetailsData, - PutUpdateEmploymentPersonalDetailsError, - PutUpdateEmploymentPersonalDetailsErrors, - PutUpdateEmploymentPersonalDetailsResponse, - PutUpdateEmploymentPersonalDetailsResponses, - PutValidateResignationData, - PutValidateResignationError, - PutValidateResignationErrors, - PutValidateResignationResponse, - PutValidateResignationResponses, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + PutV1EmploymentsEmploymentIdBasicInformationData, + PutV1EmploymentsEmploymentIdBasicInformationError, + PutV1EmploymentsEmploymentIdBasicInformationErrors, + PutV1EmploymentsEmploymentIdBasicInformationResponse, + PutV1EmploymentsEmploymentIdBasicInformationResponses, + PutV1EmploymentsEmploymentIdBenefitOffersData, + PutV1EmploymentsEmploymentIdBenefitOffersError, + PutV1EmploymentsEmploymentIdBenefitOffersErrors, + PutV1EmploymentsEmploymentIdBenefitOffersResponse, + PutV1EmploymentsEmploymentIdBenefitOffersResponses, + PutV1EmploymentsEmploymentIdFederalTaxesData, + PutV1EmploymentsEmploymentIdFederalTaxesError, + PutV1EmploymentsEmploymentIdFederalTaxesErrors, + PutV1EmploymentsEmploymentIdFederalTaxesResponse, + PutV1EmploymentsEmploymentIdFederalTaxesResponses, + PutV1EmploymentsEmploymentIdPersonalDetailsData, + PutV1EmploymentsEmploymentIdPersonalDetailsError, + PutV1EmploymentsEmploymentIdPersonalDetailsErrors, + PutV1EmploymentsEmploymentIdPersonalDetailsResponse, + PutV1EmploymentsEmploymentIdPersonalDetailsResponses, + PutV1ResignationsOffboardingRequestIdValidateData, + PutV1ResignationsOffboardingRequestIdValidateError, + PutV1ResignationsOffboardingRequestIdValidateErrors, + PutV1ResignationsOffboardingRequestIdValidateResponse, + PutV1ResignationsOffboardingRequestIdValidateResponses, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdError, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponse, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveError, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponse, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelError, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponse, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses, + PutV2EmploymentsEmploymentIdAddressDetailsData, + PutV2EmploymentsEmploymentIdAddressDetailsError, + PutV2EmploymentsEmploymentIdAddressDetailsErrors, + PutV2EmploymentsEmploymentIdAddressDetailsResponse, + PutV2EmploymentsEmploymentIdAddressDetailsResponses, + PutV2EmploymentsEmploymentIdAdministrativeDetailsData, + PutV2EmploymentsEmploymentIdAdministrativeDetailsError, + PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors, + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponse, + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses, + PutV2EmploymentsEmploymentIdBankAccountDetailsData, + PutV2EmploymentsEmploymentIdBankAccountDetailsError, + PutV2EmploymentsEmploymentIdBankAccountDetailsErrors, + PutV2EmploymentsEmploymentIdBankAccountDetailsResponse, + PutV2EmploymentsEmploymentIdBankAccountDetailsResponses, + PutV2EmploymentsEmploymentIdBasicInformationData, + PutV2EmploymentsEmploymentIdBasicInformationError, + PutV2EmploymentsEmploymentIdBasicInformationErrors, + PutV2EmploymentsEmploymentIdBasicInformationResponse, + PutV2EmploymentsEmploymentIdBasicInformationResponses, + PutV2EmploymentsEmploymentIdBillingAddressDetailsData, + PutV2EmploymentsEmploymentIdBillingAddressDetailsError, + PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors, + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponse, + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses, + PutV2EmploymentsEmploymentIdContractDetailsData, + PutV2EmploymentsEmploymentIdContractDetailsError, + PutV2EmploymentsEmploymentIdContractDetailsErrors, + PutV2EmploymentsEmploymentIdContractDetailsResponse, + PutV2EmploymentsEmploymentIdContractDetailsResponses, + PutV2EmploymentsEmploymentIdEmergencyContactData, + PutV2EmploymentsEmploymentIdEmergencyContactError, + PutV2EmploymentsEmploymentIdEmergencyContactErrors, + PutV2EmploymentsEmploymentIdEmergencyContactResponse, + PutV2EmploymentsEmploymentIdEmergencyContactResponses, + PutV2EmploymentsEmploymentIdFederalTaxesData, + PutV2EmploymentsEmploymentIdFederalTaxesError, + PutV2EmploymentsEmploymentIdFederalTaxesErrors, + PutV2EmploymentsEmploymentIdFederalTaxesResponse, + PutV2EmploymentsEmploymentIdFederalTaxesResponses, + PutV2EmploymentsEmploymentIdPersonalDetailsData, + PutV2EmploymentsEmploymentIdPersonalDetailsError, + PutV2EmploymentsEmploymentIdPersonalDetailsErrors, + PutV2EmploymentsEmploymentIdPersonalDetailsResponse, + PutV2EmploymentsEmploymentIdPersonalDetailsResponses, + PutV2EmploymentsEmploymentIdPricingPlanDetailsData, + PutV2EmploymentsEmploymentIdPricingPlanDetailsError, + PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors, + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponse, + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses, RateLimitResponse, RecurringIncentive, RecurringIncentiveResponse, @@ -1732,6 +1967,7 @@ export type { SentBackTimesheetResponse, ShortId, ShowLegalEntityAdministrativeDetailsResponse, + ShowPreOnboardingDocumentResponse, Signatory, SignatoryStatus, SignatoryType, diff --git a/src/client/sdk.gen.ts b/src/client/sdk.gen.ts index cbb483a23..5dce0bf6e 100644 --- a/src/client/sdk.gen.ts +++ b/src/client/sdk.gen.ts @@ -8,649 +8,757 @@ import { } from './client'; import { client } from './client.gen'; import type { - DeleteDeleteCompanyManagerData, - DeleteDeleteCompanyManagerErrors, - DeleteDeleteCompanyManagerResponses, - DeleteDeleteContractorCorSubscriptionSubscriptionData, - DeleteDeleteContractorCorSubscriptionSubscriptionErrors, - DeleteDeleteContractorCorSubscriptionSubscriptionResponses, - DeleteDeleteIncentiveData, - DeleteDeleteIncentiveErrors, - DeleteDeleteIncentiveResponses, - DeleteDeleteRecurringIncentiveData, - DeleteDeleteRecurringIncentiveErrors, - DeleteDeleteRecurringIncentiveResponses, - DeleteDeleteWebhookCallbackData, - DeleteDeleteWebhookCallbackErrors, - DeleteDeleteWebhookCallbackResponses, - GetCategoriesExpenseData, - GetCategoriesExpenseErrors, - GetCategoriesExpenseResponses, - GetContractorEligibilityCompanyLegalEntitiesData, - GetContractorEligibilityCompanyLegalEntitiesErrors, - GetContractorEligibilityCompanyLegalEntitiesResponses, - GetCurrentIdentityData, - GetCurrentIdentityErrors, - GetCurrentIdentityResponses, - GetDetailsSsoConfigurationData, - GetDetailsSsoConfigurationErrors, - GetDetailsSsoConfigurationResponses, - GetDownloadByIdExpenseReceiptData, - GetDownloadByIdExpenseReceiptErrors, - GetDownloadByIdExpenseReceiptResponses, - GetDownloadExpenseReceiptData, - GetDownloadExpenseReceiptErrors, - GetDownloadExpenseReceiptResponses, - GetDownloadPayslipPayslipData, - GetDownloadPayslipPayslipErrors, - GetDownloadPayslipPayslipResponses, - GetDownloadPdfBillingDocumentData, - GetDownloadPdfBillingDocumentErrors, - GetDownloadPdfBillingDocumentResponses, - GetDownloadResignationLetterData, - GetDownloadResignationLetterErrors, - GetDownloadResignationLetterResponses, - GetEmployeeDetailsPayrollRunData, - GetEmployeeDetailsPayrollRunErrors, - GetEmployeeDetailsPayrollRunResponses, - GetGetBreakdownBillingDocumentData, - GetGetBreakdownBillingDocumentErrors, - GetGetBreakdownBillingDocumentResponses, - GetGetGroupScimData, - GetGetGroupScimErrors, - GetGetGroupScimResponses, - GetGetIdentityVerificationDataIdentityVerificationData, - GetGetIdentityVerificationDataIdentityVerificationErrors, - GetGetIdentityVerificationDataIdentityVerificationResponses, - GetGetUserScimData, - GetGetUserScimErrors, - GetGetUserScimResponses, - GetIndexBenefitOfferData, - GetIndexBenefitOfferErrors, - GetIndexBenefitOfferResponses, - GetIndexBenefitOffersByEmploymentData, - GetIndexBenefitOffersByEmploymentErrors, - GetIndexBenefitOffersByEmploymentResponses, - GetIndexBenefitOffersCountrySummaryData, - GetIndexBenefitOffersCountrySummaryErrors, - GetIndexBenefitOffersCountrySummaryResponses, - GetIndexBenefitRenewalRequestData, - GetIndexBenefitRenewalRequestErrors, - GetIndexBenefitRenewalRequestResponses, - GetIndexBillingDocumentData, - GetIndexBillingDocumentErrors, - GetIndexBillingDocumentResponses, - GetIndexBulkEmploymentRowData, - GetIndexBulkEmploymentRowErrors, - GetIndexBulkEmploymentRowResponses, - GetIndexCompanyCurrencyData, - GetIndexCompanyCurrencyErrors, - GetIndexCompanyCurrencyResponses, - GetIndexCompanyData, - GetIndexCompanyDepartmentData, - GetIndexCompanyDepartmentErrors, - GetIndexCompanyDepartmentResponses, - GetIndexCompanyErrors, - GetIndexCompanyLegalEntitiesData, - GetIndexCompanyLegalEntitiesErrors, - GetIndexCompanyLegalEntitiesResponses, - GetIndexCompanyManagerData, - GetIndexCompanyManagerErrors, - GetIndexCompanyManagerResponses, - GetIndexCompanyPricingPlanData, - GetIndexCompanyPricingPlanErrors, - GetIndexCompanyPricingPlanResponses, - GetIndexCompanyProductPriceData, - GetIndexCompanyProductPriceErrors, - GetIndexCompanyProductPriceResponses, - GetIndexCompanyResponses, - GetIndexContractAmendmentData, - GetIndexContractAmendmentErrors, - GetIndexContractAmendmentResponses, - GetIndexContractorCurrencyData, - GetIndexContractorCurrencyErrors, - GetIndexContractorCurrencyResponses, - GetIndexContractorInvoiceData, - GetIndexContractorInvoiceErrors, - GetIndexContractorInvoiceResponses, - GetIndexCountryData, - GetIndexCountryResponses, - GetIndexDataSyncData, - GetIndexDataSyncErrors, - GetIndexDataSyncResponses, - GetIndexEmployeeDocumentData, - GetIndexEmployeeDocumentErrors, - GetIndexEmployeeDocumentResponses, - GetIndexEmploymentCompanyStructureNodeData, - GetIndexEmploymentCompanyStructureNodeErrors, - GetIndexEmploymentCompanyStructureNodeResponses, - GetIndexEmploymentContractData, - GetIndexEmploymentContractDocumentData, - GetIndexEmploymentContractDocumentErrors, - GetIndexEmploymentContractDocumentResponses, - GetIndexEmploymentContractErrors, - GetIndexEmploymentContractResponses, - GetIndexEmploymentCustomFieldData, - GetIndexEmploymentCustomFieldErrors, - GetIndexEmploymentCustomFieldResponses, - GetIndexEmploymentCustomFieldValueData, - GetIndexEmploymentCustomFieldValueErrors, - GetIndexEmploymentCustomFieldValueResponses, - GetIndexEmploymentData, - GetIndexEmploymentErrors, - GetIndexEmploymentFileData, - GetIndexEmploymentFileErrors, - GetIndexEmploymentFileResponses, - GetIndexEmploymentJobData, - GetIndexEmploymentJobErrors, - GetIndexEmploymentJobResponses, - GetIndexEmploymentResponses, - GetIndexEorPayrollCalendarData, - GetIndexEorPayrollCalendarErrors, - GetIndexEorPayrollCalendarResponses, - GetIndexExpenseData, - GetIndexExpenseErrors, - GetIndexExpenseResponses, - GetIndexHolidayData, - GetIndexHolidayErrors, - GetIndexHolidayResponses, - GetIndexIncentiveData, - GetIndexIncentiveErrors, - GetIndexIncentiveResponses, - GetIndexLeavePoliciesDetailsData, - GetIndexLeavePoliciesDetailsErrors, - GetIndexLeavePoliciesDetailsResponses, - GetIndexLeavePoliciesSummaryData, - GetIndexLeavePoliciesSummaryErrors, - GetIndexLeavePoliciesSummaryResponses, - GetIndexOffboardingData, - GetIndexOffboardingErrors, - GetIndexOffboardingResponses, - GetIndexPayItemsData, - GetIndexPayItemsErrors, - GetIndexPayItemsResponses, - GetIndexPayrollCalendarData, - GetIndexPayrollCalendarErrors, - GetIndexPayrollCalendarResponses, - GetIndexPayrollRunData, - GetIndexPayrollRunErrors, - GetIndexPayrollRunResponses, - GetIndexPayslipData, - GetIndexPayslipErrors, - GetIndexPayslipResponses, - GetIndexPricingPlanPartnerTemplateData, - GetIndexPricingPlanPartnerTemplateErrors, - GetIndexPricingPlanPartnerTemplateResponses, - GetIndexRecurringIncentiveData, - GetIndexRecurringIncentiveErrors, - GetIndexRecurringIncentiveResponses, - GetIndexScheduledContractorInvoiceData, - GetIndexScheduledContractorInvoiceErrors, - GetIndexScheduledContractorInvoiceResponses, - GetIndexSubscriptionData, - GetIndexSubscriptionErrors, - GetIndexSubscriptionResponses, - GetIndexTimeoffData, - GetIndexTimeoffErrors, - GetIndexTimeoffResponses, - GetIndexTimesheetData, - GetIndexTimesheetErrors, - GetIndexTimesheetResponses, - GetIndexTravelLetterRequestData, - GetIndexTravelLetterRequestErrors, - GetIndexTravelLetterRequestResponses, - GetIndexWebhookCallbackData, - GetIndexWebhookCallbackErrors, - GetIndexWebhookCallbackResponses, - GetIndexWebhookEventData, - GetIndexWebhookEventErrors, - GetIndexWebhookEventResponses, - GetIndexWorkAuthorizationRequestData, - GetIndexWorkAuthorizationRequestErrors, - GetIndexWorkAuthorizationRequestResponses, - GetListGroupsScimData, - GetListGroupsScimErrors, - GetListGroupsScimResponses, - GetListUsersScimData, - GetListUsersScimErrors, - GetListUsersScimResponses, - GetPendingChangesEmploymentContractData, - GetPendingChangesEmploymentContractErrors, - GetPendingChangesEmploymentContractResponses, - GetSchemaBenefitRenewalRequestData, - GetSchemaBenefitRenewalRequestErrors, - GetSchemaBenefitRenewalRequestResponses, - GetShowAdministrativeDetailsData, - GetShowAdministrativeDetailsErrors, - GetShowAdministrativeDetailsResponses, - GetShowBackgroundCheckData, - GetShowBackgroundCheckErrors, - GetShowBackgroundCheckResponses, - GetShowBenefitRenewalRequestData, - GetShowBenefitRenewalRequestErrors, - GetShowBenefitRenewalRequestResponses, - GetShowBillingDocumentData, - GetShowBillingDocumentErrors, - GetShowBillingDocumentResponses, - GetShowBulkEmploymentData, - GetShowBulkEmploymentErrors, - GetShowBulkEmploymentResponses, - GetShowCompanyComplianceProfileData, - GetShowCompanyComplianceProfileErrors, - GetShowCompanyComplianceProfileResponses, - GetShowCompanyData, - GetShowCompanyEmploymentOnboardingReservesStatusData, - GetShowCompanyEmploymentOnboardingReservesStatusErrors, - GetShowCompanyEmploymentOnboardingReservesStatusResponses, - GetShowCompanyErrors, - GetShowCompanyManagerData, - GetShowCompanyManagerErrors, - GetShowCompanyManagerResponses, - GetShowCompanyResponses, - GetShowCompanySchemaData, - GetShowCompanySchemaErrors, - GetShowCompanySchemaResponses, - GetShowContractAmendmentData, - GetShowContractAmendmentErrors, - GetShowContractAmendmentResponses, - GetShowContractAmendmentSchemaData, - GetShowContractAmendmentSchemaErrors, - GetShowContractAmendmentSchemaResponses, - GetShowContractDocumentData, - GetShowContractDocumentErrors, - GetShowContractDocumentResponses, - GetShowContractorContractDetailsCountryData, - GetShowContractorContractDetailsCountryErrors, - GetShowContractorContractDetailsCountryResponses, - GetShowContractorInvoiceData, - GetShowContractorInvoiceErrors, - GetShowContractorInvoiceResponses, - GetShowCorTerminationRequestSubscriptionData, - GetShowCorTerminationRequestSubscriptionErrors, - GetShowCorTerminationRequestSubscriptionResponses, - GetShowEligibilityQuestionnaireData, - GetShowEligibilityQuestionnaireErrors, - GetShowEligibilityQuestionnaireResponses, - GetShowEmployeeDocumentData, - GetShowEmployeeDocumentErrors, - GetShowEmployeeDocumentResponses, - GetShowEmploymentCustomFieldValueData, - GetShowEmploymentCustomFieldValueErrors, - GetShowEmploymentCustomFieldValueResponses, - GetShowEmploymentData, - GetShowEmploymentEngagementAgreementDetailsData, - GetShowEmploymentEngagementAgreementDetailsErrors, - GetShowEmploymentEngagementAgreementDetailsResponses, - GetShowEmploymentErrors, - GetShowEmploymentOnboardingStepsData, - GetShowEmploymentOnboardingStepsErrors, - GetShowEmploymentOnboardingStepsResponses, - GetShowEmploymentResponses, - GetShowEngagementAgreementDetailsCountryData, - GetShowEngagementAgreementDetailsCountryErrors, - GetShowEngagementAgreementDetailsCountryResponses, - GetShowExpenseData, - GetShowExpenseErrors, - GetShowExpenseResponses, - GetShowFileData, - GetShowFileErrors, - GetShowFileResponses, - GetShowFormCountryData, - GetShowFormCountryErrors, - GetShowFormCountryResponses, - GetShowHelpCenterArticleData, - GetShowHelpCenterArticleErrors, - GetShowHelpCenterArticleResponses, - GetShowIncentiveData, - GetShowIncentiveErrors, - GetShowIncentiveResponses, - GetShowLegalEntityFormCountryData, - GetShowLegalEntityFormCountryErrors, - GetShowLegalEntityFormCountryResponses, - GetShowOffboardingData, - GetShowOffboardingErrors, - GetShowOffboardingResponses, - GetShowPayrollRunData, - GetShowPayrollRunErrors, - GetShowPayrollRunResponses, - GetShowPayslipData, - GetShowPayslipErrors, - GetShowPayslipResponses, - GetShowProbationCompletionLetterData, - GetShowProbationCompletionLetterErrors, - GetShowProbationCompletionLetterResponses, - GetShowProbationExtensionData, - GetShowProbationExtensionErrors, - GetShowProbationExtensionResponses, - GetShowRegionFieldData, - GetShowRegionFieldErrors, - GetShowRegionFieldResponses, - GetShowResignationData, - GetShowResignationErrors, - GetShowResignationResponses, - GetShowScheduledContractorInvoiceData, - GetShowScheduledContractorInvoiceErrors, - GetShowScheduledContractorInvoiceResponses, - GetShowSchemaData, - GetShowSchemaErrors, - GetShowSchemaResponses, - GetShowSsoConfigurationData, - GetShowSsoConfigurationErrors, - GetShowSsoConfigurationResponses, - GetShowTestSchemaData, - GetShowTestSchemaResponses, - GetShowTimeoffBalanceData, - GetShowTimeoffBalanceErrors, - GetShowTimeoffBalanceResponses, - GetShowTimeoffData, - GetShowTimeoffErrors, - GetShowTimeoffResponses, - GetShowTimesheetData, - GetShowTimesheetErrors, - GetShowTimesheetResponses, - GetShowTravelLetterRequestData, - GetShowTravelLetterRequestErrors, - GetShowTravelLetterRequestResponses, - GetShowWorkAuthorizationRequestData, - GetShowWorkAuthorizationRequestErrors, - GetShowWorkAuthorizationRequestResponses, - GetSupportedCountryData, - GetSupportedCountryErrors, - GetSupportedCountryResponses, - GetTimeoffTypesTimeoffData, - GetTimeoffTypesTimeoffErrors, - GetTimeoffTypesTimeoffResponses, - PatchUpdateCompany2Data, - PatchUpdateCompany2Errors, - PatchUpdateCompany2Responses, - PatchUpdateCompanyData, - PatchUpdateCompanyErrors, - PatchUpdateCompanyResponses, - PatchUpdateEmployeeTimeoff2Data, - PatchUpdateEmployeeTimeoff2Errors, - PatchUpdateEmployeeTimeoff2Responses, - PatchUpdateEmployeeTimeoffData, - PatchUpdateEmployeeTimeoffErrors, - PatchUpdateEmployeeTimeoffResponses, - PatchUpdateEmployment2Data, - PatchUpdateEmployment2Errors, - PatchUpdateEmployment2Responses, - PatchUpdateEmployment3Data, - PatchUpdateEmployment3Errors, - PatchUpdateEmployment3Responses, - PatchUpdateEmployment4Data, - PatchUpdateEmployment4Errors, - PatchUpdateEmployment4Responses, - PatchUpdateEmploymentCustomFieldValue2Data, - PatchUpdateEmploymentCustomFieldValue2Errors, - PatchUpdateEmploymentCustomFieldValue2Responses, - PatchUpdateEmploymentCustomFieldValueData, - PatchUpdateEmploymentCustomFieldValueErrors, - PatchUpdateEmploymentCustomFieldValueResponses, - PatchUpdateEmploymentData, - PatchUpdateEmploymentErrors, - PatchUpdateEmploymentResponses, - PatchUpdateExpense2Data, - PatchUpdateExpense2Errors, - PatchUpdateExpense2Responses, - PatchUpdateExpenseData, - PatchUpdateExpenseErrors, - PatchUpdateExpenseResponses, - PatchUpdateIncentive2Data, - PatchUpdateIncentive2Errors, - PatchUpdateIncentive2Responses, - PatchUpdateIncentiveData, - PatchUpdateIncentiveErrors, - PatchUpdateIncentiveResponses, - PatchUpdateScheduledContractorInvoice2Data, - PatchUpdateScheduledContractorInvoice2Errors, - PatchUpdateScheduledContractorInvoice2Responses, - PatchUpdateScheduledContractorInvoiceData, - PatchUpdateScheduledContractorInvoiceErrors, - PatchUpdateScheduledContractorInvoiceResponses, - PatchUpdateTimeoff2Data, - PatchUpdateTimeoff2Errors, - PatchUpdateTimeoff2Responses, - PatchUpdateTimeoffData, - PatchUpdateTimeoffErrors, - PatchUpdateTimeoffResponses, - PatchUpdateTravelLetterRequest2Data, - PatchUpdateTravelLetterRequest2Errors, - PatchUpdateTravelLetterRequest2Responses, - PatchUpdateTravelLetterRequestData, - PatchUpdateTravelLetterRequestErrors, - PatchUpdateTravelLetterRequestResponses, - PatchUpdateWebhookCallbackData, - PatchUpdateWebhookCallbackErrors, - PatchUpdateWebhookCallbackResponses, - PatchUpdateWorkAuthorizationRequest2Data, - PatchUpdateWorkAuthorizationRequest2Errors, - PatchUpdateWorkAuthorizationRequest2Responses, - PatchUpdateWorkAuthorizationRequestData, - PatchUpdateWorkAuthorizationRequestErrors, - PatchUpdateWorkAuthorizationRequestResponses, - PostApproveCancellationRequestData, - PostApproveCancellationRequestErrors, - PostApproveCancellationRequestResponses, - PostApproveRiskReserveProofOfPaymentData, - PostApproveRiskReserveProofOfPaymentErrors, - PostApproveRiskReserveProofOfPaymentResponses, - PostApproveTimesheetData, - PostApproveTimesheetErrors, - PostApproveTimesheetResponses, - PostAutomatableContractAmendmentData, - PostAutomatableContractAmendmentErrors, - PostAutomatableContractAmendmentResponses, - PostBulkCreatePayItemsData, - PostBulkCreatePayItemsErrors, - PostBulkCreatePayItemsResponses, - PostBulkCreateScheduledContractorInvoiceData, - PostBulkCreateScheduledContractorInvoiceErrors, - PostBulkCreateScheduledContractorInvoiceResponses, - PostBypassEligibilityChecksCompanyData, - PostBypassEligibilityChecksCompanyErrors, - PostBypassEligibilityChecksCompanyResponses, - PostCancelEmployeeTimeoffData, - PostCancelEmployeeTimeoffErrors, - PostCancelEmployeeTimeoffResponses, - PostCompleteOnboardingEmploymentData, - PostCompleteOnboardingEmploymentErrors, - PostCompleteOnboardingEmploymentResponses, - PostConvertRawCurrencyConverterData, - PostConvertRawCurrencyConverterErrors, - PostConvertRawCurrencyConverterResponses, - PostConvertWithSpreadCurrencyConverter2Data, - PostConvertWithSpreadCurrencyConverter2Errors, - PostConvertWithSpreadCurrencyConverter2Responses, - PostConvertWithSpreadCurrencyConverterData, - PostConvertWithSpreadCurrencyConverterErrors, - PostConvertWithSpreadCurrencyConverterResponses, - PostCreateApprovalData, - PostCreateApprovalErrors, - PostCreateApprovalResponses, - PostCreateBenefitRenewalRequestData, - PostCreateBenefitRenewalRequestErrors, - PostCreateBenefitRenewalRequestResponses, - PostCreateBulkEmploymentData, - PostCreateBulkEmploymentErrors, - PostCreateBulkEmploymentResponses, - PostCreateCancellationData, - PostCreateCancellationErrors, - PostCreateCancellationResponses, - PostCreateCompanyData, - PostCreateCompanyDepartmentData, - PostCreateCompanyDepartmentErrors, - PostCreateCompanyDepartmentResponses, - PostCreateCompanyErrors, - PostCreateCompanyManagerData, - PostCreateCompanyManagerErrors, - PostCreateCompanyManagerResponses, - PostCreateCompanyPricingPlanData, - PostCreateCompanyPricingPlanErrors, - PostCreateCompanyPricingPlanResponses, - PostCreateCompanyResponses, - PostCreateContractAmendmentData, - PostCreateContractAmendmentErrors, - PostCreateContractAmendmentResponses, - PostCreateContractDocumentData, - PostCreateContractDocumentErrors, - PostCreateContractDocumentResponses, - PostCreateContractEligibilityData, - PostCreateContractEligibilityErrors, - PostCreateContractEligibilityResponses, - PostCreateCorTerminationRequestSubscriptionData, - PostCreateCorTerminationRequestSubscriptionErrors, - PostCreateCorTerminationRequestSubscriptionResponses, - PostCreateDataSyncData, - PostCreateDataSyncErrors, - PostCreateDataSyncResponses, - PostCreateDeclineData, - PostCreateDeclineErrors, - PostCreateDeclineResponses, - PostCreateEligibilityQuestionnaireData, - PostCreateEligibilityQuestionnaireErrors, - PostCreateEligibilityQuestionnaireResponses, - PostCreateEmployeeTimeoffData, - PostCreateEmployeeTimeoffErrors, - PostCreateEmployeeTimeoffResponses, - PostCreateEmployment2Data, - PostCreateEmployment2Errors, - PostCreateEmployment2Responses, - PostCreateEmploymentCustomFieldData, - PostCreateEmploymentCustomFieldErrors, - PostCreateEmploymentCustomFieldResponses, - PostCreateEmploymentData, - PostCreateEmploymentErrors, - PostCreateEmploymentResponses, - PostCreateEstimationCsvData, - PostCreateEstimationCsvErrors, - PostCreateEstimationCsvResponses, - PostCreateEstimationData, - PostCreateEstimationErrors, - PostCreateEstimationPdfData, - PostCreateEstimationPdfErrors, - PostCreateEstimationPdfResponses, - PostCreateEstimationResponses, - PostCreateExpenseData, - PostCreateExpenseErrors, - PostCreateExpenseResponses, - PostCreateIncentiveData, - PostCreateIncentiveErrors, - PostCreateIncentiveResponses, - PostCreateLegalEntityCompanyData, - PostCreateLegalEntityCompanyErrors, - PostCreateLegalEntityCompanyResponses, - PostCreateOffboardingData, - PostCreateOffboardingErrors, - PostCreateOffboardingResponses, - PostCreateProbationCompletionLetterData, - PostCreateProbationCompletionLetterErrors, - PostCreateProbationCompletionLetterResponses, - PostCreateProbationExtensionData, - PostCreateProbationExtensionErrors, - PostCreateProbationExtensionResponses, - PostCreateRecurringIncentiveData, - PostCreateRecurringIncentiveErrors, - PostCreateRecurringIncentiveResponses, - PostCreateRiskReserveData, - PostCreateRiskReserveErrors, - PostCreateRiskReserveResponses, - PostCreateSsoConfigurationData, - PostCreateSsoConfigurationErrors, - PostCreateSsoConfigurationResponses, - PostCreateTimeoffData, - PostCreateTimeoffErrors, - PostCreateTimeoffResponses, - PostCreateTokenCompanyTokenData, - PostCreateTokenCompanyTokenErrors, - PostCreateTokenCompanyTokenResponses, - PostCreateWebhookCallbackData, - PostCreateWebhookCallbackErrors, - PostCreateWebhookCallbackResponses, - PostDeclineCancellationRequestData, - PostDeclineCancellationRequestErrors, - PostDeclineCancellationRequestResponses, - PostDeclineIdentityVerificationData, - PostDeclineIdentityVerificationErrors, - PostDeclineIdentityVerificationResponses, - PostGenerateMagicLinkData, - PostGenerateMagicLinkErrors, - PostGenerateMagicLinkResponses, - PostInviteEmploymentInvitationData, - PostInviteEmploymentInvitationErrors, - PostInviteEmploymentInvitationResponses, - PostManageContractorCorSubscriptionSubscriptionData, - PostManageContractorCorSubscriptionSubscriptionErrors, - PostManageContractorCorSubscriptionSubscriptionResponses, - PostManageContractorPlusSubscriptionSubscriptionData, - PostManageContractorPlusSubscriptionSubscriptionErrors, - PostManageContractorPlusSubscriptionSubscriptionResponses, - PostReplayWebhookEventData, - PostReplayWebhookEventErrors, - PostReplayWebhookEventResponses, - PostReportErrorsTelemetryData, - PostReportErrorsTelemetryErrors, - PostReportErrorsTelemetryResponses, - PostSendBackTimesheetData, - PostSendBackTimesheetErrors, - PostSendBackTimesheetResponses, - PostSignContractDocumentData, - PostSignContractDocumentErrors, - PostSignContractDocumentResponses, - PostSubmitRiskReserveProofOfPaymentData, - PostSubmitRiskReserveProofOfPaymentErrors, - PostSubmitRiskReserveProofOfPaymentResponses, - PostTerminateContractorOfRecordEmploymentSubscriptionData, - PostTerminateContractorOfRecordEmploymentSubscriptionErrors, - PostTerminateContractorOfRecordEmploymentSubscriptionResponses, - PostTokenOAuth2TokenData, - PostTokenOAuth2TokenErrors, - PostTokenOAuth2TokenResponses, - PostTriggerWebhookCallbackData, - PostTriggerWebhookCallbackErrors, - PostTriggerWebhookCallbackResponses, - PostUpdateBenefitRenewalRequestData, - PostUpdateBenefitRenewalRequestErrors, - PostUpdateBenefitRenewalRequestResponses, - PostUpdateCancelOnboardingData, - PostUpdateCancelOnboardingErrors, - PostUpdateCancelOnboardingResponses, - PostUpdateEmploymentEngagementAgreementDetailsData, - PostUpdateEmploymentEngagementAgreementDetailsErrors, - PostUpdateEmploymentEngagementAgreementDetailsResponses, - PostUploadEmployeeFileFileData, - PostUploadEmployeeFileFileErrors, - PostUploadEmployeeFileFileResponses, - PostVerifyIdentityVerificationData, - PostVerifyIdentityVerificationErrors, - PostVerifyIdentityVerificationResponses, - PutApproveContractAmendmentData, - PutApproveContractAmendmentErrors, - PutApproveContractAmendmentResponses, - PutCancelContractAmendmentData, - PutCancelContractAmendmentErrors, - PutCancelContractAmendmentResponses, - PutReassignDefaultEntityCompanyData, - PutReassignDefaultEntityCompanyErrors, - PutReassignDefaultEntityCompanyResponses, - PutUpdateAdministrativeDetailsData, - PutUpdateAdministrativeDetailsErrors, - PutUpdateAdministrativeDetailsResponses, - PutUpdateBenefitOfferData, - PutUpdateBenefitOfferErrors, - PutUpdateBenefitOfferResponses, - PutUpdateEmploymentBasicInformationData, - PutUpdateEmploymentBasicInformationErrors, - PutUpdateEmploymentBasicInformationResponses, - PutUpdateEmploymentFederalTaxesData, - PutUpdateEmploymentFederalTaxesErrors, - PutUpdateEmploymentFederalTaxesResponses, - PutUpdateEmploymentPersonalDetailsData, - PutUpdateEmploymentPersonalDetailsErrors, - PutUpdateEmploymentPersonalDetailsResponses, - PutValidateResignationData, - PutValidateResignationErrors, - PutValidateResignationResponses, + DeleteV1CompanyManagersUserIdData, + DeleteV1CompanyManagersUserIdErrors, + DeleteV1CompanyManagersUserIdResponses, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + DeleteV1IncentivesIdData, + DeleteV1IncentivesIdErrors, + DeleteV1IncentivesIdResponses, + DeleteV1IncentivesRecurringIdData, + DeleteV1IncentivesRecurringIdErrors, + DeleteV1IncentivesRecurringIdResponses, + DeleteV1WebhookCallbacksIdData, + DeleteV1WebhookCallbacksIdErrors, + DeleteV1WebhookCallbacksIdResponses, + GetV1BenefitOffersCountrySummariesData, + GetV1BenefitOffersCountrySummariesErrors, + GetV1BenefitOffersCountrySummariesResponses, + GetV1BenefitOffersData, + GetV1BenefitOffersErrors, + GetV1BenefitOffersResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses, + GetV1BenefitRenewalRequestsData, + GetV1BenefitRenewalRequestsErrors, + GetV1BenefitRenewalRequestsResponses, + GetV1BillingDocumentsBillingDocumentIdBreakdownData, + GetV1BillingDocumentsBillingDocumentIdBreakdownErrors, + GetV1BillingDocumentsBillingDocumentIdBreakdownResponses, + GetV1BillingDocumentsBillingDocumentIdData, + GetV1BillingDocumentsBillingDocumentIdErrors, + GetV1BillingDocumentsBillingDocumentIdPdfData, + GetV1BillingDocumentsBillingDocumentIdPdfErrors, + GetV1BillingDocumentsBillingDocumentIdPdfResponses, + GetV1BillingDocumentsBillingDocumentIdResponses, + GetV1BillingDocumentsData, + GetV1BillingDocumentsErrors, + GetV1BillingDocumentsResponses, + GetV1BulkEmploymentJobsJobIdData, + GetV1BulkEmploymentJobsJobIdErrors, + GetV1BulkEmploymentJobsJobIdResponses, + GetV1BulkEmploymentJobsJobIdRowsData, + GetV1BulkEmploymentJobsJobIdRowsErrors, + GetV1BulkEmploymentJobsJobIdRowsResponses, + GetV1CompaniesCompanyIdComplianceProfileData, + GetV1CompaniesCompanyIdComplianceProfileErrors, + GetV1CompaniesCompanyIdComplianceProfileResponses, + GetV1CompaniesCompanyIdData, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses, + GetV1CompaniesCompanyIdErrors, + GetV1CompaniesCompanyIdLegalEntitiesData, + GetV1CompaniesCompanyIdLegalEntitiesErrors, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses, + GetV1CompaniesCompanyIdLegalEntitiesResponses, + GetV1CompaniesCompanyIdPricingPlansData, + GetV1CompaniesCompanyIdPricingPlansErrors, + GetV1CompaniesCompanyIdPricingPlansResponses, + GetV1CompaniesCompanyIdProductPricesData, + GetV1CompaniesCompanyIdProductPricesErrors, + GetV1CompaniesCompanyIdProductPricesResponses, + GetV1CompaniesCompanyIdResponses, + GetV1CompaniesCompanyIdWebhookCallbacksData, + GetV1CompaniesCompanyIdWebhookCallbacksErrors, + GetV1CompaniesCompanyIdWebhookCallbacksResponses, + GetV1CompaniesData, + GetV1CompaniesErrors, + GetV1CompaniesResponses, + GetV1CompaniesSchemaData, + GetV1CompaniesSchemaErrors, + GetV1CompaniesSchemaResponses, + GetV1CompanyCurrenciesData, + GetV1CompanyCurrenciesErrors, + GetV1CompanyCurrenciesResponses, + GetV1CompanyDepartmentsData, + GetV1CompanyDepartmentsErrors, + GetV1CompanyDepartmentsResponses, + GetV1CompanyManagersData, + GetV1CompanyManagersErrors, + GetV1CompanyManagersResponses, + GetV1CompanyManagersUserIdData, + GetV1CompanyManagersUserIdErrors, + GetV1CompanyManagersUserIdResponses, + GetV1ContractAmendmentsData, + GetV1ContractAmendmentsErrors, + GetV1ContractAmendmentsIdData, + GetV1ContractAmendmentsIdErrors, + GetV1ContractAmendmentsIdResponses, + GetV1ContractAmendmentsResponses, + GetV1ContractAmendmentsSchemaData, + GetV1ContractAmendmentsSchemaErrors, + GetV1ContractAmendmentsSchemaResponses, + GetV1ContractorInvoiceSchedulesData, + GetV1ContractorInvoiceSchedulesErrors, + GetV1ContractorInvoiceSchedulesIdData, + GetV1ContractorInvoiceSchedulesIdErrors, + GetV1ContractorInvoiceSchedulesIdResponses, + GetV1ContractorInvoiceSchedulesResponses, + GetV1ContractorInvoicesData, + GetV1ContractorInvoicesErrors, + GetV1ContractorInvoicesIdData, + GetV1ContractorInvoicesIdErrors, + GetV1ContractorInvoicesIdResponses, + GetV1ContractorInvoicesResponses, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses, + GetV1ContractorsSchemasEligibilityQuestionnaireData, + GetV1ContractorsSchemasEligibilityQuestionnaireErrors, + GetV1ContractorsSchemasEligibilityQuestionnaireResponses, + GetV1CostCalculatorCountriesData, + GetV1CostCalculatorCountriesResponses, + GetV1CostCalculatorRegionsSlugFieldsData, + GetV1CostCalculatorRegionsSlugFieldsErrors, + GetV1CostCalculatorRegionsSlugFieldsResponses, + GetV1CountriesCountryCodeContractorContractDetailsData, + GetV1CountriesCountryCodeContractorContractDetailsErrors, + GetV1CountriesCountryCodeContractorContractDetailsResponses, + GetV1CountriesCountryCodeEngagementAgreementDetailsData, + GetV1CountriesCountryCodeEngagementAgreementDetailsErrors, + GetV1CountriesCountryCodeEngagementAgreementDetailsResponses, + GetV1CountriesCountryCodeFormData, + GetV1CountriesCountryCodeFormErrors, + GetV1CountriesCountryCodeFormResponses, + GetV1CountriesCountryCodeHolidaysYearData, + GetV1CountriesCountryCodeHolidaysYearErrors, + GetV1CountriesCountryCodeHolidaysYearResponses, + GetV1CountriesCountryCodeLegalEntityFormsFormData, + GetV1CountriesCountryCodeLegalEntityFormsFormErrors, + GetV1CountriesCountryCodeLegalEntityFormsFormResponses, + GetV1CountriesData, + GetV1CountriesErrors, + GetV1CountriesResponses, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + GetV1CustomFieldsData, + GetV1CustomFieldsErrors, + GetV1CustomFieldsResponses, + GetV1DataSyncData, + GetV1DataSyncErrors, + GetV1DataSyncResponses, + GetV1EmployeeDocumentsData, + GetV1EmployeeDocumentsErrors, + GetV1EmployeeDocumentsIdData, + GetV1EmployeeDocumentsIdErrors, + GetV1EmployeeDocumentsIdResponses, + GetV1EmployeeDocumentsResponses, + GetV1EmployeeExpenseCategoriesData, + GetV1EmployeeExpenseCategoriesErrors, + GetV1EmployeeExpenseCategoriesResponses, + GetV1EmployeeExpensesData, + GetV1EmployeeExpensesErrors, + GetV1EmployeeExpensesResponses, + GetV1EmployeeIncentivesData, + GetV1EmployeeIncentivesErrors, + GetV1EmployeeIncentivesResponses, + GetV1EmployeeLeavePoliciesData, + GetV1EmployeeLeavePoliciesErrors, + GetV1EmployeeLeavePoliciesResponses, + GetV1EmployeePayslipFilesData, + GetV1EmployeePayslipFilesErrors, + GetV1EmployeePayslipFilesResponses, + GetV1EmployeePayslipsData, + GetV1EmployeePayslipsErrors, + GetV1EmployeePayslipsResponses, + GetV1EmployeePersonalInformationData, + GetV1EmployeePersonalInformationErrors, + GetV1EmployeePersonalInformationResponses, + GetV1EmployeeTimeoffData, + GetV1EmployeeTimeoffErrors, + GetV1EmployeeTimeoffResponses, + GetV1EmployeeTimesheetsData, + GetV1EmployeeTimesheetsErrors, + GetV1EmployeeTimesheetsResponses, + GetV1EmploymentContractsData, + GetV1EmploymentContractsEmploymentIdPendingChangesData, + GetV1EmploymentContractsEmploymentIdPendingChangesErrors, + GetV1EmploymentContractsEmploymentIdPendingChangesResponses, + GetV1EmploymentContractsErrors, + GetV1EmploymentContractsResponses, + GetV1EmploymentsData, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses, + GetV1EmploymentsEmploymentIdBenefitOffersData, + GetV1EmploymentsEmploymentIdBenefitOffersErrors, + GetV1EmploymentsEmploymentIdBenefitOffersResponses, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaData, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses, + GetV1EmploymentsEmploymentIdCompanyStructureNodesData, + GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors, + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses, + GetV1EmploymentsEmploymentIdContractDocumentsData, + GetV1EmploymentsEmploymentIdContractDocumentsErrors, + GetV1EmploymentsEmploymentIdContractDocumentsResponses, + GetV1EmploymentsEmploymentIdCustomFieldsData, + GetV1EmploymentsEmploymentIdCustomFieldsErrors, + GetV1EmploymentsEmploymentIdCustomFieldsResponses, + GetV1EmploymentsEmploymentIdData, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + GetV1EmploymentsEmploymentIdErrors, + GetV1EmploymentsEmploymentIdFilesData, + GetV1EmploymentsEmploymentIdFilesErrors, + GetV1EmploymentsEmploymentIdFilesResponses, + GetV1EmploymentsEmploymentIdJobData, + GetV1EmploymentsEmploymentIdJobErrors, + GetV1EmploymentsEmploymentIdJobResponses, + GetV1EmploymentsEmploymentIdOnboardingStepsData, + GetV1EmploymentsEmploymentIdOnboardingStepsErrors, + GetV1EmploymentsEmploymentIdOnboardingStepsResponses, + GetV1EmploymentsEmploymentIdResponses, + GetV1EmploymentsErrors, + GetV1EmploymentsResponses, + GetV1ExpensesCategoriesData, + GetV1ExpensesCategoriesErrors, + GetV1ExpensesCategoriesResponses, + GetV1ExpensesData, + GetV1ExpensesErrors, + GetV1ExpensesExpenseIdReceiptData, + GetV1ExpensesExpenseIdReceiptErrors, + GetV1ExpensesExpenseIdReceiptResponses, + GetV1ExpensesExpenseIdReceiptsReceiptIdData, + GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, + GetV1ExpensesExpenseIdReceiptsReceiptIdResponses, + GetV1ExpensesIdData, + GetV1ExpensesIdErrors, + GetV1ExpensesIdResponses, + GetV1ExpensesResponses, + GetV1FilesIdData, + GetV1FilesIdErrors, + GetV1FilesIdResponses, + GetV1HelpCenterArticlesIdData, + GetV1HelpCenterArticlesIdErrors, + GetV1HelpCenterArticlesIdResponses, + GetV1IdentityCurrentData, + GetV1IdentityCurrentErrors, + GetV1IdentityCurrentResponses, + GetV1IdentityVerificationEmploymentIdData, + GetV1IdentityVerificationEmploymentIdErrors, + GetV1IdentityVerificationEmploymentIdResponses, + GetV1IncentivesData, + GetV1IncentivesErrors, + GetV1IncentivesIdData, + GetV1IncentivesIdErrors, + GetV1IncentivesIdResponses, + GetV1IncentivesRecurringData, + GetV1IncentivesRecurringErrors, + GetV1IncentivesRecurringResponses, + GetV1IncentivesResponses, + GetV1LeavePoliciesDetailsEmploymentIdData, + GetV1LeavePoliciesDetailsEmploymentIdErrors, + GetV1LeavePoliciesDetailsEmploymentIdResponses, + GetV1LeavePoliciesSummaryEmploymentIdData, + GetV1LeavePoliciesSummaryEmploymentIdErrors, + GetV1LeavePoliciesSummaryEmploymentIdResponses, + GetV1OffboardingsData, + GetV1OffboardingsErrors, + GetV1OffboardingsIdData, + GetV1OffboardingsIdErrors, + GetV1OffboardingsIdResponses, + GetV1OffboardingsResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses, + GetV1PayItemsData, + GetV1PayItemsErrors, + GetV1PayItemsResponses, + GetV1PayrollCalendarsCycleData, + GetV1PayrollCalendarsCycleErrors, + GetV1PayrollCalendarsCycleResponses, + GetV1PayrollCalendarsData, + GetV1PayrollCalendarsErrors, + GetV1PayrollCalendarsResponses, + GetV1PayrollRunsData, + GetV1PayrollRunsErrors, + GetV1PayrollRunsPayrollRunIdData, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsData, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses, + GetV1PayrollRunsPayrollRunIdErrors, + GetV1PayrollRunsPayrollRunIdResponses, + GetV1PayrollRunsResponses, + GetV1PayslipsData, + GetV1PayslipsErrors, + GetV1PayslipsIdData, + GetV1PayslipsIdErrors, + GetV1PayslipsIdResponses, + GetV1PayslipsPayslipIdPdfData, + GetV1PayslipsPayslipIdPdfErrors, + GetV1PayslipsPayslipIdPdfResponses, + GetV1PayslipsResponses, + GetV1PricingPlanPartnerTemplatesData, + GetV1PricingPlanPartnerTemplatesErrors, + GetV1PricingPlanPartnerTemplatesResponses, + GetV1ProbationCompletionLetterIdData, + GetV1ProbationCompletionLetterIdErrors, + GetV1ProbationCompletionLetterIdResponses, + GetV1ProbationExtensionsIdData, + GetV1ProbationExtensionsIdErrors, + GetV1ProbationExtensionsIdResponses, + GetV1ResignationsOffboardingRequestIdData, + GetV1ResignationsOffboardingRequestIdErrors, + GetV1ResignationsOffboardingRequestIdResignationLetterData, + GetV1ResignationsOffboardingRequestIdResignationLetterErrors, + GetV1ResignationsOffboardingRequestIdResignationLetterResponses, + GetV1ResignationsOffboardingRequestIdResponses, + GetV1ScimV2GroupsData, + GetV1ScimV2GroupsErrors, + GetV1ScimV2GroupsIdData, + GetV1ScimV2GroupsIdErrors, + GetV1ScimV2GroupsIdResponses, + GetV1ScimV2GroupsResponses, + GetV1ScimV2UsersData, + GetV1ScimV2UsersErrors, + GetV1ScimV2UsersIdData, + GetV1ScimV2UsersIdErrors, + GetV1ScimV2UsersIdResponses, + GetV1ScimV2UsersResponses, + GetV1SsoConfigurationData, + GetV1SsoConfigurationDetailsData, + GetV1SsoConfigurationDetailsErrors, + GetV1SsoConfigurationDetailsResponses, + GetV1SsoConfigurationErrors, + GetV1SsoConfigurationResponses, + GetV1TestSchemaData, + GetV1TestSchemaResponses, + GetV1TimeoffBalancesEmploymentIdData, + GetV1TimeoffBalancesEmploymentIdErrors, + GetV1TimeoffBalancesEmploymentIdResponses, + GetV1TimeoffData, + GetV1TimeoffErrors, + GetV1TimeoffIdData, + GetV1TimeoffIdErrors, + GetV1TimeoffIdResponses, + GetV1TimeoffResponses, + GetV1TimeoffTypesData, + GetV1TimeoffTypesErrors, + GetV1TimeoffTypesResponses, + GetV1TimesheetsData, + GetV1TimesheetsErrors, + GetV1TimesheetsIdData, + GetV1TimesheetsIdErrors, + GetV1TimesheetsIdResponses, + GetV1TimesheetsResponses, + GetV1TravelLetterRequestsData, + GetV1TravelLetterRequestsErrors, + GetV1TravelLetterRequestsIdData, + GetV1TravelLetterRequestsIdErrors, + GetV1TravelLetterRequestsIdResponses, + GetV1TravelLetterRequestsResponses, + GetV1WdGphPayDetailData, + GetV1WdGphPayDetailDataData, + GetV1WdGphPayDetailDataErrors, + GetV1WdGphPayDetailDataResponses, + GetV1WdGphPayDetailErrors, + GetV1WdGphPayDetailResponses, + GetV1WdGphPayProcessingFeatureData, + GetV1WdGphPayProcessingFeatureErrors, + GetV1WdGphPayProcessingFeatureResponses, + GetV1WdGphPayProgressData, + GetV1WdGphPayProgressErrors, + GetV1WdGphPayProgressResponses, + GetV1WdGphPaySummaryData, + GetV1WdGphPaySummaryErrors, + GetV1WdGphPaySummaryResponses, + GetV1WdGphPayVarianceData, + GetV1WdGphPayVarianceErrors, + GetV1WdGphPayVarianceResponses, + GetV1WebhookEventsData, + GetV1WebhookEventsErrors, + GetV1WebhookEventsResponses, + GetV1WorkAuthorizationRequestsData, + GetV1WorkAuthorizationRequestsErrors, + GetV1WorkAuthorizationRequestsIdData, + GetV1WorkAuthorizationRequestsIdErrors, + GetV1WorkAuthorizationRequestsIdResponses, + GetV1WorkAuthorizationRequestsResponses, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PatchV1CompaniesCompanyId2Data, + PatchV1CompaniesCompanyId2Errors, + PatchV1CompaniesCompanyId2Responses, + PatchV1CompaniesCompanyIdData, + PatchV1CompaniesCompanyIdErrors, + PatchV1CompaniesCompanyIdResponses, + PatchV1ContractorInvoiceSchedulesId2Data, + PatchV1ContractorInvoiceSchedulesId2Errors, + PatchV1ContractorInvoiceSchedulesId2Responses, + PatchV1ContractorInvoiceSchedulesIdData, + PatchV1ContractorInvoiceSchedulesIdErrors, + PatchV1ContractorInvoiceSchedulesIdResponses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + PatchV1EmployeeTimeoffId2Data, + PatchV1EmployeeTimeoffId2Errors, + PatchV1EmployeeTimeoffId2Responses, + PatchV1EmployeeTimeoffIdData, + PatchV1EmployeeTimeoffIdErrors, + PatchV1EmployeeTimeoffIdResponses, + PatchV1EmploymentsEmploymentId2Data, + PatchV1EmploymentsEmploymentId2Errors, + PatchV1EmploymentsEmploymentId2Responses, + PatchV1EmploymentsEmploymentIdData, + PatchV1EmploymentsEmploymentIdErrors, + PatchV1EmploymentsEmploymentIdResponses, + PatchV1ExpensesId2Data, + PatchV1ExpensesId2Errors, + PatchV1ExpensesId2Responses, + PatchV1ExpensesIdData, + PatchV1ExpensesIdErrors, + PatchV1ExpensesIdResponses, + PatchV1IncentivesId2Data, + PatchV1IncentivesId2Errors, + PatchV1IncentivesId2Responses, + PatchV1IncentivesIdData, + PatchV1IncentivesIdErrors, + PatchV1IncentivesIdResponses, + PatchV1SandboxEmploymentsEmploymentId2Data, + PatchV1SandboxEmploymentsEmploymentId2Errors, + PatchV1SandboxEmploymentsEmploymentId2Responses, + PatchV1SandboxEmploymentsEmploymentIdData, + PatchV1SandboxEmploymentsEmploymentIdErrors, + PatchV1SandboxEmploymentsEmploymentIdResponses, + PatchV1TimeoffId2Data, + PatchV1TimeoffId2Errors, + PatchV1TimeoffId2Responses, + PatchV1TimeoffIdData, + PatchV1TimeoffIdErrors, + PatchV1TimeoffIdResponses, + PatchV1TravelLetterRequestsId2Data, + PatchV1TravelLetterRequestsId2Errors, + PatchV1TravelLetterRequestsId2Responses, + PatchV1TravelLetterRequestsIdData, + PatchV1TravelLetterRequestsIdErrors, + PatchV1TravelLetterRequestsIdResponses, + PatchV1WebhookCallbacksIdData, + PatchV1WebhookCallbacksIdErrors, + PatchV1WebhookCallbacksIdResponses, + PatchV1WorkAuthorizationRequestsId2Data, + PatchV1WorkAuthorizationRequestsId2Errors, + PatchV1WorkAuthorizationRequestsId2Responses, + PatchV1WorkAuthorizationRequestsIdData, + PatchV1WorkAuthorizationRequestsIdErrors, + PatchV1WorkAuthorizationRequestsIdResponses, + PatchV2EmploymentsEmploymentId2Data, + PatchV2EmploymentsEmploymentId2Errors, + PatchV2EmploymentsEmploymentId2Responses, + PatchV2EmploymentsEmploymentIdData, + PatchV2EmploymentsEmploymentIdErrors, + PatchV2EmploymentsEmploymentIdResponses, + PostAuthOauth2Token2Data, + PostAuthOauth2Token2Errors, + PostAuthOauth2Token2Responses, + PostAuthOauth2TokenData, + PostAuthOauth2TokenErrors, + PostAuthOauth2TokenResponses, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + PostV1BulkEmploymentJobsData, + PostV1BulkEmploymentJobsErrors, + PostV1BulkEmploymentJobsResponses, + PostV1CancelOnboardingEmploymentIdData, + PostV1CancelOnboardingEmploymentIdErrors, + PostV1CancelOnboardingEmploymentIdResponses, + PostV1CompaniesCompanyIdCreateTokenData, + PostV1CompaniesCompanyIdCreateTokenErrors, + PostV1CompaniesCompanyIdCreateTokenResponses, + PostV1CompaniesCompanyIdPricingPlansData, + PostV1CompaniesCompanyIdPricingPlansErrors, + PostV1CompaniesCompanyIdPricingPlansResponses, + PostV1CompaniesData, + PostV1CompaniesErrors, + PostV1CompaniesResponses, + PostV1CompanyDepartmentsData, + PostV1CompanyDepartmentsErrors, + PostV1CompanyDepartmentsResponses, + PostV1CompanyManagersData, + PostV1CompanyManagersErrors, + PostV1CompanyManagersResponses, + PostV1ContractAmendmentsAutomatableData, + PostV1ContractAmendmentsAutomatableErrors, + PostV1ContractAmendmentsAutomatableResponses, + PostV1ContractAmendmentsData, + PostV1ContractAmendmentsErrors, + PostV1ContractAmendmentsResponses, + PostV1ContractorInvoiceSchedulesData, + PostV1ContractorInvoiceSchedulesErrors, + PostV1ContractorInvoiceSchedulesResponses, + PostV1ContractorsEligibilityQuestionnaireData, + PostV1ContractorsEligibilityQuestionnaireErrors, + PostV1ContractorsEligibilityQuestionnaireResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses, + PostV1CostCalculatorEstimationCsvData, + PostV1CostCalculatorEstimationCsvErrors, + PostV1CostCalculatorEstimationCsvResponses, + PostV1CostCalculatorEstimationData, + PostV1CostCalculatorEstimationErrors, + PostV1CostCalculatorEstimationPdfData, + PostV1CostCalculatorEstimationPdfErrors, + PostV1CostCalculatorEstimationPdfResponses, + PostV1CostCalculatorEstimationResponses, + PostV1CurrencyConverterEffective2Data, + PostV1CurrencyConverterEffective2Errors, + PostV1CurrencyConverterEffective2Responses, + PostV1CurrencyConverterEffectiveData, + PostV1CurrencyConverterEffectiveErrors, + PostV1CurrencyConverterEffectiveResponses, + PostV1CurrencyConverterRawData, + PostV1CurrencyConverterRawErrors, + PostV1CurrencyConverterRawResponses, + PostV1CustomFieldsData, + PostV1CustomFieldsErrors, + PostV1CustomFieldsResponses, + PostV1DataSyncData, + PostV1DataSyncErrors, + PostV1DataSyncResponses, + PostV1DocumentsData, + PostV1DocumentsErrors, + PostV1DocumentsResponses, + PostV1EmployeeExpensesData, + PostV1EmployeeExpensesErrors, + PostV1EmployeeExpensesResponses, + PostV1EmployeeTimeoffData, + PostV1EmployeeTimeoffErrors, + PostV1EmployeeTimeoffIdCancelData, + PostV1EmployeeTimeoffIdCancelErrors, + PostV1EmployeeTimeoffIdCancelResponses, + PostV1EmployeeTimeoffResponses, + PostV1EmploymentsData, + PostV1EmploymentsEmploymentIdContractEligibilityData, + PostV1EmploymentsEmploymentIdContractEligibilityErrors, + PostV1EmploymentsEmploymentIdContractEligibilityResponses, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PostV1EmploymentsEmploymentIdInviteData, + PostV1EmploymentsEmploymentIdInviteErrors, + PostV1EmploymentsEmploymentIdInviteResponses, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses, + PostV1EmploymentsErrors, + PostV1EmploymentsResponses, + PostV1ExpensesData, + PostV1ExpensesErrors, + PostV1ExpensesResponses, + PostV1IdentityVerificationEmploymentIdDeclineData, + PostV1IdentityVerificationEmploymentIdDeclineErrors, + PostV1IdentityVerificationEmploymentIdDeclineResponses, + PostV1IdentityVerificationEmploymentIdVerifyData, + PostV1IdentityVerificationEmploymentIdVerifyErrors, + PostV1IdentityVerificationEmploymentIdVerifyResponses, + PostV1IncentivesData, + PostV1IncentivesErrors, + PostV1IncentivesRecurringData, + PostV1IncentivesRecurringErrors, + PostV1IncentivesRecurringResponses, + PostV1IncentivesResponses, + PostV1MagicLinkData, + PostV1MagicLinkErrors, + PostV1MagicLinkResponses, + PostV1OffboardingsData, + PostV1OffboardingsErrors, + PostV1OffboardingsResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses, + PostV1PayItemsBulkData, + PostV1PayItemsBulkErrors, + PostV1PayItemsBulkResponses, + PostV1ProbationCompletionLetterData, + PostV1ProbationCompletionLetterErrors, + PostV1ProbationCompletionLetterResponses, + PostV1ProbationExtensionsData, + PostV1ProbationExtensionsErrors, + PostV1ProbationExtensionsResponses, + PostV1ReadyData, + PostV1ReadyErrors, + PostV1ReadyResponses, + PostV1RiskReserveData, + PostV1RiskReserveErrors, + PostV1RiskReserveResponses, + PostV1SandboxBenefitRenewalRequestsData, + PostV1SandboxBenefitRenewalRequestsErrors, + PostV1SandboxBenefitRenewalRequestsResponses, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses, + PostV1SandboxCompaniesCompanyIdLegalEntitiesData, + PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors, + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses, + PostV1SandboxEmploymentsData, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses, + PostV1SandboxEmploymentsErrors, + PostV1SandboxEmploymentsResponses, + PostV1SandboxWebhookCallbacksTriggerData, + PostV1SandboxWebhookCallbacksTriggerErrors, + PostV1SandboxWebhookCallbacksTriggerResponses, + PostV1SdkTelemetryErrorsData, + PostV1SdkTelemetryErrorsErrors, + PostV1SdkTelemetryErrorsResponses, + PostV1SsoConfigurationData, + PostV1SsoConfigurationErrors, + PostV1SsoConfigurationResponses, + PostV1TimeoffData, + PostV1TimeoffErrors, + PostV1TimeoffResponses, + PostV1TimeoffTimeoffIdApproveData, + PostV1TimeoffTimeoffIdApproveErrors, + PostV1TimeoffTimeoffIdApproveResponses, + PostV1TimeoffTimeoffIdCancelData, + PostV1TimeoffTimeoffIdCancelErrors, + PostV1TimeoffTimeoffIdCancelRequestApproveData, + PostV1TimeoffTimeoffIdCancelRequestApproveErrors, + PostV1TimeoffTimeoffIdCancelRequestApproveResponses, + PostV1TimeoffTimeoffIdCancelRequestDeclineData, + PostV1TimeoffTimeoffIdCancelRequestDeclineErrors, + PostV1TimeoffTimeoffIdCancelRequestDeclineResponses, + PostV1TimeoffTimeoffIdCancelResponses, + PostV1TimeoffTimeoffIdDeclineData, + PostV1TimeoffTimeoffIdDeclineErrors, + PostV1TimeoffTimeoffIdDeclineResponses, + PostV1TimesheetsData, + PostV1TimesheetsErrors, + PostV1TimesheetsResponses, + PostV1TimesheetsTimesheetIdApproveData, + PostV1TimesheetsTimesheetIdApproveErrors, + PostV1TimesheetsTimesheetIdApproveResponses, + PostV1TimesheetsTimesheetIdSendBackData, + PostV1TimesheetsTimesheetIdSendBackErrors, + PostV1TimesheetsTimesheetIdSendBackResponses, + PostV1WebhookCallbacksData, + PostV1WebhookCallbacksErrors, + PostV1WebhookCallbacksResponses, + PostV1WebhookEventsReplayData, + PostV1WebhookEventsReplayErrors, + PostV1WebhookEventsReplayResponses, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + PutV1EmploymentsEmploymentIdBasicInformationData, + PutV1EmploymentsEmploymentIdBasicInformationErrors, + PutV1EmploymentsEmploymentIdBasicInformationResponses, + PutV1EmploymentsEmploymentIdBenefitOffersData, + PutV1EmploymentsEmploymentIdBenefitOffersErrors, + PutV1EmploymentsEmploymentIdBenefitOffersResponses, + PutV1EmploymentsEmploymentIdFederalTaxesData, + PutV1EmploymentsEmploymentIdFederalTaxesErrors, + PutV1EmploymentsEmploymentIdFederalTaxesResponses, + PutV1EmploymentsEmploymentIdPersonalDetailsData, + PutV1EmploymentsEmploymentIdPersonalDetailsErrors, + PutV1EmploymentsEmploymentIdPersonalDetailsResponses, + PutV1ResignationsOffboardingRequestIdValidateData, + PutV1ResignationsOffboardingRequestIdValidateErrors, + PutV1ResignationsOffboardingRequestIdValidateResponses, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses, + PutV2EmploymentsEmploymentIdAddressDetailsData, + PutV2EmploymentsEmploymentIdAddressDetailsErrors, + PutV2EmploymentsEmploymentIdAddressDetailsResponses, + PutV2EmploymentsEmploymentIdAdministrativeDetailsData, + PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors, + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses, + PutV2EmploymentsEmploymentIdBankAccountDetailsData, + PutV2EmploymentsEmploymentIdBankAccountDetailsErrors, + PutV2EmploymentsEmploymentIdBankAccountDetailsResponses, + PutV2EmploymentsEmploymentIdBasicInformationData, + PutV2EmploymentsEmploymentIdBasicInformationErrors, + PutV2EmploymentsEmploymentIdBasicInformationResponses, + PutV2EmploymentsEmploymentIdBillingAddressDetailsData, + PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors, + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses, + PutV2EmploymentsEmploymentIdContractDetailsData, + PutV2EmploymentsEmploymentIdContractDetailsErrors, + PutV2EmploymentsEmploymentIdContractDetailsResponses, + PutV2EmploymentsEmploymentIdEmergencyContactData, + PutV2EmploymentsEmploymentIdEmergencyContactErrors, + PutV2EmploymentsEmploymentIdEmergencyContactResponses, + PutV2EmploymentsEmploymentIdFederalTaxesData, + PutV2EmploymentsEmploymentIdFederalTaxesErrors, + PutV2EmploymentsEmploymentIdFederalTaxesResponses, + PutV2EmploymentsEmploymentIdPersonalDetailsData, + PutV2EmploymentsEmploymentIdPersonalDetailsErrors, + PutV2EmploymentsEmploymentIdPersonalDetailsResponses, + PutV2EmploymentsEmploymentIdPricingPlanDetailsData, + PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors, + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses, } from './types.gen'; export type Options< @@ -672,191 +780,212 @@ export type Options< }; /** - * List Offboarding + * Update administrative details + * + * Updates employment's administrative details. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * * - * Lists Offboarding requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getIndexOffboarding = ( - options?: Options, +export const putV2EmploymentsEmploymentIdAdministrativeDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdAdministrativeDetailsData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetIndexOffboardingResponses, - GetIndexOffboardingErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses, + PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/offboardings', + url: '/api/eor/v2/employments/{employment_id}/administrative_details', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create Offboarding - * - * Creates an Offboarding request. + * Get engagement agreement details * + * Returns the engagement agreement details for an employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage offboarding (`offboarding:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const postCreateOffboarding = ( - options?: Options, +export const getV1EmploymentsEmploymentIdEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => - (options?.client ?? client).post< - PostCreateOffboardingResponses, - PostCreateOffboardingErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/offboardings', + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details', ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, }); /** - * Show timesheet + * Upsert engagement agreement details + * + * Creates or updates the engagement agreement details for an employment. + * + * This endpoint requires country-specific data. The exact required fields will vary depending on + * which country the employment is in. To see the list of parameters for each country, see the + * **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that compliance requirements for each country are subject to change according to local laws. + * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended + * to avoid compliance issues and to have the latest version of a country's requirements. + * * - * Shows a timesheet by its ID. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getShowTimesheet = ( - options: Options, +export const postV1EmploymentsEmploymentIdEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetShowTimesheetResponses, - GetShowTimesheetErrors, + (options.client ?? client).post< + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets/{id}', + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Cancel onboarding - * - * Cancel onboarding. - * - * Requirements for the cancellation to succeed: - * - * * Employment has to be in `invited`, `created`, `created_awaiting_reserve`, `created_reserve_paid`, `pre_hire` status - * * Employee must not have signed the employment contract + * Convert currency using dynamic rates * + * Convert currency using the rates Remote applies during employment creation and invoicing. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage onboarding (`onboarding:write`) | + * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | * */ -export const postUpdateCancelOnboarding = < +export const postV1CurrencyConverterEffective2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).post< - PostUpdateCancelOnboardingResponses, - PostUpdateCancelOnboardingErrors, + PostV1CurrencyConverterEffective2Responses, + PostV1CurrencyConverterEffective2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cancel-onboarding/{employment_id}', + url: '/api/eor/v1/currency-converter', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show form schema + * List contractor subscriptions * - * Returns the json schema of the `contract_amendment` form for a specific employment. - * This endpoint requires a company access token, as forms are dependent on certain - * properties of companies and their current employments. + * Endpoint that can be used to list contractor subscriptions. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getShowContractAmendmentSchema = < +export const getV1ContractorsEmploymentsEmploymentIdContractorSubscriptions = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetShowContractAmendmentSchemaResponses, - GetShowContractAmendmentSchemaErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments/schema', + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-subscriptions', ...options, }); /** - * Bulk Create Pay Items - * - * Bulk creates pay items for employments. Supports up to 500 items per request. - * Integration-specific fields (shift code, currency, pay amount, etc.) go in the `meta` object. - * Only Global Payroll employments are supported. Non-GP employments are returned as `employment_not_global_payroll`. + * Convert currency using flat rates * + * Convert currency using FX rates used in Remoteā€™s estimation tools. + * These rates are not guaranteed to match final onboarding or contract rates. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | - | - | Manage pay items (`pay_item:write`) | + * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | * */ -export const postBulkCreatePayItems = ( - options: Options, +export const postV1CurrencyConverterRaw = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).post< - PostBulkCreatePayItemsResponses, - PostBulkCreatePayItemsErrors, + PostV1CurrencyConverterRawResponses, + PostV1CurrencyConverterRawErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/pay-items/bulk', + url: '/api/eor/v1/currency-converter/raw', ...options, headers: { 'Content-Type': 'application/json', @@ -865,48 +994,50 @@ export const postBulkCreatePayItems = ( }); /** - * Get latest data sync events + * List Incentives * - * Get the latest data sync events for each data type that have passed + * Lists all Incentives of a company + * + * ## Scopes * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * - * @deprecated */ -export const getIndexDataSync = ( - options?: Options, +export const getV1Incentives = ( + options: Options, ) => - (options?.client ?? client).get< - GetIndexDataSyncResponses, - GetIndexDataSyncErrors, + (options.client ?? client).get< + GetV1IncentivesResponses, + GetV1IncentivesErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/data-sync', - ...options, - }); + >({ url: '/api/eor/v1/incentives', ...options }); /** - * Create test data sync job + * Create Incentive * - * Create Test Data Synchronization job that will sync test data to the database from production - * The job will be handled asynchronously and the response will be a 202 status code. + * Creates an Incentive. * - * **Heads up:** This endpoint is only available for specific usecases and should not be used for general data sync needs, - * if you need to request access to this endpoint, please contact the api-support@remote.com. + * Incentives use the currency of the employment specified provided in the `employment_id` field. * * - * @deprecated + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * */ -export const postCreateDataSync = ( - options: Options, +export const postV1Incentives = ( + options: Options, ) => (options.client ?? client).post< - PostCreateDataSyncResponses, - PostCreateDataSyncErrors, + PostV1IncentivesResponses, + PostV1IncentivesErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/data-sync', + url: '/api/eor/v1/incentives', ...options, headers: { 'Content-Type': 'application/json', @@ -915,67 +1046,44 @@ export const postCreateDataSync = ( }); /** - * List pricing plans + * List Benefit Offers By Employment * - * List all pricing plans for a company. - * Currently the endpoint only returns the pricing plans for the EOR monthly product and the contractor products (Standard, Plus and COR). + * List benefit offers by employment. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const getIndexCompanyPricingPlan = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1BenefitOffers = ( + options: Options, ) => (options.client ?? client).get< - GetIndexCompanyPricingPlanResponses, - GetIndexCompanyPricingPlanErrors, + GetV1BenefitOffersResponses, + GetV1BenefitOffersErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/pricing-plans', - ...options, - }); + >({ url: '/api/eor/v1/benefit-offers', ...options }); /** - * Create a pricing plan for a company - * - * Create a pricing plan for a company, in order to do that we have 2 ways: - * - * 1. Create a pricing plan from a partner template - * 2. Create a pricing plan from a product price - * - * The pricing plan is always created in the company's desired currency. - * - * - * ## Scopes + * Complete onboarding * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage companies (`company_management`) | - | Manage pricing plans (`pricing_plan:write`) | + * Completes the employee onboarding. When all tasks are completed, the employee is marked as in `review` status * + * @deprecated */ -export const postCreateCompanyPricingPlan = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1Ready = ( + options: Options, ) => (options.client ?? client).post< - PostCreateCompanyPricingPlanResponses, - PostCreateCompanyPricingPlanErrors, + PostV1ReadyResponses, + PostV1ReadyErrors, ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}/pricing-plans', + url: '/api/eor/v1/ready', ...options, headers: { 'Content-Type': 'application/json', @@ -984,92 +1092,72 @@ export const postCreateCompanyPricingPlan = < }); /** - * Show probation completion letter - * - * Show a single probation completion letter. - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | - * + * Creates a cost estimation of employments */ -export const getShowProbationCompletionLetter = < +export const postV1CostCalculatorEstimation = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetShowProbationCompletionLetterResponses, - GetShowProbationCompletionLetterErrors, + (options.client ?? client).post< + PostV1CostCalculatorEstimationResponses, + PostV1CostCalculatorEstimationErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-completion-letter/{id}', + url: '/api/eor/v1/cost-calculator/estimation', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show Contractor Invoice + * List Recurring Incentive + * + * List all Recurring Incentives of a company. * - * Shows a single Contractor Invoice record. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * */ -export const getShowContractorInvoice = ( - options: Options, +export const getV1IncentivesRecurring = ( + options: Options, ) => (options.client ?? client).get< - GetShowContractorInvoiceResponses, - GetShowContractorInvoiceErrors, + GetV1IncentivesRecurringResponses, + GetV1IncentivesRecurringErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoices/{id}', - ...options, - }); + >({ url: '/api/eor/v1/incentives/recurring', ...options }); /** - * Convert currency using flat rates + * Create Recurring Incentive + * + * Create a Recurring Incentive, that is, a monthly paid incentive. + * + * Incentives use the currency of the employment specified provided in the `employment_id` field. * - * Convert currency using FX rates used in Remoteā€™s estimation tools. - * These rates are not guaranteed to match final onboarding or contract rates. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const postConvertRawCurrencyConverter = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1IncentivesRecurring = ( + options: Options, ) => (options.client ?? client).post< - PostConvertRawCurrencyConverterResponses, - PostConvertRawCurrencyConverterErrors, + PostV1IncentivesRecurringResponses, + PostV1IncentivesRecurringErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/currency-converter/raw', + url: '/api/eor/v1/incentives/recurring', ...options, headers: { 'Content-Type': 'application/json', @@ -1078,283 +1166,192 @@ export const postConvertRawCurrencyConverter = < }); /** - * Show contractor contract details + * List timesheets * - * Returns the contract details JSON Schema for contractors given a country + * Lists all timesheets. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | * */ -export const getShowContractorContractDetailsCountry = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1Timesheets = ( + options?: Options, ) => - (options.client ?? client).get< - GetShowContractorContractDetailsCountryResponses, - GetShowContractorContractDetailsCountryErrors, + (options?.client ?? client).get< + GetV1TimesheetsResponses, + GetV1TimesheetsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/contractor-contract-details', - ...options, - }); + >({ url: '/api/eor/v1/timesheets', ...options }); /** - * List employments - * - * Lists all employments, except for the deleted ones. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * Create timesheet * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * Creates a new timesheet. * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * ## Scopes * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | * */ -export const getIndexEmployment = ( - options: Options, +export const postV1Timesheets = ( + options?: Options, ) => - (options.client ?? client).get< - GetIndexEmploymentResponses, - GetIndexEmploymentErrors, + (options?.client ?? client).post< + PostV1TimesheetsResponses, + PostV1TimesheetsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employments', - ...options, - }); - -/** - * Create employment - * - * Creates an employment. We support creating employees and contractors. - * - * ## Global Payroll Employees - * - * To create a Global Payroll employee, pass `global_payroll_employee` as the `type` parameter, - * and provide the slug of the specific legal entity that the employee will be engaged by and billed to as the `engaged_by_entity_slug` parameter. - * - * ## HRIS Employees - * - * To create a HRIS employee, pass `hris` as the `type` parameter. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | - * - */ -export const postCreateEmployment2 = ( - options: Options, -) => - (options.client ?? client).post< - PostCreateEmployment2Responses, - PostCreateEmployment2Errors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments', + url: '/api/eor/v1/timesheets', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Get Onboarding Reserves Status for Employment - * - * Returns the onboarding reserves status for a specific employment. - * - * The status is the same as the credit risk status but takes the onboarding reserves policies into account. + * Approve timesheet * + * Approves the given timesheet. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | * */ -export const getShowCompanyEmploymentOnboardingReservesStatus = < +export const postV1TimesheetsTimesheetIdApprove = < ThrowOnError extends boolean = false, >( - options: Options< - GetShowCompanyEmploymentOnboardingReservesStatusData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetShowCompanyEmploymentOnboardingReservesStatusResponses, - GetShowCompanyEmploymentOnboardingReservesStatusErrors, + (options.client ?? client).post< + PostV1TimesheetsTimesheetIdApproveResponses, + PostV1TimesheetsTimesheetIdApproveErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status', - ...options, - }); + >({ url: '/api/eor/v1/timesheets/{timesheet_id}/approve', ...options }); /** - * Get Help Center Article - * - * Get a help center article by its ID + * Get latest data sync events * - * ## Scopes + * Get the latest data sync events for each data type that have passed * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View help articles (`help_center_article:read`) | - | * + * @deprecated */ -export const getShowHelpCenterArticle = ( - options: Options, +export const getV1DataSync = ( + options?: Options, ) => - (options.client ?? client).get< - GetShowHelpCenterArticleResponses, - GetShowHelpCenterArticleErrors, + (options?.client ?? client).get< + GetV1DataSyncResponses, + GetV1DataSyncErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/help-center-articles/{id}', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/data-sync', ...options, }); /** - * Get user by ID via SCIM v2.0 + * Create test data sync job * - * Retrieves a single user for the authenticated company by user ID + * Create Test Data Synchronization job that will sync test data to the database from production + * The job will be handled asynchronously and the response will be a 202 status code. + * + * **Heads up:** This endpoint is only available for specific usecases and should not be used for general data sync needs, + * if you need to request access to this endpoint, please contact the api-support@remote.com. + * + * + * @deprecated */ -export const getGetUserScim = ( - options: Options, +export const postV1DataSync = ( + options: Options, ) => - (options.client ?? client).get< - GetGetUserScimResponses, - GetGetUserScimErrors, + (options.client ?? client).post< + PostV1DataSyncResponses, + PostV1DataSyncErrors, ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Users/{id}', + url: '/api/eor/v1/data-sync', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Download a document for the employee + * Show probation completion letter + * + * Show a single probation completion letter. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | * */ -export const getShowEmployeeDocument = ( - options: Options, +export const getV1ProbationCompletionLetterId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetShowEmployeeDocumentResponses, - GetShowEmployeeDocumentErrors, + GetV1ProbationCompletionLetterIdResponses, + GetV1ProbationCompletionLetterIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/documents/{id}', - ...options, - }); + >({ url: '/api/eor/v1/probation-completion-letter/{id}', ...options }); /** - * List Contractor Invoices + * Show the current SSO Configuration * - * Lists Contractor Invoice records. + * Shows the current SSO Configuration for the company. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage company resources (`company_admin`) | View SSO configuration (`sso_configuration:read`) | Manage SSO (`sso_configuration:write`) | * */ -export const getIndexContractorInvoice = ( - options?: Options, +export const getV1SsoConfiguration = ( + options?: Options, ) => (options?.client ?? client).get< - GetIndexContractorInvoiceResponses, - GetIndexContractorInvoiceErrors, + GetV1SsoConfigurationResponses, + GetV1SsoConfigurationErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoices', - ...options, - }); + >({ url: '/api/eor/v1/sso-configuration', ...options }); /** - * Report SDK errors + * Create the SSO Configuration * - * Receives error telemetry from the frontend SDK. - * Errors are logged to observability backend for monitoring and debugging. + * Creates the SSO Configuration for the company. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | * */ -export const postReportErrorsTelemetry = ( - options: Options, +export const postV1SsoConfiguration = ( + options: Options, ) => (options.client ?? client).post< - PostReportErrorsTelemetryResponses, - PostReportErrorsTelemetryErrors, + PostV1SsoConfigurationResponses, + PostV1SsoConfigurationErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sdk/telemetry-errors', + url: '/api/eor/v1/sso-configuration', ...options, headers: { 'Content-Type': 'application/json', @@ -1363,126 +1360,135 @@ export const postReportErrorsTelemetry = ( }); /** - * Show the SSO Configuration Details + * List Offboarding * - * Shows the SSO Configuration details for the company. + * Lists Offboarding requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | + * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | * */ -export const getDetailsSsoConfiguration = < - ThrowOnError extends boolean = false, ->( - options?: Options, +export const getV1Offboardings = ( + options?: Options, ) => (options?.client ?? client).get< - GetDetailsSsoConfigurationResponses, - GetDetailsSsoConfigurationErrors, + GetV1OffboardingsResponses, + GetV1OffboardingsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sso-configuration/details', - ...options, - }); + >({ url: '/api/eor/v1/offboardings', ...options }); /** - * Creates a cost estimation of employments + * Create Offboarding + * + * Creates an Offboarding request. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage offboarding (`offboarding:write`) | + * */ -export const postCreateEstimation = ( - options: Options, +export const postV1Offboardings = ( + options?: Options, ) => - (options.client ?? client).post< - PostCreateEstimationResponses, - PostCreateEstimationErrors, + (options?.client ?? client).post< + PostV1OffboardingsResponses, + PostV1OffboardingsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/estimation', + url: '/api/eor/v1/offboardings', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Show form schema + * Create a contract document for a contractor * - * Returns the json schema of the requested company form. - * Currently only supports the `address_details` form. + * Create a contract document for a contractor. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const getShowCompanySchema = ( - options: Options, +export const postV1ContractorsEmploymentsEmploymentIdContractDocuments = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetShowCompanySchemaResponses, - GetShowCompanySchemaErrors, + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/schema', + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Get employment benefit offers + * Update federal taxes + * + * Updates employment's federal taxes. + * + * Requirements to update federal taxes successfully: + * * Employment should be Global Payroll + * * Employment should be in the post-enrollment state + * * Employment should belong to USA + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * + * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getIndexBenefitOffer = ( - options: Options, -) => - (options.client ?? client).get< - GetIndexBenefitOfferResponses, - GetIndexBenefitOfferErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/benefit-offers', - ...options, - }); - -/** - * Upserts employment benefit offers - */ -export const putUpdateBenefitOffer = ( - options: Options, +export const putV1EmploymentsEmploymentIdFederalTaxes = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).put< - PutUpdateBenefitOfferResponses, - PutUpdateBenefitOfferErrors, + PutV1EmploymentsEmploymentIdFederalTaxesResponses, + PutV1EmploymentsEmploymentIdFederalTaxesErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employments/{employment_id}/benefit-offers', + url: '/api/eor/v1/employments/{employment_id}/federal-taxes', ...options, headers: { 'Content-Type': 'application/json', @@ -1491,219 +1497,205 @@ export const putUpdateBenefitOffer = ( }); /** - * Get Employment Profile + * List pricing plans * - * Gets necessary information to perform the identity verification of an employee. + * List all pricing plans for a company. + * Currently the endpoint only returns the pricing plans for the EOR monthly product and the contractor products (Standard, Plus and COR). * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View identity verification (`identity_verification:read`) | Manage identity verification (`identity_verification:write`) | + * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | * */ -export const getGetIdentityVerificationDataIdentityVerification = < +export const getV1CompaniesCompanyIdPricingPlans = < ThrowOnError extends boolean = false, >( - options: Options< - GetGetIdentityVerificationDataIdentityVerificationData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).get< - GetGetIdentityVerificationDataIdentityVerificationResponses, - GetGetIdentityVerificationDataIdentityVerificationErrors, + GetV1CompaniesCompanyIdPricingPlansResponses, + GetV1CompaniesCompanyIdPricingPlansErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity-verification/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/companies/{company_id}/pricing-plans', ...options }); /** - * List contractor subscriptions + * Create a pricing plan for a company * - * Endpoint that can be used to list contractor subscriptions. + * Create a pricing plan for a company, in order to do that we have 2 ways: + * + * 1. Create a pricing plan from a partner template + * 2. Create a pricing plan from a product price + * + * The pricing plan is always created in the company's desired currency. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage companies (`company_management`) | - | Manage pricing plans (`pricing_plan:write`) | * */ -export const getIndexSubscription = ( - options: Options, +export const postV1CompaniesCompanyIdPricingPlans = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).get< - GetIndexSubscriptionResponses, - GetIndexSubscriptionErrors, + (options.client ?? client).post< + PostV1CompaniesCompanyIdPricingPlansResponses, + PostV1CompaniesCompanyIdPricingPlansErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-subscriptions', + url: '/api/eor/v1/companies/{company_id}/pricing-plans', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Webhook Events + * Update federal taxes * - * List all webhook events + * Updates employment's federal taxes. * - * ## Scopes + * Requirements to update federal taxes successfully: + * * Employment should be Global Payroll + * * Employment should be in the post-enrollment state + * * Employment should belong to USA * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * - */ -export const getIndexWebhookEvent = ( - options?: Options, -) => - (options?.client ?? client).get< - GetIndexWebhookEventResponses, - GetIndexWebhookEventErrors, - ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/webhook-events', - ...options, - }); - -/** - * Pass KYB + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. * - * Pass KYB and credit risk for a company without the intervention of a Remote admin. + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * - */ -export const postBypassEligibilityChecksCompany = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).post< - PostBypassEligibilityChecksCompanyResponses, - PostBypassEligibilityChecksCompanyErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/companies/{company_id}/bypass-eligibility-checks', - ...options, - }); - -/** - * Approve risk reserve proof of payment + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. * - * Approves a risk reserve proof of payment without the intervention of a Remote admin. * - * Triggers an `employment.cor_hiring.proof_of_payment_accepted` webhook event. * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postApproveRiskReserveProofOfPayment = < +export const putV2EmploymentsEmploymentIdFederalTaxes = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostApproveRiskReserveProofOfPaymentResponses, - PostApproveRiskReserveProofOfPaymentErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdFederalTaxesResponses, + PutV2EmploymentsEmploymentIdFederalTaxesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve', + url: '/api/eor/v2/employments/{employment_id}/federal-taxes', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Get a mock JSON Schema + * List travel letter requests + * + * List travel letter requests. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | - | View travel letters (`travel_letter:read`) | - | * - * Get a mock JSON Schema for testing purposes */ -export const getShowTestSchema = ( - options?: Options, +export const getV1TravelLetterRequests = ( + options?: Options, ) => (options?.client ?? client).get< - GetShowTestSchemaResponses, - unknown, + GetV1TravelLetterRequestsResponses, + GetV1TravelLetterRequestsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/test-schema', - ...options, - }); + >({ url: '/api/eor/v1/travel-letter-requests', ...options }); /** - * List all holidays of a country + * Get engagement agreement details * - * List all holidays of a country for a specific year. Optionally, it can be filtered by country subdivision. + * Returns the engagement agreement details for an employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getIndexHoliday = ( - options: Options, +export const getV2EmploymentsEmploymentIdEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetIndexHolidayResponses, - GetIndexHolidayErrors, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/holidays/{year}', + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details', ...options, }); /** - * Cancel Time Off + * Upsert engagement agreement details + * + * Creates or updates the engagement agreement details for an employment. + * + * This endpoint requires country-specific data. The exact required fields will vary depending on + * which country the employment is in. To see the list of parameters for each country, see the + * **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that compliance requirements for each country are subject to change according to local laws. + * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended + * to avoid compliance issues and to have the latest version of a country's requirements. + * * - * Cancel a time off request that was already approved. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postCreateCancellation = ( - options: Options, +export const postV2EmploymentsEmploymentIdEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostCreateCancellationResponses, - PostCreateCancellationErrors, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/cancel', + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details', ...options, headers: { 'Content-Type': 'application/json', @@ -1712,144 +1704,135 @@ export const postCreateCancellation = ( }); /** - * Show employment job - * - * Shows an employment job details. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * Payroll processing summary API resource * + * API to retrieve summary data for processing pay groups */ -export const getIndexEmploymentJob = ( - options: Options, +export const getV1WdGphPaySummary = ( + options?: Options, ) => - (options.client ?? client).get< - GetIndexEmploymentJobResponses, - GetIndexEmploymentJobErrors, + (options?.client ?? client).get< + GetV1WdGphPaySummaryResponses, + GetV1WdGphPaySummaryErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/job', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/paySummary', ...options, }); /** - * List pricing plan partner templates + * Show employment job * - * List all pricing plan partner templates. + * Shows an employment job details. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getIndexPricingPlanPartnerTemplate = < +export const getV1EmploymentsEmploymentIdJob = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options, ) => - (options?.client ?? client).get< - GetIndexPricingPlanPartnerTemplateResponses, - GetIndexPricingPlanPartnerTemplateErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdJobResponses, + GetV1EmploymentsEmploymentIdJobErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/pricing-plan-partner-templates', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}/job', ...options }); /** - * List EOR Payroll Calendar + * Create bulk employment job * - * List all active payroll calendars for EOR. + * Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getIndexEorPayrollCalendar = < - ThrowOnError extends boolean = false, ->( - options?: Options, +export const postV1BulkEmploymentJobs = ( + options?: Options, ) => - (options?.client ?? client).get< - GetIndexEorPayrollCalendarResponses, - GetIndexEorPayrollCalendarErrors, + (options?.client ?? client).post< + PostV1BulkEmploymentJobsResponses, + PostV1BulkEmploymentJobsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/payroll-calendars', + url: '/api/eor/v1/bulk-employment-jobs', ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, }); /** - * Update Time Off as Employee + * List Contract Amendment * - * Updates a Time Off record as Employee + * List Contract Amendment requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | * */ -export const patchUpdateEmployeeTimeoff2 = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1ContractAmendments = ( + options: Options, ) => - (options.client ?? client).patch< - PatchUpdateEmployeeTimeoff2Responses, - PatchUpdateEmployeeTimeoff2Errors, + (options.client ?? client).get< + GetV1ContractAmendmentsResponses, + GetV1ContractAmendmentsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/contract-amendments', ...options }); /** - * Update Time Off as Employee + * Create Contract Amendment + * + * Creates a Contract Amendment request. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * * - * Updates a Time Off record as Employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | * */ -export const patchUpdateEmployeeTimeoff = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1ContractAmendments = ( + options: Options, ) => - (options.client ?? client).put< - PatchUpdateEmployeeTimeoffResponses, - PatchUpdateEmployeeTimeoffErrors, + (options.client ?? client).post< + PostV1ContractAmendmentsResponses, + PostV1ContractAmendmentsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff/{id}', + url: '/api/eor/v1/contract-amendments', ...options, headers: { 'Content-Type': 'application/json', @@ -1858,95 +1841,91 @@ export const patchUpdateEmployeeTimeoff = < }); /** - * List Recurring Incentive + * Delete a Recurring Incentive * - * List all Recurring Incentives of a company. + * Delete a Recurring Incentive, that is, a monthly paid incentive. + * + * Internally, Remote schedules upcoming incentives. As such, when you attempt to + * delete a recurring incentive, Remote will **ONLY** delete scheduled incentives + * with the `pending` status. + * + * Incentives payments that are already scheduled and cannot be deleted will be + * included in the response, in case you need to reference them. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const getIndexRecurringIncentive = < +export const deleteV1IncentivesRecurringId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetIndexRecurringIncentiveResponses, - GetIndexRecurringIncentiveErrors, + (options.client ?? client).delete< + DeleteV1IncentivesRecurringIdResponses, + DeleteV1IncentivesRecurringIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/recurring', - ...options, - }); + >({ url: '/api/eor/v1/incentives/recurring/{id}', ...options }); /** - * Create Recurring Incentive - * - * Create a Recurring Incentive, that is, a monthly paid incentive. - * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * Show Benefit Renewal Request * + * Show Benefit Renewal Request details. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | * */ -export const postCreateRecurringIncentive = < +export const getV1BenefitRenewalRequestsBenefitRenewalRequestId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostCreateRecurringIncentiveResponses, - PostCreateRecurringIncentiveErrors, + (options.client ?? client).get< + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/recurring', + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Creates a Benefit Renewal Request + * Updates a Benefit Renewal Request Response * - * Creates a Benefit Renewal Request for a specific Benefit Group. - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * Updates a Benefit Renewal Request with the given response. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) | * */ -export const postCreateBenefitRenewalRequest = < +export const postV1BenefitRenewalRequestsBenefitRenewalRequestId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostCreateBenefitRenewalRequestResponses, - PostCreateBenefitRenewalRequestErrors, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/benefit-renewal-requests', + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -1955,176 +1934,153 @@ export const postCreateBenefitRenewalRequest = < }); /** - * Return a base64 encoded version of the contract document + * List all holidays of a country + * + * List all holidays of a country for a specific year. Optionally, it can be filtered by country subdivision. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | * */ -export const getShowContractDocument = ( - options: Options, +export const getV1CountriesCountryCodeHolidaysYear = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetShowContractDocumentResponses, - GetShowContractDocumentErrors, + GetV1CountriesCountryCodeHolidaysYearResponses, + GetV1CountriesCountryCodeHolidaysYearErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contract-documents/{id}', + url: '/api/eor/v1/countries/{country_code}/holidays/{year}', ...options, }); /** - * List contract documents for an employment + * List custom field value for an employment * - * Only contractor employment types are supported. Lists contract documents for a specific employment with pagination, filtering by status, and sorted by updated_at descending (latest first). + * Returns a list of custom field values for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | * */ -export const getIndexEmploymentContractDocument = < +export const getV1EmploymentsEmploymentIdCustomFields = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetIndexEmploymentContractDocumentResponses, - GetIndexEmploymentContractDocumentErrors, + GetV1EmploymentsEmploymentIdCustomFieldsResponses, + GetV1EmploymentsEmploymentIdCustomFieldsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/contract-documents', + url: '/api/eor/v1/employments/{employment_id}/custom-fields', ...options, }); /** - * List expenses + * Show timesheet * - * Lists all expenses records + * Shows a timesheet by its ID. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | * */ -export const getIndexExpense = ( - options: Options, +export const getV1TimesheetsId = ( + options: Options, ) => (options.client ?? client).get< - GetIndexExpenseResponses, - GetIndexExpenseErrors, + GetV1TimesheetsIdResponses, + GetV1TimesheetsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses', - ...options, - }); + >({ url: '/api/eor/v1/timesheets/{id}', ...options }); /** - * Create expense + * List Company Managers + * + * List all company managers of an integration. If filtered by the company_id param, + * it lists only company managers belonging to the specified company. * - * Creates an **approved** expense * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | + * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | * */ -export const postCreateExpense = ( - options: Options, +export const getV1CompanyManagers = ( + options: Options, ) => - (options.client ?? client).post< - PostCreateExpenseResponses, - PostCreateExpenseErrors, + (options.client ?? client).get< + GetV1CompanyManagersResponses, + GetV1CompanyManagersErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/company-managers', ...options }); /** - * Show the current SSO Configuration + * Create and invite a Company Manager * - * Shows the current SSO Configuration for the company. + * Create a Company Manager and sends the invitation email for signing in to the Remote Platform. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View SSO configuration (`sso_configuration:read`) | Manage SSO (`sso_configuration:write`) | + * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | * */ -export const getShowSsoConfiguration = ( - options?: Options, +export const postV1CompanyManagers = ( + options: Options, ) => - (options?.client ?? client).get< - GetShowSsoConfigurationResponses, - GetShowSsoConfigurationErrors, + (options.client ?? client).post< + PostV1CompanyManagersResponses, + PostV1CompanyManagersErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sso-configuration', + url: '/api/eor/v1/company-managers', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create the SSO Configuration + * Bulk Create Pay Items + * + * Bulk creates pay items for employments. Supports up to 500 items per request. + * Integration-specific fields (shift code, currency, pay amount, etc.) go in the `meta` object. + * Only Global Payroll employments are supported. Non-GP employments are returned as `employment_not_global_payroll`. * - * Creates the SSO Configuration for the company. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | + * | Manage payroll runs (`payroll`) | - | Manage pay items (`pay_item:write`) | * */ -export const postCreateSsoConfiguration = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1PayItemsBulk = ( + options: Options, ) => (options.client ?? client).post< - PostCreateSsoConfigurationResponses, - PostCreateSsoConfigurationErrors, + PostV1PayItemsBulkResponses, + PostV1PayItemsBulkErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sso-configuration', + url: '/api/eor/v1/pay-items/bulk', ...options, headers: { 'Content-Type': 'application/json', @@ -2133,90 +2089,81 @@ export const postCreateSsoConfiguration = < }); /** - * Approve Contract Amendment + * Show travel letter request * - * Approves a contract amendment request without the intervention of a Remote admin. - * Approvals done via this endpoint are effective immediately, - * regardless of the effective date entered on the contract amendment creation. + * Show a single travel letter request. * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | - | View travel letters (`travel_letter:read`) | - | * */ -export const putApproveContractAmendment = < +export const getV1TravelLetterRequestsId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).put< - PutApproveContractAmendmentResponses, - PutApproveContractAmendmentErrors, + (options.client ?? client).get< + GetV1TravelLetterRequestsIdResponses, + GetV1TravelLetterRequestsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve', - ...options, - }); + >({ url: '/api/eor/v1/travel-letter-requests/{id}', ...options }); /** - * List all currencies for the contractor - * - * The currencies are listed in the following order: - * 1. billing currency of the company - * 2. currencies of contractorā€™s existing withdrawal methods - * 3. currency of the contractorā€™s country - * 4. the rest, alphabetical. + * Updates a travel letter request * + * Updates a travel letter request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | - | - | Manage travel letters (`travel_letter:write`) | * */ -export const getIndexContractorCurrency = < +export const patchV1TravelLetterRequestsId2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetIndexContractorCurrencyResponses, - GetIndexContractorCurrencyErrors, + (options.client ?? client).patch< + PatchV1TravelLetterRequestsId2Responses, + PatchV1TravelLetterRequestsId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-currencies', + url: '/api/eor/v1/travel-letter-requests/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Replay Webhook Events + * Updates a travel letter request * - * Replay webhook events + * Updates a travel letter request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * | - | - | Manage travel letters (`travel_letter:write`) | * */ -export const postReplayWebhookEvent = ( - options: Options, +export const patchV1TravelLetterRequestsId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).post< - PostReplayWebhookEventResponses, - PostReplayWebhookEventErrors, + (options.client ?? client).put< + PatchV1TravelLetterRequestsIdResponses, + PatchV1TravelLetterRequestsIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/webhook-events/replay', + url: '/api/eor/v1/travel-letter-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2225,225 +2172,149 @@ export const postReplayWebhookEvent = ( }); /** - * Create a contractor of record (COR) termination request - * - * Initiates a termination request for a Contractor of Record employment. - * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. - * Currently, only Contractor of Record employments can be terminated. - * + * Pass KYB * - * ## Scopes + * Pass KYB and credit risk for a company without the intervention of a Remote admin. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const postCreateCorTerminationRequestSubscription = < +export const postV1SandboxCompaniesCompanyIdBypassEligibilityChecks = < ThrowOnError extends boolean = false, >( options: Options< - PostCreateCorTerminationRequestSubscriptionData, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData, ThrowOnError >, ) => (options.client ?? client).post< - PostCreateCorTerminationRequestSubscriptionResponses, - PostCreateCorTerminationRequestSubscriptionErrors, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests', + url: '/api/eor/v1/sandbox/companies/{company_id}/bypass-eligibility-checks', ...options, }); /** - * Show Background Check + * List Employee Leave Policies * - * Show Background Check details for a given employment and background check request. + * List the leave policies for the current employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View background checks (`background_check:read`) | - | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getShowBackgroundCheck = ( - options: Options, +export const getV1EmployeeLeavePolicies = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => - (options.client ?? client).get< - GetShowBackgroundCheckResponses, - GetShowBackgroundCheckErrors, + (options?.client ?? client).get< + GetV1EmployeeLeavePoliciesResponses, + GetV1EmployeeLeavePoliciesErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employments/{employment_id}/background-checks/{background_check_id}', - ...options, - }); + >({ url: '/api/eor/v1/employee/leave-policies', ...options }); /** - * Show benefit renewal request schema - * - * Returns the json schema of the `benefit_renewal_request` form for a specific request. - * This endpoint requires a company access token, as forms are dependent on certain - * properties of companies and their current employments. + * List Webhook Callbacks * + * List callbacks for a given company * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | * */ -export const getSchemaBenefitRenewalRequest = < +export const getV1CompaniesCompanyIdWebhookCallbacks = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetSchemaBenefitRenewalRequestResponses, - GetSchemaBenefitRenewalRequestErrors, + GetV1CompaniesCompanyIdWebhookCallbacksResponses, + GetV1CompaniesCompanyIdWebhookCallbacksErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema', + url: '/api/eor/v1/companies/{company_id}/webhook-callbacks', ...options, }); /** - * Magic links generator - * - * Generates a magic link for a passwordless authentication. - * To create a magic link for a company admin, you need to provide the `user_id` parameter. - * To create a magic link for an employee, you need to provide the `employment_id` parameter. + * Download a billing document PDF * + * Downloads a billing document PDF * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Create magic links (`magic_link:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const postGenerateMagicLink = ( - options: Options, +export const getV1BillingDocumentsBillingDocumentIdPdf = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).post< - PostGenerateMagicLinkResponses, - PostGenerateMagicLinkErrors, + (options.client ?? client).get< + GetV1BillingDocumentsBillingDocumentIdPdfResponses, + GetV1BillingDocumentsBillingDocumentIdPdfErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/magic-link', + url: '/api/eor/v1/billing-documents/{billing_document_id}/pdf', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Delete a Recurring Incentive - * - * Delete a Recurring Incentive, that is, a monthly paid incentive. - * - * Internally, Remote schedules upcoming incentives. As such, when you attempt to - * delete a recurring incentive, Remote will **ONLY** delete scheduled incentives - * with the `pending` status. - * - * Incentives payments that are already scheduled and cannot be deleted will be - * included in the response, in case you need to reference them. + * Delete a Webhook Callback * + * Delete a callback previously registered for webhooks * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * */ -export const deleteDeleteRecurringIncentive = < +export const deleteV1WebhookCallbacksId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).delete< - DeleteDeleteRecurringIncentiveResponses, - DeleteDeleteRecurringIncentiveErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/recurring/{id}', - ...options, - }); - -/** - * List Incentives - * - * Lists all Incentives of a company - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | - * - */ -export const getIndexIncentive = ( - options: Options, -) => - (options.client ?? client).get< - GetIndexIncentiveResponses, - GetIndexIncentiveErrors, + DeleteV1WebhookCallbacksIdResponses, + DeleteV1WebhookCallbacksIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives', - ...options, - }); + >({ url: '/api/eor/v1/webhook-callbacks/{id}', ...options }); /** - * Create Incentive - * - * Creates an Incentive. - * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * Update a Webhook Callback * + * Update a callback previously registered for webhooks * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * */ -export const postCreateIncentive = ( - options: Options, +export const patchV1WebhookCallbacksId = ( + options: Options, ) => - (options.client ?? client).post< - PostCreateIncentiveResponses, - PostCreateIncentiveErrors, + (options.client ?? client).patch< + PatchV1WebhookCallbacksIdResponses, + PatchV1WebhookCallbacksIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives', + url: '/api/eor/v1/webhook-callbacks/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2452,96 +2323,84 @@ export const postCreateIncentive = ( }); /** - * Create probation completion letter + * List countries + * + * Returns a list of all countries that are supported by Remote API alphabetically ordered. + * The supported list accounts for creating employment with basic information and it does not imply fully onboarding employment via JSON Schema. + * The countries present in the list are the ones where creating a company is allowed. * - * Create a new probation completion letter request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | + * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | * */ -export const postCreateProbationCompletionLetter = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1Countries = ( + options: Options, ) => - (options.client ?? client).post< - PostCreateProbationCompletionLetterResponses, - PostCreateProbationCompletionLetterErrors, + (options.client ?? client).get< + GetV1CountriesResponses, + GetV1CountriesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-completion-letter', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/countries', ...options }); /** - * Show Contractor Invoice Schedule + * Show contractor eligibility and COR-supported countries for legal entity + * + * Returns which contractor products (standard, plus, cor) the legal entity is eligible to use, + * and the list of country codes where COR is supported for this legal entity. + * COR-supported countries exclude sanctioned and signup-prevented countries and apply entity rules (same-country, local-to-local). + * When the legal entity is not COR-eligible, `cor_supported_country_codes` is an empty list. * - * Shows a single Contractor Invoice Schedule record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getShowScheduledContractorInvoice = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetShowScheduledContractorInvoiceResponses, - GetShowScheduledContractorInvoiceErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules/{id}', - ...options, - }); +export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibility = + ( + options: Options< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility', + ...options, + }); /** - * Updates Contractor Invoice Schedule + * Convert currency using dynamic rates * - * Updates a contractor invoice schedule record + * Convert currency using the rates Remote applies during employment creation and invoicing. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | + * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | * */ -export const patchUpdateScheduledContractorInvoice2 = < +export const postV1CurrencyConverterEffective = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).patch< - PatchUpdateScheduledContractorInvoice2Responses, - PatchUpdateScheduledContractorInvoice2Errors, + (options.client ?? client).post< + PostV1CurrencyConverterEffectiveResponses, + PostV1CurrencyConverterEffectiveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules/{id}', + url: '/api/eor/v1/currency-converter/effective', ...options, headers: { 'Content-Type': 'application/json', @@ -2550,188 +2409,124 @@ export const patchUpdateScheduledContractorInvoice2 = < }); /** - * Updates Contractor Invoice Schedule + * Show personal information for the authenticated employee * - * Updates a contractor invoice schedule record + * Returns personal information for the authenticated employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | + * | Manage employments (`employments`) | View personal details (`personal_detail:read`) | - | * */ -export const patchUpdateScheduledContractorInvoice = < +export const getV1EmployeePersonalInformation = < ThrowOnError extends boolean = false, >( - options: Options, + options?: Options, ) => - (options.client ?? client).put< - PatchUpdateScheduledContractorInvoiceResponses, - PatchUpdateScheduledContractorInvoiceErrors, + (options?.client ?? client).get< + GetV1EmployeePersonalInformationResponses, + GetV1EmployeePersonalInformationErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/employee/personal-information', ...options }); /** - * Show Billing Document - * - * Shows a billing document details. - * - * Please contact api-support@remote.com to request access to this endpoint. - * - * - * ## Scopes + * Show form schema * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * Returns the json schema of a supported form. Possible form names are: + * ``` + * - address_details + * - administrative_details + * - bank_account_details + * - employment_basic_information + * - contractor_basic_information + * - contractor_contract_details + * - billing_address_details + * - contract_details + * - emergency_contact + * - emergency_contact_details + * - employment_document_details + * - personal_details + * - pricing_plan_details + * - company_basic_information + * - global_payroll_administrative_details + * - global_payroll_basic_information + * - global_payroll_contract_details + * - global_payroll_federal_taxes + * - global_payroll_personal_details + * - benefit_renewal_request + * - hris_personal_details * - */ -export const getShowBillingDocument = ( - options: Options, -) => - (options.client ?? client).get< - GetShowBillingDocumentResponses, - GetShowBillingDocumentErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents/{billing_document_id}', - ...options, - }); - -/** - * Creates PDF cost estimation of employments + * ``` + * + * Most forms require a company access token, as they are dependent on certain + * properties of companies and their current employments. However, the `address_details` + * and `company_basic_information` forms can be accessed using client_credentials + * authentication (without a company). * - * Creates a PDF cost estimation of employments based on the provided parameters. - */ -export const postCreateEstimationPdf = ( - options?: Options, -) => - (options?.client ?? client).post< - PostCreateEstimationPdfResponses, - PostCreateEstimationPdfErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/estimation-pdf', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, - }); - -/** - * Show work authorization request * - * Show a single work authorization request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const getShowWorkAuthorizationRequest = < +export const getV1CountriesCountryCodeForm = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetShowWorkAuthorizationRequestResponses, - GetShowWorkAuthorizationRequestErrors, + GetV1CountriesCountryCodeFormResponses, + GetV1CountriesCountryCodeFormErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests/{id}', - ...options, - }); + >({ url: '/api/eor/v1/countries/{country_code}/{form}', ...options }); /** - * Update work authorization request + * List Time Off * - * Updates a work authorization request. + * Lists all Time Off records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const patchUpdateWorkAuthorizationRequest2 = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1Timeoff = ( + options: Options, ) => - (options.client ?? client).patch< - PatchUpdateWorkAuthorizationRequest2Responses, - PatchUpdateWorkAuthorizationRequest2Errors, + (options.client ?? client).get< + GetV1TimeoffResponses, + GetV1TimeoffErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/timeoff', ...options }); /** - * Update work authorization request + * Create Time Off * - * Updates a work authorization request. + * Creates a Time Off record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const patchUpdateWorkAuthorizationRequest = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1Timeoff = ( + options: Options, ) => - (options.client ?? client).put< - PatchUpdateWorkAuthorizationRequestResponses, - PatchUpdateWorkAuthorizationRequestErrors, + (options.client ?? client).post< + PostV1TimeoffResponses, + PostV1TimeoffErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests/{id}', + url: '/api/eor/v1/timeoff', ...options, headers: { 'Content-Type': 'application/json', @@ -2740,70 +2535,20 @@ export const patchUpdateWorkAuthorizationRequest = < }); /** - * Create Probation Extension - * - * Create a probation extension request. - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | + * List countries for Cost Calculator * + * Lists active and processing countries */ -export const postCreateProbationExtension = < +export const getV1CostCalculatorCountries = < ThrowOnError extends boolean = false, >( - options: Options, -) => - (options.client ?? client).post< - PostCreateProbationExtensionResponses, - PostCreateProbationExtensionErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-extensions', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); - -/** - * Create risk reserve - * - * Create a new risk reserve - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | - * - */ -export const postCreateRiskReserve = ( - options: Options, + options?: Options, ) => - (options.client ?? client).post< - PostCreateRiskReserveResponses, - PostCreateRiskReserveErrors, + (options?.client ?? client).get< + GetV1CostCalculatorCountriesResponses, + unknown, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/risk-reserve', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/cost-calculator/countries', ...options }); /** * Submit risk reserve proof of payment @@ -2820,22 +2565,21 @@ export const postCreateRiskReserve = ( * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | * */ -export const postSubmitRiskReserveProofOfPayment = < +export const postV1EmploymentsEmploymentIdRiskReserveProofOfPayments = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostSubmitRiskReserveProofOfPaymentResponses, - PostSubmitRiskReserveProofOfPaymentErrors, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors, ThrowOnError >({ ...formDataBodySerializer, - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/risk-reserve-proof-of-payments', + url: '/api/eor/v1/employments/{employment_id}/risk-reserve-proof-of-payments', ...options, headers: { 'Content-Type': null, @@ -2844,309 +2588,221 @@ export const postSubmitRiskReserveProofOfPayment = < }); /** - * Get Company Compliance Profile - * - * Returns the KYB and credit risk status for the company's default legal entity. + * Show Background Check * + * Show Background Check details for a given employment and background check request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage employments (`employments`) | View background checks (`background_check:read`) | - | * */ -export const getShowCompanyComplianceProfile = < +export const getV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetShowCompanyComplianceProfileResponses, - GetShowCompanyComplianceProfileErrors, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/compliance-profile', + url: '/api/eor/v1/employments/{employment_id}/background-checks/{background_check_id}', ...options, }); /** - * Show product prices in the company's desired currency + * Show Time Off Balance * - * list product prices in the company's desired currency. - * the endpoint currently only returns the product prices for the EOR monthly product and the contractor products (Standard, Plus and COR). - * the product prices are then used to create a pricing plan for the company. + * Shows the time off balance for the given employment_id. + * + * Deprecated since February 2025 in favour of **[List Leave Policies Summary](#tag/Leave-Policies/operation/get_index_leave_policies_summary)** endpoint. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * + * + * @deprecated */ -export const getIndexCompanyProductPrice = < +export const getV1TimeoffBalancesEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetIndexCompanyProductPriceResponses, - GetIndexCompanyProductPriceErrors, + GetV1TimeoffBalancesEmploymentIdResponses, + GetV1TimeoffBalancesEmploymentIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}/product-prices', - ...options, - }); + >({ url: '/api/eor/v1/timeoff-balances/{employment_id}', ...options }); /** - * Show a company - * - * Given an ID, shows a company. - * - * If the used access token was issued by the OAuth 2.0 Authorization Code flow, - * then only the associated company can be accessed through the endpoint. + * List expenses for the authenticated employee * + * Returns a paginated list of expenses belonging to the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const getShowCompany = ( - options: Options, +export const getV1EmployeeExpenses = ( + options?: Options, ) => - (options.client ?? client).get< - GetShowCompanyResponses, - GetShowCompanyErrors, + (options?.client ?? client).get< + GetV1EmployeeExpensesResponses, + GetV1EmployeeExpensesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}', - ...options, - }); + >({ url: '/api/eor/v1/employee/expenses', ...options }); /** - * Update a company - * - * Given an ID and a request object with new information, updates a company. - * - * ### Getting a company and its owner to `active` status - * If you created a company using the - * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required - * request body parameters, you can use this endpoint to provide the missing data. Once the company - * and its owner have all the necessary data, both their statuses will be set to `active` and the company - * onboarding will be marked as "completed". - * - * The following constitutes a company with "all the necessary data": - * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the - * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters - * are required). - * * Company `tax_number` or `registration_number` is not nil - * * Company `name` is not nil (already required when creating the company) - * * Company has a `desired_currency` in their bank account (already required when creating the company) - * * Company has accepted terms of service (already required when creating the company) + * Create an expense for the authenticated employee * + * Creates a new expense record for the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const patchUpdateCompany2 = ( - options: Options, +export const postV1EmployeeExpenses = ( + options?: Options, ) => - (options.client ?? client).patch< - PatchUpdateCompany2Responses, - PatchUpdateCompany2Errors, + (options?.client ?? client).post< + PostV1EmployeeExpensesResponses, + PostV1EmployeeExpensesErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}', + url: '/api/eor/v1/employee/expenses', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Update a company - * - * Given an ID and a request object with new information, updates a company. - * - * ### Getting a company and its owner to `active` status - * If you created a company using the - * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required - * request body parameters, you can use this endpoint to provide the missing data. Once the company - * and its owner have all the necessary data, both their statuses will be set to `active` and the company - * onboarding will be marked as "completed". - * - * The following constitutes a company with "all the necessary data": - * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the - * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters - * are required). - * * Company `tax_number` or `registration_number` is not nil - * * Company `name` is not nil (already required when creating the company) - * * Company has a `desired_currency` in their bank account (already required when creating the company) - * * Company has accepted terms of service (already required when creating the company) + * Download a resignation letter * + * Downloads a resignation letter from an employment request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage employment documents (`employment_documents`) | View resignation letters (`resignation_letter:read`) | - | * */ -export const patchUpdateCompany = ( - options: Options, +export const getV1ResignationsOffboardingRequestIdResignationLetter = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1ResignationsOffboardingRequestIdResignationLetterData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PatchUpdateCompanyResponses, - PatchUpdateCompanyErrors, + (options.client ?? client).get< + GetV1ResignationsOffboardingRequestIdResignationLetterResponses, + GetV1ResignationsOffboardingRequestIdResignationLetterErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}', + url: '/api/eor/v1/resignations/{offboarding_request_id}/resignation-letter', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Download a resignation letter + * Deletes a Company Manager user * - * Downloads a resignation letter from an employment request. + * Deletes a Company Manager user * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View resignation letters (`resignation_letter:read`) | - | + * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | * */ -export const getDownloadResignationLetter = < +export const deleteV1CompanyManagersUserId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetDownloadResignationLetterResponses, - GetDownloadResignationLetterErrors, + (options.client ?? client).delete< + DeleteV1CompanyManagersUserIdResponses, + DeleteV1CompanyManagersUserIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/resignations/{offboarding_request_id}/resignation-letter', - ...options, - }); + >({ url: '/api/eor/v1/company-managers/{user_id}', ...options }); /** - * Update federal taxes + * Show company manager user * - * Updates employment's federal taxes. + * Shows a single company manager user * - * Requirements to update federal taxes successfully: - * * Employment should be Global Payroll - * * Employment should be in the post-enrollment state - * * Employment should belong to USA - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * - * - * - * ## Scopes + * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | * */ -export const putUpdateEmploymentFederalTaxes = < +export const getV1CompanyManagersUserId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).put< - PutUpdateEmploymentFederalTaxesResponses, - PutUpdateEmploymentFederalTaxesErrors, + (options.client ?? client).get< + GetV1CompanyManagersUserIdResponses, + GetV1CompanyManagersUserIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/federal-taxes', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/company-managers/{user_id}', ...options }); /** - * List Contract Amendment + * Show onboarding steps for an employment * - * List Contract Amendment requests. + * Returns onboarding steps and substeps in a hierarchical, ordered structure. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getIndexContractAmendment = ( - options: Options, +export const getV1EmploymentsEmploymentIdOnboardingSteps = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentsEmploymentIdOnboardingStepsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetIndexContractAmendmentResponses, - GetIndexContractAmendmentErrors, + GetV1EmploymentsEmploymentIdOnboardingStepsResponses, + GetV1EmploymentsEmploymentIdOnboardingStepsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments', + url: '/api/eor/v1/employments/{employment_id}/onboarding-steps', ...options, }); /** - * Create Contract Amendment + * Automatable Contract Amendment * - * Creates a Contract Amendment request. + * Check if a contract amendment request is automatable. + * If the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract + * and send them an updated document. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -3173,21 +2829,17 @@ export const getIndexContractAmendment = ( * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | * */ -export const postCreateContractAmendment = < +export const postV1ContractAmendmentsAutomatable = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).post< - PostCreateContractAmendmentResponses, - PostCreateContractAmendmentErrors, + PostV1ContractAmendmentsAutomatableResponses, + PostV1ContractAmendmentsAutomatableErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments', + url: '/api/eor/v1/contract-amendments/automatable', ...options, headers: { 'Content-Type': 'application/json', @@ -3196,11 +2848,9 @@ export const postCreateContractAmendment = < }); /** - * Show Company Payroll Runs - * - * Given an ID, shows a payroll run. - * `employee_details` field is deprecated in favour of the `employee_details` endpoint and will be removed in the future. + * List Company Payroll Runs * + * Lists all payroll runs for a company * * ## Scopes * @@ -3209,112 +2859,59 @@ export const postCreateContractAmendment = < * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | * */ -export const getShowPayrollRun = ( - options: Options, -) => - (options.client ?? client).get< - GetShowPayrollRunResponses, - GetShowPayrollRunErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-runs/{payroll_run_id}', - ...options, - }); - -/** - * Download a receipt - * - * Downloads an expense receipt. - * - * Deprecated since late February 2024 in favour of **[Download a receipt by id](#tag/Expenses/operation/get_download_by_id_expense_receipt)** endpoint. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | - * - * - * @deprecated - */ -export const getDownloadExpenseReceipt = ( - options: Options, +export const getV1PayrollRuns = ( + options?: Options, ) => - (options.client ?? client).get< - GetDownloadExpenseReceiptResponses, - GetDownloadExpenseReceiptErrors, + (options?.client ?? client).get< + GetV1PayrollRunsResponses, + GetV1PayrollRunsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{expense_id}/receipt', - ...options, - }); + >({ url: '/api/eor/v1/payroll-runs', ...options }); /** - * Show travel letter request + * List incentives for the authenticated employee * - * Show a single travel letter request. + * Returns all incentives for the authenticated employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | - | View travel letters (`travel_letter:read`) | - | + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * */ -export const getShowTravelLetterRequest = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeeIncentives = ( + options?: Options, ) => - (options.client ?? client).get< - GetShowTravelLetterRequestResponses, - GetShowTravelLetterRequestErrors, + (options?.client ?? client).get< + GetV1EmployeeIncentivesResponses, + GetV1EmployeeIncentivesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests/{id}', - ...options, - }); + >({ url: '/api/eor/v1/employee/incentives', ...options }); /** - * Updates a travel letter request + * Update employment * - * Updates a travel letter request + * Updates an employment. Use this endpoint to: + * - modify employment states for testing + * - Backdate employment start dates * - * ## Scopes + * This endpoint will respond with a 404 outside of the Sandbox environment. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | - | - | Manage travel letters (`travel_letter:write`) | + * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). * */ -export const patchUpdateTravelLetterRequest2 = < +export const patchV1SandboxEmploymentsEmploymentId2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).patch< - PatchUpdateTravelLetterRequest2Responses, - PatchUpdateTravelLetterRequest2Errors, + PatchV1SandboxEmploymentsEmploymentId2Responses, + PatchV1SandboxEmploymentsEmploymentId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests/{id}', + url: '/api/eor/v1/sandbox/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -3323,32 +2920,28 @@ export const patchUpdateTravelLetterRequest2 = < }); /** - * Updates a travel letter request + * Update employment * - * Updates a travel letter request + * Updates an employment. Use this endpoint to: + * - modify employment states for testing + * - Backdate employment start dates * - * ## Scopes + * This endpoint will respond with a 404 outside of the Sandbox environment. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | - | - | Manage travel letters (`travel_letter:write`) | + * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). * */ -export const patchUpdateTravelLetterRequest = < +export const patchV1SandboxEmploymentsEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).put< - PatchUpdateTravelLetterRequestResponses, - PatchUpdateTravelLetterRequestErrors, + PatchV1SandboxEmploymentsEmploymentIdResponses, + PatchV1SandboxEmploymentsEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests/{id}', + url: '/api/eor/v1/sandbox/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -3357,44 +2950,41 @@ export const patchUpdateTravelLetterRequest = < }); /** - * Show Time Off Balance - * - * Shows the time off balance for the given employment_id. + * Show benefit renewal request schema * - * Deprecated since February 2025 in favour of **[List Leave Policies Summary](#tag/Leave-Policies/operation/get_index_leave_policies_summary)** endpoint. + * Returns the json schema of the `benefit_renewal_request` form for a specific request. + * This endpoint requires a company access token, as forms are dependent on certain + * properties of companies and their current employments. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | - * + * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | * - * @deprecated */ -export const getShowTimeoffBalance = ( - options: Options, +export const getV1BenefitRenewalRequestsBenefitRenewalRequestIdSchema = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetShowTimeoffBalanceResponses, - GetShowTimeoffBalanceErrors, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff-balances/{employment_id}', + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema', ...options, }); /** - * Update basic information - * - * Updates employment's basic information. + * Update billing address details * - * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. + * Updates employment's billing address details. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -3410,7 +3000,7 @@ export const getShowTimeoffBalance = ( * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * * * @@ -3421,21 +3011,20 @@ export const getShowTimeoffBalance = ( * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const putUpdateEmploymentBasicInformation = < +export const putV2EmploymentsEmploymentIdBillingAddressDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PutV2EmploymentsEmploymentIdBillingAddressDetailsData, + ThrowOnError + >, ) => (options.client ?? client).put< - PutUpdateEmploymentBasicInformationResponses, - PutUpdateEmploymentBasicInformationErrors, + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses, + PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/basic_information', + url: '/api/eor/v2/employments/{employment_id}/billing_address_details', ...options, headers: { 'Content-Type': 'application/json', @@ -3444,227 +3033,224 @@ export const putUpdateEmploymentBasicInformation = < }); /** - * List expense categories + * Delete an Incentive + * + * Delete an incentive. + * + * `one_time` incentives that have the following status **CANNOT** be deleted: + * * `processing` + * * `paid` + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * - * Lists the effective hierarchy of expense categories. Either employment_id or expense_id (or both) must be provided. */ -export const getCategoriesExpense = ( - options?: Options, +export const deleteV1IncentivesId = ( + options: Options, ) => - (options?.client ?? client).get< - GetCategoriesExpenseResponses, - GetCategoriesExpenseErrors, + (options.client ?? client).delete< + DeleteV1IncentivesIdResponses, + DeleteV1IncentivesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/categories', - ...options, - }); + >({ url: '/api/eor/v1/incentives/{id}', ...options }); /** - * Cancel Time Off as Employee + * Show Incentive * - * Cancels a Time Off record as Employee + * Show an Incentive's details * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * */ -export const postCancelEmployeeTimeoff = ( - options: Options, +export const getV1IncentivesId = ( + options: Options, ) => - (options.client ?? client).post< - PostCancelEmployeeTimeoffResponses, - PostCancelEmployeeTimeoffErrors, + (options.client ?? client).get< + GetV1IncentivesIdResponses, + GetV1IncentivesIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff/{id}/cancel', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/incentives/{id}', ...options }); /** - * Show form schema - * - * Returns the json schema of a supported form. Possible form names are: - * ``` - * - address_details - * - administrative_details - * - bank_account_details - * - employment_basic_information - * - contractor_basic_information - * - contractor_contract_details - * - billing_address_details - * - contract_details - * - emergency_contact - * - emergency_contact_details - * - employment_document_details - * - personal_details - * - pricing_plan_details - * - company_basic_information - * - global_payroll_administrative_details - * - global_payroll_basic_information - * - global_payroll_contract_details - * - global_payroll_federal_taxes - * - global_payroll_personal_details - * - benefit_renewal_request - * - hris_personal_details + * Update Incentive * - * ``` + * Updates an Incentive. * - * Most forms require a company access token, as they are dependent on certain - * properties of companies and their current employments. However, the `address_details` - * and `company_basic_information` forms can be accessed using client_credentials - * authentication (without a company). + * Incentives use the currency of the employment specified provided in the `employment_id` field. * + * The API doesn't support updating paid incentives. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const getShowFormCountry = ( - options: Options, +export const patchV1IncentivesId2 = ( + options: Options, ) => - (options.client ?? client).get< - GetShowFormCountryResponses, - GetShowFormCountryErrors, + (options.client ?? client).patch< + PatchV1IncentivesId2Responses, + PatchV1IncentivesId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/{form}', + url: '/api/eor/v1/incentives/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Download file + * Update Incentive * - * Downloads a file. + * Updates an Incentive. + * + * Incentives use the currency of the employment specified provided in the `employment_id` field. + * + * The API doesn't support updating paid incentives. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const getShowFile = ( - options: Options, +export const patchV1IncentivesId = ( + options: Options, ) => - (options.client ?? client).get< - GetShowFileResponses, - GetShowFileErrors, + (options.client ?? client).put< + PatchV1IncentivesIdResponses, + PatchV1IncentivesIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/files/{id}', + url: '/api/eor/v1/incentives/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show Contract Amendment + * Show Legal Entity Administrative details + * + * Show administrative details of legal entity for the authorized company specified in the request. * - * Show a single Contract Amendment request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getShowContractAmendment = ( - options: Options, -) => - (options.client ?? client).get< - GetShowContractAmendmentResponses, - GetShowContractAmendmentErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments/{id}', - ...options, - }); +export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails = + ( + options: Options< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + ...options, + }); /** - * List Company Managers + * Update Legal Entity Administrative details * - * List all company managers of an integration. If filtered by the company_id param, - * it lists only company managers belonging to the specified company. + * Update administrative details of legal entity for the authorized company specified in the request. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | * */ -export const getIndexCompanyManager = ( - options: Options, -) => - (options.client ?? client).get< - GetIndexCompanyManagerResponses, - GetIndexCompanyManagerErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers', - ...options, - }); +export const putV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails = + ( + options: Options< + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + ThrowOnError + >, + ) => + (options.client ?? client).put< + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); /** - * Create and invite a Company Manager + * Update bank account details + * + * Updates employment's bank account details. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * * - * Create a Company Manager and sends the invitation email for signing in to the Remote Platform. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postCreateCompanyManager = ( - options: Options, +export const putV2EmploymentsEmploymentIdBankAccountDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdBankAccountDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostCreateCompanyManagerResponses, - PostCreateCompanyManagerErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdBankAccountDetailsResponses, + PutV2EmploymentsEmploymentIdBankAccountDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers', + url: '/api/eor/v2/employments/{employment_id}/bank_account_details', ...options, headers: { 'Content-Type': 'application/json', @@ -3673,64 +3259,73 @@ export const postCreateCompanyManager = ( }); /** - * List countries for Cost Calculator + * List Contractor Invoices + * + * Lists Contractor Invoice records. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * - * Lists active and processing countries */ -export const getIndexCountry = ( - options?: Options, +export const getV1ContractorInvoices = ( + options?: Options, ) => (options?.client ?? client).get< - GetIndexCountryResponses, - unknown, + GetV1ContractorInvoicesResponses, + GetV1ContractorInvoicesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/countries', - ...options, - }); + >({ url: '/api/eor/v1/contractor-invoices', ...options }); /** - * Decline Identity Verification + * List expense categories * - * Declines the identity verification of an employee. + * Lists the effective hierarchy of expense categories. At least one of employment_id, expense_id, or country_code must be provided. + */ +export const getV1ExpensesCategories = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1ExpensesCategoriesResponses, + GetV1ExpensesCategoriesErrors, + ThrowOnError + >({ url: '/api/eor/v1/expenses/categories', ...options }); + +/** + * List contract documents for an employment * + * Only contractor employment types are supported. Lists contract documents for a specific employment with pagination, filtering by status, and sorted by updated_at descending (latest first). * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const postDeclineIdentityVerification = < +export const getV1EmploymentsEmploymentIdContractDocuments = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1EmploymentsEmploymentIdContractDocumentsData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostDeclineIdentityVerificationResponses, - PostDeclineIdentityVerificationErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdContractDocumentsResponses, + GetV1EmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity-verification/{employment_id}/decline', + url: '/api/eor/v1/employments/{employment_id}/contract-documents', ...options, }); /** - * Show engagement agreement details - * - * Returns the engagement agreement details JSON Schema for a country. Only DEU country is supported for now. + * Show contractor contract details * + * Returns the contract details JSON Schema for contractors given a country * * ## Scopes * @@ -3739,109 +3334,134 @@ export const postDeclineIdentityVerification = < * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const getShowEngagementAgreementDetailsCountry = < +export const getV1CountriesCountryCodeContractorContractDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1CountriesCountryCodeContractorContractDetailsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetShowEngagementAgreementDetailsCountryResponses, - GetShowEngagementAgreementDetailsCountryErrors, + GetV1CountriesCountryCodeContractorContractDetailsResponses, + GetV1CountriesCountryCodeContractorContractDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/engagement-agreement-details', + url: '/api/eor/v1/countries/{country_code}/contractor-contract-details', ...options, }); /** - * List Billing Documents - * - * List billing documents for a company - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * Get user by ID via SCIM v2.0 * + * Retrieves a single user for the authenticated company by user ID */ -export const getIndexBillingDocument = ( - options: Options, +export const getV1ScimV2UsersId = ( + options: Options, ) => (options.client ?? client).get< - GetIndexBillingDocumentResponses, - GetIndexBillingDocumentErrors, + GetV1ScimV2UsersIdResponses, + GetV1ScimV2UsersIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Users/{id}', ...options, }); /** - * Delete a Webhook Callback + * List employment files + * + * Lists files associated with a specific employment. + * + * Supports filtering by file type and sub_type. * - * Delete a callback previously registered for webhooks * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const deleteDeleteWebhookCallback = < +export const getV1EmploymentsEmploymentIdFiles = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).delete< - DeleteDeleteWebhookCallbackResponses, - DeleteDeleteWebhookCallbackErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdFilesResponses, + GetV1EmploymentsEmploymentIdFilesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/webhook-callbacks/{id}', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}/files', ...options }); /** - * Update a Webhook Callback + * Manage contractor plus subscription + * + * Endpoint that can be used to upgrade, assign or downgrade a contractor's subscription. + * This can be used when company admins desire to assign someone to the Contractor Plus plan, + * but also to change the contractor's subscription between Plus and Standard. * - * Update a callback previously registered for webhooks * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * + */ +export const postV1ContractorsEmploymentsEmploymentIdContractorPlusSubscription = + ( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-plus-subscription', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Submit eligibility questionnaire + * + * Submits an eligibility questionnaire for a contractor employment. + * + * The questionnaire determines if the contractor is eligible for certain products or features. + * The responses are validated against the JSON schema for the questionnaire type. + * + * **Requirements:** + * - Employment must be of type `contractor` + * - Employment must be in `created` status + * - Responses must conform to the questionnaire JSON schema + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const patchUpdateWebhookCallback = < +export const postV1ContractorsEligibilityQuestionnaire = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).patch< - PatchUpdateWebhookCallbackResponses, - PatchUpdateWebhookCallbackErrors, + (options.client ?? client).post< + PostV1ContractorsEligibilityQuestionnaireResponses, + PostV1ContractorsEligibilityQuestionnaireErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/webhook-callbacks/{id}', + url: '/api/eor/v1/contractors/eligibility-questionnaire', ...options, headers: { 'Content-Type': 'application/json', @@ -3850,9 +3470,11 @@ export const patchUpdateWebhookCallback = < }); /** - * Update personal details + * Update basic information * - * Updates employment's personal details. + * Updates employment's basic information. + * + * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -3879,21 +3501,20 @@ export const patchUpdateWebhookCallback = < * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const putUpdateEmploymentPersonalDetails = < +export const putV1EmploymentsEmploymentIdBasicInformation = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PutV1EmploymentsEmploymentIdBasicInformationData, + ThrowOnError + >, ) => (options.client ?? client).put< - PutUpdateEmploymentPersonalDetailsResponses, - PutUpdateEmploymentPersonalDetailsErrors, + PutV1EmploymentsEmploymentIdBasicInformationResponses, + PutV1EmploymentsEmploymentIdBasicInformationErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/personal_details', + url: '/api/eor/v1/employments/{employment_id}/basic_information', ...options, headers: { 'Content-Type': 'application/json', @@ -3902,90 +3523,153 @@ export const putUpdateEmploymentPersonalDetails = < }); /** - * List travel letter requests + * Show a contractor of record (COR) termination request + * + * Retrieves a Contractor of Record termination request by ID. * - * List travel letter requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | - | View travel letters (`travel_letter:read`) | - | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * + */ +export const getV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestId = + ( + options: Options< + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}', + ...options, + }); + +/** + * Create a legal entity + * + * Create a new legal entity for a company in a given country, with KYB automatically passed. + * + * The entity is created with active status and can be set as the company's default + * using the reassign default entity endpoint. + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const getIndexTravelLetterRequest = < +export const postV1SandboxCompaniesCompanyIdLegalEntities = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options< + PostV1SandboxCompaniesCompanyIdLegalEntitiesData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetIndexTravelLetterRequestResponses, - GetIndexTravelLetterRequestErrors, + (options.client ?? client).post< + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses, + PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests', + url: '/api/eor/v1/sandbox/companies/{company_id}/legal-entities', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Benefit Renewal Requests + * Payroll processing details data API resource + * + * API to retrieve the run details of a pay group + */ +export const getV1WdGphPayDetailData = ( + options: Options, +) => + (options.client ?? client).get< + GetV1WdGphPayDetailDataResponses, + GetV1WdGphPayDetailDataErrors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payDetailData', + ...options, + }); + +/** + * Show region fields + * + * Returns required fields JSON Schema for a given region. These are required in order to calculate + * the cost of employment for the region. These fields are based on employer contributions that are associated + * with the region or any of it's parent regions. + */ +export const getV1CostCalculatorRegionsSlugFields = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1CostCalculatorRegionsSlugFieldsResponses, + GetV1CostCalculatorRegionsSlugFieldsErrors, + ThrowOnError + >({ url: '/api/eor/v1/cost-calculator/regions/{slug}/fields', ...options }); + +/** + * Cancel onboarding + * + * Cancel onboarding. + * + * Requirements for the cancellation to succeed: + * + * * Employment has to be in `invited`, `created`, `created_awaiting_reserve`, `created_reserve_paid`, `pre_hire` status + * * Employee must not have signed the employment contract * - * List Benefit Renewal Requests for each country. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage employments (`employments`) | - | Manage onboarding (`onboarding:write`) | * */ -export const getIndexBenefitRenewalRequest = < +export const postV1CancelOnboardingEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetIndexBenefitRenewalRequestResponses, - GetIndexBenefitRenewalRequestErrors, + (options.client ?? client).post< + PostV1CancelOnboardingEmploymentIdResponses, + PostV1CancelOnboardingEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests', - ...options, - }); + >({ url: '/api/eor/v1/cancel-onboarding/{employment_id}', ...options }); /** - * Create a Webhook Callback + * Cancel Time Off as Employee * - * Register a callback to be used for webhooks + * Cancels a Time Off record as Employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postCreateWebhookCallback = ( - options: Options, +export const postV1EmployeeTimeoffIdCancel = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).post< - PostCreateWebhookCallbackResponses, - PostCreateWebhookCallbackErrors, + PostV1EmployeeTimeoffIdCancelResponses, + PostV1EmployeeTimeoffIdCancelErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/webhook-callbacks', + url: '/api/eor/v1/employee/timeoff/{id}/cancel', ...options, headers: { 'Content-Type': 'application/json', @@ -3994,68 +3678,61 @@ export const postCreateWebhookCallback = ( }); /** - * Approve timesheet + * Download a receipt + * + * Downloads an expense receipt. + * + * Deprecated since late February 2024 in favour of **[Download a receipt by id](#tag/Expenses/operation/get_download_by_id_expense_receipt)** endpoint. * - * Approves the given timesheet. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * * + * @deprecated */ -export const postApproveTimesheet = ( - options: Options, +export const getV1ExpensesExpenseIdReceipt = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).post< - PostApproveTimesheetResponses, - PostApproveTimesheetErrors, + (options.client ?? client).get< + GetV1ExpensesExpenseIdReceiptResponses, + GetV1ExpensesExpenseIdReceiptErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets/{timesheet_id}/approve', - ...options, - }); + >({ url: '/api/eor/v1/expenses/{expense_id}/receipt', ...options }); /** - * Show payslip - * - * Given an ID, shows a payslip. + * List Benefit Offers * - * Please contact api-support@remote.com to request access to this endpoint. + * List benefit offers for each country. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const getShowPayslip = ( - options: Options, +export const getV1BenefitOffersCountrySummaries = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetShowPayslipResponses, - GetShowPayslipErrors, + GetV1BenefitOffersCountrySummariesResponses, + GetV1BenefitOffersCountrySummariesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payslips/{id}', - ...options, - }); + >({ url: '/api/eor/v1/benefit-offers/country-summaries', ...options }); /** - * List Leave Policies Summary + * List Leave Policies Details * - * List all the data related to time off for a given employment + * Describe the leave policies (custom or not) for a given employment * * ## Scopes * @@ -4064,80 +3741,170 @@ export const getShowPayslip = ( * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getIndexLeavePoliciesSummary = < +export const getV1LeavePoliciesDetailsEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetIndexLeavePoliciesSummaryResponses, - GetIndexLeavePoliciesSummaryErrors, + GetV1LeavePoliciesDetailsEmploymentIdResponses, + GetV1LeavePoliciesDetailsEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/leave-policies/summary/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/leave-policies/details/{employment_id}', ...options }); /** - * List Company Departments + * List work authorization requests * - * Lists all departments for the authorized company specified in the request. + * List work authorization requests. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | * + */ +export const getV1WorkAuthorizationRequests = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).get< + GetV1WorkAuthorizationRequestsResponses, + GetV1WorkAuthorizationRequestsErrors, + ThrowOnError + >({ url: '/api/eor/v1/work-authorization-requests', ...options }); + +/** + * Get employment benefit offers * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View departments (`company_department:read`) | Manage departments (`company_department:write`) | + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const getIndexCompanyDepartment = ( - options: Options, +export const getV1EmploymentsEmploymentIdBenefitOffers = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetIndexCompanyDepartmentResponses, - GetIndexCompanyDepartmentErrors, + GetV1EmploymentsEmploymentIdBenefitOffersResponses, + GetV1EmploymentsEmploymentIdBenefitOffersErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-departments', + url: '/api/eor/v1/employments/{employment_id}/benefit-offers', ...options, }); /** - * Create New Department + * Upserts employment benefit offers + */ +export const putV1EmploymentsEmploymentIdBenefitOffers = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).put< + PutV1EmploymentsEmploymentIdBenefitOffersResponses, + PutV1EmploymentsEmploymentIdBenefitOffersErrors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/employments/{employment_id}/benefit-offers', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List employments + * + * Lists all employments, except for the deleted ones. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * + * + */ +export const getV1Employments = ( + options: Options, +) => + (options.client ?? client).get< + GetV1EmploymentsResponses, + GetV1EmploymentsErrors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/employments', + ...options, + }); + +/** + * Create employment + * + * Creates an employment. We support creating employees and contractors. + * + * ## Global Payroll Employees + * + * To create a Global Payroll employee, pass `global_payroll_employee` as the `type` parameter, + * and provide the slug of the specific legal entity that the employee will be engaged by and billed to as the `engaged_by_entity_slug` parameter. + * + * ## HRIS Employees + * + * To create a HRIS employee, pass `hris` as the `type` parameter. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * * - * Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points). * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage departments (`company_department:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postCreateCompanyDepartment = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1Employments = ( + options: Options, ) => (options.client ?? client).post< - PostCreateCompanyDepartmentResponses, - PostCreateCompanyDepartmentErrors, + PostV1EmploymentsResponses, + PostV1EmploymentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-departments', + url: '/api/eor/v1/employments', ...options, headers: { 'Content-Type': 'application/json', @@ -4146,9 +3913,32 @@ export const postCreateCompanyDepartment = < }); /** - * Decline a time off cancellation request + * Show Time Off * - * Decline a time off cancellation request. + * Shows a single Time Off record + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * + */ +export const getV1TimeoffId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1TimeoffIdResponses, + GetV1TimeoffIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/timeoff/{id}', ...options }); + +/** + * Update Time Off + * + * Updates a Time Off record. + * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. + * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. * * * ## Scopes @@ -4158,21 +3948,15 @@ export const postCreateCompanyDepartment = < * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postDeclineCancellationRequest = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const patchV1TimeoffId2 = ( + options: Options, ) => - (options.client ?? client).post< - PostDeclineCancellationRequestResponses, - PostDeclineCancellationRequestErrors, + (options.client ?? client).patch< + PatchV1TimeoffId2Responses, + PatchV1TimeoffId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/cancel-request/decline', + url: '/api/eor/v1/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4181,127 +3965,151 @@ export const postDeclineCancellationRequest = < }); /** - * Get a employment benefit offers JSON schema + * Update Time Off + * + * Updates a Time Off record. + * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. + * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. + * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getShowSchema = ( - options: Options, +export const patchV1TimeoffId = ( + options: Options, ) => - (options.client ?? client).get< - GetShowSchemaResponses, - GetShowSchemaErrors, + (options.client ?? client).put< + PatchV1TimeoffIdResponses, + PatchV1TimeoffIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/benefit-offers/schema', + url: '/api/eor/v1/timeoff/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Submit eligibility questionnaire + * Get token identity * - * Submits an eligibility questionnaire for a contractor employment. + * Shows information about the entities that can be controlled by the current auth token. * - * The questionnaire determines if the contractor is eligible for certain products or features. - * The responses are validated against the JSON schema for the questionnaire type. + */ +export const getV1IdentityCurrent = ( + options: Options, +) => + (options.client ?? client).get< + GetV1IdentityCurrentResponses, + GetV1IdentityCurrentErrors, + ThrowOnError + >({ url: '/api/eor/v1/identity/current', ...options }); + +/** + * Payroll Variance Analysis API resource * - * **Requirements:** - * - Employment must be of type `contractor` - * - Employment must be in `created` status - * - Responses must conform to the questionnaire JSON schema + * API to retrieve the variance analysis data of a pay group + */ +export const getV1WdGphPayVariance = ( + options: Options, +) => + (options.client ?? client).get< + GetV1WdGphPayVarianceResponses, + GetV1WdGphPayVarianceErrors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payVariance', + ...options, + }); + +/** + * List Company Payroll Calendar * + * List all payroll calendars for the company within the requested cycle. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | * */ -export const postCreateEligibilityQuestionnaire = < +export const getV1PayrollCalendarsCycle = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostCreateEligibilityQuestionnaireResponses, - PostCreateEligibilityQuestionnaireErrors, + (options.client ?? client).get< + GetV1PayrollCalendarsCycleResponses, + GetV1PayrollCalendarsCycleErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/eligibility-questionnaire', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/payroll-calendars/{cycle}', ...options }); /** - * List timesheets + * Terminate contractor of record employment + * + * **Deprecated.** Use `POST /contractors/employments/{employment_id}/cor-termination-requests` instead. + * + * Initiates a termination request for a Contractor of Record employment. + * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. + * Currently, only Contractor of Record employments can be terminated. * - * Lists all timesheets. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * + * + * @deprecated */ -export const getIndexTimesheet = ( - options?: Options, +export const postV1ContractorsEmploymentsEmploymentIdTerminateCorEmployment = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetIndexTimesheetResponses, - GetIndexTimesheetErrors, + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets', + url: '/api/eor/v1/contractors/employments/{employment_id}/terminate-cor-employment', ...options, }); /** - * Create a legal entity + * Send back a timesheet for review or modification * - * Create a new legal entity for a company in a given country, with KYB automatically passed. + * Sends the given timesheet back to the employee for review or modification. * - * The entity is created with active status and can be set as the company's default - * using the reassign default entity endpoint. - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | * */ -export const postCreateLegalEntityCompany = < +export const postV1TimesheetsTimesheetIdSendBack = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).post< - PostCreateLegalEntityCompanyResponses, - PostCreateLegalEntityCompanyErrors, + PostV1TimesheetsTimesheetIdSendBackResponses, + PostV1TimesheetsTimesheetIdSendBackErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/companies/{company_id}/legal-entities', + url: '/api/eor/v1/timesheets/{timesheet_id}/send-back', ...options, headers: { 'Content-Type': 'application/json', @@ -4310,78 +4118,762 @@ export const postCreateLegalEntityCompany = < }); /** - * Show employment - * - * Shows all the information of an employment. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * Sign a pre-onboarding document * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * Signs the latest contract document associated with the given pre-onboarding document on behalf + * of the company signatory. * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * ## Scopes * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * + */ +export const postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSign = + ( + options: Options< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, + ThrowOnError + >({ + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List Benefit Renewal Requests * + * List Benefit Renewal Requests for each country. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | + * + */ +export const getV1BenefitRenewalRequests = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1BenefitRenewalRequestsResponses, + GetV1BenefitRenewalRequestsErrors, + ThrowOnError + >({ url: '/api/eor/v1/benefit-renewal-requests', ...options }); + +/** + * Reassign default legal entity + * + * Set a different legal entity as the company's default entity. + * + * The default entity is used when creating new employments without an explicit entity. + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * + */ +export const putV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityId = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData, + ThrowOnError + >, +) => + (options.client ?? client).put< + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}', + ...options, + }); + +/** + * List Employment Contract. + * + * Get the employment contract history for a given employment. If `only_active` is true, it will return only the active or last active contract. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View contracts (`contract:read`) | - | + * + */ +export const getV1EmploymentContracts = ( + options: Options, +) => + (options.client ?? client).get< + GetV1EmploymentContractsResponses, + GetV1EmploymentContractsErrors, + ThrowOnError + >({ url: '/api/eor/v1/employment-contracts', ...options }); + +/** + * Cancel Contract Amendment + * + * Use this endpoint to cancel an existing contract amendment request. + * + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * + */ +export const putV1SandboxContractAmendmentsContractAmendmentRequestIdCancel = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData, + ThrowOnError + >, +) => + (options.client ?? client).put< + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel', + ...options, + }); + +/** + * Download payslip in the PDF format + * + * Given a Payslip ID, downloads a payslip. + * It is important to note that each country has a different payslip format and they are not authored by Remote. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | + * + */ +export const getV1PayslipsPayslipIdPdf = ( + options: Options, +) => + (options.client ?? client).get< + GetV1PayslipsPayslipIdPdfResponses, + GetV1PayslipsPayslipIdPdfErrors, + ThrowOnError + >({ url: '/api/eor/v1/payslips/{payslip_id}/pdf', ...options }); + +/** + * Approve Time Off + * + * Approve a time off request. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * + */ +export const postV1TimeoffTimeoffIdApprove = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).post< + PostV1TimeoffTimeoffIdApproveResponses, + PostV1TimeoffTimeoffIdApproveErrors, + ThrowOnError + >({ + url: '/api/eor/v1/timeoff/{timeoff_id}/approve', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List all companies + * + * List all companies that authorized your integration to act on their behalf. In other words, these are all the companies that your integration can manage. Any company that has completed the authorization flow for your integration will be included in the response. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * + */ +export const getV1Companies = ( + options: Options, +) => + (options.client ?? client).get< + GetV1CompaniesResponses, + GetV1CompaniesErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies', ...options }); + +/** + * Create a company + * + * Creates a new company. + * + * ### Creating a company with only the required request body parameters + * When you call this endpoint and omit all the optional parameters in the request body, + * the following resources get created upon a successful response: + * * A new company with status `pending`. + * * A company owner for the new company with status `initiated`. + * + * See the [update a company endpoint](#tag/Companies/operation/patch_update_company) for + * more details on how to get your company and its owner to `active` status. + * + * If you'd like to create a company and its owner with `active` status in a single request, + * please provide the optional `address_details` parameter as well. + * + * ### Accepting the Terms of Service + * + * A required step for creating a company in Remote is to accept our Terms of Service (ToS). + * + * Company managers need to be aware of our Terms of Service and Privacy Policy, + * hence **it's the responsibility of our partners to advise and ensure company managers read + * and accept the ToS**. The terms have to be accepted only once, before creating a company, + * and the Remote API will collect the acceptance timestamp as its confirmation. + * + * To ensure users read the most recent version of Remote's Terms of Service, their **acceptance + * must be done within the last fifteen minutes prior the company creation action**. + * + * To retrieve this information, partners can provide an element with any text and a description + * explaining that by performing that action they are accepting Remote's Term of Service. For + * instance, the partner can add a checkbox or a "Create Remote Account" button followed by a + * description saying "By creating an account, you agree to + * [Remote's Terms of Service](https://remote.com/terms-of-service). Also see Remote's + * [Privacy Policy](https://remote.com/privacy-policy)". + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * + */ +export const postV1Companies = ( + options: Options, +) => + (options.client ?? client).post< + PostV1CompaniesResponses, + PostV1CompaniesErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List company structure nodes + * + * Shows all the company structure nodes of an employment. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View company structure (`company_structure:read`) | - | + * + */ +export const getV1EmploymentsEmploymentIdCompanyStructureNodes = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentsEmploymentIdCompanyStructureNodesData, + ThrowOnError + >, +) => + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses, + GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors, + ThrowOnError + >({ + url: '/api/eor/v1/employments/{employment_id}/company-structure-nodes', + ...options, + }); + +/** + * Update employment + */ +export const patchV2EmploymentsEmploymentId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).patch< + PatchV2EmploymentsEmploymentId2Responses, + PatchV2EmploymentsEmploymentId2Errors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v2/employments/{employment_id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Update employment + */ +export const patchV2EmploymentsEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).put< + PatchV2EmploymentsEmploymentIdResponses, + PatchV2EmploymentsEmploymentIdErrors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v2/employments/{employment_id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Create probation completion letter + * + * Create a new probation completion letter request. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | + * + */ +export const postV1ProbationCompletionLetter = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).post< + PostV1ProbationCompletionLetterResponses, + PostV1ProbationCompletionLetterErrors, + ThrowOnError + >({ + url: '/api/eor/v1/probation-completion-letter', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Creates PDF cost estimation of employments + * + * Creates a PDF cost estimation of employments based on the provided parameters. + */ +export const postV1CostCalculatorEstimationPdf = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).post< + PostV1CostCalculatorEstimationPdfResponses, + PostV1CostCalculatorEstimationPdfErrors, + ThrowOnError + >({ + url: '/api/eor/v1/cost-calculator/estimation-pdf', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, + }); + +/** + * Token + * + * Endpoint to exchange tokens in the Authorization Code, Assertion Flow, Client Credentials and Refresh Token flows + */ +export const postAuthOauth2Token2 = ( + options?: Options, +) => + (options?.client ?? client).post< + PostAuthOauth2Token2Responses, + PostAuthOauth2Token2Errors, + ThrowOnError + >({ + url: '/api/eor/auth/oauth2/token', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, + }); + +/** + * Download a document for the employee + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * + */ +export const getV1EmployeeDocumentsId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1EmployeeDocumentsIdResponses, + GetV1EmployeeDocumentsIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/employee/documents/{id}', ...options }); + +/** + * Replay Webhook Events + * + * Replay webhook events + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * + */ +export const postV1WebhookEventsReplay = ( + options: Options, +) => + (options.client ?? client).post< + PostV1WebhookEventsReplayResponses, + PostV1WebhookEventsReplayErrors, + ThrowOnError + >({ + url: '/api/eor/v1/webhook-events/replay', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Trigger a Webhook + * + * Triggers a callback previously registered for webhooks. Use this endpoint to + * emit a webhook for testing in the Sandbox environment. This endpoint will + * respond with a 404 outside of the Sandbox environment. + * + */ +export const postV1SandboxWebhookCallbacksTrigger = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).post< + PostV1SandboxWebhookCallbacksTriggerResponses, + PostV1SandboxWebhookCallbacksTriggerErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/webhook-callbacks/trigger', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, + }); + +/** + * Show bulk employment job + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * + */ +export const getV1BulkEmploymentJobsJobId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1BulkEmploymentJobsJobIdResponses, + GetV1BulkEmploymentJobsJobIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/bulk-employment-jobs/{job_id}', ...options }); + +/** + * List bulk employment rows + * + * Returns grouped bulk employment rows, including field-level validation errors in `errors`, row-level failures in `row_errors`, and submission-phase failures in `submission_errors`. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * + */ +export const getV1BulkEmploymentJobsJobIdRows = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1BulkEmploymentJobsJobIdRowsResponses, + GetV1BulkEmploymentJobsJobIdRowsErrors, + ThrowOnError + >({ url: '/api/eor/v1/bulk-employment-jobs/{job_id}/rows', ...options }); + +/** + * Magic links generator + * + * Generates a magic link for a passwordless authentication. + * To create a magic link for a company admin, you need to provide the `user_id` parameter. + * To create a magic link for an employee, you need to provide the `employment_id` parameter. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | - | Create magic links (`magic_link:write`) | + * + */ +export const postV1MagicLink = ( + options: Options, +) => + (options.client ?? client).post< + PostV1MagicLinkResponses, + PostV1MagicLinkErrors, + ThrowOnError + >({ + url: '/api/eor/v1/magic-link', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Show a company + * + * Given an ID, shows a company. + * + * If the used access token was issued by the OAuth 2.0 Authorization Code flow, + * then only the associated company can be accessed through the endpoint. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * + */ +export const getV1CompaniesCompanyId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdResponses, + GetV1CompaniesCompanyIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies/{company_id}', ...options }); + +/** + * Update a company + * + * Given an ID and a request object with new information, updates a company. + * + * ### Getting a company and its owner to `active` status + * If you created a company using the + * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required + * request body parameters, you can use this endpoint to provide the missing data. Once the company + * and its owner have all the necessary data, both their statuses will be set to `active` and the company + * onboarding will be marked as "completed". + * + * The following constitutes a company with "all the necessary data": + * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the + * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters + * are required). + * * Company `tax_number` or `registration_number` is not nil + * * Company `name` is not nil (already required when creating the company) + * * Company has a `desired_currency` in their bank account (already required when creating the company) + * * Company has accepted terms of service (already required when creating the company) + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * + */ +export const patchV1CompaniesCompanyId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).patch< + PatchV1CompaniesCompanyId2Responses, + PatchV1CompaniesCompanyId2Errors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Update a company + * + * Given an ID and a request object with new information, updates a company. + * + * ### Getting a company and its owner to `active` status + * If you created a company using the + * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required + * request body parameters, you can use this endpoint to provide the missing data. Once the company + * and its owner have all the necessary data, both their statuses will be set to `active` and the company + * onboarding will be marked as "completed". + * + * The following constitutes a company with "all the necessary data": + * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the + * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters + * are required). + * * Company `tax_number` or `registration_number` is not nil + * * Company `name` is not nil (already required when creating the company) + * * Company has a `desired_currency` in their bank account (already required when creating the company) + * * Company has accepted terms of service (already required when creating the company) + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * + */ +export const patchV1CompaniesCompanyId = ( + options: Options, +) => + (options.client ?? client).put< + PatchV1CompaniesCompanyIdResponses, + PatchV1CompaniesCompanyIdErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Show form schema + * + * Returns the json schema of the requested company form. + * Currently only supports the `address_details` form. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * + */ +export const getV1CompaniesSchema = ( + options: Options, +) => + (options.client ?? client).get< + GetV1CompaniesSchemaResponses, + GetV1CompaniesSchemaErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies/schema', ...options }); + +/** + * List pricing plan partner templates + * + * List all pricing plan partner templates. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * + */ +export const getV1PricingPlanPartnerTemplates = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).get< + GetV1PricingPlanPartnerTemplatesResponses, + GetV1PricingPlanPartnerTemplatesErrors, + ThrowOnError + >({ url: '/api/eor/v1/pricing-plan-partner-templates', ...options }); + +/** + * Show engagement agreement details + * + * Returns the engagement agreement details JSON Schema for a country. Only DEU country is supported for now. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const getShowEmployment = ( - options: Options, +export const getV1CountriesCountryCodeEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1CountriesCountryCodeEngagementAgreementDetailsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetShowEmploymentResponses, - GetShowEmploymentErrors, + GetV1CountriesCountryCodeEngagementAgreementDetailsResponses, + GetV1CountriesCountryCodeEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}', + url: '/api/eor/v1/countries/{country_code}/engagement-agreement-details', ...options, }); /** - * Update employment - * - * Updates an employment. - * - * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. - * - * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. - * - * **For `invited` employments:** You can update the work_email. - * - * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. - * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. - * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. - * Currently, these amendments can only be done through the Remote UI. - * - * It is possible to update the `external_id` of the employment for all employment statuses. - * - * ## Global Payroll Employees - * - * To update a Global Payment employment your input data must comply with the global payroll json schemas. - * - * **For `active` employments:** In addition to the above list, you can update personal_details. - * - * ## Direct Employees + * Update contract details * - * To update an HRIS employment your input data must comply with the HRIS json schemas. + * Updates employment's contract details. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -4397,10 +4889,8 @@ export const getShowEmployment = ( * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * - * Please contact Remote if you need to update contractors via API since it's currently not supported. * * * ## Scopes @@ -4410,19 +4900,20 @@ export const getShowEmployment = ( * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const patchUpdateEmployment2 = ( - options: Options, +export const putV2EmploymentsEmploymentIdContractDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdContractDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).patch< - PatchUpdateEmployment2Responses, - PatchUpdateEmployment2Errors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdContractDetailsResponses, + PutV2EmploymentsEmploymentIdContractDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}', + url: '/api/eor/v2/employments/{employment_id}/contract_details', ...options, headers: { 'Content-Type': 'application/json', @@ -4431,185 +4922,223 @@ export const patchUpdateEmployment2 = ( }); /** - * Update employment - * - * Updates an employment. - * - * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. - * - * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. - * - * **For `invited` employments:** You can update the work_email. - * - * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. - * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. - * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. - * Currently, these amendments can only be done through the Remote UI. - * - * It is possible to update the `external_id` of the employment for all employment statuses. - * - * ## Global Payroll Employees + * Show product prices in the company's desired currency * - * To update a Global Payment employment your input data must comply with the global payroll json schemas. + * list product prices in the company's desired currency. + * the endpoint currently only returns the product prices for the EOR monthly product and the contractor products (Standard, Plus and COR). + * the product prices are then used to create a pricing plan for the company. * - * **For `active` employments:** In addition to the above list, you can update personal_details. * - * ## Direct Employees + * ## Scopes * - * To update an HRIS employment your input data must comply with the HRIS json schemas. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + */ +export const getV1CompaniesCompanyIdProductPrices = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdProductPricesResponses, + GetV1CompaniesCompanyIdProductPricesErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies/{company_id}/product-prices', ...options }); + +/** + * Create a new token for a company * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * Creates new tokens for a given company + */ +export const postV1CompaniesCompanyIdCreateToken = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).post< + PostV1CompaniesCompanyIdCreateTokenResponses, + PostV1CompaniesCompanyIdCreateTokenErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies/{company_id}/create-token', ...options }); + +/** + * Get Employment Profile * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * Gets necessary information to perform the identity verification of an employee. * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * ## Scopes * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | View identity verification (`identity_verification:read`) | Manage identity verification (`identity_verification:write`) | * - * Please contact Remote if you need to update contractors via API since it's currently not supported. + */ +export const getV1IdentityVerificationEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1IdentityVerificationEmploymentIdResponses, + GetV1IdentityVerificationEmploymentIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/identity-verification/{employment_id}', ...options }); + +/** + * Download a receipt by id * + * Download a receipt by id. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const patchUpdateEmployment = ( - options: Options, +export const getV1ExpensesExpenseIdReceiptsReceiptId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).put< - PatchUpdateEmploymentResponses, - PatchUpdateEmploymentErrors, + (options.client ?? client).get< + GetV1ExpensesExpenseIdReceiptsReceiptIdResponses, + GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}', + url: '/api/eor/v1/expenses/{expense_id}/receipts/{receipt_id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * List users via SCIM v2.0 + * List groups via SCIM v2.0 * - * Retrieves a list of users for the authenticated company following SCIM 2.0 standard + * Retrieves a list of groups (departments) for the authenticated company following SCIM 2.0 standard */ -export const getListUsersScim = ( - options?: Options, +export const getV1ScimV2Groups = ( + options?: Options, ) => (options?.client ?? client).get< - GetListUsersScimResponses, - GetListUsersScimErrors, + GetV1ScimV2GroupsResponses, + GetV1ScimV2GroupsErrors, ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Users', + url: '/api/eor/v1/scim/v2/Groups', ...options, }); /** - * List Company Payroll Calendar + * Show expense * - * List all payroll calendars for the company within the requested cycle. + * Shows a single expense record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const getIndexPayrollCalendar = ( - options: Options, +export const getV1ExpensesId = ( + options: Options, ) => (options.client ?? client).get< - GetIndexPayrollCalendarResponses, - GetIndexPayrollCalendarErrors, + GetV1ExpensesIdResponses, + GetV1ExpensesIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/expenses/{id}', ...options }); + +/** + * Update an expense + * + * Updates an expense + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | + * + */ +export const patchV1ExpensesId2 = ( + options: Options, +) => + (options.client ?? client).patch< + PatchV1ExpensesId2Responses, + PatchV1ExpensesId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-calendars/{cycle}', + url: '/api/eor/v1/expenses/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show Legal Entity Administrative details - * - * Show administrative details of legal entity for the authorized company specified in the request. + * Update an expense * + * Updates an expense * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const getShowAdministrativeDetails = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const patchV1ExpensesId = ( + options: Options, ) => - (options.client ?? client).get< - GetShowAdministrativeDetailsResponses, - GetShowAdministrativeDetailsErrors, + (options.client ?? client).put< + PatchV1ExpensesIdResponses, + PatchV1ExpensesIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + url: '/api/eor/v1/expenses/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Update Legal Entity Administrative details + * Update emergency contact * - * Update administrative details of legal entity for the authorized company specified in the request. + * Updates the employment's emergency contact details. + * + * This endpoint requires country-specific data. Query the **Show form schema** endpoint + * passing the country code and `emergency_contact_details` as path parameters to see + * the required fields for a given country. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const putUpdateAdministrativeDetails = < +export const putV2EmploymentsEmploymentIdEmergencyContact = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PutV2EmploymentsEmploymentIdEmergencyContactData, + ThrowOnError + >, ) => (options.client ?? client).put< - PutUpdateAdministrativeDetailsResponses, - PutUpdateAdministrativeDetailsErrors, + PutV2EmploymentsEmploymentIdEmergencyContactResponses, + PutV2EmploymentsEmploymentIdEmergencyContactErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + url: '/api/eor/v2/employments/{employment_id}/emergency_contact', ...options, headers: { 'Content-Type': 'application/json', @@ -4618,292 +5147,315 @@ export const putUpdateAdministrativeDetails = < }); /** - * Show region fields + * Creates a Benefit Renewal Request + * + * Creates a Benefit Renewal Request for a specific Benefit Group. + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * - * Returns required fields JSON Schema for a given region. These are required in order to calculate - * the cost of employment for the region. These fields are based on employer contributions that are associated - * with the region or any of it's parent regions. */ -export const getShowRegionField = ( - options: Options, +export const postV1SandboxBenefitRenewalRequests = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).get< - GetShowRegionFieldResponses, - GetShowRegionFieldErrors, + (options.client ?? client).post< + PostV1SandboxBenefitRenewalRequestsResponses, + PostV1SandboxBenefitRenewalRequestsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/regions/{slug}/fields', + url: '/api/eor/v1/sandbox/benefit-renewal-requests', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show Offboarding + * Update basic information + * + * Updates employment's basic information. + * + * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * * - * Shows an Offboarding request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getShowOffboarding = ( - options: Options, +export const putV2EmploymentsEmploymentIdBasicInformation = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdBasicInformationData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetShowOffboardingResponses, - GetShowOffboardingErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdBasicInformationResponses, + PutV2EmploymentsEmploymentIdBasicInformationErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/offboardings/{id}', + url: '/api/eor/v2/employments/{employment_id}/basic_information', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Get Employee Details for a Payroll Run + * List Leave Policies Summary * - * Gets the employee details for a payroll run + * List all the data related to time off for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * + */ +export const getV1LeavePoliciesSummaryEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1LeavePoliciesSummaryEmploymentIdResponses, + GetV1LeavePoliciesSummaryEmploymentIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/leave-policies/summary/{employment_id}', ...options }); + +/** + * Cancel Time Off + * + * Cancel a time off request that was already approved. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getEmployeeDetailsPayrollRun = < +export const postV1TimeoffTimeoffIdCancel = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetEmployeeDetailsPayrollRunResponses, - GetEmployeeDetailsPayrollRunErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdCancelResponses, + PostV1TimeoffTimeoffIdCancelErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-runs/{payroll_run_id}/employee-details', + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List bulk employment rows + * Get Help Center Article * - * Returns grouped bulk employment rows, including field-level validation errors in `errors`, row-level failures in `row_errors`, and submission-phase failures in `submission_errors`. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response. + * Get a help center article by its ID * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View help articles (`help_center_article:read`) | - | * */ -export const getIndexBulkEmploymentRow = ( - options: Options, +export const getV1HelpCenterArticlesId = ( + options: Options, ) => (options.client ?? client).get< - GetIndexBulkEmploymentRowResponses, - GetIndexBulkEmploymentRowErrors, + GetV1HelpCenterArticlesIdResponses, + GetV1HelpCenterArticlesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/bulk-employment-jobs/{job_id}/rows', - ...options, - }); + >({ url: '/api/eor/v1/help-center-articles/{id}', ...options }); /** - * Create employment + * Upload file * - * Creates an employment without provisional_start_date validation. + * Uploads a file associated with a specified employment. * - * This endpoint is only available in Sandbox and allows creating employments which - * `provisional_start_date` is in the past. This is especially helpful for: - * * Testing the Timeoff Balance endpoints - * * Testing the Offboarding endpoints - * * Testing features around probation periods + * Please contact api-support@remote.com to request access to this endpoint. * - * This endpoint will respond with a 404 outside of the Sandbox environment. * - * For creating an employment's parameters outside of testing purposes, use [this - * Employment create endpoint](#operation/post_create_employment) + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const postCreateEmployment = ( - options: Options, +export const postV1Documents = ( + options: Options, ) => (options.client ?? client).post< - PostCreateEmploymentResponses, - PostCreateEmploymentErrors, + PostV1DocumentsResponses, + PostV1DocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments', + ...formDataBodySerializer, + url: '/api/eor/v1/documents', ...options, headers: { - 'Content-Type': 'application/json', + 'Content-Type': null, ...options.headers, }, }); /** - * Create contract eligibility - * - * Create contract eligibility for an employment. + * Verify Employment Identity * - * This will create a new contract eligibility for the employment. + * Endpoint to confirms the employment profile is from the actual employee * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage contract eligibility (`contract_eligibility:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | * */ -export const postCreateContractEligibility = < +export const postV1IdentityVerificationEmploymentIdVerify = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1IdentityVerificationEmploymentIdVerifyData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostCreateContractEligibilityResponses, - PostCreateContractEligibilityErrors, + PostV1IdentityVerificationEmploymentIdVerifyResponses, + PostV1IdentityVerificationEmploymentIdVerifyErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/contract-eligibility', + url: '/api/eor/v1/identity-verification/{employment_id}/verify', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * List countries - * - * Returns a list of all countries that are supported by Remote API alphabetically ordered. - * The supported list accounts for creating employment with basic information and it does not imply fully onboarding employment via JSON Schema. - * The countries present in the list are the ones where creating a company is allowed. + * Lists custom fields definitions * + * Returns custom fields definitions * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | + * | Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) | * */ -export const getSupportedCountry = ( - options: Options, +export const getV1CustomFields = ( + options?: Options, ) => - (options.client ?? client).get< - GetSupportedCountryResponses, - GetSupportedCountryErrors, + (options?.client ?? client).get< + GetV1CustomFieldsResponses, + GetV1CustomFieldsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries', - ...options, - }); + >({ url: '/api/eor/v1/custom-fields', ...options }); /** - * Create a new token for a company + * Create Custom Field Definition + * + * Creates a new custom field definition. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View custom fields (`custom_field:read`) | Manage custom fields (`custom_field:write`) | * - * Creates new tokens for a given company */ -export const postCreateTokenCompanyToken = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1CustomFields = ( + options: Options, ) => (options.client ?? client).post< - PostCreateTokenCompanyTokenResponses, - PostCreateTokenCompanyTokenErrors, + PostV1CustomFieldsResponses, + PostV1CustomFieldsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}/create-token', + url: '/api/eor/v1/custom-fields', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Company Legal Entities - * - * Lists all active legal entities for the authorized company specified in the request. + * Approve risk reserve proof of payment * + * Approves a risk reserve proof of payment without the intervention of a Remote admin. * - * ## Scopes + * Triggers an `employment.cor_hiring.proof_of_payment_accepted` webhook event. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const getIndexCompanyLegalEntities = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetIndexCompanyLegalEntitiesResponses, - GetIndexCompanyLegalEntitiesErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities', - ...options, - }); +export const postV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApprove = + ( + options: Options< + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve', + ...options, + }); /** - * Complete onboarding + * Create a Webhook Callback * - * Completes the employee onboarding. When all tasks are completed, the employee is marked as in `review` status + * Register a callback to be used for webhooks + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * - * @deprecated */ -export const postCompleteOnboardingEmployment = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1WebhookCallbacks = ( + options: Options, ) => (options.client ?? client).post< - PostCompleteOnboardingEmploymentResponses, - PostCompleteOnboardingEmploymentErrors, + PostV1WebhookCallbacksResponses, + PostV1WebhookCallbacksErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/ready', + url: '/api/eor/v1/webhook-callbacks', ...options, headers: { 'Content-Type': 'application/json', @@ -4912,278 +5464,266 @@ export const postCompleteOnboardingEmployment = < }); /** - * List Leave Policies Details + * Show the SSO Configuration Details * - * Describe the leave policies (custom or not) for a given employment + * Shows the SSO Configuration details for the company. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | * */ -export const getIndexLeavePoliciesDetails = < +export const getV1SsoConfigurationDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options?: Options, ) => - (options.client ?? client).get< - GetIndexLeavePoliciesDetailsResponses, - GetIndexLeavePoliciesDetailsErrors, + (options?.client ?? client).get< + GetV1SsoConfigurationDetailsResponses, + GetV1SsoConfigurationDetailsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/leave-policies/details/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/sso-configuration/details', ...options }); /** - * List Time Off Types + * Sign a document for a contractor * - * Lists all time off types that can be used for the `timeoff_type` parameter. + * ## Scopes * - * **Backward compatibility:** Calling this endpoint without the `type` query parameter returns the same response as before (time off types for full-time employments). Existing integrations do not need to change. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * - * Optionally, pass `type=contractor` to get time off types for contractor employments, or `type=full_time` for full-time employments (same as omitting the parameter). + */ +export const postV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSign = + ( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List Pay Items * + * Lists pay items for a company with optional filtering by employment, date range, and pagination. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) | * */ -export const getTimeoffTypesTimeoff = ( - options: Options, +export const getV1PayItems = ( + options?: Options, ) => - (options.client ?? client).get< - GetTimeoffTypesTimeoffResponses, - GetTimeoffTypesTimeoffErrors, + (options?.client ?? client).get< + GetV1PayItemsResponses, + GetV1PayItemsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/types', - ...options, - }); + >({ url: '/api/eor/v1/pay-items', ...options }); /** - * Creates a CSV cost estimation of employments + * List users via SCIM v2.0 * - * Creates CSV cost estimation of employments + * Retrieves a list of users for the authenticated company following SCIM 2.0 standard */ -export const postCreateEstimationCsv = ( - options?: Options, +export const getV1ScimV2Users = ( + options?: Options, ) => - (options?.client ?? client).post< - PostCreateEstimationCsvResponses, - PostCreateEstimationCsvErrors, + (options?.client ?? client).get< + GetV1ScimV2UsersResponses, + GetV1ScimV2UsersErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/estimation-csv', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Users', ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, }); /** - * List groups via SCIM v2.0 + * Show Resignation + * + * Shows the details of a resignation with status `submitted`. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View resignations (`resignation:read`) | Manage resignations (`resignation:write`) | * - * Retrieves a list of groups (departments) for the authenticated company following SCIM 2.0 standard */ -export const getListGroupsScim = ( - options?: Options, +export const getV1ResignationsOffboardingRequestId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options?.client ?? client).get< - GetListGroupsScimResponses, - GetListGroupsScimErrors, + (options.client ?? client).get< + GetV1ResignationsOffboardingRequestIdResponses, + GetV1ResignationsOffboardingRequestIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Groups', - ...options, - }); + >({ url: '/api/eor/v1/resignations/{offboarding_request_id}', ...options }); /** - * Create a contract document for a contractor - * - * Create a contract document for a contractor. + * Get Billing Document Breakdown * + * Get billing document breakdown * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const postCreateContractDocument = < +export const getV1BillingDocumentsBillingDocumentIdBreakdown = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1BillingDocumentsBillingDocumentIdBreakdownData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostCreateContractDocumentResponses, - PostCreateContractDocumentErrors, + (options.client ?? client).get< + GetV1BillingDocumentsBillingDocumentIdBreakdownResponses, + GetV1BillingDocumentsBillingDocumentIdBreakdownErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contract-documents', + url: '/api/eor/v1/billing-documents/{billing_document_id}/breakdown', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Trigger a Webhook + * Decline a time off cancellation request * - * Triggers a callback previously registered for webhooks. Use this endpoint to - * emit a webhook for testing in the Sandbox environment. This endpoint will - * respond with a 404 outside of the Sandbox environment. + * Decline a time off cancellation request. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postTriggerWebhookCallback = < +export const postV1TimeoffTimeoffIdCancelRequestDecline = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options< + PostV1TimeoffTimeoffIdCancelRequestDeclineData, + ThrowOnError + >, ) => - (options?.client ?? client).post< - PostTriggerWebhookCallbackResponses, - PostTriggerWebhookCallbackErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdCancelRequestDeclineResponses, + PostV1TimeoffTimeoffIdCancelRequestDeclineErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/webhook-callbacks/trigger', + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/decline', ...options, headers: { 'Content-Type': 'application/json', - ...options?.headers, + ...options.headers, }, }); /** - * Download payslip in the PDF format - * - * Given a Payslip ID, downloads a payslip. - * It is important to note that each country has a different payslip format and they are not authored by Remote. + * List EOR Payroll Calendar * + * List all active payroll calendars for EOR. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | + * + */ +export const getV1PayrollCalendars = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1PayrollCalendarsResponses, + GetV1PayrollCalendarsErrors, + ThrowOnError + >({ url: '/api/eor/v1/payroll-calendars', ...options }); + +/** + * Payroll processing details API resource * + * API to retrieve header details of a pay group */ -export const getDownloadPayslipPayslip = ( - options: Options, +export const getV1WdGphPayDetail = ( + options: Options, ) => (options.client ?? client).get< - GetDownloadPayslipPayslipResponses, - GetDownloadPayslipPayslipErrors, + GetV1WdGphPayDetailResponses, + GetV1WdGphPayDetailErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payslips/{payslip_id}/pdf', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payDetail', ...options, }); /** - * Convert currency using dynamic rates + * Show form schema + * + * Returns the json schema of the `contract_amendment` form for a specific employment. + * This endpoint requires a company access token, as forms are dependent on certain + * properties of companies and their current employments. * - * Convert currency using the rates Remote applies during employment creation and invoicing. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | + * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | * */ -export const postConvertWithSpreadCurrencyConverter = < +export const getV1ContractAmendmentsSchema = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostConvertWithSpreadCurrencyConverterResponses, - PostConvertWithSpreadCurrencyConverterErrors, + (options.client ?? client).get< + GetV1ContractAmendmentsSchemaResponses, + GetV1ContractAmendmentsSchemaErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/currency-converter/effective', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/contract-amendments/schema', ...options }); /** - * Show Time Off - * - * Shows a single Time Off record - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * Get a mock JSON Schema * + * Get a mock JSON Schema for testing purposes */ -export const getShowTimeoff = ( - options: Options, +export const getV1TestSchema = ( + options?: Options, ) => - (options.client ?? client).get< - GetShowTimeoffResponses, - GetShowTimeoffErrors, + (options?.client ?? client).get< + GetV1TestSchemaResponses, + unknown, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{id}', - ...options, - }); + >({ url: '/api/eor/v1/test-schema', ...options }); /** - * Update Time Off - * - * Updates a Time Off record. - * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. - * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. + * Update Time Off as Employee * + * Updates a Time Off record as Employee * * ## Scopes * @@ -5192,19 +5732,15 @@ export const getShowTimeoff = ( * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const patchUpdateTimeoff2 = ( - options: Options, +export const patchV1EmployeeTimeoffId2 = ( + options: Options, ) => (options.client ?? client).patch< - PatchUpdateTimeoff2Responses, - PatchUpdateTimeoff2Errors, + PatchV1EmployeeTimeoffId2Responses, + PatchV1EmployeeTimeoffId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{id}', + url: '/api/eor/v1/employee/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5213,12 +5749,9 @@ export const patchUpdateTimeoff2 = ( }); /** - * Update Time Off - * - * Updates a Time Off record. - * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. - * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. + * Update Time Off as Employee * + * Updates a Time Off record as Employee * * ## Scopes * @@ -5227,19 +5760,15 @@ export const patchUpdateTimeoff2 = ( * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const patchUpdateTimeoff = ( - options: Options, +export const patchV1EmployeeTimeoffId = ( + options: Options, ) => (options.client ?? client).put< - PatchUpdateTimeoffResponses, - PatchUpdateTimeoffErrors, + PatchV1EmployeeTimeoffIdResponses, + PatchV1EmployeeTimeoffIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{id}', + url: '/api/eor/v1/employee/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5248,59 +5777,33 @@ export const patchUpdateTimeoff = ( }); /** - * Decline Time Off - * - * Decline a time off request. Please note that only time off requests on the `requested` status can be declined. - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * Get group by ID via SCIM v2.0 * + * Retrieves a single group (department) for the authenticated company by group ID */ -export const postCreateDecline = ( - options: Options, +export const getV1ScimV2GroupsId = ( + options: Options, ) => - (options.client ?? client).post< - PostCreateDeclineResponses, - PostCreateDeclineErrors, + (options.client ?? client).get< + GetV1ScimV2GroupsIdResponses, + GetV1ScimV2GroupsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/decline', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Groups/{id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Automatable Contract Amendment - * - * Check if a contract amendment request is automatable. - * If the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract - * and send them an updated document. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * Show legal entity administrative details form schema * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * Returns the json schema of a supported form. Possible form names are: + * ``` + * - administrative_details + * ``` * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * Most forms require a company access token, as they are dependent on certain + * properties of companies and their current employments. * * * @@ -5308,56 +5811,71 @@ export const postCreateDecline = ( * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const postAutomatableContractAmendment = < +export const getV1CountriesCountryCodeLegalEntityFormsForm = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1CountriesCountryCodeLegalEntityFormsFormData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostAutomatableContractAmendmentResponses, - PostAutomatableContractAmendmentErrors, + (options.client ?? client).get< + GetV1CountriesCountryCodeLegalEntityFormsFormResponses, + GetV1CountriesCountryCodeLegalEntityFormsFormErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments/automatable', + url: '/api/eor/v1/countries/{country_code}/legal_entity_forms/{form}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Approve Time Off + * Get employment contract pending changes * - * Approve a time off request. + * Get all the pending changes (waiting for aproval or signature) for the employment contract. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employments (`employments`) | View contracts (`contract:read`) | - | + * + */ +export const getV1EmploymentContractsEmploymentIdPendingChanges = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentContractsEmploymentIdPendingChangesData, + ThrowOnError + >, +) => + (options.client ?? client).get< + GetV1EmploymentContractsEmploymentIdPendingChangesResponses, + GetV1EmploymentContractsEmploymentIdPendingChangesErrors, + ThrowOnError + >({ + url: '/api/eor/v1/employment-contracts/{employment_id}/pending-changes', + ...options, + }); + +/** + * Report SDK errors + * + * Receives error telemetry from the frontend SDK. + * Errors are logged to observability backend for monitoring and debugging. * */ -export const postCreateApproval = ( - options: Options, +export const postV1SdkTelemetryErrors = ( + options: Options, ) => (options.client ?? client).post< - PostCreateApprovalResponses, - PostCreateApprovalErrors, + PostV1SdkTelemetryErrorsResponses, + PostV1SdkTelemetryErrorsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/approve', + url: '/api/eor/v1/sdk/telemetry-errors', ...options, headers: { 'Content-Type': 'application/json', @@ -5366,186 +5884,187 @@ export const postCreateApproval = ( }); /** - * List employment files - * - * Lists files associated with a specific employment. + * Get Company Compliance Profile * - * Supports filtering by file type and sub_type. + * Returns the KYB and credit risk status for the company's default legal entity. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getIndexEmploymentFile = ( - options: Options, +export const getV1CompaniesCompanyIdComplianceProfile = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetIndexEmploymentFileResponses, - GetIndexEmploymentFileErrors, + GetV1CompaniesCompanyIdComplianceProfileResponses, + GetV1CompaniesCompanyIdComplianceProfileErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/files', + url: '/api/eor/v1/companies/{company_id}/compliance-profile', ...options, }); /** - * Lists custom fields definitions + * Show payslip + * + * Given an ID, shows a payslip. + * + * Please contact api-support@remote.com to request access to this endpoint. * - * Returns custom fields definitions * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const getIndexEmploymentCustomField = < - ThrowOnError extends boolean = false, ->( - options?: Options, +export const getV1PayslipsId = ( + options: Options, ) => - (options?.client ?? client).get< - GetIndexEmploymentCustomFieldResponses, - GetIndexEmploymentCustomFieldErrors, + (options.client ?? client).get< + GetV1PayslipsIdResponses, + GetV1PayslipsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields', - ...options, - }); + >({ url: '/api/eor/v1/payslips/{id}', ...options }); /** - * Create Custom Field Definition + * Approve a time off cancellation request + * + * Approve a time off cancellation request. + * In order to approve a time off cancellation request, the timeoff status must be `cancel_requested`. * - * Creates a new custom field definition. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View custom fields (`custom_field:read`) | Manage custom fields (`custom_field:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postCreateEmploymentCustomField = < +export const postV1TimeoffTimeoffIdCancelRequestApprove = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1TimeoffTimeoffIdCancelRequestApproveData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostCreateEmploymentCustomFieldResponses, - PostCreateEmploymentCustomFieldErrors, + PostV1TimeoffTimeoffIdCancelRequestApproveResponses, + PostV1TimeoffTimeoffIdCancelRequestApproveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields', + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/approve', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * List company supported currencies + * List Webhook Events * - * List company supported currencies + * List all webhook events * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View company currencies (`company_currencies:read`) | - | + * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | * */ -export const getIndexCompanyCurrency = ( - options?: Options, +export const getV1WebhookEvents = ( + options?: Options, ) => (options?.client ?? client).get< - GetIndexCompanyCurrencyResponses, - GetIndexCompanyCurrencyErrors, + GetV1WebhookEventsResponses, + GetV1WebhookEventsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-currencies', - ...options, - }); + >({ url: '/api/eor/v1/webhook-events', ...options }); /** - * Update employment + * List Time Off Types * - * Updates an employment. Use this endpoint to: - * - modify employment states for testing - * - Backdate employment start dates + * Lists all time off types that can be used for the `timeoff_type` parameter. * - * This endpoint will respond with a 404 outside of the Sandbox environment. + * **Backward compatibility:** Calling this endpoint without the `type` query parameter returns the same response as before (time off types for full-time employments). Existing integrations do not need to change. * - * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). + * Optionally, pass `type=contractor` to get time off types for contractor employments, or `type=full_time` for full-time employments (same as omitting the parameter). + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const patchUpdateEmployment4 = ( - options: Options, +export const getV1TimeoffTypes = ( + options: Options, ) => - (options.client ?? client).patch< - PatchUpdateEmployment4Responses, - PatchUpdateEmployment4Errors, + (options.client ?? client).get< + GetV1TimeoffTypesResponses, + GetV1TimeoffTypesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments/{employment_id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/timeoff/types', ...options }); /** - * Update employment + * List Company Legal Entities * - * Updates an employment. Use this endpoint to: - * - modify employment states for testing - * - Backdate employment start dates + * Lists all active legal entities for the authorized company specified in the request. * - * This endpoint will respond with a 404 outside of the Sandbox environment. * - * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * + */ +export const getV1CompaniesCompanyIdLegalEntities = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdLegalEntitiesResponses, + GetV1CompaniesCompanyIdLegalEntitiesErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies/{company_id}/legal-entities', ...options }); + +/** + * Create contract eligibility + * + * Create contract eligibility for an employment. + * + * This will create a new contract eligibility for the employment. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage contract eligibility (`contract_eligibility:write`) | * */ -export const patchUpdateEmployment3 = ( - options: Options, +export const postV1EmploymentsEmploymentIdContractEligibility = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1EmploymentsEmploymentIdContractEligibilityData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PatchUpdateEmployment3Responses, - PatchUpdateEmployment3Errors, + (options.client ?? client).post< + PostV1EmploymentsEmploymentIdContractEligibilityResponses, + PostV1EmploymentsEmploymentIdContractEligibilityErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments/{employment_id}', + url: '/api/eor/v1/employments/{employment_id}/contract-eligibility', ...options, headers: { 'Content-Type': 'application/json', @@ -5554,150 +6073,175 @@ export const patchUpdateEmployment3 = ( }); /** - * Get employment contract pending changes + * List all currencies for the contractor + * + * The currencies are listed in the following order: + * 1. billing currency of the company + * 2. currencies of contractorā€™s existing withdrawal methods + * 3. currency of the contractorā€™s country + * 4. the rest, alphabetical. * - * Get all the pending changes (waiting for aproval or signature) for the employment contract. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contracts (`contract:read`) | - | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getPendingChangesEmploymentContract = < +export const getV1ContractorsEmploymentsEmploymentIdContractorCurrencies = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetPendingChangesEmploymentContractResponses, - GetPendingChangesEmploymentContractErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employment-contracts/{employment_id}/pending-changes', + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-currencies', ...options, }); /** - * Show Resignation + * List payslips * - * Shows the details of a resignation with status `submitted`. + * Lists all payslips belonging to a company. Can also filter for a single employment belonging + * to that company. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | + * + */ +export const getV1Payslips = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1PayslipsResponses, + GetV1PayslipsErrors, + ThrowOnError + >({ url: '/api/eor/v1/payslips', ...options }); + +/** + * Create employment + * + * Creates an employment without provisional_start_date validation. + * + * This endpoint is only available in Sandbox and allows creating employments which + * `provisional_start_date` is in the past. This is especially helpful for: + * * Testing the Timeoff Balance endpoints + * * Testing the Offboarding endpoints + * * Testing features around probation periods * - * ## Scopes + * This endpoint will respond with a 404 outside of the Sandbox environment. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View resignations (`resignation:read`) | Manage resignations (`resignation:write`) | + * For creating an employment's parameters outside of testing purposes, use [this + * Employment create endpoint](#operation/post_create_employment) * */ -export const getShowResignation = ( - options: Options, +export const postV1SandboxEmployments = ( + options: Options, ) => - (options.client ?? client).get< - GetShowResignationResponses, - GetShowResignationErrors, + (options.client ?? client).post< + PostV1SandboxEmploymentsResponses, + PostV1SandboxEmploymentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/resignations/{offboarding_request_id}', + url: '/api/eor/v1/sandbox/employments', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Upload file - * - * Uploads a file associated with a specified employment. + * Show Company Payroll Runs * - * Please contact api-support@remote.com to request access to this endpoint. + * Given an ID, shows a payroll run. + * `employee_details` field is deprecated in favour of the `employee_details` endpoint and will be removed in the future. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | + * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | * */ -export const postUploadEmployeeFileFile = < +export const getV1PayrollRunsPayrollRunId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostUploadEmployeeFileFileResponses, - PostUploadEmployeeFileFileErrors, + (options.client ?? client).get< + GetV1PayrollRunsPayrollRunIdResponses, + GetV1PayrollRunsPayrollRunIdErrors, ThrowOnError - >({ - ...formDataBodySerializer, - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/documents', - ...options, - headers: { - 'Content-Type': null, - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/payroll-runs/{payroll_run_id}', ...options }); /** - * Invite employment + * List pre-onboarding document requirements for an employment * - * Invite an employment to start the self-enrollment. - * - * Requirements for the invitation to succeed: + * Returns the list of pre-onboarding document requirements (e.g. master service agreements, + * individual labour agreements) that must be fulfilled before the given employment can be onboarded. * - * * Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details` - * * `provisional_start_date` must consider the minimum onboarding time of the employment's country * - * If there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message. - * HTTP Status OK (200) is returned in case of success. + * ## Scopes * - * In case of the following error message: - * `"Please reselect benefits - the previous selection is no longer available"` - * it means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * - * In this case, reselect benefits by updating `contract_details` JSON Schema form. + */ +export const getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirements = + ( + options: Options< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements', + ...options, + }); + +/** + * Show Offboarding * + * Shows an Offboarding request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | * */ -export const postInviteEmploymentInvitation = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1OffboardingsId = ( + options: Options, ) => - (options.client ?? client).post< - PostInviteEmploymentInvitationResponses, - PostInviteEmploymentInvitationErrors, + (options.client ?? client).get< + GetV1OffboardingsIdResponses, + GetV1OffboardingsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/invite', - ...options, - }); + >({ url: '/api/eor/v1/offboardings/{id}', ...options }); /** - * Show expense + * List expenses * - * Shows a single expense record + * Lists all expenses records * * ## Scopes * @@ -5706,26 +6250,19 @@ export const postInviteEmploymentInvitation = < * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const getShowExpense = ( - options: Options, +export const getV1Expenses = ( + options: Options, ) => (options.client ?? client).get< - GetShowExpenseResponses, - GetShowExpenseErrors, + GetV1ExpensesResponses, + GetV1ExpensesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{id}', - ...options, - }); + >({ url: '/api/eor/v1/expenses', ...options }); /** - * Update an expense + * Create expense * - * Updates an expense + * Creates an **approved** expense * * ## Scopes * @@ -5734,19 +6271,15 @@ export const getShowExpense = ( * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const patchUpdateExpense2 = ( - options: Options, +export const postV1Expenses = ( + options: Options, ) => - (options.client ?? client).patch< - PatchUpdateExpense2Responses, - PatchUpdateExpense2Errors, + (options.client ?? client).post< + PostV1ExpensesResponses, + PostV1ExpensesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{id}', + url: '/api/eor/v1/expenses', ...options, headers: { 'Content-Type': 'application/json', @@ -5755,94 +6288,85 @@ export const patchUpdateExpense2 = ( }); /** - * Update an expense + * List payslip files for the authenticated employee * - * Updates an expense + * Returns a paginated list of payslip files belonging to the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const patchUpdateExpense = ( - options: Options, +export const getV1EmployeePayslipFiles = ( + options?: Options, ) => - (options.client ?? client).put< - PatchUpdateExpenseResponses, - PatchUpdateExpenseErrors, + (options?.client ?? client).get< + GetV1EmployeePayslipFilesResponses, + GetV1EmployeePayslipFilesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/employee/payslip-files', ...options }); /** - * Show Benefit Renewal Request + * Invite employment + * + * Invite an employment to start the self-enrollment. + * + * Requirements for the invitation to succeed: + * + * * Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details` + * * `provisional_start_date` must consider the minimum onboarding time of the employment's country + * + * If there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message. + * HTTP Status OK (200) is returned in case of success. + * + * In case of the following error message: + * `"Please reselect benefits - the previous selection is no longer available"` + * it means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema. + * + * In this case, reselect benefits by updating `contract_details` JSON Schema form. * - * Show Benefit Renewal Request details. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getShowBenefitRenewalRequest = < +export const postV1EmploymentsEmploymentIdInvite = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetShowBenefitRenewalRequestResponses, - GetShowBenefitRenewalRequestErrors, + (options.client ?? client).post< + PostV1EmploymentsEmploymentIdInviteResponses, + PostV1EmploymentsEmploymentIdInviteErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}/invite', ...options }); /** - * Updates a Benefit Renewal Request Response + * Create Probation Extension * - * Updates a Benefit Renewal Request with the given response. + * Create a probation extension request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | * */ -export const postUpdateBenefitRenewalRequest = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1ProbationExtensions = ( + options: Options, ) => (options.client ?? client).post< - PostUpdateBenefitRenewalRequestResponses, - PostUpdateBenefitRenewalRequestErrors, + PostV1ProbationExtensionsResponses, + PostV1ProbationExtensionsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}', + url: '/api/eor/v1/probation-extensions', ...options, headers: { 'Content-Type': 'application/json', @@ -5851,277 +6375,271 @@ export const postUpdateBenefitRenewalRequest = < }); /** - * Show onboarding steps for an employment - * - * Returns onboarding steps and substeps in a hierarchical, ordered structure. + * Approve Contract Amendment * - * ## Scopes + * Approves a contract amendment request without the intervention of a Remote admin. + * Approvals done via this endpoint are effective immediately, + * regardless of the effective date entered on the contract amendment creation. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const getShowEmploymentOnboardingSteps = < +export const putV1SandboxContractAmendmentsContractAmendmentRequestIdApprove = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetShowEmploymentOnboardingStepsResponses, - GetShowEmploymentOnboardingStepsErrors, + (options.client ?? client).put< + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/onboarding-steps', + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve', ...options, }); /** - * List company structure nodes + * Get Onboarding Reserves Status for Employment * - * Shows all the company structure nodes of an employment. + * Returns the onboarding reserves status for a specific employment. + * + * The status is the same as the credit risk status but takes the onboarding reserves policies into account. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View company structure (`company_structure:read`) | - | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getIndexEmploymentCompanyStructureNode = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetIndexEmploymentCompanyStructureNodeResponses, - GetIndexEmploymentCompanyStructureNodeErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/company-structure-nodes', - ...options, - }); +export const getV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatus = + ( + options: Options< + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status', + ...options, + }); /** - * List custom field value for an employment + * Show Contractor Invoice * - * Returns a list of custom field values for a given employment + * Shows a single Contractor Invoice record. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * + */ +export const getV1ContractorInvoicesId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1ContractorInvoicesIdResponses, + GetV1ContractorInvoicesIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/contractor-invoices/{id}', ...options }); + +/** + * Payroll Feature API resource * + * API to retrieve feature properties from the vendor system */ -export const getIndexEmploymentCustomFieldValue = < +export const getV1WdGphPayProcessingFeature = < ThrowOnError extends boolean = false, >( - options: Options, + options?: Options, +) => + (options?.client ?? client).get< + GetV1WdGphPayProcessingFeatureResponses, + GetV1WdGphPayProcessingFeatureErrors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payProcessingFeature', + ...options, + }); + +/** + * Payroll processing progress API resource + * + * API to retrieve the processing stages of a pay group + */ +export const getV1WdGphPayProgress = ( + options: Options, ) => (options.client ?? client).get< - GetIndexEmploymentCustomFieldValueResponses, - GetIndexEmploymentCustomFieldValueErrors, + GetV1WdGphPayProgressResponses, + GetV1WdGphPayProgressErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/custom-fields', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payProgress', ...options, }); /** - * Validate resignation request + * List company supported currencies * - * Validates a resignation employment request + * List company supported currencies * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage resignations (`resignation:write`) | + * | Manage company resources (`company_admin`) | View company currencies (`company_currencies:read`) | - | * */ -export const putValidateResignation = ( - options: Options, +export const getV1CompanyCurrencies = ( + options?: Options, ) => - (options.client ?? client).put< - PutValidateResignationResponses, - PutValidateResignationErrors, + (options?.client ?? client).get< + GetV1CompanyCurrenciesResponses, + GetV1CompanyCurrenciesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/resignations/{offboarding_request_id}/validate', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/company-currencies', ...options }); /** - * Reassign default legal entity + * Get a employment benefit offers JSON schema * - * Set a different legal entity as the company's default entity. + * ## Scopes * - * The default entity is used when creating new employments without an explicit entity. - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const putReassignDefaultEntityCompany = < +export const getV1EmploymentsEmploymentIdBenefitOffersSchema = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1EmploymentsEmploymentIdBenefitOffersSchemaData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PutReassignDefaultEntityCompanyResponses, - PutReassignDefaultEntityCompanyErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}', + url: '/api/eor/v1/employments/{employment_id}/benefit-offers/schema', ...options, }); /** - * List Webhook Callbacks + * List Contractor Invoice Schedules * - * List callbacks for a given company + * Lists Contractor Invoice Schedule records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | + * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const getIndexWebhookCallback = ( - options: Options, +export const getV1ContractorInvoiceSchedules = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => - (options.client ?? client).get< - GetIndexWebhookCallbackResponses, - GetIndexWebhookCallbackErrors, + (options?.client ?? client).get< + GetV1ContractorInvoiceSchedulesResponses, + GetV1ContractorInvoiceSchedulesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/webhook-callbacks', - ...options, - }); + >({ url: '/api/eor/v1/contractor-invoice-schedules', ...options }); /** - * Show contractor eligibility and COR-supported countries for legal entity + * Create Contractor Invoice Schedules * - * Returns which contractor products (standard, plus, cor) the legal entity is eligible to use, - * and the list of country codes where COR is supported for this legal entity. - * COR-supported countries exclude sanctioned and signup-prevented countries and apply entity rules (same-country, local-to-local). - * When the legal entity is not COR-eligible, `cor_supported_country_codes` is an empty list. + * Creates many invoice schedules records. + * It's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const getContractorEligibilityCompanyLegalEntities = < +export const postV1ContractorInvoiceSchedules = < ThrowOnError extends boolean = false, >( - options: Options< - GetContractorEligibilityCompanyLegalEntitiesData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetContractorEligibilityCompanyLegalEntitiesResponses, - GetContractorEligibilityCompanyLegalEntitiesErrors, + (options.client ?? client).post< + PostV1ContractorInvoiceSchedulesResponses, + PostV1ContractorInvoiceSchedulesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility', + url: '/api/eor/v1/contractor-invoice-schedules', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show a custom field value + * Show work authorization request * - * Returns a custom field value for a given employment + * Show a single work authorization request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | + * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | * */ -export const getShowEmploymentCustomFieldValue = < +export const getV1WorkAuthorizationRequestsId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetShowEmploymentCustomFieldValueResponses, - GetShowEmploymentCustomFieldValueErrors, + GetV1WorkAuthorizationRequestsIdResponses, + GetV1WorkAuthorizationRequestsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/work-authorization-requests/{id}', ...options }); /** - * Update a Custom Field Value + * Update work authorization request * - * Updates a custom field value for a given employment. + * Updates a work authorization request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | + * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | * */ -export const patchUpdateEmploymentCustomFieldValue2 = < +export const patchV1WorkAuthorizationRequestsId2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).patch< - PatchUpdateEmploymentCustomFieldValue2Responses, - PatchUpdateEmploymentCustomFieldValue2Errors, + PatchV1WorkAuthorizationRequestsId2Responses, + PatchV1WorkAuthorizationRequestsId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/api/eor/v1/work-authorization-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -6130,32 +6648,28 @@ export const patchUpdateEmploymentCustomFieldValue2 = < }); /** - * Update a Custom Field Value + * Update work authorization request * - * Updates a custom field value for a given employment. + * Updates a work authorization request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | + * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | * */ -export const patchUpdateEmploymentCustomFieldValue = < +export const patchV1WorkAuthorizationRequestsId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).put< - PatchUpdateEmploymentCustomFieldValueResponses, - PatchUpdateEmploymentCustomFieldValueErrors, + PatchV1WorkAuthorizationRequestsIdResponses, + PatchV1WorkAuthorizationRequestsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/api/eor/v1/work-authorization-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -6164,220 +6678,195 @@ export const patchUpdateEmploymentCustomFieldValue = < }); /** - * Show a contractor of record (COR) termination request - * - * Retrieves a Contractor of Record termination request by ID. + * Decline Time Off * + * Decline a time off request. Please note that only time off requests on the `requested` status can be declined. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getShowCorTerminationRequestSubscription = < +export const postV1TimeoffTimeoffIdDecline = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetShowCorTerminationRequestSubscriptionResponses, - GetShowCorTerminationRequestSubscriptionErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdDeclineResponses, + PostV1TimeoffTimeoffIdDeclineErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}', + url: '/api/eor/v1/timeoff/{timeoff_id}/decline', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Terminate contractor of record employment + * Get eligibility questionnaire schema * - * **Deprecated.** Use `POST /contractors/employments/{employment_id}/cor-termination-requests` instead. + * Returns the JSON schema for the eligibility questionnaire by type. * - * Initiates a termination request for a Contractor of Record employment. - * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. - * Currently, only Contractor of Record employments can be terminated. + * The schema defines the structure and validation rules for the questionnaire responses. + * Supports versioning to allow for schema evolution while maintaining backwards compatibility. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | - * + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * - * @deprecated */ -export const postTerminateContractorOfRecordEmploymentSubscription = < +export const getV1ContractorsSchemasEligibilityQuestionnaire = < ThrowOnError extends boolean = false, >( options: Options< - PostTerminateContractorOfRecordEmploymentSubscriptionData, + GetV1ContractorsSchemasEligibilityQuestionnaireData, ThrowOnError >, ) => - (options.client ?? client).post< - PostTerminateContractorOfRecordEmploymentSubscriptionResponses, - PostTerminateContractorOfRecordEmploymentSubscriptionErrors, + (options.client ?? client).get< + GetV1ContractorsSchemasEligibilityQuestionnaireResponses, + GetV1ContractorsSchemasEligibilityQuestionnaireErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/terminate-cor-employment', + url: '/api/eor/v1/contractors/schemas/eligibility-questionnaire', ...options, }); /** - * Sign a document for a contractor - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | + * Token * + * Endpoint to exchange tokens in the Authorization Code, Assertion Flow, Client Credentials and Refresh Token flows */ -export const postSignContractDocument = ( - options: Options, +export const postAuthOauth2Token = ( + options?: Options, ) => - (options.client ?? client).post< - PostSignContractDocumentResponses, - PostSignContractDocumentErrors, + (options?.client ?? client).post< + PostAuthOauth2TokenResponses, + PostAuthOauth2TokenErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign', + url: '/api/eor/oauth2/token', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Get token identity - * - * Shows information about the entities that can be controlled by the current auth token. - * - */ -export const getCurrentIdentity = ( - options: Options, -) => - (options.client ?? client).get< - GetCurrentIdentityResponses, - GetCurrentIdentityErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity/current', - ...options, - }); - -/** - * Delete an Incentive - * - * Delete an incentive. + * Delete contractor of record subscription intent * - * `one_time` incentives that have the following status **CANNOT** be deleted: - * * `processing` - * * `paid` + * Deletes Contractor of Record subscription intent. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const deleteDeleteIncentive = ( - options: Options, -) => - (options.client ?? client).delete< - DeleteDeleteIncentiveResponses, - DeleteDeleteIncentiveErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', - ...options, - }); +export const deleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = + ( + options: Options< + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + ThrowOnError + >, + ) => + (options.client ?? client).delete< + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + ...options, + }); /** - * Show Incentive + * Create contractor of record subscription intent + * + * Assigns Contractor of Record subscription in pending state to employment. + * Once risk analysis is performed, subscription may start upon contract signing, + * or might be denied. + * + * Requires a non-blocking eligibility questionnaire to be submitted before creating the subscription intent. * - * Show an Incentive's details * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getShowIncentive = ( - options: Options, -) => - (options.client ?? client).get< - GetShowIncentiveResponses, - GetShowIncentiveErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', - ...options, - }); +export const postV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = + ( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + ...options, + }); /** - * Update Incentive + * Update personal details * - * Updates an Incentive. + * Updates employment's personal details. * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * - * The API doesn't support updating paid incentives. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const patchUpdateIncentive2 = ( - options: Options, +export const putV2EmploymentsEmploymentIdPersonalDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdPersonalDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).patch< - PatchUpdateIncentive2Responses, - PatchUpdateIncentive2Errors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdPersonalDetailsResponses, + PutV2EmploymentsEmploymentIdPersonalDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', + url: '/api/eor/v2/employments/{employment_id}/personal_details', ...options, headers: { 'Content-Type': 'application/json', @@ -6386,35 +6875,34 @@ export const patchUpdateIncentive2 = ( }); /** - * Update Incentive - * - * Updates an Incentive. - * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * Find or create a pre-onboarding document for an employment * - * The API doesn't support updating paid incentives. + * Finds an existing unsigned pre-onboarding document for the given requirement, or creates a new one. + * Idempotent: repeated calls with the same `pre_onboarding_document_requirement_slug` return the same + * document until it is signed. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const patchUpdateIncentive = ( - options: Options, +export const postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocuments = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PatchUpdateIncentiveResponses, - PatchUpdateIncentiveErrors, + (options.client ?? client).post< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents', ...options, headers: { 'Content-Type': 'application/json', @@ -6423,396 +6911,270 @@ export const patchUpdateIncentive = ( }); /** - * Get eligibility questionnaire schema - * - * Returns the JSON schema for the eligibility questionnaire by type. - * - * The schema defines the structure and validation rules for the questionnaire responses. - * Supports versioning to allow for schema evolution while maintaining backwards compatibility. + * Show Contract Amendment * + * Show a single Contract Amendment request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | * */ -export const getShowEligibilityQuestionnaire = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1ContractAmendmentsId = ( + options: Options, ) => (options.client ?? client).get< - GetShowEligibilityQuestionnaireResponses, - GetShowEligibilityQuestionnaireErrors, + GetV1ContractAmendmentsIdResponses, + GetV1ContractAmendmentsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/schemas/eligibility-questionnaire', - ...options, - }); + >({ url: '/api/eor/v1/contract-amendments/{id}', ...options }); /** - * List work authorization requests + * Decline Identity Verification + * + * Declines the identity verification of an employee. * - * List work authorization requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | * */ -export const getIndexWorkAuthorizationRequest = < +export const postV1IdentityVerificationEmploymentIdDecline = < ThrowOnError extends boolean = false, >( - options?: Options, -) => - (options?.client ?? client).get< - GetIndexWorkAuthorizationRequestResponses, - GetIndexWorkAuthorizationRequestErrors, + options: Options< + PostV1IdentityVerificationEmploymentIdDeclineData, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests', - ...options, - }); - -/** - * Show bulk employment job - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | - * - */ -export const getShowBulkEmployment = ( - options: Options, + >, ) => - (options.client ?? client).get< - GetShowBulkEmploymentResponses, - GetShowBulkEmploymentErrors, + (options.client ?? client).post< + PostV1IdentityVerificationEmploymentIdDeclineResponses, + PostV1IdentityVerificationEmploymentIdDeclineErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/bulk-employment-jobs/{job_id}', + url: '/api/eor/v1/identity-verification/{employment_id}/decline', ...options, }); /** - * List Pay Items + * List expense categories for the authenticated employee * - * Lists pay items for a company with optional filtering by employment, date range, and pagination. + * Returns the flat list of expense categories applicable to the current employee. Only active categories are returned, filtered by the employee's country / legal-entity visibility rules. Leaf nodes have `is_selectable: true`; parent nodes are excluded unless `include_parents=true`. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const getIndexPayItems = ( - options?: Options, +export const getV1EmployeeExpenseCategories = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => (options?.client ?? client).get< - GetIndexPayItemsResponses, - GetIndexPayItemsErrors, + GetV1EmployeeExpenseCategoriesResponses, + GetV1EmployeeExpenseCategoriesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/pay-items', - ...options, - }); + >({ url: '/api/eor/v1/employee/expense-categories', ...options }); /** - * List Benefit Offers - * - * List benefit offers for each country. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * Creates a CSV cost estimation of employments * + * Creates CSV cost estimation of employments */ -export const getIndexBenefitOffersCountrySummary = < +export const postV1CostCalculatorEstimationCsv = < ThrowOnError extends boolean = false, >( - options: Options, + options?: Options, ) => - (options.client ?? client).get< - GetIndexBenefitOffersCountrySummaryResponses, - GetIndexBenefitOffersCountrySummaryErrors, + (options?.client ?? client).post< + PostV1CostCalculatorEstimationCsvResponses, + PostV1CostCalculatorEstimationCsvErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-offers/country-summaries', + url: '/api/eor/v1/cost-calculator/estimation-csv', ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, }); /** - * List Benefit Offers By Employment + * Retrieve a pre-onboarding document with its rendered PDF content * - * List benefit offers by employment. + * Returns the rendered contract PDF (base64-encoded) and the list of signatories for the given + * pre-onboarding document. The `content` field is prefixed with `data:application/pdf;base64,` so + * it can be embedded directly in a document viewer. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const getIndexBenefitOffersByEmployment = < +export const getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsId = < ThrowOnError extends boolean = false, >( - options: Options, -) => - (options.client ?? client).get< - GetIndexBenefitOffersByEmploymentResponses, - GetIndexBenefitOffersByEmploymentErrors, + options: Options< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-offers', - ...options, - }); - -/** - * Cancel Contract Amendment - * - * Use this endpoint to cancel an existing contract amendment request. - * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. - * - */ -export const putCancelContractAmendment = < - ThrowOnError extends boolean = false, ->( - options: Options, + >, ) => - (options.client ?? client).put< - PutCancelContractAmendmentResponses, - PutCancelContractAmendmentErrors, + (options.client ?? client).get< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel', + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}', ...options, }); /** - * Create a Pending Time Off + * List Billing Documents * - * Creates a pending Time Off record + * List billing documents for a company * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const postCreateEmployeeTimeoff = ( - options: Options, +export const getV1BillingDocuments = ( + options: Options, ) => - (options.client ?? client).post< - PostCreateEmployeeTimeoffResponses, - PostCreateEmployeeTimeoffErrors, + (options.client ?? client).get< + GetV1BillingDocumentsResponses, + GetV1BillingDocumentsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/billing-documents', ...options }); /** - * Show Probation Extension + * Show Billing Document * - * Shows a Probation Extension Request. + * Shows a billing document details. + * + * Please contact api-support@remote.com to request access to this endpoint. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const getShowProbationExtension = ( - options: Options, +export const getV1BillingDocumentsBillingDocumentId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetShowProbationExtensionResponses, - GetShowProbationExtensionErrors, + GetV1BillingDocumentsBillingDocumentIdResponses, + GetV1BillingDocumentsBillingDocumentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-extensions/{id}', - ...options, - }); + >({ url: '/api/eor/v1/billing-documents/{billing_document_id}', ...options }); /** - * List payslips - * - * Lists all payslips belonging to a company. Can also filter for a single employment belonging - * to that company. - * + * Indexes all the documents for the employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const getIndexPayslip = ( - options?: Options, +export const getV1EmployeeDocuments = ( + options?: Options, ) => (options?.client ?? client).get< - GetIndexPayslipResponses, - GetIndexPayslipErrors, + GetV1EmployeeDocumentsResponses, + GetV1EmployeeDocumentsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payslips', - ...options, - }); + >({ url: '/api/eor/v1/employee/documents', ...options }); /** - * Download a receipt by id + * List employee time offs * - * Download a receipt by id. + * Lists the current employee's time off records * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getDownloadByIdExpenseReceipt = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeeTimeoff = ( + options?: Options, ) => - (options.client ?? client).get< - GetDownloadByIdExpenseReceiptResponses, - GetDownloadByIdExpenseReceiptErrors, + (options?.client ?? client).get< + GetV1EmployeeTimeoffResponses, + GetV1EmployeeTimeoffErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{expense_id}/receipts/{receipt_id}', - ...options, - }); + >({ url: '/api/eor/v1/employee/timeoff', ...options }); /** - * Token + * Create a Pending Time Off + * + * Creates a pending Time Off record + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * - * Endpoint to exchange tokens in the Authorization Code, Assertion Flow, Client Credentials and Refresh Token flows */ -export const postTokenOAuth2Token = ( - options?: Options, +export const postV1EmployeeTimeoff = ( + options: Options, ) => - (options?.client ?? client).post< - PostTokenOAuth2TokenResponses, - PostTokenOAuth2TokenErrors, + (options.client ?? client).post< + PostV1EmployeeTimeoffResponses, + PostV1EmployeeTimeoffErrors, ThrowOnError >({ - security: [{ scheme: 'basic', type: 'http' }], - url: '/auth/oauth2/token', + url: '/api/eor/v1/employee/timeoff', ...options, headers: { 'Content-Type': 'application/json', - ...options?.headers, + ...options.headers, }, }); /** - * Show legal entity administrative details form schema - * - * Returns the json schema of a supported form. Possible form names are: - * ``` - * - administrative_details - * ``` + * Update personal details * - * Most forms require a company access token, as they are dependent on certain - * properties of companies and their current employments. + * Updates employment's personal details. * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. * - * ## Scopes + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * - */ -export const getShowLegalEntityFormCountry = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetShowLegalEntityFormCountryResponses, - GetShowLegalEntityFormCountryErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/legal_entity_forms/{form}', - ...options, - }); - -/** - * Manage contractor plus subscription + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * - * Endpoint that can be used to upgrade, assign or downgrade a contractor's subscription. - * This can be used when company admins desire to assign someone to the Contractor Plus plan, - * but also to change the contractor's subscription between Plus and Standard. * * * ## Scopes @@ -6822,24 +7184,20 @@ export const getShowLegalEntityFormCountry = < * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postManageContractorPlusSubscriptionSubscription = < +export const putV1EmploymentsEmploymentIdPersonalDetails = < ThrowOnError extends boolean = false, >( options: Options< - PostManageContractorPlusSubscriptionSubscriptionData, + PutV1EmploymentsEmploymentIdPersonalDetailsData, ThrowOnError >, ) => - (options.client ?? client).post< - PostManageContractorPlusSubscriptionSubscriptionResponses, - PostManageContractorPlusSubscriptionSubscriptionErrors, + (options.client ?? client).put< + PutV1EmploymentsEmploymentIdPersonalDetailsResponses, + PutV1EmploymentsEmploymentIdPersonalDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-plus-subscription', + url: '/api/eor/v1/employments/{employment_id}/personal_details', ...options, headers: { 'Content-Type': 'application/json', @@ -6848,255 +7206,237 @@ export const postManageContractorPlusSubscriptionSubscription = < }); /** - * List Time Off + * Show Probation Extension + * + * Shows a Probation Extension Request. * - * Lists all Time Off records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | * */ -export const getIndexTimeoff = ( - options: Options, +export const getV1ProbationExtensionsId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetIndexTimeoffResponses, - GetIndexTimeoffErrors, + GetV1ProbationExtensionsIdResponses, + GetV1ProbationExtensionsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff', - ...options, - }); + >({ url: '/api/eor/v1/probation-extensions/{id}', ...options }); /** - * Create Time Off + * Download file + * + * Downloads a file. * - * Creates a Time Off record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const postCreateTimeoff = ( - options: Options, +export const getV1FilesId = ( + options: Options, ) => - (options.client ?? client).post< - PostCreateTimeoffResponses, - PostCreateTimeoffErrors, + (options.client ?? client).get< + GetV1FilesIdResponses, + GetV1FilesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/files/{id}', ...options }); /** - * List Company Payroll Runs + * List Company Departments + * + * Lists all departments for the authorized company specified in the request. * - * Lists all payroll runs for a company * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | - * - */ -export const getIndexPayrollRun = ( - options?: Options, -) => - (options?.client ?? client).get< - GetIndexPayrollRunResponses, - GetIndexPayrollRunErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-runs', - ...options, - }); - -/** - * Get group by ID via SCIM v2.0 + * | Manage company resources (`company_admin`) | View departments (`company_department:read`) | Manage departments (`company_department:write`) | * - * Retrieves a single group (department) for the authenticated company by group ID */ -export const getGetGroupScim = ( - options: Options, +export const getV1CompanyDepartments = ( + options: Options, ) => (options.client ?? client).get< - GetGetGroupScimResponses, - GetGetGroupScimErrors, + GetV1CompanyDepartmentsResponses, + GetV1CompanyDepartmentsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Groups/{id}', - ...options, - }); + >({ url: '/api/eor/v1/company-departments', ...options }); /** - * List Employment Contract. + * Create New Department * - * Get the employment contract history for a given employment. If `only_active` is true, it will return only the active or last active contract. + * Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points). * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contracts (`contract:read`) | - | + * | Manage company resources (`company_admin`) | - | Manage departments (`company_department:write`) | * */ -export const getIndexEmploymentContract = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1CompanyDepartments = ( + options: Options, ) => - (options.client ?? client).get< - GetIndexEmploymentContractResponses, - GetIndexEmploymentContractErrors, + (options.client ?? client).post< + PostV1CompanyDepartmentsResponses, + PostV1CompanyDepartmentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employment-contracts', + url: '/api/eor/v1/company-departments', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Convert currency using dynamic rates + * Get Employee Details for a Payroll Run * - * Convert currency using the rates Remote applies during employment creation and invoicing. + * Gets the employee details for a payroll run * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | + * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | * */ -export const postConvertWithSpreadCurrencyConverter2 = < +export const getV1PayrollRunsPayrollRunIdEmployeeDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1PayrollRunsPayrollRunIdEmployeeDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostConvertWithSpreadCurrencyConverter2Responses, - PostConvertWithSpreadCurrencyConverter2Errors, + (options.client ?? client).get< + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/currency-converter', + url: '/api/eor/v1/payroll-runs/{payroll_run_id}/employee-details', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * List all companies + * Show employment + * + * Shows all the information of an employment. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * * - * List all companies that authorized your integration to act on their behalf. In other words, these are all the companies that your integration can manage. Any company that has completed the authorization flow for your integration will be included in the response. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getIndexCompany = ( - options: Options, +export const getV1EmploymentsEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetIndexCompanyResponses, - GetIndexCompanyErrors, + GetV1EmploymentsEmploymentIdResponses, + GetV1EmploymentsEmploymentIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}', ...options }); /** - * Create a company + * Update employment * - * Creates a new company. + * Updates an employment. * - * ### Creating a company with only the required request body parameters - * When you call this endpoint and omit all the optional parameters in the request body, - * the following resources get created upon a successful response: - * * A new company with status `pending`. - * * A company owner for the new company with status `initiated`. + * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. * - * See the [update a company endpoint](#tag/Companies/operation/patch_update_company) for - * more details on how to get your company and its owner to `active` status. + * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. * - * If you'd like to create a company and its owner with `active` status in a single request, - * please provide the optional `address_details` parameter as well. + * **For `invited` employments:** You can update the work_email. * - * ### Accepting the Terms of Service + * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. + * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. + * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. + * Currently, these amendments can only be done through the Remote UI. * - * A required step for creating a company in Remote is to accept our Terms of Service (ToS). + * It is possible to update the `external_id` of the employment for all employment statuses. * - * Company managers need to be aware of our Terms of Service and Privacy Policy, - * hence **it's the responsibility of our partners to advise and ensure company managers read - * and accept the ToS**. The terms have to be accepted only once, before creating a company, - * and the Remote API will collect the acceptance timestamp as its confirmation. + * ## Global Payroll Employees * - * To ensure users read the most recent version of Remote's Terms of Service, their **acceptance - * must be done within the last fifteen minutes prior the company creation action**. + * To update a Global Payment employment your input data must comply with the global payroll json schemas. * - * To retrieve this information, partners can provide an element with any text and a description - * explaining that by performing that action they are accepting Remote's Term of Service. For - * instance, the partner can add a checkbox or a "Create Remote Account" button followed by a - * description saying "By creating an account, you agree to - * [Remote's Terms of Service](https://remote.com/terms-of-service). Also see Remote's - * [Privacy Policy](https://remote.com/privacy-policy)". + * **For `active` employments:** In addition to the above list, you can update personal_details. + * + * ## Direct Employees + * + * To update an HRIS employment your input data must comply with the HRIS json schemas. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * + * + * Please contact Remote if you need to update contractors via API since it's currently not supported. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postCreateCompany = ( - options: Options, +export const patchV1EmploymentsEmploymentId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).post< - PostCreateCompanyResponses, - PostCreateCompanyErrors, + (options.client ?? client).patch< + PatchV1EmploymentsEmploymentId2Responses, + PatchV1EmploymentsEmploymentId2Errors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies', + url: '/api/eor/v1/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7105,9 +7445,52 @@ export const postCreateCompany = ( }); /** - * Create bulk employment job + * Update employment + * + * Updates an employment. + * + * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. + * + * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. + * + * **For `invited` employments:** You can update the work_email. + * + * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. + * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. + * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. + * Currently, these amendments can only be done through the Remote UI. + * + * It is possible to update the `external_id` of the employment for all employment statuses. + * + * ## Global Payroll Employees + * + * To update a Global Payment employment your input data must comply with the global payroll json schemas. + * + * **For `active` employments:** In addition to the above list, you can update personal_details. + * + * ## Direct Employees + * + * To update an HRIS employment your input data must comply with the HRIS json schemas. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * + * + * Please contact Remote if you need to update contractors via API since it's currently not supported. * - * Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country. * * ## Scopes * @@ -7116,224 +7499,200 @@ export const postCreateCompany = ( * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postCreateBulkEmployment = ( - options?: Options, +export const patchV1EmploymentsEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options?.client ?? client).post< - PostCreateBulkEmploymentResponses, - PostCreateBulkEmploymentErrors, + (options.client ?? client).put< + PatchV1EmploymentsEmploymentIdResponses, + PatchV1EmploymentsEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/bulk-employment-jobs', + url: '/api/eor/v1/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', - ...options?.headers, + ...options.headers, }, }); /** - * Send back a timesheet for review or modification + * List timesheets for the authenticated employee * - * Sends the given timesheet back to the employee for review or modification. + * Returns a paginated list of timesheets for the authenticated employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | * */ -export const postSendBackTimesheet = ( - options: Options, +export const getV1EmployeeTimesheets = ( + options?: Options, ) => - (options.client ?? client).post< - PostSendBackTimesheetResponses, - PostSendBackTimesheetErrors, + (options?.client ?? client).get< + GetV1EmployeeTimesheetsResponses, + GetV1EmployeeTimesheetsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets/{timesheet_id}/send-back', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/employee/timesheets', ...options }); /** - * Deletes a Company Manager user + * Show a custom field value * - * Deletes a Company Manager user + * Returns a custom field value for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | + * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | * */ -export const deleteDeleteCompanyManager = < +export const getV1CustomFieldsCustomFieldIdValuesEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + ThrowOnError + >, ) => - (options.client ?? client).delete< - DeleteDeleteCompanyManagerResponses, - DeleteDeleteCompanyManagerErrors, + (options.client ?? client).get< + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers/{user_id}', + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, }); /** - * Show company manager user + * Update a Custom Field Value * - * Shows a single company manager user + * Updates a custom field value for a given employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | + * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | * */ -export const getShowCompanyManager = ( - options: Options, +export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId2 = < + ThrowOnError extends boolean = false, +>( + options: Options< + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetShowCompanyManagerResponses, - GetShowCompanyManagerErrors, + (options.client ?? client).patch< + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers/{user_id}', + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Delete contractor of record subscription intent - * - * Deletes Contractor of Record subscription intent. + * Update a Custom Field Value * + * Updates a custom field value for a given employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | * */ -export const deleteDeleteContractorCorSubscriptionSubscription = < +export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId = < ThrowOnError extends boolean = false, >( options: Options< - DeleteDeleteContractorCorSubscriptionSubscriptionData, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData, ThrowOnError >, ) => - (options.client ?? client).delete< - DeleteDeleteContractorCorSubscriptionSubscriptionResponses, - DeleteDeleteContractorCorSubscriptionSubscriptionErrors, + (options.client ?? client).put< + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create contractor of record subscription intent - * - * Assigns Contractor of Record subscription in pending state to employment. - * Once risk analysis is performed, subscription may start upon contract signing, - * or might be denied. - * - * Requires a non-blocking eligibility questionnaire to be submitted before creating the subscription intent. + * Validate resignation request * + * Validates a resignation employment request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | - | Manage resignations (`resignation:write`) | * */ -export const postManageContractorCorSubscriptionSubscription = < +export const putV1ResignationsOffboardingRequestIdValidate = < ThrowOnError extends boolean = false, >( options: Options< - PostManageContractorCorSubscriptionSubscriptionData, + PutV1ResignationsOffboardingRequestIdValidateData, ThrowOnError >, ) => - (options.client ?? client).post< - PostManageContractorCorSubscriptionSubscriptionResponses, - PostManageContractorCorSubscriptionSubscriptionErrors, + (options.client ?? client).put< + PutV1ResignationsOffboardingRequestIdValidateResponses, + PutV1ResignationsOffboardingRequestIdValidateErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + url: '/api/eor/v1/resignations/{offboarding_request_id}/validate', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Contractor Invoice Schedules + * Show Contractor Invoice Schedule * - * Lists Contractor Invoice Schedule records. + * Shows a single Contractor Invoice Schedule record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const getIndexScheduledContractorInvoice = < +export const getV1ContractorInvoiceSchedulesId = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options, ) => - (options?.client ?? client).get< - GetIndexScheduledContractorInvoiceResponses, - GetIndexScheduledContractorInvoiceErrors, + (options.client ?? client).get< + GetV1ContractorInvoiceSchedulesIdResponses, + GetV1ContractorInvoiceSchedulesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules', - ...options, - }); + >({ url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options }); /** - * Create Contractor Invoice Schedules - * - * Creates many invoice schedules records. - * It's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted. + * Updates Contractor Invoice Schedule * + * Updates a contractor invoice schedule record * * ## Scopes * @@ -7342,21 +7701,17 @@ export const getIndexScheduledContractorInvoice = < * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const postBulkCreateScheduledContractorInvoice = < +export const patchV1ContractorInvoiceSchedulesId2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostBulkCreateScheduledContractorInvoiceResponses, - PostBulkCreateScheduledContractorInvoiceErrors, + (options.client ?? client).patch< + PatchV1ContractorInvoiceSchedulesId2Responses, + PatchV1ContractorInvoiceSchedulesId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules', + url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7365,51 +7720,40 @@ export const postBulkCreateScheduledContractorInvoice = < }); /** - * Get engagement agreement details + * Updates Contractor Invoice Schedule * - * Returns the engagement agreement details for an employment. + * Updates a contractor invoice schedule record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const getShowEmploymentEngagementAgreementDetails = < +export const patchV1ContractorInvoiceSchedulesId = < ThrowOnError extends boolean = false, >( - options: Options< - GetShowEmploymentEngagementAgreementDetailsData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetShowEmploymentEngagementAgreementDetailsResponses, - GetShowEmploymentEngagementAgreementDetailsErrors, + (options.client ?? client).put< + PatchV1ContractorInvoiceSchedulesIdResponses, + PatchV1ContractorInvoiceSchedulesIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/engagement-agreement-details', + url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Upsert engagement agreement details - * - * Creates or updates the engagement agreement details for an employment. - * - * This endpoint requires country-specific data. The exact required fields will vary depending on - * which country the employment is in. To see the list of parameters for each country, see the - * **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that compliance requirements for each country are subject to change according to local laws. - * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended - * to avoid compliance issues and to have the latest version of a country's requirements. + * Update pricing plan details * + * Updates the pricing plan for an employment. The frequency determines how often Remote bills the + * employer for management fees. Annual billing typically offers a discount. * * * ## Scopes @@ -7419,24 +7763,20 @@ export const getShowEmploymentEngagementAgreementDetails = < * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postUpdateEmploymentEngagementAgreementDetails = < +export const putV2EmploymentsEmploymentIdPricingPlanDetails = < ThrowOnError extends boolean = false, >( options: Options< - PostUpdateEmploymentEngagementAgreementDetailsData, + PutV2EmploymentsEmploymentIdPricingPlanDetailsData, ThrowOnError >, ) => - (options.client ?? client).post< - PostUpdateEmploymentEngagementAgreementDetailsResponses, - PostUpdateEmploymentEngagementAgreementDetailsErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses, + PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/engagement-agreement-details', + url: '/api/eor/v2/employments/{employment_id}/pricing_plan_details', ...options, headers: { 'Content-Type': 'application/json', @@ -7445,147 +7785,160 @@ export const postUpdateEmploymentEngagementAgreementDetails = < }); /** - * Get Billing Document Breakdown + * Create risk reserve * - * Get billing document breakdown + * Create a new risk reserve * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | * */ -export const getGetBreakdownBillingDocument = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1RiskReserve = ( + options: Options, ) => - (options.client ?? client).get< - GetGetBreakdownBillingDocumentResponses, - GetGetBreakdownBillingDocumentErrors, + (options.client ?? client).post< + PostV1RiskReserveResponses, + PostV1RiskReserveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents/{billing_document_id}/breakdown', + url: '/api/eor/v1/risk-reserve', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Indexes all the documents for the employee + * Update address details + * + * Updates employment's address details. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * + * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getIndexEmployeeDocument = ( - options?: Options, +export const putV2EmploymentsEmploymentIdAddressDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdAddressDetailsData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetIndexEmployeeDocumentResponses, - GetIndexEmployeeDocumentErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdAddressDetailsResponses, + PutV2EmploymentsEmploymentIdAddressDetailsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/documents', + url: '/api/eor/v2/employments/{employment_id}/address_details', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Approve a time off cancellation request - * - * Approve a time off cancellation request. - * In order to approve a time off cancellation request, the timeoff status must be `cancel_requested`. - * + * Return a base64 encoded version of the contract document * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const postApproveCancellationRequest = < +export const getV1ContractorsEmploymentsEmploymentIdContractDocumentsId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostApproveCancellationRequestResponses, - PostApproveCancellationRequestErrors, + (options.client ?? client).get< + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/cancel-request/approve', + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{id}', ...options, }); /** - * Verify Employment Identity + * Create a contractor of record (COR) termination request * - * Endpoint to confirms the employment profile is from the actual employee + * Initiates a termination request for a Contractor of Record employment. + * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. + * Currently, only Contractor of Record employments can be terminated. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postVerifyIdentityVerification = < +export const postV1ContractorsEmploymentsEmploymentIdCorTerminationRequests = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostVerifyIdentityVerificationResponses, - PostVerifyIdentityVerificationErrors, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity-verification/{employment_id}/verify', + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests', ...options, }); /** - * Download a billing document PDF + * List approved payslip files for the authenticated employee * - * Downloads a billing document PDF + * Returns a paginated list of payslip files belonging to the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const getDownloadPdfBillingDocument = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeePayslips = ( + options?: Options, ) => - (options.client ?? client).get< - GetDownloadPdfBillingDocumentResponses, - GetDownloadPdfBillingDocumentErrors, + (options?.client ?? client).get< + GetV1EmployeePayslipsResponses, + GetV1EmployeePayslipsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents/{billing_document_id}/pdf', - ...options, - }); + >({ url: '/api/eor/v1/employee/payslips', ...options }); diff --git a/src/client/types.gen.ts b/src/client/types.gen.ts index c21170963..0cd4d31f3 100644 --- a/src/client/types.gen.ts +++ b/src/client/types.gen.ts @@ -1,10 +1,7 @@ // This file is auto-generated by @hey-api/openapi-ts export type ClientOptions = { - baseUrl: - | 'https://gateway.remote.com/' - | 'https://gateway.remote-sandbox.com/' - | (string & {}); + baseUrl: string; }; /** @@ -54,6 +51,19 @@ export type CreateEmployeeTimeoffParams = { timezone: Timezone; }; +/** + * CreatePreOnboardingDocumentResponse + * + * Returns the slug of the found-or-created pre-onboarding document. + */ +export type CreatePreOnboardingDocumentResponse = { + data: { + pre_onboarding_document: { + id: UuidSlug; + }; + }; +}; + /** * CreateCurrencyCustomFieldDefinitionParams * @@ -425,6 +435,41 @@ export type CreateSsoConfigurationResponse = { data: CreateSsoConfigurationResult; }; +/** + * EmploymentAddressDetailsParams + * + * Employment address details params. + * + */ +export type EmploymentAddressDetailsParams = { + /** + * Home address information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `address_details` as path parameters. + * + */ + address_details: { + [key: string]: unknown; + }; +}; + +/** + * PayslipFile + * + * A single payslip file with its associated payroll run metadata. + */ +export type PayslipFile = { + currency?: PayslipFileCurrency; + id: UuidSlug; + /** + * Original filename of the payslip + */ + name: string; + net_salary?: PayslipFileNetSalary; + period_end?: string | null; + period_start?: string | null; +}; + /** * OfferedBenefitTier * @@ -1011,6 +1056,51 @@ export type CreateRiskReserveParams = { employment_slug: string; }; +/** + * PreOnboardingDocumentRequirement + * + * A pre-onboarding document requirement that must be fulfilled before an employee can be onboarded. + */ +export type PreOnboardingDocumentRequirement = { + /** + * The requirement that must be fulfilled before this one becomes available (if any). + */ + depends_on_requirement?: PreOnboardingDocumentRequirement | null; + /** + * Human-readable description of the requirement. + */ + description: string; + /** + * Timestamp when the customer acknowledged the constraints (if any). + */ + document_constraints_ack_at?: string | null; + /** + * Whether the employment data is frozen because a document for this requirement exists. + */ + freeze_employment_data?: boolean | null; + /** + * Human-readable name of the requirement. + */ + name: string; + /** + * Whether the customer must acknowledge the hiring constraints of the country before creating a document. + */ + needs_constraints_ack: boolean; + /** + * Email address to contact for help with redlining when supported. + */ + redlining_help_email?: string | null; + slug: UuidSlug; + /** + * Current status of this requirement for the given employment. + */ + status?: 'blocked' | 'awaiting_signatures' | 'finished' | 'revised'; + /** + * Whether the requirement supports redlining (collaborative editing) of the generated document. + */ + supports_redlining: boolean; +}; + /** * HolidaysResponse * @@ -1052,6 +1142,29 @@ export type BenefitOffersEmployment = { */ export type CurrencyCode = string | null; +/** + * ListEmployeePayslipsResponse + * + * Response schema listing many payslips + */ +export type ListEmployeePayslipsResponse = { + data?: { + /** + * The current page among all of the total_pages + */ + current_page?: number; + payslips?: Array; + /** + * The total number of records in the result + */ + total_count?: number; + /** + * The total number of pages the user can go through + */ + total_pages?: number; + }; +}; + /** * CompanyComplianceProfileResponse */ @@ -2333,6 +2446,34 @@ export type ContractorContractDocumentStatus = | 'awaiting_signatures' | 'finished'; +/** + * EmploymentV2UpdateParams + * + * Parameters for updating employment-level fields such as department, manager, work email, and external ID. + */ +export type EmploymentV2UpdateParams = { + /** + * The department of the employment. The department must belong to the same company as the employment. + * When set to `null`, the employment will be unassigned from a department. + * + */ + department_id?: string | null; + /** + * A unique reference code for the employment record in a non-Remote system. This optional field links to external data sources. If not provided, it defaults to `null`. While uniqueness is recommended, it is not strictly enforced within Remote's system. + */ + external_id?: string; + /** + * The user id of the manager, who should have an `admin`, `owner` or `people_manager` role. + * You can find these users by querying the [Company Managers endpoint](#operation/get_index_company_manager). + * + */ + manager_id?: string; + /** + * The work email of the employment. + */ + work_email?: string; +}; + /** * ContractDocumentResponse * @@ -2367,6 +2508,15 @@ export type ImportJobRow = { metadata?: { [key: string]: unknown; }; + row_error_details?: { + ambiguous?: Array<{ + amount: number | null; + effective_date: string | null; + end_date: string | null; + occurrence: string | null; + slug: string; + }>; + }; row_errors?: { [key: string]: unknown; }; @@ -3395,6 +3545,24 @@ export type UnprocessableEntityResponse = | Array; }; +/** + * EmploymentBillingAddressDetailsParams + * + * Employment billing address details params. + * + */ +export type EmploymentBillingAddressDetailsParams = { + /** + * Billing address information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `billing_address_details` as path parameters. + * + */ + billing_address_details: { + [key: string]: unknown; + }; +}; + /** * CountriesResponse * @@ -3696,6 +3864,10 @@ export type BulkEmploymentImportJob = { | 'candidate'; signup_source?: string | null; }; + legal_entity?: { + name?: string; + slug?: UuidSlug; + } | null; /** * The metadata for the import job */ @@ -3736,6 +3908,31 @@ export type BulkEmploymentImportJob = { updated_at: DateTime; }; +/** + * ShowPreOnboardingDocumentResponse + * + * Returns the rendered contract PDF (base64) and signatories for a pre-onboarding document. + */ +export type ShowPreOnboardingDocumentResponse = { + data: { + pre_onboarding_document: { + /** + * Base64-encoded PDF, prefixed with `data:application/pdf;base64,`. + */ + content: Blob | File; + /** + * File name of the rendered document. + */ + name: string; + /** + * Parties that must sign or have signed the document. + */ + signatories: Array; + status: ContractorContractDocumentStatus; + }; + }; +}; + /** * JSONSchema * @@ -4659,6 +4856,20 @@ export type ListLeavePoliciesSummaryResponse = { data: Array; }; +/** + * PayslipFileNetSalary + * + * Net salary amount including source/converted amounts, currencies and conversion rate. Shape produced by `Tiger.Billing.Value.Amount.build/1`. + */ +export type PayslipFileNetSalary = { + converted_amount?: number | null; + converter?: string | null; + fee?: Decimal; + rate?: Decimal; + source_amount?: number | null; + [key: string]: unknown; +} | null; + /** * ImportJobColumnMapping * @@ -5350,11 +5561,11 @@ export type ResourceErrorResponse = { * A machine-readable error code identifying the specific type of resource error. */ code?: - | 'parameter_invalid_date' | 'resource_not_eligible' | 'resource_already_exists' | 'action_unrecognized' | 'action_invalid' + | 'parameter_invalid_date' | 'resource_invalid_state' | 'parameter_value_invalid' | 'parameter_value_unknown' @@ -6292,6 +6503,14 @@ export type Signatory = { * Signature image as a data URI (e.g. `data:image/png;base64,...`), null if not yet signed */ signature?: string | null; + /** + * Signing method used by this signatory + */ + signature_method?: 'in_platform' | 'docusign'; + /** + * Legal signature level applied when signing + */ + signature_type?: 'standard' | 'qes' | 'aes' | 'ses'; /** * Timestamp when the signatory signed the document, null if not yet signed */ @@ -6473,6 +6692,82 @@ export type ContractAmendmentFormResponse = { }; }; +/** + * ParamsToCreateEmployeeExpense + * + * Params for creating an expense as the authenticated employee. + * + * The employment is implied by the access token, so `employment_id` is not accepted. + * `reviewer_id` and `reviewed_at` are also omitted ā€” they only apply to manager-created expenses. + * + * Category selection mirrors the company endpoint: use either `category` (legacy enum, deprecated but supported) + * or `expense_category_slug` (recommended). When both are provided, `expense_category_slug` wins. + * + */ +export type ParamsToCreateEmployeeExpense = { + /** + * The expense amount in the specified currency, in cents. + */ + amount: number; + /** + * Categories allowed for an expense (legacy, deprecated).
+ * Note: `coworking`, `home_office`, `phone_utilities`, `travel` are deprecated and will be removed in the future. + * + * + * @deprecated + */ + category?: + | 'car_rental' + | 'coworking_office' + | 'education_training' + | 'entertainment' + | 'flight' + | 'fuel' + | 'gifts' + | 'insurance' + | 'lodging' + | 'meals' + | 'other' + | 'parking_toll' + | 'subscription' + | 'tech_equipment' + | 'telecommunication' + | 'transport' + | 'utilities' + | 'vaccination_testing' + | 'visa' + | 'wellness' + | 'coworking' + | 'home_office' + | 'phone_utilities' + | 'travel'; + /** + * The three-letter code for the expense currency.
+ * Examples: `"USD"`, `"EUR"`, `"CAD"` + * + */ + currency: string; + /** + * Slug of the expense category from the hierarchical categories system (recommended). Takes precedence over legacy category field. + */ + expense_category_slug?: string | null; + /** + * Date of the purchase, which must be in the past + */ + expense_date: string; + receipt?: Base64File; + receipts?: Array; + /** + * The tax portion of the expense amount, in cents. Use 0 if no tax applies. + */ + tax_amount?: number; + timezone?: Timezone; + /** + * A short description of the expense (e.g., "New keyboard", "Team dinner"). + */ + title: string; +}; + /** * OnboardingTasks * @@ -8320,6 +8615,15 @@ export type IdentityCompany = { name: string; }; +/** + * IndexPreOnboardingDocumentRequirementsResponse + * + * List of pre-onboarding document requirements for an employment. + */ +export type IndexPreOnboardingDocumentRequirementsResponse = { + data: Array; +}; + /** * CreateGeneralCustomFieldDefinitionParams * @@ -8408,6 +8712,14 @@ export type ListSignatory = { * Full name of the signatory */ name?: string | null; + /** + * Signing method used by this signatory + */ + signature_method?: 'in_platform' | 'docusign'; + /** + * Legal signature level applied when signing + */ + signature_type?: 'standard' | 'qes' | 'aes' | 'ses'; /** * Timestamp when the signatory signed the document, null if not yet signed */ @@ -8589,6 +8901,29 @@ export type BadRequestResponse = }; }; +/** + * ListPayslipFilesResponse + * + * Response schema listing many payslip_files + */ +export type ListPayslipFilesResponse = { + data?: { + /** + * The current page among all of the total_pages + */ + current_page?: number; + payslip_files?: Array; + /** + * The total number of records in the result + */ + total_count?: number; + /** + * The total number of pages the user can go through + */ + total_pages?: number; + }; +}; + /** * ListEmploymentsResponse * @@ -8756,11 +9091,27 @@ export type PricingPlanDetails = { }; /** - * UpdateCompanyParams + * EmploymentPricingPlanDetailsParams + * + * Employment pricing plan details params. */ -export type UpdateCompanyParams = { +export type EmploymentPricingPlanDetailsParams = { /** - * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country). + * Pricing plan details information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `pricing_plan_details` as path parameters. + */ + pricing_plan_details: { + [key: string]: unknown; + }; +}; + +/** + * UpdateCompanyParams + */ +export type UpdateCompanyParams = { + /** + * Fields can vary depending on the country. Please, check the required fields structure using the [Show form schema endpoint](#operation/get_show_form_country). * Use the desired country and `address_details` as the form name for the placeholders. * The response complies with the [JSON Schema](https://developer.remote.com/docs/how-json-schemas-work) specification. * @@ -9795,6 +10146,24 @@ export type ProbationExtensionFile = { name: string; }; +/** + * EmploymentAdministrativeDetailsParams + * + * Employment administrative details params. + * + */ +export type EmploymentAdministrativeDetailsParams = { + /** + * Administrative information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `administrative_details` as path parameters. + * + */ + administrative_details: { + [key: string]: unknown; + }; +}; + /** * EmploymentBasicInformationParams * @@ -10201,6 +10570,24 @@ export type UpdateWebhookCallbackParams = { url?: string; }; +/** + * EmploymentBankAccountDetailsParams + * + * Employment bank account details params. + * + */ +export type EmploymentBankAccountDetailsParams = { + /** + * Bank account information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `bank_account_details` as path parameters. + * + */ + bank_account_details: { + [key: string]: unknown; + }; +}; + /** * EngagementAgreementDetailsResponse * @@ -10224,6 +10611,57 @@ export type EngagementAgreementDetailsResponse = { }; }; +/** + * PayslipItem + * + * A payslip with file, payslip, payroll run, and payroll output metadata. + */ +export type PayslipItem = { + /** + * File metadata + */ + file: { + inserted_at?: string; + name?: string; + slug?: UuidSlug; + }; + has_employee_payroll_overviews: boolean; + /** + * Payroll output breakdown + */ + payroll_output?: { + [key: string]: unknown; + } | null; + /** + * Payroll run metadata + */ + payroll_run?: { + expected_payout_date?: string | null; + period_end?: string; + period_start?: string; + type?: string; + } | null; + /** + * Payslip data + */ + payslip: { + /** + * Active compensation at the time of the payslip + */ + active_compensation?: { + [key: string]: unknown; + } | null; + has_content_layout?: boolean; + /** + * Net salary amount + */ + net_salary?: { + [key: string]: unknown; + } | null; + slug?: UuidSlug; + }; +}; + /** * TimeoffType */ @@ -10312,6 +10750,17 @@ export type ProbationExtensionResponse = { */ export type Decimal = string; +/** + * PayslipFileCurrency + */ +export type PayslipFileCurrency = { + code: CurrencyCode; + /** + * The currency symbol + */ + symbol: string; +} | null; + /** * ListEmploymentContractResponse */ @@ -10514,6 +10963,24 @@ export type SalaryDecreaseDetails = { was_employee_informed?: string; } | null; +/** + * EmploymentContractDetailsParams + * + * Employment contract details params. + * + */ +export type EmploymentContractDetailsParams = { + /** + * Contract information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `contract_details` as path parameters. + * + */ + contract_details: { + [key: string]: unknown; + }; +}; + /** * JSONSchemaResponse * @@ -10918,6 +11385,23 @@ export type BenefitRenewalRequestsCreateBenefitRenewalRequestResponse = { }; }; +/** + * EmploymentEmergencyContactParams + * + * Employment emergency contact params. + */ +export type EmploymentEmergencyContactParams = { + /** + * Emergency contact information. As its properties may vary depending on the country, + * you must query the [Show form schema](#tag/Countries/operation/get_show_form_country) endpoint + * passing the country code and `emergency_contact_details` as path parameters. + * + */ + emergency_contact_details: { + [key: string]: unknown; + }; +}; + /** * ContractorInvoiceScheduleItem * @@ -11416,6 +11900,19 @@ export type BillingDocumentAmountItem = { */ export type EmploymentId = string; +/** + * FindOrCreatePreOnboardingDocumentParams + * + * Parameters to find an existing unsigned pre-onboarding document or create a new one. + */ +export type FindOrCreatePreOnboardingDocumentParams = { + /** + * Timestamp when the customer acknowledged the hiring constraints. Required when the requirement has `needs_constraints_ack: true`. + */ + constraints_ack_at?: string | null; + pre_onboarding_document_requirement_slug: UuidSlug; +}; + /** * ContractAmendmentResponse * @@ -11473,37 +11970,22 @@ export type ContractorInvoiceScheduleCreateResponseSuccess = { start_date: string; }; -export type GetIndexOffboardingData = { - body?: never; - path?: never; - query?: { - /** - * Filter by Employment ID - */ - employment_id?: string; - /** - * Filter by offboarding type - */ - type?: string; - /** - * By default, the results do not include confidential termination requests. - * Send `include_confidential=true` to include confidential requests in the response. - * - */ - include_confidential?: string; - /** - * Starts fetching records after the given page - */ - page?: number; +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsData = { + /** + * Employment administrative details params + */ + body?: EmploymentAdministrativeDetailsParams; + path: { /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/offboardings'; + query?: never; + url: '/api/eor/v2/employments/{employment_id}/administrative_details'; }; -export type GetIndexOffboardingErrors = { +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors = { /** * Bad Request */ @@ -11512,52 +11994,62 @@ export type GetIndexOffboardingErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetIndexOffboardingError = - GetIndexOffboardingErrors[keyof GetIndexOffboardingErrors]; +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsError = + PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors[keyof PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors]; -export type GetIndexOffboardingResponses = { +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses = { /** * Success */ - 200: ListOffboardingResponse; + 200: EmploymentResponse; }; -export type GetIndexOffboardingResponse = - GetIndexOffboardingResponses[keyof GetIndexOffboardingResponses]; +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsResponse = + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses[keyof PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses]; -export type PostCreateOffboardingData = { - /** - * Offboarding - */ - body?: CreateOffboardingParams; - path?: never; +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/offboardings'; + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details'; }; -export type PostCreateOffboardingErrors = { +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** * Not Found */ @@ -11567,148 +12059,171 @@ export type PostCreateOffboardingErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; - /** - * Internal Server Error - */ - 500: RequestError; }; -export type PostCreateOffboardingError = - PostCreateOffboardingErrors[keyof PostCreateOffboardingErrors]; +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsError = + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type PostCreateOffboardingResponses = { +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 201: OffboardingResponse; + 200: EmploymentEngagementAgreementDetailsResponse; }; -export type PostCreateOffboardingResponse = - PostCreateOffboardingResponses[keyof PostCreateOffboardingResponses]; +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type GetShowTimesheetData = { - body?: never; +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { + /** + * Employment engagement agreement details params + */ + body?: EmploymentEngagementAgreementDetailsParams; path: { /** - * Timesheet ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/timesheets/{id}'; + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details'; }; -export type GetShowTimesheetErrors = { +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowTimesheetError = - GetShowTimesheetErrors[keyof GetShowTimesheetErrors]; +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsError = + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type GetShowTimesheetResponses = { +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 200: TimesheetResponse; + 200: SuccessResponse; }; -export type GetShowTimesheetResponse = - GetShowTimesheetResponses[keyof GetShowTimesheetResponses]; +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type PostUpdateCancelOnboardingData = { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Whether the request should be performed async - * - */ - async?: boolean; - }; - url: '/v1/cancel-onboarding/{employment_id}'; +export type PostV1CurrencyConverterEffective2Data = { + /** + * Convert currency parameters + */ + body: ConvertCurrencyParams; + path?: never; + query?: never; + url: '/api/eor/v1/currency-converter'; }; -export type PostUpdateCancelOnboardingErrors = { +export type PostV1CurrencyConverterEffective2Errors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PostUpdateCancelOnboardingError = - PostUpdateCancelOnboardingErrors[keyof PostUpdateCancelOnboardingErrors]; +export type PostV1CurrencyConverterEffective2Error = + PostV1CurrencyConverterEffective2Errors[keyof PostV1CurrencyConverterEffective2Errors]; -export type PostUpdateCancelOnboardingResponses = { +export type PostV1CurrencyConverterEffective2Responses = { /** * Success */ - 200: SuccessResponse; + 200: ConvertCurrencyResponse; }; -export type PostUpdateCancelOnboardingResponse = - PostUpdateCancelOnboardingResponses[keyof PostUpdateCancelOnboardingResponses]; +export type PostV1CurrencyConverterEffective2Response = + PostV1CurrencyConverterEffective2Responses[keyof PostV1CurrencyConverterEffective2Responses]; -export type GetShowContractAmendmentSchemaData = { - body?: never; - headers: { +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-subscriptions'; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Unauthorized */ - Authorization: string; - }; - path?: never; - query: { + 401: UnauthorizedResponse; /** - * The ID of the employment concerned by the contract amendment request. + * Forbidden */ - employment_id: string; - /** - * Country code according to ISO 3-digit alphabetic codes. - */ - country_code: string; + 403: ForbiddenResponse; /** - * Name of the desired form + * Not Found */ - form?: 'contract_amendment'; + 404: NotFoundResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsError = + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors]; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses = + { /** - * Version of the form schema + * Success */ - json_schema_version?: number | 'latest'; + 200: ContractorSubscriptionSummariesResponse; }; - url: '/v1/contract-amendments/schema'; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponse = + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses]; + +export type PostV1CurrencyConverterRawData = { + /** + * Convert currency parameters + */ + body: ConvertCurrencyParams; + path?: never; + query?: never; + url: '/api/eor/v1/currency-converter/raw'; }; -export type GetShowContractAmendmentSchemaErrors = { +export type PostV1CurrencyConverterRawErrors = { /** * Unauthorized */ @@ -11723,73 +12238,112 @@ export type GetShowContractAmendmentSchemaErrors = { 422: UnprocessableEntityResponse; }; -export type GetShowContractAmendmentSchemaError = - GetShowContractAmendmentSchemaErrors[keyof GetShowContractAmendmentSchemaErrors]; +export type PostV1CurrencyConverterRawError = + PostV1CurrencyConverterRawErrors[keyof PostV1CurrencyConverterRawErrors]; -export type GetShowContractAmendmentSchemaResponses = { +export type PostV1CurrencyConverterRawResponses = { /** * Success */ - 200: ContractAmendmentFormResponse; + 200: ConvertCurrencyResponse; }; -export type GetShowContractAmendmentSchemaResponse = - GetShowContractAmendmentSchemaResponses[keyof GetShowContractAmendmentSchemaResponses]; +export type PostV1CurrencyConverterRawResponse = + PostV1CurrencyConverterRawResponses[keyof PostV1CurrencyConverterRawResponses]; -export type PostBulkCreatePayItemsData = { - /** - * Pay Items - */ - body: BulkCreatePayItemsParams; +export type GetV1IncentivesData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; - query?: never; - url: '/v1/pay-items/bulk'; + query?: { + /** + * Filter by Employment ID + */ + employment_id?: string; + /** + * Filter by Incentive status + */ + status?: string; + /** + * Filter by Recurring Incentive id + */ + recurring_incentive_id?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; + }; + url: '/api/eor/v1/incentives'; }; -export type PostBulkCreatePayItemsErrors = { +export type GetV1IncentivesErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostBulkCreatePayItemsError = - PostBulkCreatePayItemsErrors[keyof PostBulkCreatePayItemsErrors]; +export type GetV1IncentivesError = + GetV1IncentivesErrors[keyof GetV1IncentivesErrors]; -export type PostBulkCreatePayItemsResponses = { +export type GetV1IncentivesResponses = { /** * Success */ - 200: BulkCreatePayItemsResponse; + 200: ListIncentivesResponse; }; -export type PostBulkCreatePayItemsResponse = - PostBulkCreatePayItemsResponses[keyof PostBulkCreatePayItemsResponses]; +export type GetV1IncentivesResponse = + GetV1IncentivesResponses[keyof GetV1IncentivesResponses]; -export type GetIndexDataSyncData = { - body?: never; +export type PostV1IncentivesData = { + /** + * Incentive + */ + body?: CreateOneTimeIncentiveParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; query?: never; - url: '/v1/data-sync'; + url: '/api/eor/v1/incentives'; }; -export type GetIndexDataSyncErrors = { +export type PostV1IncentivesErrors = { /** * Bad Request */ @@ -11799,139 +12353,133 @@ export type GetIndexDataSyncErrors = { */ 401: UnauthorizedResponse; /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetIndexDataSyncError = - GetIndexDataSyncErrors[keyof GetIndexDataSyncErrors]; +export type PostV1IncentivesError = + PostV1IncentivesErrors[keyof PostV1IncentivesErrors]; -export type GetIndexDataSyncResponses = { +export type PostV1IncentivesResponses = { /** * Success */ - 200: ListDataSyncEventsResponse; + 201: IncentiveResponse; }; -export type GetIndexDataSyncResponse = - GetIndexDataSyncResponses[keyof GetIndexDataSyncResponses]; +export type PostV1IncentivesResponse = + PostV1IncentivesResponses[keyof PostV1IncentivesResponses]; -export type PostCreateDataSyncData = { - /** - * DataSync - */ - body: CreateDataSyncParams; +export type GetV1BenefitOffersData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; query?: never; - url: '/v1/data-sync'; + url: '/api/eor/v1/benefit-offers'; }; -export type PostCreateDataSyncErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict - */ - 409: ConflictErrorResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; +export type GetV1BenefitOffersErrors = { /** - * Unprocessable Entity + * Not Found */ - 429: TooManyRequestsResponse; + 404: NotFoundResponse; }; -export type PostCreateDataSyncError = - PostCreateDataSyncErrors[keyof PostCreateDataSyncErrors]; +export type GetV1BenefitOffersError = + GetV1BenefitOffersErrors[keyof GetV1BenefitOffersErrors]; -export type PostCreateDataSyncResponses = { +export type GetV1BenefitOffersResponses = { /** - * Accepted + * Success */ - 202: unknown; + 200: BenefitOfferByEmploymentResponse; }; -export type GetIndexCompanyPricingPlanData = { - body?: never; - path: { +export type GetV1BenefitOffersResponse = + GetV1BenefitOffersResponses[keyof GetV1BenefitOffersResponses]; + +export type PostV1ReadyData = { + /** + * Employment slug + */ + body?: CompleteOnboarding; + headers: { /** - * Company ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - company_id: UuidSlug; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/companies/{company_id}/pricing-plans'; + url: '/api/eor/v1/ready'; }; -export type GetIndexCompanyPricingPlanErrors = { +export type PostV1ReadyErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexCompanyPricingPlanError = - GetIndexCompanyPricingPlanErrors[keyof GetIndexCompanyPricingPlanErrors]; +export type PostV1ReadyError = PostV1ReadyErrors[keyof PostV1ReadyErrors]; -export type GetIndexCompanyPricingPlanResponses = { +export type PostV1ReadyResponses = { /** * Success */ - 200: ListCompanyPricingPlansResponse; + 200: EmploymentResponse; }; -export type GetIndexCompanyPricingPlanResponse = - GetIndexCompanyPricingPlanResponses[keyof GetIndexCompanyPricingPlanResponses]; +export type PostV1ReadyResponse = + PostV1ReadyResponses[keyof PostV1ReadyResponses]; -export type PostCreateCompanyPricingPlanData = { +export type PostV1CostCalculatorEstimationData = { /** - * Create Pricing Plan parameters + * Estimate params */ - body: CreatePricingPlanParams; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - }; + body: CostCalculatorEstimateParams; + path?: never; query?: never; - url: '/v1/companies/{company_id}/pricing-plans'; + url: '/api/eor/v1/cost-calculator/estimation'; }; -export type PostCreateCompanyPricingPlanErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; +export type PostV1CostCalculatorEstimationErrors = { /** * Not Found */ @@ -11942,32 +12490,61 @@ export type PostCreateCompanyPricingPlanErrors = { 422: UnprocessableEntityResponse; }; -export type PostCreateCompanyPricingPlanError = - PostCreateCompanyPricingPlanErrors[keyof PostCreateCompanyPricingPlanErrors]; +export type PostV1CostCalculatorEstimationError = + PostV1CostCalculatorEstimationErrors[keyof PostV1CostCalculatorEstimationErrors]; -export type PostCreateCompanyPricingPlanResponses = { +export type PostV1CostCalculatorEstimationResponses = { /** * Success */ - 200: CreatePricingPlanResponse; + 200: CostCalculatorEstimateResponse; }; -export type PostCreateCompanyPricingPlanResponse = - PostCreateCompanyPricingPlanResponses[keyof PostCreateCompanyPricingPlanResponses]; +export type PostV1CostCalculatorEstimationResponse = + PostV1CostCalculatorEstimationResponses[keyof PostV1CostCalculatorEstimationResponses]; -export type GetShowProbationCompletionLetterData = { +export type GetV1IncentivesRecurringData = { body?: never; - path: { + headers: { /** - * probation completion letter ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; - query?: never; - url: '/v1/probation-completion-letter/{id}'; + path?: never; + query?: { + /** + * Filter by recurring incentive status: active or deactive. + */ + status?: string; + /** + * Filter by recurring incentive type. + */ + type?: string; + /** + * Filter by recurring incentives that contain the value in their notes. + */ + note?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; + }; + url: '/api/eor/v1/incentives/recurring'; }; -export type GetShowProbationCompletionLetterErrors = { +export type GetV1IncentivesRecurringErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -11980,42 +12557,53 @@ export type GetShowProbationCompletionLetterErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetShowProbationCompletionLetterError = - GetShowProbationCompletionLetterErrors[keyof GetShowProbationCompletionLetterErrors]; +export type GetV1IncentivesRecurringError = + GetV1IncentivesRecurringErrors[keyof GetV1IncentivesRecurringErrors]; -export type GetShowProbationCompletionLetterResponses = { +export type GetV1IncentivesRecurringResponses = { /** * Success */ - 200: ProbationCompletionLetterResponse; + 201: ListRecurringIncentivesResponse; }; -export type GetShowProbationCompletionLetterResponse = - GetShowProbationCompletionLetterResponses[keyof GetShowProbationCompletionLetterResponses]; +export type GetV1IncentivesRecurringResponse = + GetV1IncentivesRecurringResponses[keyof GetV1IncentivesRecurringResponses]; -export type GetShowContractorInvoiceData = { - body?: never; - path: { +export type PostV1IncentivesRecurringData = { + /** + * RecurringIncentive + */ + body?: CreateRecurringIncentiveParams; + headers: { /** - * Resource unique identifier + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: UuidSlug; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/contractor-invoices/{id}'; + url: '/api/eor/v1/incentives/recurring'; }; -export type GetShowContractorInvoiceErrors = { +export type PostV1IncentivesRecurringErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -12024,32 +12612,96 @@ export type GetShowContractorInvoiceErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetShowContractorInvoiceError = - GetShowContractorInvoiceErrors[keyof GetShowContractorInvoiceErrors]; +export type PostV1IncentivesRecurringError = + PostV1IncentivesRecurringErrors[keyof PostV1IncentivesRecurringErrors]; -export type GetShowContractorInvoiceResponses = { +export type PostV1IncentivesRecurringResponses = { /** * Success */ - 200: ContractorInvoiceResponse; + 201: RecurringIncentiveResponse; }; -export type GetShowContractorInvoiceResponse = - GetShowContractorInvoiceResponses[keyof GetShowContractorInvoiceResponses]; +export type PostV1IncentivesRecurringResponse = + PostV1IncentivesRecurringResponses[keyof PostV1IncentivesRecurringResponses]; + +export type GetV1TimesheetsData = { + body?: never; + path?: never; + query?: { + /** + * Filter timesheets by their status + */ + status?: TimesheetStatus; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'submitted_at'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/timesheets'; +}; -export type PostConvertRawCurrencyConverterData = { +export type GetV1TimesheetsErrors = { /** - * Convert currency parameters + * Unauthorized */ - body: ConvertCurrencyParams; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1TimesheetsError = + GetV1TimesheetsErrors[keyof GetV1TimesheetsErrors]; + +export type GetV1TimesheetsResponses = { + /** + * Success + */ + 200: ListTimesheetsResponse; +}; + +export type GetV1TimesheetsResponse = + GetV1TimesheetsResponses[keyof GetV1TimesheetsResponses]; + +export type PostV1TimesheetsData = { + /** + * Timesheet + */ + body?: CreateTimesheetParams; path?: never; query?: never; - url: '/v1/currency-converter/raw'; + url: '/api/eor/v1/timesheets'; }; -export type PostConvertRawCurrencyConverterErrors = { +export type PostV1TimesheetsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12064,45 +12716,32 @@ export type PostConvertRawCurrencyConverterErrors = { 422: UnprocessableEntityResponse; }; -export type PostConvertRawCurrencyConverterError = - PostConvertRawCurrencyConverterErrors[keyof PostConvertRawCurrencyConverterErrors]; +export type PostV1TimesheetsError = + PostV1TimesheetsErrors[keyof PostV1TimesheetsErrors]; -export type PostConvertRawCurrencyConverterResponses = { +export type PostV1TimesheetsResponses = { /** * Success */ - 200: ConvertCurrencyResponse; + 200: TimesheetResponse; }; -export type PostConvertRawCurrencyConverterResponse = - PostConvertRawCurrencyConverterResponses[keyof PostConvertRawCurrencyConverterResponses]; +export type PostV1TimesheetsResponse = + PostV1TimesheetsResponses[keyof PostV1TimesheetsResponses]; -export type GetShowContractorContractDetailsCountryData = { +export type PostV1TimesheetsTimesheetIdApproveData = { body?: never; path: { /** - * Country code according to ISO 3-digit alphabetic codes - */ - country_code: string; - }; - query?: { - /** - * Employment ID - */ - employment_id?: string; - /** - * Version of the form schema + * Timesheet ID */ - json_schema_version?: number | 'latest'; + timesheet_id: string; }; - url: '/v1/countries/{country_code}/contractor-contract-details'; + query?: never; + url: '/api/eor/v1/timesheets/{timesheet_id}/approve'; }; -export type GetShowContractorContractDetailsCountryErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1TimesheetsTimesheetIdApproveErrors = { /** * Unauthorized */ @@ -12115,80 +12754,37 @@ export type GetShowContractorContractDetailsCountryErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetShowContractorContractDetailsCountryError = - GetShowContractorContractDetailsCountryErrors[keyof GetShowContractorContractDetailsCountryErrors]; +export type PostV1TimesheetsTimesheetIdApproveError = + PostV1TimesheetsTimesheetIdApproveErrors[keyof PostV1TimesheetsTimesheetIdApproveErrors]; -export type GetShowContractorContractDetailsCountryResponses = { +export type PostV1TimesheetsTimesheetIdApproveResponses = { /** * Success */ - 200: ContractorContractDetailsResponse; + 200: MinimalTimesheetResponse; }; -export type GetShowContractorContractDetailsCountryResponse = - GetShowContractorContractDetailsCountryResponses[keyof GetShowContractorContractDetailsCountryResponses]; +export type PostV1TimesheetsTimesheetIdApproveResponse = + PostV1TimesheetsTimesheetIdApproveResponses[keyof PostV1TimesheetsTimesheetIdApproveResponses]; -export type GetIndexEmploymentData = { +export type GetV1DataSyncData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path?: never; - query?: { - /** - * Company ID - */ - company_id?: string; - /** - * Filters the results by employments whose login email matches the value - */ - email?: string; - /** - * Filters the results by employments whose status matches the value. - * Supports multiple values separated by commas. - * Also supports the value `incomplete` to get all employments that are not onboarded yet. - * - */ - status?: string; - /** - * Filters the results by employments whose employment product type matches the value - */ - employment_type?: string; - /** - * Filters the results by employments whose employment model matches the value. - * Possible values: `global_payroll`, `peo`, `eor` - * - */ - employment_model?: 'global_payroll' | 'peo' | 'eor'; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/employments'; + query?: never; + url: '/api/eor/v1/data-sync'; }; -export type GetIndexEmploymentErrors = { +export type GetV1DataSyncErrors = { /** * Bad Request */ 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ @@ -12207,44 +12803,29 @@ export type GetIndexEmploymentErrors = { 429: TooManyRequestsResponse; }; -export type GetIndexEmploymentError = - GetIndexEmploymentErrors[keyof GetIndexEmploymentErrors]; +export type GetV1DataSyncError = GetV1DataSyncErrors[keyof GetV1DataSyncErrors]; -export type GetIndexEmploymentResponses = { +export type GetV1DataSyncResponses = { /** * Success */ - 200: ListEmploymentsResponse; + 200: ListDataSyncEventsResponse; }; -export type GetIndexEmploymentResponse = - GetIndexEmploymentResponses[keyof GetIndexEmploymentResponses]; +export type GetV1DataSyncResponse = + GetV1DataSyncResponses[keyof GetV1DataSyncResponses]; -export type PostCreateEmployment2Data = { +export type PostV1DataSyncData = { /** - * Employment params + * DataSync */ - body?: EmploymentCreateParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body: CreateDataSyncParams; path?: never; - query?: { - /** - * Version of the form schema - */ - json_schema_version?: number | 'latest'; - }; - url: '/v1/employments'; + query?: never; + url: '/api/eor/v1/data-sync'; }; -export type PostCreateEmployment2Errors = { +export type PostV1DataSyncErrors = { /** * Bad Request */ @@ -12256,7 +12837,7 @@ export type PostCreateEmployment2Errors = { /** * Conflict */ - 409: ConflictResponse; + 409: ConflictErrorResponse; /** * Unprocessable Entity */ @@ -12267,148 +12848,110 @@ export type PostCreateEmployment2Errors = { 429: TooManyRequestsResponse; }; -export type PostCreateEmployment2Error = - PostCreateEmployment2Errors[keyof PostCreateEmployment2Errors]; +export type PostV1DataSyncError = + PostV1DataSyncErrors[keyof PostV1DataSyncErrors]; -export type PostCreateEmployment2Responses = { +export type PostV1DataSyncResponses = { /** - * Success + * Accepted */ - 200: EmploymentCreationResponse; + 202: unknown; }; -export type PostCreateEmployment2Response = - PostCreateEmployment2Responses[keyof PostCreateEmployment2Responses]; - -export type GetShowCompanyEmploymentOnboardingReservesStatusData = { +export type GetV1ProbationCompletionLetterIdData = { body?: never; path: { /** - * Company ID - */ - company_id: UuidSlug; - /** - * Employment ID + * probation completion letter ID */ - employment_id: UuidSlug; + id: string; }; query?: never; - url: '/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status'; + url: '/api/eor/v1/probation-completion-letter/{id}'; }; -export type GetShowCompanyEmploymentOnboardingReservesStatusErrors = { +export type GetV1ProbationCompletionLetterIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; -}; - -export type GetShowCompanyEmploymentOnboardingReservesStatusError = - GetShowCompanyEmploymentOnboardingReservesStatusErrors[keyof GetShowCompanyEmploymentOnboardingReservesStatusErrors]; - -export type GetShowCompanyEmploymentOnboardingReservesStatusResponses = { - /** - * Success - */ - 200: OnboardingReservesStatusResponse; -}; - -export type GetShowCompanyEmploymentOnboardingReservesStatusResponse = - GetShowCompanyEmploymentOnboardingReservesStatusResponses[keyof GetShowCompanyEmploymentOnboardingReservesStatusResponses]; - -export type GetShowHelpCenterArticleData = { - body?: never; - path: { - /** - * Help Center Article Zendesk ID - */ - id: number; - }; - query?: never; - url: '/v1/help-center-articles/{id}'; -}; - -export type GetShowHelpCenterArticleErrors = { /** - * Not Found + * Unprocessable Entity */ - 404: NotFoundResponse; + 422: UnprocessableEntityResponse; }; -export type GetShowHelpCenterArticleError = - GetShowHelpCenterArticleErrors[keyof GetShowHelpCenterArticleErrors]; +export type GetV1ProbationCompletionLetterIdError = + GetV1ProbationCompletionLetterIdErrors[keyof GetV1ProbationCompletionLetterIdErrors]; -export type GetShowHelpCenterArticleResponses = { +export type GetV1ProbationCompletionLetterIdResponses = { /** * Success */ - 200: HelpCenterArticleResponse; + 200: ProbationCompletionLetterResponse; }; -export type GetShowHelpCenterArticleResponse = - GetShowHelpCenterArticleResponses[keyof GetShowHelpCenterArticleResponses]; +export type GetV1ProbationCompletionLetterIdResponse = + GetV1ProbationCompletionLetterIdResponses[keyof GetV1ProbationCompletionLetterIdResponses]; -export type GetGetUserScimData = { +export type GetV1SsoConfigurationData = { body?: never; - path: { - /** - * User ID (slug) - */ - id: string; - }; + path?: never; query?: never; - url: '/v1/scim/v2/Users/{id}'; + url: '/api/eor/v1/sso-configuration'; }; -export type GetGetUserScimErrors = { +export type GetV1SsoConfigurationErrors = { /** - * Unauthorized + * Bad Request */ - 401: IntegrationsScimErrorResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** * Not Found */ - 404: IntegrationsScimErrorResponse; + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetGetUserScimError = - GetGetUserScimErrors[keyof GetGetUserScimErrors]; +export type GetV1SsoConfigurationError = + GetV1SsoConfigurationErrors[keyof GetV1SsoConfigurationErrors]; -export type GetGetUserScimResponses = { +export type GetV1SsoConfigurationResponses = { /** * Success */ - 200: IntegrationsScimUser; + 200: SsoConfigurationResponse; }; -export type GetGetUserScimResponse = - GetGetUserScimResponses[keyof GetGetUserScimResponses]; +export type GetV1SsoConfigurationResponse = + GetV1SsoConfigurationResponses[keyof GetV1SsoConfigurationResponses]; -export type GetShowEmployeeDocumentData = { - body?: never; - path: { - /** - * Document ID - */ - id: string; - }; +export type PostV1SsoConfigurationData = { + /** + * CreateSSOConfiguration + */ + body: CreateSsoConfigurationParams; + path?: never; query?: never; - url: '/v1/employee/documents/{id}'; + url: '/api/eor/v1/sso-configuration'; }; -export type GetShowEmployeeDocumentErrors = { +export type PostV1SsoConfigurationErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12417,98 +12960,72 @@ export type GetShowEmployeeDocumentErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowEmployeeDocumentError = - GetShowEmployeeDocumentErrors[keyof GetShowEmployeeDocumentErrors]; +export type PostV1SsoConfigurationError = + PostV1SsoConfigurationErrors[keyof PostV1SsoConfigurationErrors]; -export type GetShowEmployeeDocumentResponses = { +export type PostV1SsoConfigurationResponses = { /** - * Success + * Created */ - 200: DownloadDocumentResponse; + 201: CreateSsoConfigurationResponse; }; -export type GetShowEmployeeDocumentResponse = - GetShowEmployeeDocumentResponses[keyof GetShowEmployeeDocumentResponses]; +export type PostV1SsoConfigurationResponse = + PostV1SsoConfigurationResponses[keyof PostV1SsoConfigurationResponses]; -export type GetIndexContractorInvoiceData = { +export type GetV1OffboardingsData = { body?: never; path?: never; query?: { /** - * Filters contractor invoices by status matching the value. + * Filter by Employment ID */ - status?: ContractorInvoiceStatus; + employment_id?: string; /** - * Filters contractor invoices by invoice schedule ID matching the value. + * Filter by offboarding type */ - contractor_invoice_schedule_id?: UuidSlug; - /** - * Filters contractor invoices by date greater than or equal to the value. - */ - date_from?: Date; - /** - * Filters contractor invoices by date less than or equal to the value. - */ - date_to?: Date; - /** - * Filters contractor invoices by due date greater than or equal to the value. - */ - due_date_from?: Date; - /** - * Filters contractor invoices by due date less than or equal to the value. - */ - due_date_to?: Date; - /** - * Filters contractor invoices by approved date greater than or equal to the value. - */ - approved_date_from?: Date; - /** - * Filters contractor invoices by approved date less than or equal to the value. - */ - approved_date_to?: Date; - /** - * Filters contractor invoices by paid out date greater than or equal to the value. - */ - paid_out_date_from?: Date; - /** - * Filters contractor invoices by paid out date less than or equal to the value. - */ - paid_out_date_to?: Date; - /** - * Field to sort by - */ - sort_by?: 'date' | 'due_date' | 'approved_at' | 'paid_out_at'; + type?: string; /** - * Sort order + * By default, the results do not include confidential termination requests. + * Send `include_confidential=true` to include confidential requests in the response. + * */ - order?: 'asc' | 'desc'; + include_confidential?: string; /** * Starts fetching records after the given page */ page?: number; /** - * Number of items per page + * Change the amount of records returned per page, defaults to 20, limited to 100 */ page_size?: number; }; - url: '/v1/contractor-invoices'; + url: '/api/eor/v1/offboardings'; }; -export type GetIndexContractorInvoiceErrors = { +export type GetV1OffboardingsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -12517,60 +13034,36 @@ export type GetIndexContractorInvoiceErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; -}; - -export type GetIndexContractorInvoiceError = - GetIndexContractorInvoiceErrors[keyof GetIndexContractorInvoiceErrors]; - -export type GetIndexContractorInvoiceResponses = { /** - * Success + * Too many requests */ - 200: ListContractorInvoicesResponse; + 429: TooManyRequestsResponse; }; -export type GetIndexContractorInvoiceResponse = - GetIndexContractorInvoiceResponses[keyof GetIndexContractorInvoiceResponses]; - -export type PostReportErrorsTelemetryData = { - /** - * SDK Error Report - */ - body: SdkErrorPayload; - path?: never; - query?: never; - url: '/v1/sdk/telemetry-errors'; -}; +export type GetV1OffboardingsError = + GetV1OffboardingsErrors[keyof GetV1OffboardingsErrors]; -export type PostReportErrorsTelemetryErrors = { - /** - * Bad Request - */ - 400: ErrorResponse; +export type GetV1OffboardingsResponses = { /** - * Too Many Requests + * Success */ - 429: RateLimitResponse; + 200: ListOffboardingResponse; }; -export type PostReportErrorsTelemetryError = - PostReportErrorsTelemetryErrors[keyof PostReportErrorsTelemetryErrors]; +export type GetV1OffboardingsResponse = + GetV1OffboardingsResponses[keyof GetV1OffboardingsResponses]; -export type PostReportErrorsTelemetryResponses = { +export type PostV1OffboardingsData = { /** - * No Content + * Offboarding */ - 204: unknown; -}; - -export type GetDetailsSsoConfigurationData = { - body?: never; + body?: CreateOffboardingParams; path?: never; query?: never; - url: '/v1/sso-configuration/details'; + url: '/api/eor/v1/offboardings'; }; -export type GetDetailsSsoConfigurationErrors = { +export type PostV1OffboardingsErrors = { /** * Bad Request */ @@ -12586,77 +13079,46 @@ export type GetDetailsSsoConfigurationErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; -}; - -export type GetDetailsSsoConfigurationError = - GetDetailsSsoConfigurationErrors[keyof GetDetailsSsoConfigurationErrors]; - -export type GetDetailsSsoConfigurationResponses = { - /** - * Success - */ - 200: SsoConfigurationDetailsResponse; -}; - -export type GetDetailsSsoConfigurationResponse = - GetDetailsSsoConfigurationResponses[keyof GetDetailsSsoConfigurationResponses]; - -export type PostCreateEstimationData = { - /** - * Estimate params - */ - body: CostCalculatorEstimateParams; - path?: never; - query?: never; - url: '/v1/cost-calculator/estimation'; -}; - -export type PostCreateEstimationErrors = { + 422: UnprocessableEntityResponse; /** - * Not Found + * Too many requests */ - 404: NotFoundResponse; + 429: TooManyRequestsResponse; /** - * Unprocessable Entity + * Internal Server Error */ - 422: UnprocessableEntityResponse; + 500: RequestError; }; -export type PostCreateEstimationError = - PostCreateEstimationErrors[keyof PostCreateEstimationErrors]; +export type PostV1OffboardingsError = + PostV1OffboardingsErrors[keyof PostV1OffboardingsErrors]; -export type PostCreateEstimationResponses = { +export type PostV1OffboardingsResponses = { /** * Success */ - 200: CostCalculatorEstimateResponse; + 201: OffboardingResponse; }; -export type PostCreateEstimationResponse = - PostCreateEstimationResponses[keyof PostCreateEstimationResponses]; +export type PostV1OffboardingsResponse = + PostV1OffboardingsResponses[keyof PostV1OffboardingsResponses]; -export type GetShowCompanySchemaData = { - body?: never; - path?: never; - query: { - /** - * Country code according to ISO 3-digit alphabetic codes. - */ - country_code: string; - /** - * Name of the desired form - */ - form: 'address_details'; +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData = { + /** + * CreateContractDocumentParams + */ + body: CreateContractDocument; + path: { /** - * Version of the form schema + * Employment ID */ - json_schema_version?: number | 'latest'; + employment_id: string; }; - url: '/v1/companies/schema'; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents'; }; -export type GetShowCompanySchemaErrors = { +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors = { /** * Unauthorized */ @@ -12671,45 +13133,40 @@ export type GetShowCompanySchemaErrors = { 422: UnprocessableEntityResponse; }; -export type GetShowCompanySchemaError = - GetShowCompanySchemaErrors[keyof GetShowCompanySchemaErrors]; - -export type GetShowCompanySchemaResponses = { - /** - * Success - */ - 200: CompanyFormResponse; -}; - -export type GetShowCompanySchemaResponse = - GetShowCompanySchemaResponses[keyof GetShowCompanySchemaResponses]; +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsError = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors]; -export type GetIndexBenefitOfferData = { - body?: never; - path: { +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses = + { /** - * Unique identifier of the employment + * Success */ - employment_id: UuidSlug; + 200: CreateContractDocumentResponse; }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponse = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses]; + +export type PutV1EmploymentsEmploymentIdFederalTaxesData = { + /** + * Employment federal taxes params + */ + body?: EmploymentFederalTaxesParams; + path: { /** - * Number of items per page + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/employments/{employment_id}/benefit-offers'; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/federal-taxes'; }; -export type GetIndexBenefitOfferErrors = { +export type PutV1EmploymentsEmploymentIdFederalTaxesErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** * Forbidden */ @@ -12718,54 +13175,50 @@ export type GetIndexBenefitOfferErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexBenefitOfferError = - GetIndexBenefitOfferErrors[keyof GetIndexBenefitOfferErrors]; +export type PutV1EmploymentsEmploymentIdFederalTaxesError = + PutV1EmploymentsEmploymentIdFederalTaxesErrors[keyof PutV1EmploymentsEmploymentIdFederalTaxesErrors]; -export type GetIndexBenefitOfferResponses = { +export type PutV1EmploymentsEmploymentIdFederalTaxesResponses = { /** * Success */ - 200: EmploymentsBenefitOffersListBenefitOffers; + 200: SuccessResponse; }; -export type GetIndexBenefitOfferResponse = - GetIndexBenefitOfferResponses[keyof GetIndexBenefitOfferResponses]; +export type PutV1EmploymentsEmploymentIdFederalTaxesResponse = + PutV1EmploymentsEmploymentIdFederalTaxesResponses[keyof PutV1EmploymentsEmploymentIdFederalTaxesResponses]; -export type PutUpdateBenefitOfferData = { - /** - * Upsert employment benefit offers request - */ - body: UnifiedEmploymentUpsertBenefitOffersRequest; +export type GetV1CompaniesCompanyIdPricingPlansData = { + body?: never; path: { /** - * Unique identifier of the employment - */ - employment_id: UuidSlug; - }; - query?: { - /** - * Version of the form schema + * Company ID */ - json_schema_version?: number | 'latest'; + company_id: UuidSlug; }; - url: '/v1/employments/{employment_id}/benefit-offers'; + query?: never; + url: '/api/eor/v1/companies/{company_id}/pricing-plans'; }; -export type PutUpdateBenefitOfferErrors = { +export type GetV1CompaniesCompanyIdPricingPlansErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -12776,32 +13229,35 @@ export type PutUpdateBenefitOfferErrors = { 422: UnprocessableEntityResponse; }; -export type PutUpdateBenefitOfferError = - PutUpdateBenefitOfferErrors[keyof PutUpdateBenefitOfferErrors]; +export type GetV1CompaniesCompanyIdPricingPlansError = + GetV1CompaniesCompanyIdPricingPlansErrors[keyof GetV1CompaniesCompanyIdPricingPlansErrors]; -export type PutUpdateBenefitOfferResponses = { +export type GetV1CompaniesCompanyIdPricingPlansResponses = { /** * Success */ - 200: SuccessResponse; + 200: ListCompanyPricingPlansResponse; }; -export type PutUpdateBenefitOfferResponse = - PutUpdateBenefitOfferResponses[keyof PutUpdateBenefitOfferResponses]; +export type GetV1CompaniesCompanyIdPricingPlansResponse = + GetV1CompaniesCompanyIdPricingPlansResponses[keyof GetV1CompaniesCompanyIdPricingPlansResponses]; -export type GetGetIdentityVerificationDataIdentityVerificationData = { - body?: never; +export type PostV1CompaniesCompanyIdPricingPlansData = { + /** + * Create Pricing Plan parameters + */ + body: CreatePricingPlanParams; path: { /** - * Employment ID + * Company ID */ - employment_id: string; + company_id: UuidSlug; }; query?: never; - url: '/v1/identity-verification/{employment_id}'; + url: '/api/eor/v1/companies/{company_id}/pricing-plans'; }; -export type GetGetIdentityVerificationDataIdentityVerificationErrors = { +export type PostV1CompaniesCompanyIdPricingPlansErrors = { /** * Unauthorized */ @@ -12816,21 +13272,24 @@ export type GetGetIdentityVerificationDataIdentityVerificationErrors = { 422: UnprocessableEntityResponse; }; -export type GetGetIdentityVerificationDataIdentityVerificationError = - GetGetIdentityVerificationDataIdentityVerificationErrors[keyof GetGetIdentityVerificationDataIdentityVerificationErrors]; +export type PostV1CompaniesCompanyIdPricingPlansError = + PostV1CompaniesCompanyIdPricingPlansErrors[keyof PostV1CompaniesCompanyIdPricingPlansErrors]; -export type GetGetIdentityVerificationDataIdentityVerificationResponses = { +export type PostV1CompaniesCompanyIdPricingPlansResponses = { /** * Success */ - 200: IdentityVerificationResponse; + 200: CreatePricingPlanResponse; }; -export type GetGetIdentityVerificationDataIdentityVerificationResponse = - GetGetIdentityVerificationDataIdentityVerificationResponses[keyof GetGetIdentityVerificationDataIdentityVerificationResponses]; +export type PostV1CompaniesCompanyIdPricingPlansResponse = + PostV1CompaniesCompanyIdPricingPlansResponses[keyof PostV1CompaniesCompanyIdPricingPlansResponses]; -export type GetIndexSubscriptionData = { - body?: never; +export type PutV2EmploymentsEmploymentIdFederalTaxesData = { + /** + * Employment federal taxes params + */ + body?: EmploymentFederalTaxesParams; path: { /** * Employment ID @@ -12838,14 +13297,14 @@ export type GetIndexSubscriptionData = { employment_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-subscriptions'; + url: '/api/eor/v2/employments/{employment_id}/federal-taxes'; }; -export type GetIndexSubscriptionErrors = { +export type PutV2EmploymentsEmploymentIdFederalTaxesErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** * Forbidden */ @@ -12854,53 +13313,63 @@ export type GetIndexSubscriptionErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexSubscriptionError = - GetIndexSubscriptionErrors[keyof GetIndexSubscriptionErrors]; +export type PutV2EmploymentsEmploymentIdFederalTaxesError = + PutV2EmploymentsEmploymentIdFederalTaxesErrors[keyof PutV2EmploymentsEmploymentIdFederalTaxesErrors]; -export type GetIndexSubscriptionResponses = { +export type PutV2EmploymentsEmploymentIdFederalTaxesResponses = { /** * Success */ - 200: ContractorSubscriptionSummariesResponse; + 200: SuccessResponse; }; -export type GetIndexSubscriptionResponse = - GetIndexSubscriptionResponses[keyof GetIndexSubscriptionResponses]; +export type PutV2EmploymentsEmploymentIdFederalTaxesResponse = + PutV2EmploymentsEmploymentIdFederalTaxesResponses[keyof PutV2EmploymentsEmploymentIdFederalTaxesResponses]; -export type GetIndexWebhookEventData = { +export type GetV1TravelLetterRequestsData = { body?: never; path?: never; query?: { /** - * Filter by webhook event type + * Filter results on the given status */ - event_type?: string; + status?: + | 'pending' + | 'cancelled' + | 'declined_by_manager' + | 'declined_by_remote' + | 'approved_by_manager' + | 'approved_by_remote'; /** - * Filter by delivery status (true = 200, false = 4xx/5xx) + * Filter results on the given employment slug */ - successfully_delivered?: boolean; + employment_id?: string; /** - * Filter by company ID + * Filter results on the given employee name */ - company_id?: string; + employee_name?: string; /** - * Filter by date before (ISO 8601 format) + * Sort order */ - before?: string; + order?: 'asc' | 'desc'; /** - * Filter by date after (ISO 8601 format) + * Field to sort by */ - after?: string; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - /** - * Field to sort by - */ - sort_by?: 'first_triggered_at'; + sort_by?: 'submitted_at'; /** * Starts fetching records after the given page */ @@ -12910,14 +13379,10 @@ export type GetIndexWebhookEventData = { */ page_size?: number; }; - url: '/v1/webhook-events'; + url: '/api/eor/v1/travel-letter-requests'; }; -export type GetIndexWebhookEventErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; +export type GetV1TravelLetterRequestsErrors = { /** * Not Found */ @@ -12928,49 +13393,40 @@ export type GetIndexWebhookEventErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexWebhookEventError = - GetIndexWebhookEventErrors[keyof GetIndexWebhookEventErrors]; +export type GetV1TravelLetterRequestsError = + GetV1TravelLetterRequestsErrors[keyof GetV1TravelLetterRequestsErrors]; -export type GetIndexWebhookEventResponses = { +export type GetV1TravelLetterRequestsResponses = { /** * Success */ - 200: ListWebhookEventsResponse; + 200: ListTravelLettersResponse; }; -export type GetIndexWebhookEventResponse = - GetIndexWebhookEventResponses[keyof GetIndexWebhookEventResponses]; +export type GetV1TravelLetterRequestsResponse = + GetV1TravelLetterRequestsResponses[keyof GetV1TravelLetterRequestsResponses]; -export type PostBypassEligibilityChecksCompanyData = { +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Company ID + * Employment ID */ - company_id: string; + employment_id: string; }; query?: never; - url: '/v1/sandbox/companies/{company_id}/bypass-eligibility-checks'; + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details'; }; -export type PostBypassEligibilityChecksCompanyErrors = { +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** * Not Found */ @@ -12980,26 +13436,29 @@ export type PostBypassEligibilityChecksCompanyErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PostBypassEligibilityChecksCompanyError = - PostBypassEligibilityChecksCompanyErrors[keyof PostBypassEligibilityChecksCompanyErrors]; +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsError = + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type PostBypassEligibilityChecksCompanyResponses = { +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentEngagementAgreementDetailsResponse; }; -export type PostBypassEligibilityChecksCompanyResponse = - PostBypassEligibilityChecksCompanyResponses[keyof PostBypassEligibilityChecksCompanyResponses]; +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type PostApproveRiskReserveProofOfPaymentData = { - body?: never; +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { + /** + * Employment engagement agreement details params + */ + body?: EmploymentEngagementAgreementDetailsParams; path: { /** * Employment ID @@ -13007,141 +13466,72 @@ export type PostApproveRiskReserveProofOfPaymentData = { employment_id: string; }; query?: never; - url: '/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve'; + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details'; }; -export type PostApproveRiskReserveProofOfPaymentErrors = { +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PostApproveRiskReserveProofOfPaymentError = - PostApproveRiskReserveProofOfPaymentErrors[keyof PostApproveRiskReserveProofOfPaymentErrors]; - -export type PostApproveRiskReserveProofOfPaymentResponses = { - /** - * Success - */ - 200: RiskReserveProofOfPaymentResponse; -}; - -export type PostApproveRiskReserveProofOfPaymentResponse = - PostApproveRiskReserveProofOfPaymentResponses[keyof PostApproveRiskReserveProofOfPaymentResponses]; - -export type GetShowTestSchemaData = { - body?: never; - path?: never; - query?: { - /** - * Version of the form schema - */ - json_schema_version?: number | 'latest'; - }; - url: '/v1/test-schema'; -}; +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsError = + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type GetShowTestSchemaResponses = { +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 200: CompanyFormResponse; + 200: SuccessResponse; }; -export type GetShowTestSchemaResponse = - GetShowTestSchemaResponses[keyof GetShowTestSchemaResponses]; +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type GetIndexHolidayData = { +export type GetV1WdGphPaySummaryData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { + headers?: { /** - * Country code according to ISO 3166-1 3-digit alphabetic codes - */ - country_code: string; - /** - * Year for the holidays + * The preferred language of the inquiring user in Workday */ - year: string; + accept_language?: string; }; + path?: never; query?: { /** - * Country subdivision code according to ISO 3166-2 codes + * The pay group ids to lookup (comma separated). Returns all pay groups if not provided */ - country_subdivision_code?: string; - }; - url: '/v1/countries/{country_code}/holidays/{year}'; -}; - -export type GetIndexHolidayErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; -}; - -export type GetIndexHolidayError = - GetIndexHolidayErrors[keyof GetIndexHolidayErrors]; - -export type GetIndexHolidayResponses = { - /** - * Success - */ - 200: HolidaysResponse; -}; - -export type GetIndexHolidayResponse = - GetIndexHolidayResponses[keyof GetIndexHolidayResponses]; - -export type PostCreateCancellationData = { - /** - * CancelTimeoff - */ - body: CancelTimeoffParams; - path: { + payGroupExternalId?: string; /** - * Time Off ID + * Optional country filter (ISO 3166 alpha-2, comma separated) */ - timeoff_id: string; + countryCode?: string; }; - query?: never; - url: '/v1/timeoff/{timeoff_id}/cancel'; + url: '/api/eor/v1/wd/gph/paySummary'; }; -export type PostCreateCancellationErrors = { +export type GetV1WdGphPaySummaryErrors = { /** * Bad Request */ @@ -13154,30 +13544,22 @@ export type PostCreateCancellationErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostCreateCancellationError = - PostCreateCancellationErrors[keyof PostCreateCancellationErrors]; +export type GetV1WdGphPaySummaryError = + GetV1WdGphPaySummaryErrors[keyof GetV1WdGphPaySummaryErrors]; -export type PostCreateCancellationResponses = { +export type GetV1WdGphPaySummaryResponses = { /** * Success */ - 200: TimeoffResponse; + 200: PaySummaryResponse; }; -export type PostCreateCancellationResponse = - PostCreateCancellationResponses[keyof PostCreateCancellationResponses]; +export type GetV1WdGphPaySummaryResponse = + GetV1WdGphPaySummaryResponses[keyof GetV1WdGphPaySummaryResponses]; -export type GetIndexEmploymentJobData = { +export type GetV1EmploymentsEmploymentIdJobData = { body?: never; path: { /** @@ -13186,10 +13568,10 @@ export type GetIndexEmploymentJobData = { employment_id: string; }; query?: never; - url: '/v1/employments/{employment_id}/job'; + url: '/api/eor/v1/employments/{employment_id}/job'; }; -export type GetIndexEmploymentJobErrors = { +export type GetV1EmploymentsEmploymentIdJobErrors = { /** * Unauthorized */ @@ -13204,66 +13586,82 @@ export type GetIndexEmploymentJobErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexEmploymentJobError = - GetIndexEmploymentJobErrors[keyof GetIndexEmploymentJobErrors]; +export type GetV1EmploymentsEmploymentIdJobError = + GetV1EmploymentsEmploymentIdJobErrors[keyof GetV1EmploymentsEmploymentIdJobErrors]; -export type GetIndexEmploymentJobResponses = { +export type GetV1EmploymentsEmploymentIdJobResponses = { /** * Success */ 200: EmploymentJobResponse; }; -export type GetIndexEmploymentJobResponse = - GetIndexEmploymentJobResponses[keyof GetIndexEmploymentJobResponses]; +export type GetV1EmploymentsEmploymentIdJobResponse = + GetV1EmploymentsEmploymentIdJobResponses[keyof GetV1EmploymentsEmploymentIdJobResponses]; -export type GetIndexPricingPlanPartnerTemplateData = { - body?: never; +export type PostV1BulkEmploymentJobsData = { + /** + * Bulk employment params + */ + body?: BulkEmploymentCreateParams; path?: never; query?: never; - url: '/v1/pricing-plan-partner-templates'; + url: '/api/eor/v1/bulk-employment-jobs'; }; -export type GetIndexPricingPlanPartnerTemplateErrors = { +export type PostV1BulkEmploymentJobsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexPricingPlanPartnerTemplateError = - GetIndexPricingPlanPartnerTemplateErrors[keyof GetIndexPricingPlanPartnerTemplateErrors]; +export type PostV1BulkEmploymentJobsError = + PostV1BulkEmploymentJobsErrors[keyof PostV1BulkEmploymentJobsErrors]; -export type GetIndexPricingPlanPartnerTemplateResponses = { +export type PostV1BulkEmploymentJobsResponses = { /** - * Success + * Accepted */ - 200: ListPricingPlanPartnerTemplatesResponse; + 202: BulkEmploymentImportJobResponse; }; -export type GetIndexPricingPlanPartnerTemplateResponse = - GetIndexPricingPlanPartnerTemplateResponses[keyof GetIndexPricingPlanPartnerTemplateResponses]; +export type PostV1BulkEmploymentJobsResponse = + PostV1BulkEmploymentJobsResponses[keyof PostV1BulkEmploymentJobsResponses]; -export type GetIndexEorPayrollCalendarData = { +export type GetV1ContractAmendmentsData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; query?: { /** - * Filter payroll calendars by country code + * Employment ID */ - country_code?: string; + employment_id?: string; /** - * Filter payroll calendars by year + * Contract Amendment status */ - year?: string; + status?: ContractAmendmentStatus; /** * Starts fetching records after the given page */ @@ -13273,10 +13671,10 @@ export type GetIndexEorPayrollCalendarData = { */ page_size?: number; }; - url: '/v1/payroll-calendars'; + url: '/api/eor/v1/contract-amendments'; }; -export type GetIndexEorPayrollCalendarErrors = { +export type GetV1ContractAmendmentsErrors = { /** * Unauthorized */ @@ -13291,39 +13689,44 @@ export type GetIndexEorPayrollCalendarErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexEorPayrollCalendarError = - GetIndexEorPayrollCalendarErrors[keyof GetIndexEorPayrollCalendarErrors]; +export type GetV1ContractAmendmentsError = + GetV1ContractAmendmentsErrors[keyof GetV1ContractAmendmentsErrors]; -export type GetIndexEorPayrollCalendarResponses = { +export type GetV1ContractAmendmentsResponses = { /** * Success */ - 200: PayrollCalendarsEorResponse; + 200: ListContractAmendmentResponse; }; -export type GetIndexEorPayrollCalendarResponse = - GetIndexEorPayrollCalendarResponses[keyof GetIndexEorPayrollCalendarResponses]; +export type GetV1ContractAmendmentsResponse = + GetV1ContractAmendmentsResponses[keyof GetV1ContractAmendmentsResponses]; -export type PatchUpdateEmployeeTimeoff2Data = { +export type PostV1ContractAmendmentsData = { /** - * UpdateTimeoff + * Contract Amendment */ - body: UpdateEmployeeTimeoffParams; - path: { + body?: CreateContractAmendmentParams; + headers: { /** - * Timeoff ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; - query?: never; - url: '/v1/employee/timeoff/{id}'; + path?: never; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/contract-amendments'; }; -export type PatchUpdateEmployeeTimeoff2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1ContractAmendmentsErrors = { /** * Unauthorized */ @@ -13336,41 +13739,43 @@ export type PatchUpdateEmployeeTimeoff2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateEmployeeTimeoff2Error = - PatchUpdateEmployeeTimeoff2Errors[keyof PatchUpdateEmployeeTimeoff2Errors]; +export type PostV1ContractAmendmentsError = + PostV1ContractAmendmentsErrors[keyof PostV1ContractAmendmentsErrors]; -export type PatchUpdateEmployeeTimeoff2Responses = { +export type PostV1ContractAmendmentsResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ContractAmendmentResponse; }; -export type PatchUpdateEmployeeTimeoff2Response = - PatchUpdateEmployeeTimeoff2Responses[keyof PatchUpdateEmployeeTimeoff2Responses]; +export type PostV1ContractAmendmentsResponse = + PostV1ContractAmendmentsResponses[keyof PostV1ContractAmendmentsResponses]; -export type PatchUpdateEmployeeTimeoffData = { - /** - * UpdateTimeoff - */ - body: UpdateEmployeeTimeoffParams; +export type DeleteV1IncentivesRecurringIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Timeoff ID + * Recurring Incentive ID */ id: string; }; query?: never; - url: '/v1/employee/timeoff/{id}'; + url: '/api/eor/v1/incentives/recurring/{id}'; }; -export type PatchUpdateEmployeeTimeoffErrors = { +export type DeleteV1IncentivesRecurringIdErrors = { /** * Bad Request */ @@ -13388,25 +13793,25 @@ export type PatchUpdateEmployeeTimeoffErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PatchUpdateEmployeeTimeoffError = - PatchUpdateEmployeeTimeoffErrors[keyof PatchUpdateEmployeeTimeoffErrors]; +export type DeleteV1IncentivesRecurringIdError = + DeleteV1IncentivesRecurringIdErrors[keyof DeleteV1IncentivesRecurringIdErrors]; -export type PatchUpdateEmployeeTimeoffResponses = { +export type DeleteV1IncentivesRecurringIdResponses = { /** * Success */ - 200: TimeoffResponse; + 200: DeleteRecurringIncentiveResponse; }; -export type PatchUpdateEmployeeTimeoffResponse = - PatchUpdateEmployeeTimeoffResponses[keyof PatchUpdateEmployeeTimeoffResponses]; +export type DeleteV1IncentivesRecurringIdResponse = + DeleteV1IncentivesRecurringIdResponses[keyof DeleteV1IncentivesRecurringIdResponses]; -export type GetIndexRecurringIncentiveData = { +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { body?: never; headers: { /** @@ -13417,37 +13822,17 @@ export type GetIndexRecurringIncentiveData = { */ Authorization: string; }; - path?: never; - query?: { - /** - * Filter by recurring incentive status: active or deactive. - */ - status?: string; - /** - * Filter by recurring incentive type. - */ - type?: string; - /** - * Filter by recurring incentives that contain the value in their notes. - */ - note?: string; - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * Benefit Renewal Request Id */ - page_size?: number; + benefit_renewal_request_id: UuidSlug; }; - url: '/v1/incentives/recurring'; + query?: never; + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; }; -export type GetIndexRecurringIncentiveErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { /** * Unauthorized */ @@ -13460,30 +13845,26 @@ export type GetIndexRecurringIncentiveErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetIndexRecurringIncentiveError = - GetIndexRecurringIncentiveErrors[keyof GetIndexRecurringIncentiveErrors]; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdError = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors]; -export type GetIndexRecurringIncentiveResponses = { +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses = { /** * Success */ - 201: ListRecurringIncentivesResponse; + 200: BenefitRenewalRequestsBenefitRenewalRequestResponse; }; -export type GetIndexRecurringIncentiveResponse = - GetIndexRecurringIncentiveResponses[keyof GetIndexRecurringIncentiveResponses]; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses]; -export type PostCreateRecurringIncentiveData = { +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { /** - * RecurringIncentive + * Benefit Renewal Request Response */ - body?: CreateRecurringIncentiveParams; + body?: BenefitRenewalRequestsUpdateBenefitRenewalRequest; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -13493,52 +13874,51 @@ export type PostCreateRecurringIncentiveData = { */ Authorization: string; }; - path?: never; - query?: never; - url: '/v1/incentives/recurring'; + path: { + /** + * Benefit Renewal Request Id + */ + benefit_renewal_request_id: UuidSlug; + }; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; }; -export type PostCreateRecurringIncentiveErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PostCreateRecurringIncentiveError = - PostCreateRecurringIncentiveErrors[keyof PostCreateRecurringIncentiveErrors]; +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdError = + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors[keyof PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors]; -export type PostCreateRecurringIncentiveResponses = { +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses = { /** * Success */ - 201: RecurringIncentiveResponse; + 200: SuccessResponse; }; -export type PostCreateRecurringIncentiveResponse = - PostCreateRecurringIncentiveResponses[keyof PostCreateRecurringIncentiveResponses]; +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse = + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses[keyof PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses]; -export type PostCreateBenefitRenewalRequestData = { - /** - * Benefit Renewal Request - */ - body: BenefitRenewalRequestsCreateBenefitRenewalRequest; +export type GetV1CountriesCountryCodeHolidaysYearData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -13548,60 +13928,75 @@ export type PostCreateBenefitRenewalRequestData = { */ Authorization: string; }; - path?: never; - query?: never; - url: '/v1/sandbox/benefit-renewal-requests'; + path: { + /** + * Country code according to ISO 3166-1 3-digit alphabetic codes + */ + country_code: string; + /** + * Year for the holidays + */ + year: string; + }; + query?: { + /** + * Country subdivision code according to ISO 3166-2 codes + */ + country_subdivision_code?: string; + }; + url: '/api/eor/v1/countries/{country_code}/holidays/{year}'; }; -export type PostCreateBenefitRenewalRequestErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CountriesCountryCodeHolidaysYearErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PostCreateBenefitRenewalRequestError = - PostCreateBenefitRenewalRequestErrors[keyof PostCreateBenefitRenewalRequestErrors]; +export type GetV1CountriesCountryCodeHolidaysYearError = + GetV1CountriesCountryCodeHolidaysYearErrors[keyof GetV1CountriesCountryCodeHolidaysYearErrors]; -export type PostCreateBenefitRenewalRequestResponses = { +export type GetV1CountriesCountryCodeHolidaysYearResponses = { /** * Success */ - 200: BenefitRenewalRequestsCreateBenefitRenewalRequestResponse; + 200: HolidaysResponse; }; -export type PostCreateBenefitRenewalRequestResponse = - PostCreateBenefitRenewalRequestResponses[keyof PostCreateBenefitRenewalRequestResponses]; +export type GetV1CountriesCountryCodeHolidaysYearResponse = + GetV1CountriesCountryCodeHolidaysYearResponses[keyof GetV1CountriesCountryCodeHolidaysYearResponses]; -export type GetShowContractDocumentData = { +export type GetV1EmploymentsEmploymentIdCustomFieldsData = { body?: never; path: { /** * Employment ID */ employment_id: string; + }; + query?: { /** - * Document ID + * Starts fetching records after the given page */ - id: string; + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contract-documents/{id}'; + url: '/api/eor/v1/employments/{employment_id}/custom-fields'; }; -export type GetShowContractDocumentErrors = { +export type GetV1EmploymentsEmploymentIdCustomFieldsErrors = { /** * Unauthorized */ @@ -13616,49 +14011,32 @@ export type GetShowContractDocumentErrors = { 422: UnprocessableEntityResponse; }; -export type GetShowContractDocumentError = - GetShowContractDocumentErrors[keyof GetShowContractDocumentErrors]; +export type GetV1EmploymentsEmploymentIdCustomFieldsError = + GetV1EmploymentsEmploymentIdCustomFieldsErrors[keyof GetV1EmploymentsEmploymentIdCustomFieldsErrors]; -export type GetShowContractDocumentResponses = { +export type GetV1EmploymentsEmploymentIdCustomFieldsResponses = { /** * Success */ - 200: ContractDocumentResponse; + 200: ListEmploymentCustomFieldValuePaginatedResponse; }; -export type GetShowContractDocumentResponse = - GetShowContractDocumentResponses[keyof GetShowContractDocumentResponses]; +export type GetV1EmploymentsEmploymentIdCustomFieldsResponse = + GetV1EmploymentsEmploymentIdCustomFieldsResponses[keyof GetV1EmploymentsEmploymentIdCustomFieldsResponses]; -export type GetIndexEmploymentContractDocumentData = { +export type GetV1TimesheetsIdData = { body?: never; path: { /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Filter by contract document statuses - */ - statuses?: Array; - /** - * Exclude contract documents with specific statuses - */ - except_statuses?: Array; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Timesheet ID */ - page_size?: number; + id: string; }; - url: '/v1/employments/{employment_id}/contract-documents'; + query?: never; + url: '/api/eor/v1/timesheets/{id}'; }; -export type GetIndexEmploymentContractDocumentErrors = { +export type GetV1TimesheetsIdErrors = { /** * Unauthorized */ @@ -13673,20 +14051,20 @@ export type GetIndexEmploymentContractDocumentErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexEmploymentContractDocumentError = - GetIndexEmploymentContractDocumentErrors[keyof GetIndexEmploymentContractDocumentErrors]; +export type GetV1TimesheetsIdError = + GetV1TimesheetsIdErrors[keyof GetV1TimesheetsIdErrors]; -export type GetIndexEmploymentContractDocumentResponses = { +export type GetV1TimesheetsIdResponses = { /** * Success */ - 200: IndexContractDocumentsResponse; + 200: TimesheetResponse; }; -export type GetIndexEmploymentContractDocumentResponse = - GetIndexEmploymentContractDocumentResponses[keyof GetIndexEmploymentContractDocumentResponses]; +export type GetV1TimesheetsIdResponse = + GetV1TimesheetsIdResponses[keyof GetV1TimesheetsIdResponses]; -export type GetIndexExpenseData = { +export type GetV1CompanyManagersData = { body?: never; headers: { /** @@ -13699,6 +14077,10 @@ export type GetIndexExpenseData = { }; path?: never; query?: { + /** + * A Company ID to filter the results (only applicable for Integration Partners). + */ + company_id?: string; /** * Starts fetching records after the given page */ @@ -13708,10 +14090,10 @@ export type GetIndexExpenseData = { */ page_size?: number; }; - url: '/v1/expenses'; + url: '/api/eor/v1/company-managers'; }; -export type GetIndexExpenseErrors = { +export type GetV1CompanyManagersErrors = { /** * Bad Request */ @@ -13734,24 +14116,24 @@ export type GetIndexExpenseErrors = { 429: TooManyRequestsResponse; }; -export type GetIndexExpenseError = - GetIndexExpenseErrors[keyof GetIndexExpenseErrors]; +export type GetV1CompanyManagersError = + GetV1CompanyManagersErrors[keyof GetV1CompanyManagersErrors]; -export type GetIndexExpenseResponses = { +export type GetV1CompanyManagersResponses = { /** * Success */ - 201: ListExpenseResponse; + 200: CompanyManagersResponse; }; -export type GetIndexExpenseResponse = - GetIndexExpenseResponses[keyof GetIndexExpenseResponses]; +export type GetV1CompanyManagersResponse = + GetV1CompanyManagersResponses[keyof GetV1CompanyManagersResponses]; -export type PostCreateExpenseData = { +export type PostV1CompanyManagersData = { /** - * Expenses + * Company Manager params */ - body?: ParamsToCreateExpense; + body?: CompanyManagerParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -13762,11 +14144,19 @@ export type PostCreateExpenseData = { Authorization: string; }; path?: never; - query?: never; - url: '/v1/expenses'; + query?: { + /** + * Complementary action(s) to perform when creating a company manager: + * + * - `no_invite` skips the email invitation step + * + */ + actions?: string; + }; + url: '/api/eor/v1/company-managers'; }; -export type PostCreateExpenseErrors = { +export type PostV1CompanyManagersErrors = { /** * Bad Request */ @@ -13789,81 +14179,38 @@ export type PostCreateExpenseErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateExpenseError = - PostCreateExpenseErrors[keyof PostCreateExpenseErrors]; - -export type PostCreateExpenseResponses = { - /** - * Success - */ - 201: ExpenseResponse; -}; - -export type PostCreateExpenseResponse = - PostCreateExpenseResponses[keyof PostCreateExpenseResponses]; - -export type GetShowSsoConfigurationData = { - body?: never; - path?: never; - query?: never; - url: '/v1/sso-configuration'; -}; - -export type GetShowSsoConfigurationErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; -}; - -export type GetShowSsoConfigurationError = - GetShowSsoConfigurationErrors[keyof GetShowSsoConfigurationErrors]; +export type PostV1CompanyManagersError = + PostV1CompanyManagersErrors[keyof PostV1CompanyManagersErrors]; -export type GetShowSsoConfigurationResponses = { +export type PostV1CompanyManagersResponses = { /** * Success */ - 200: SsoConfigurationResponse; + 201: CompanyManagerData; }; -export type GetShowSsoConfigurationResponse = - GetShowSsoConfigurationResponses[keyof GetShowSsoConfigurationResponses]; +export type PostV1CompanyManagersResponse = + PostV1CompanyManagersResponses[keyof PostV1CompanyManagersResponses]; -export type PostCreateSsoConfigurationData = { +export type PostV1PayItemsBulkData = { /** - * CreateSSOConfiguration + * Pay Items */ - body: CreateSsoConfigurationParams; + body: BulkCreatePayItemsParams; path?: never; query?: never; - url: '/v1/sso-configuration'; + url: '/api/eor/v1/pay-items/bulk'; }; -export type PostCreateSsoConfigurationErrors = { +export type PostV1PayItemsBulkErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** * Conflict */ @@ -13878,36 +14225,32 @@ export type PostCreateSsoConfigurationErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateSsoConfigurationError = - PostCreateSsoConfigurationErrors[keyof PostCreateSsoConfigurationErrors]; +export type PostV1PayItemsBulkError = + PostV1PayItemsBulkErrors[keyof PostV1PayItemsBulkErrors]; -export type PostCreateSsoConfigurationResponses = { +export type PostV1PayItemsBulkResponses = { /** - * Created + * Success */ - 201: CreateSsoConfigurationResponse; + 200: BulkCreatePayItemsResponse; }; -export type PostCreateSsoConfigurationResponse = - PostCreateSsoConfigurationResponses[keyof PostCreateSsoConfigurationResponses]; +export type PostV1PayItemsBulkResponse = + PostV1PayItemsBulkResponses[keyof PostV1PayItemsBulkResponses]; -export type PutApproveContractAmendmentData = { +export type GetV1TravelLetterRequestsIdData = { body?: never; path: { /** - * Contract amendment request ID + * travel letter request ID */ - contract_amendment_request_id: string; + id: UuidSlug; }; query?: never; - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve'; + url: '/api/eor/v1/travel-letter-requests/{id}'; }; -export type PutApproveContractAmendmentErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1TravelLetterRequestsIdErrors = { /** * Unauthorized */ @@ -13920,85 +14263,80 @@ export type PutApproveContractAmendmentErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PutApproveContractAmendmentError = - PutApproveContractAmendmentErrors[keyof PutApproveContractAmendmentErrors]; +export type GetV1TravelLetterRequestsIdError = + GetV1TravelLetterRequestsIdErrors[keyof GetV1TravelLetterRequestsIdErrors]; -export type PutApproveContractAmendmentResponses = { +export type GetV1TravelLetterRequestsIdResponses = { /** * Success */ - 200: ContractAmendmentResponse; + 200: TravelLetterResponse; }; -export type PutApproveContractAmendmentResponse = - PutApproveContractAmendmentResponses[keyof PutApproveContractAmendmentResponses]; +export type GetV1TravelLetterRequestsIdResponse = + GetV1TravelLetterRequestsIdResponses[keyof GetV1TravelLetterRequestsIdResponses]; -export type GetIndexContractorCurrencyData = { - body?: never; +export type PatchV1TravelLetterRequestsId2Data = { + /** + * Travel letter Request + */ + body: UpdateTravelLetterRequestParams; path: { /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Restrict to currencies which payout is guaranteed (default: true) + * Travel letter Request ID */ - restrict_to_guaranteed_pay_out_currencies?: boolean; + id: string; }; - url: '/v1/contractors/employments/{employment_id}/contractor-currencies'; + query?: never; + url: '/api/eor/v1/travel-letter-requests/{id}'; }; -export type GetIndexContractorCurrencyErrors = { +export type PatchV1TravelLetterRequestsId2Errors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; /** - * Internal Server Error + * Unprocessable Entity */ - 500: InternalServerErrorResponse; + 422: UnprocessableEntityResponse; }; -export type GetIndexContractorCurrencyError = - GetIndexContractorCurrencyErrors[keyof GetIndexContractorCurrencyErrors]; +export type PatchV1TravelLetterRequestsId2Error = + PatchV1TravelLetterRequestsId2Errors[keyof PatchV1TravelLetterRequestsId2Errors]; -export type GetIndexContractorCurrencyResponses = { +export type PatchV1TravelLetterRequestsId2Responses = { /** * Success */ - 200: ContractorCurrencyResponse; + 200: TravelLetterResponse; }; -export type GetIndexContractorCurrencyResponse = - GetIndexContractorCurrencyResponses[keyof GetIndexContractorCurrencyResponses]; +export type PatchV1TravelLetterRequestsId2Response = + PatchV1TravelLetterRequestsId2Responses[keyof PatchV1TravelLetterRequestsId2Responses]; -export type PostReplayWebhookEventData = { +export type PatchV1TravelLetterRequestsIdData = { /** - * WebhookEvent + * Travel letter Request */ - body: ReplayWebhookEventsParams; - path?: never; + body: UpdateTravelLetterRequestParams; + path: { + /** + * Travel letter Request ID + */ + id: string; + }; query?: never; - url: '/v1/webhook-events/replay'; + url: '/api/eor/v1/travel-letter-requests/{id}'; }; -export type PostReplayWebhookEventErrors = { +export type PatchV1TravelLetterRequestsIdErrors = { /** * Unauthorized */ @@ -14013,40 +14351,49 @@ export type PostReplayWebhookEventErrors = { 422: UnprocessableEntityResponse; }; -export type PostReplayWebhookEventError = - PostReplayWebhookEventErrors[keyof PostReplayWebhookEventErrors]; +export type PatchV1TravelLetterRequestsIdError = + PatchV1TravelLetterRequestsIdErrors[keyof PatchV1TravelLetterRequestsIdErrors]; -export type PostReplayWebhookEventResponses = { +export type PatchV1TravelLetterRequestsIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: TravelLetterResponse; }; -export type PostReplayWebhookEventResponse = - PostReplayWebhookEventResponses[keyof PostReplayWebhookEventResponses]; +export type PatchV1TravelLetterRequestsIdResponse = + PatchV1TravelLetterRequestsIdResponses[keyof PatchV1TravelLetterRequestsIdResponses]; -export type PostCreateCorTerminationRequestSubscriptionData = { +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Employment ID + * Company ID */ - employment_id: string; + company_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests'; + url: '/api/eor/v1/sandbox/companies/{company_id}/bypass-eligibility-checks'; }; -export type PostCreateCorTerminationRequestSubscriptionErrors = { +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -14055,38 +14402,33 @@ export type PostCreateCorTerminationRequestSubscriptionErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostCreateCorTerminationRequestSubscriptionError = - PostCreateCorTerminationRequestSubscriptionErrors[keyof PostCreateCorTerminationRequestSubscriptionErrors]; +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksError = + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors[keyof PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors]; -export type PostCreateCorTerminationRequestSubscriptionResponses = { +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses = { /** - * Created + * Success */ - 201: CorTerminationRequestCreatedResponse; + 200: SuccessResponse; }; -export type PostCreateCorTerminationRequestSubscriptionResponse = - PostCreateCorTerminationRequestSubscriptionResponses[keyof PostCreateCorTerminationRequestSubscriptionResponses]; +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponse = + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses[keyof PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses]; -export type GetShowBackgroundCheckData = { +export type GetV1EmployeeLeavePoliciesData = { body?: never; - path: { - /** - * Employment Id - */ - employment_id: UuidSlug; - /** - * Background Check Id - */ - background_check_id: UuidSlug; - }; + path?: never; query?: never; - url: '/v1/employments/{employment_id}/background-checks/{background_check_id}'; + url: '/api/eor/v1/employee/leave-policies'; }; -export type GetShowBackgroundCheckErrors = { +export type GetV1EmployeeLeavePoliciesErrors = { /** * Unauthorized */ @@ -14095,52 +14437,34 @@ export type GetShowBackgroundCheckErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type GetShowBackgroundCheckError = - GetShowBackgroundCheckErrors[keyof GetShowBackgroundCheckErrors]; +export type GetV1EmployeeLeavePoliciesError = + GetV1EmployeeLeavePoliciesErrors[keyof GetV1EmployeeLeavePoliciesErrors]; -export type GetShowBackgroundCheckResponses = { +export type GetV1EmployeeLeavePoliciesResponses = { /** * Success */ - 200: BackgroundChecksBackgroundCheckResponse; + 200: ListLeavePoliciesDetailsResponse; }; -export type GetShowBackgroundCheckResponse = - GetShowBackgroundCheckResponses[keyof GetShowBackgroundCheckResponses]; +export type GetV1EmployeeLeavePoliciesResponse = + GetV1EmployeeLeavePoliciesResponses[keyof GetV1EmployeeLeavePoliciesResponses]; -export type GetSchemaBenefitRenewalRequestData = { +export type GetV1CompaniesCompanyIdWebhookCallbacksData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Benefit Renewal Request Id - */ - benefit_renewal_request_id: UuidSlug; - }; - query?: { - /** - * Version of the form schema + * Company ID */ - json_schema_version?: number | 'latest'; + company_id: string; }; - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema'; + query?: never; + url: '/api/eor/v1/companies/{company_id}/webhook-callbacks'; }; -export type GetSchemaBenefitRenewalRequestErrors = { +export type GetV1CompaniesCompanyIdWebhookCallbacksErrors = { /** * Unauthorized */ @@ -14149,65 +14473,22 @@ export type GetSchemaBenefitRenewalRequestErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; -}; - -export type GetSchemaBenefitRenewalRequestError = - GetSchemaBenefitRenewalRequestErrors[keyof GetSchemaBenefitRenewalRequestErrors]; - -export type GetSchemaBenefitRenewalRequestResponses = { - /** - * Success - */ - 200: BenefitRenewalRequestsBenefitRenewalRequestFormResponse; -}; - -export type GetSchemaBenefitRenewalRequestResponse = - GetSchemaBenefitRenewalRequestResponses[keyof GetSchemaBenefitRenewalRequestResponses]; - -export type PostGenerateMagicLinkData = { - /** - * Magic links generator body - */ - body: MagicLinkParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: never; - url: '/v1/magic-link'; -}; - -export type PostGenerateMagicLinkErrors = { - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type PostGenerateMagicLinkError = - PostGenerateMagicLinkErrors[keyof PostGenerateMagicLinkErrors]; +export type GetV1CompaniesCompanyIdWebhookCallbacksError = + GetV1CompaniesCompanyIdWebhookCallbacksErrors[keyof GetV1CompaniesCompanyIdWebhookCallbacksErrors]; -export type PostGenerateMagicLinkResponses = { +export type GetV1CompaniesCompanyIdWebhookCallbacksResponses = { /** * Success */ - 200: MagicLinkResponse; + 200: ListWebhookCallbacksResponse; }; -export type PostGenerateMagicLinkResponse = - PostGenerateMagicLinkResponses[keyof PostGenerateMagicLinkResponses]; +export type GetV1CompaniesCompanyIdWebhookCallbacksResponse = + GetV1CompaniesCompanyIdWebhookCallbacksResponses[keyof GetV1CompaniesCompanyIdWebhookCallbacksResponses]; -export type DeleteDeleteRecurringIncentiveData = { +export type GetV1BillingDocumentsBillingDocumentIdPdfData = { body?: never; headers: { /** @@ -14220,19 +14501,15 @@ export type DeleteDeleteRecurringIncentiveData = { }; path: { /** - * Recurring Incentive ID + * The billing document's ID */ - id: string; + billing_document_id: string; }; query?: never; - url: '/v1/incentives/recurring/{id}'; + url: '/api/eor/v1/billing-documents/{billing_document_id}/pdf'; }; -export type DeleteDeleteRecurringIncentiveErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1BillingDocumentsBillingDocumentIdPdfErrors = { /** * Unauthorized */ @@ -14245,26 +14522,22 @@ export type DeleteDeleteRecurringIncentiveErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type DeleteDeleteRecurringIncentiveError = - DeleteDeleteRecurringIncentiveErrors[keyof DeleteDeleteRecurringIncentiveErrors]; +export type GetV1BillingDocumentsBillingDocumentIdPdfError = + GetV1BillingDocumentsBillingDocumentIdPdfErrors[keyof GetV1BillingDocumentsBillingDocumentIdPdfErrors]; -export type DeleteDeleteRecurringIncentiveResponses = { +export type GetV1BillingDocumentsBillingDocumentIdPdfResponses = { /** * Success */ - 200: DeleteRecurringIncentiveResponse; + 200: GenericFile; }; -export type DeleteDeleteRecurringIncentiveResponse = - DeleteDeleteRecurringIncentiveResponses[keyof DeleteDeleteRecurringIncentiveResponses]; +export type GetV1BillingDocumentsBillingDocumentIdPdfResponse = + GetV1BillingDocumentsBillingDocumentIdPdfResponses[keyof GetV1BillingDocumentsBillingDocumentIdPdfResponses]; -export type GetIndexIncentiveData = { +export type DeleteV1WebhookCallbacksIdData = { body?: never; headers: { /** @@ -14275,37 +14548,17 @@ export type GetIndexIncentiveData = { */ Authorization: string; }; - path?: never; - query?: { - /** - * Filter by Employment ID - */ - employment_id?: string; - /** - * Filter by Incentive status - */ - status?: string; - /** - * Filter by Recurring Incentive id - */ - recurring_incentive_id?: string; - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * Webhook Callback ID */ - page_size?: number; + id: string; }; - url: '/v1/incentives'; + query?: never; + url: '/api/eor/v1/webhook-callbacks/{id}'; }; -export type GetIndexIncentiveErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type DeleteV1WebhookCallbacksIdErrors = { /** * Unauthorized */ @@ -14318,91 +14571,37 @@ export type GetIndexIncentiveErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetIndexIncentiveError = - GetIndexIncentiveErrors[keyof GetIndexIncentiveErrors]; +export type DeleteV1WebhookCallbacksIdError = + DeleteV1WebhookCallbacksIdErrors[keyof DeleteV1WebhookCallbacksIdErrors]; -export type GetIndexIncentiveResponses = { +export type DeleteV1WebhookCallbacksIdResponses = { /** * Success */ - 200: ListIncentivesResponse; + 200: SuccessResponse; }; -export type GetIndexIncentiveResponse = - GetIndexIncentiveResponses[keyof GetIndexIncentiveResponses]; +export type DeleteV1WebhookCallbacksIdResponse = + DeleteV1WebhookCallbacksIdResponses[keyof DeleteV1WebhookCallbacksIdResponses]; -export type PostCreateIncentiveData = { +export type PatchV1WebhookCallbacksIdData = { /** - * Incentive + * WebhookCallback */ - body?: CreateOneTimeIncentiveParams; - headers: { + body?: UpdateWebhookCallbackParams; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Webhook Callback ID */ - Authorization: string; + id: string; }; - path?: never; - query?: never; - url: '/v1/incentives'; -}; - -export type PostCreateIncentiveErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; -}; - -export type PostCreateIncentiveError = - PostCreateIncentiveErrors[keyof PostCreateIncentiveErrors]; - -export type PostCreateIncentiveResponses = { - /** - * Success - */ - 201: IncentiveResponse; -}; - -export type PostCreateIncentiveResponse = - PostCreateIncentiveResponses[keyof PostCreateIncentiveResponses]; - -export type PostCreateProbationCompletionLetterData = { - /** - * Work Authorization Request - */ - body: CreateProbationCompletionLetterParams; - path?: never; query?: never; - url: '/v1/probation-completion-letter'; + url: '/api/eor/v1/webhook-callbacks/{id}'; }; -export type PostCreateProbationCompletionLetterErrors = { +export type PatchV1WebhookCallbacksIdErrors = { /** * Unauthorized */ @@ -14417,32 +14616,35 @@ export type PostCreateProbationCompletionLetterErrors = { 422: UnprocessableEntityResponse; }; -export type PostCreateProbationCompletionLetterError = - PostCreateProbationCompletionLetterErrors[keyof PostCreateProbationCompletionLetterErrors]; +export type PatchV1WebhookCallbacksIdError = + PatchV1WebhookCallbacksIdErrors[keyof PatchV1WebhookCallbacksIdErrors]; -export type PostCreateProbationCompletionLetterResponses = { +export type PatchV1WebhookCallbacksIdResponses = { /** * Success */ - 200: ProbationCompletionLetterResponse; + 200: WebhookCallbackResponse; }; -export type PostCreateProbationCompletionLetterResponse = - PostCreateProbationCompletionLetterResponses[keyof PostCreateProbationCompletionLetterResponses]; +export type PatchV1WebhookCallbacksIdResponse = + PatchV1WebhookCallbacksIdResponses[keyof PatchV1WebhookCallbacksIdResponses]; -export type GetShowScheduledContractorInvoiceData = { +export type GetV1CountriesData = { body?: never; - path: { + headers: { /** - * Resource unique identifier + * This endpoint works with any of the access tokens provided. You can use an access + * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. + * */ - id: UuidSlug; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/contractor-invoice-schedules/{id}'; + url: '/api/eor/v1/countries'; }; -export type GetShowScheduledContractorInvoiceErrors = { +export type GetV1CountriesErrors = { /** * Bad Request */ @@ -14451,10 +14653,6 @@ export type GetShowScheduledContractorInvoiceErrors = { * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -14464,48 +14662,82 @@ export type GetShowScheduledContractorInvoiceErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetShowScheduledContractorInvoiceError = - GetShowScheduledContractorInvoiceErrors[keyof GetShowScheduledContractorInvoiceErrors]; +export type GetV1CountriesError = + GetV1CountriesErrors[keyof GetV1CountriesErrors]; -export type GetShowScheduledContractorInvoiceResponses = { +export type GetV1CountriesResponses = { /** * Success */ - 200: ContractorInvoiceScheduleResponse; + 200: CountriesResponse; }; -export type GetShowScheduledContractorInvoiceResponse = - GetShowScheduledContractorInvoiceResponses[keyof GetShowScheduledContractorInvoiceResponses]; +export type GetV1CountriesResponse = + GetV1CountriesResponses[keyof GetV1CountriesResponses]; -export type PatchUpdateScheduledContractorInvoice2Data = { - /** - * Update parameters - */ - body: UpdateScheduleContractorInvoiceParams; - path: { +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData = + { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Legal entity ID + */ + legal_entity_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility'; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors = + { /** - * Resource unique identifier + * Unauthorized */ - id: UuidSlug; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityError = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors]; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses = + { + /** + * Success + */ + 200: ContractorEligibilityResponse; }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponse = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses]; + +export type PostV1CurrencyConverterEffectiveData = { + /** + * Convert currency parameters + */ + body: ConvertCurrencyParams; + path?: never; query?: never; - url: '/v1/contractor-invoice-schedules/{id}'; + url: '/api/eor/v1/currency-converter/effective'; }; -export type PatchUpdateScheduledContractorInvoice2Errors = { +export type PostV1CurrencyConverterEffectiveErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -14516,35 +14748,27 @@ export type PatchUpdateScheduledContractorInvoice2Errors = { 422: UnprocessableEntityResponse; }; -export type PatchUpdateScheduledContractorInvoice2Error = - PatchUpdateScheduledContractorInvoice2Errors[keyof PatchUpdateScheduledContractorInvoice2Errors]; +export type PostV1CurrencyConverterEffectiveError = + PostV1CurrencyConverterEffectiveErrors[keyof PostV1CurrencyConverterEffectiveErrors]; -export type PatchUpdateScheduledContractorInvoice2Responses = { +export type PostV1CurrencyConverterEffectiveResponses = { /** * Success */ - 200: ContractorInvoiceScheduleResponse; + 200: ConvertCurrencyResponse; }; -export type PatchUpdateScheduledContractorInvoice2Response = - PatchUpdateScheduledContractorInvoice2Responses[keyof PatchUpdateScheduledContractorInvoice2Responses]; +export type PostV1CurrencyConverterEffectiveResponse = + PostV1CurrencyConverterEffectiveResponses[keyof PostV1CurrencyConverterEffectiveResponses]; -export type PatchUpdateScheduledContractorInvoiceData = { - /** - * Update parameters - */ - body: UpdateScheduleContractorInvoiceParams; - path: { - /** - * Resource unique identifier - */ - id: UuidSlug; - }; +export type GetV1EmployeePersonalInformationData = { + body?: never; + path?: never; query?: never; - url: '/v1/contractor-invoice-schedules/{id}'; + url: '/api/eor/v1/employee/personal-information'; }; -export type PatchUpdateScheduledContractorInvoiceErrors = { +export type GetV1EmployeePersonalInformationErrors = { /** * Unauthorized */ @@ -14557,26 +14781,22 @@ export type PatchUpdateScheduledContractorInvoiceErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type PatchUpdateScheduledContractorInvoiceError = - PatchUpdateScheduledContractorInvoiceErrors[keyof PatchUpdateScheduledContractorInvoiceErrors]; +export type GetV1EmployeePersonalInformationError = + GetV1EmployeePersonalInformationErrors[keyof GetV1EmployeePersonalInformationErrors]; -export type PatchUpdateScheduledContractorInvoiceResponses = { +export type GetV1EmployeePersonalInformationResponses = { /** * Success */ - 200: ContractorInvoiceScheduleResponse; + 200: SuccessResponse; }; -export type PatchUpdateScheduledContractorInvoiceResponse = - PatchUpdateScheduledContractorInvoiceResponses[keyof PatchUpdateScheduledContractorInvoiceResponses]; +export type GetV1EmployeePersonalInformationResponse = + GetV1EmployeePersonalInformationResponses[keyof GetV1EmployeePersonalInformationResponses]; -export type GetShowBillingDocumentData = { +export type GetV1CountriesCountryCodeFormData = { body?: never; headers: { /** @@ -14589,20 +14809,36 @@ export type GetShowBillingDocumentData = { }; path: { /** - * The billing document's ID + * Country code according to ISO 3-digit alphabetic codes */ - billing_document_id: string; + country_code: string; + /** + * Name of the desired form + */ + form: string; }; query?: { /** - * When true, includes billing document items whose type is not part of the standard set for the invoice type. + * Required for `contract_amendment` form */ - include_unrecognized_types?: boolean; + employment_id?: string; + /** + * FOR TESTING PURPOSES ONLY: Include scheduled benefit groups. + */ + only_for_testing_include_scheduled_benefit_groups?: boolean; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - url: '/v1/billing-documents/{billing_document_id}'; + url: '/api/eor/v1/countries/{country_code}/{form}'; }; -export type GetShowBillingDocumentErrors = { +export type GetV1CountriesCountryCodeFormErrors = { /** * Bad Request */ @@ -14625,66 +14861,73 @@ export type GetShowBillingDocumentErrors = { 429: TooManyRequestsResponse; }; -export type GetShowBillingDocumentError = - GetShowBillingDocumentErrors[keyof GetShowBillingDocumentErrors]; +export type GetV1CountriesCountryCodeFormError = + GetV1CountriesCountryCodeFormErrors[keyof GetV1CountriesCountryCodeFormErrors]; -export type GetShowBillingDocumentResponses = { +export type GetV1CountriesCountryCodeFormResponses = { /** * Success */ - 200: BillingDocumentResponse; + 200: CountryFormResponse; }; -export type GetShowBillingDocumentResponse = - GetShowBillingDocumentResponses[keyof GetShowBillingDocumentResponses]; +export type GetV1CountriesCountryCodeFormResponse = + GetV1CountriesCountryCodeFormResponses[keyof GetV1CountriesCountryCodeFormResponses]; -export type PostCreateEstimationPdfData = { - /** - * Estimate params - */ - body?: CostCalculatorEstimateParams; +export type GetV1TimeoffData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; - query?: never; - url: '/v1/cost-calculator/estimation-pdf'; + query?: { + /** + * Only show time off for a specific employment + */ + employment_id?: string; + /** + * Filter time off by its type + */ + timeoff_type?: TimeoffType; + /** + * Filter time off by its status + */ + status?: TimeoffStatus; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'timeoff_type' | 'status'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/timeoff'; }; -export type PostCreateEstimationPdfErrors = { - /** - * Not Found - */ - 404: NotFoundResponse; +export type GetV1TimeoffErrors = { /** - * Unprocessable Entity + * Bad Request */ - 422: UnprocessableEntityResponse; -}; - -export type PostCreateEstimationPdfError = - PostCreateEstimationPdfErrors[keyof PostCreateEstimationPdfErrors]; - -export type PostCreateEstimationPdfResponses = { + 400: BadRequestResponse; /** - * Success + * Unauthorized */ - 200: CostCalculatorEstimatePdfResponse; -}; - -export type PostCreateEstimationPdfResponse = - PostCreateEstimationPdfResponses[keyof PostCreateEstimationPdfResponses]; - -export type GetShowWorkAuthorizationRequestData = { - body?: never; - path: { - /** - * work authorization request ID - */ - id: string; - }; - query?: never; - url: '/v1/work-authorization-requests/{id}'; -}; - -export type GetShowWorkAuthorizationRequestErrors = { + 401: UnauthorizedResponse; /** * Not Found */ @@ -14693,37 +14936,48 @@ export type GetShowWorkAuthorizationRequestErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowWorkAuthorizationRequestError = - GetShowWorkAuthorizationRequestErrors[keyof GetShowWorkAuthorizationRequestErrors]; +export type GetV1TimeoffError = GetV1TimeoffErrors[keyof GetV1TimeoffErrors]; -export type GetShowWorkAuthorizationRequestResponses = { +export type GetV1TimeoffResponses = { /** * Success */ - 200: WorkAuthorizationRequestResponse; + 200: ListTimeoffResponse; }; -export type GetShowWorkAuthorizationRequestResponse = - GetShowWorkAuthorizationRequestResponses[keyof GetShowWorkAuthorizationRequestResponses]; +export type GetV1TimeoffResponse = + GetV1TimeoffResponses[keyof GetV1TimeoffResponses]; -export type PatchUpdateWorkAuthorizationRequest2Data = { +export type PostV1TimeoffData = { /** - * Work Authorization Request + * Timeoff */ - body: UpdateWorkAuthorizationRequestParams; - path: { + body: CreateApprovedTimeoffParams; + headers: { /** - * work authorization request ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/work-authorization-requests/{id}'; + url: '/api/eor/v1/timeoff'; }; -export type PatchUpdateWorkAuthorizationRequest2Errors = { +export type PostV1TimeoffErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -14736,37 +14990,62 @@ export type PatchUpdateWorkAuthorizationRequest2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PostV1TimeoffError = PostV1TimeoffErrors[keyof PostV1TimeoffErrors]; + +export type PostV1TimeoffResponses = { + /** + * Created + */ + 201: TimeoffResponse; }; -export type PatchUpdateWorkAuthorizationRequest2Error = - PatchUpdateWorkAuthorizationRequest2Errors[keyof PatchUpdateWorkAuthorizationRequest2Errors]; +export type PostV1TimeoffResponse = + PostV1TimeoffResponses[keyof PostV1TimeoffResponses]; + +export type GetV1CostCalculatorCountriesData = { + body?: never; + path?: never; + query?: { + /** + * If the premium benefits should be included in the response + */ + include_premium_benefits?: boolean; + }; + url: '/api/eor/v1/cost-calculator/countries'; +}; -export type PatchUpdateWorkAuthorizationRequest2Responses = { +export type GetV1CostCalculatorCountriesResponses = { /** * Success */ - 200: WorkAuthorizationRequestResponse; + 200: CostCalculatorListCountryResponse; }; -export type PatchUpdateWorkAuthorizationRequest2Response = - PatchUpdateWorkAuthorizationRequest2Responses[keyof PatchUpdateWorkAuthorizationRequest2Responses]; +export type GetV1CostCalculatorCountriesResponse = + GetV1CostCalculatorCountriesResponses[keyof GetV1CostCalculatorCountriesResponses]; -export type PatchUpdateWorkAuthorizationRequestData = { +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData = { /** - * Work Authorization Request + * Proof of Payment */ - body: UpdateWorkAuthorizationRequestParams; + body: CreateRiskReserveProofOfPaymentParams; path: { /** - * work authorization request ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/work-authorization-requests/{id}'; + url: '/api/eor/v1/employments/{employment_id}/risk-reserve-proof-of-payments'; }; -export type PatchUpdateWorkAuthorizationRequestErrors = { +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors = { /** * Unauthorized */ @@ -14781,30 +15060,88 @@ export type PatchUpdateWorkAuthorizationRequestErrors = { 422: UnprocessableEntityResponse; }; -export type PatchUpdateWorkAuthorizationRequestError = - PatchUpdateWorkAuthorizationRequestErrors[keyof PatchUpdateWorkAuthorizationRequestErrors]; +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsError = + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors[keyof PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors]; -export type PatchUpdateWorkAuthorizationRequestResponses = { +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses = { /** * Success */ - 200: WorkAuthorizationRequestResponse; + 200: RiskReserveProofOfPaymentResponse; }; -export type PatchUpdateWorkAuthorizationRequestResponse = - PatchUpdateWorkAuthorizationRequestResponses[keyof PatchUpdateWorkAuthorizationRequestResponses]; +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponse = + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses[keyof PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses]; -export type PostCreateProbationExtensionData = { - /** - * ProbationExtension - */ - body: CreateProbationExtensionParams; - path?: never; +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData = + { + body?: never; + path: { + /** + * Employment Id + */ + employment_id: UuidSlug; + /** + * Background Check Id + */ + background_check_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/background-checks/{background_check_id}'; + }; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdError = + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors[keyof GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors]; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses = + { + /** + * Success + */ + 200: BackgroundChecksBackgroundCheckResponse; + }; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponse = + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses[keyof GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses]; + +export type GetV1TimeoffBalancesEmploymentIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Employment ID for which to show the time off balance + */ + employment_id: string; + }; query?: never; - url: '/v1/probation-extensions'; + url: '/api/eor/v1/timeoff-balances/{employment_id}'; }; -export type PostCreateProbationExtensionErrors = { +export type GetV1TimeoffBalancesEmploymentIdErrors = { /** * Bad Request */ @@ -14814,122 +15151,126 @@ export type PostCreateProbationExtensionErrors = { */ 401: UnauthorizedResponse; /** - * Not Found + * TimeoffBalanceNotFoundResponse */ - 404: NotFoundResponse; + 404: TimeoffBalanceNotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostCreateProbationExtensionError = - PostCreateProbationExtensionErrors[keyof PostCreateProbationExtensionErrors]; +export type GetV1TimeoffBalancesEmploymentIdError = + GetV1TimeoffBalancesEmploymentIdErrors[keyof GetV1TimeoffBalancesEmploymentIdErrors]; -export type PostCreateProbationExtensionResponses = { +export type GetV1TimeoffBalancesEmploymentIdResponses = { /** * Success */ - 200: ProbationExtensionResponse; + 200: TimeoffBalanceResponse; }; -export type PostCreateProbationExtensionResponse = - PostCreateProbationExtensionResponses[keyof PostCreateProbationExtensionResponses]; +export type GetV1TimeoffBalancesEmploymentIdResponse = + GetV1TimeoffBalancesEmploymentIdResponses[keyof GetV1TimeoffBalancesEmploymentIdResponses]; -export type PostCreateRiskReserveData = { - /** - * Risk Reserve - */ - body: CreateRiskReserveParams; +export type GetV1EmployeeExpensesData = { + body?: never; path?: never; query?: never; - url: '/v1/risk-reserve'; + url: '/api/eor/v1/employee/expenses'; }; -export type PostCreateRiskReserveErrors = { +export type GetV1EmployeeExpensesErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; }; -export type PostCreateRiskReserveError = - PostCreateRiskReserveErrors[keyof PostCreateRiskReserveErrors]; +export type GetV1EmployeeExpensesError = + GetV1EmployeeExpensesErrors[keyof GetV1EmployeeExpensesErrors]; -export type PostCreateRiskReserveResponses = { +export type GetV1EmployeeExpensesResponses = { /** * Success */ 200: SuccessResponse; }; -export type PostCreateRiskReserveResponse = - PostCreateRiskReserveResponses[keyof PostCreateRiskReserveResponses]; +export type GetV1EmployeeExpensesResponse = + GetV1EmployeeExpensesResponses[keyof GetV1EmployeeExpensesResponses]; -export type PostSubmitRiskReserveProofOfPaymentData = { +export type PostV1EmployeeExpensesData = { /** - * Proof of Payment + * Expense params */ - body: CreateRiskReserveProofOfPaymentParams; - path: { - /** - * Employment ID - */ - employment_id: string; - }; + body?: ParamsToCreateEmployeeExpense; + path?: never; query?: never; - url: '/v1/employments/{employment_id}/risk-reserve-proof-of-payments'; + url: '/api/eor/v1/employee/expenses'; }; -export type PostSubmitRiskReserveProofOfPaymentErrors = { +export type PostV1EmployeeExpensesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type PostSubmitRiskReserveProofOfPaymentError = - PostSubmitRiskReserveProofOfPaymentErrors[keyof PostSubmitRiskReserveProofOfPaymentErrors]; +export type PostV1EmployeeExpensesError = + PostV1EmployeeExpensesErrors[keyof PostV1EmployeeExpensesErrors]; -export type PostSubmitRiskReserveProofOfPaymentResponses = { +export type PostV1EmployeeExpensesResponses = { /** - * Success + * Created */ - 200: RiskReserveProofOfPaymentResponse; + 201: SuccessResponse; }; -export type PostSubmitRiskReserveProofOfPaymentResponse = - PostSubmitRiskReserveProofOfPaymentResponses[keyof PostSubmitRiskReserveProofOfPaymentResponses]; +export type PostV1EmployeeExpensesResponse = + PostV1EmployeeExpensesResponses[keyof PostV1EmployeeExpensesResponses]; -export type GetShowCompanyComplianceProfileData = { +export type GetV1ResignationsOffboardingRequestIdResignationLetterData = { body?: never; path: { /** - * Company ID + * Offboarding request ID */ - company_id: UuidSlug; + offboarding_request_id: string; }; query?: never; - url: '/v1/companies/{company_id}/compliance-profile'; + url: '/api/eor/v1/resignations/{offboarding_request_id}/resignation-letter'; }; -export type GetShowCompanyComplianceProfileErrors = { +export type GetV1ResignationsOffboardingRequestIdResignationLetterErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -14942,34 +15283,55 @@ export type GetShowCompanyComplianceProfileErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowCompanyComplianceProfileError = - GetShowCompanyComplianceProfileErrors[keyof GetShowCompanyComplianceProfileErrors]; +export type GetV1ResignationsOffboardingRequestIdResignationLetterError = + GetV1ResignationsOffboardingRequestIdResignationLetterErrors[keyof GetV1ResignationsOffboardingRequestIdResignationLetterErrors]; -export type GetShowCompanyComplianceProfileResponses = { +export type GetV1ResignationsOffboardingRequestIdResignationLetterResponses = { /** * Success */ - 200: CompanyComplianceProfileResponse; + 200: GenericFile; }; -export type GetShowCompanyComplianceProfileResponse = - GetShowCompanyComplianceProfileResponses[keyof GetShowCompanyComplianceProfileResponses]; +export type GetV1ResignationsOffboardingRequestIdResignationLetterResponse = + GetV1ResignationsOffboardingRequestIdResignationLetterResponses[keyof GetV1ResignationsOffboardingRequestIdResignationLetterResponses]; -export type GetIndexCompanyProductPriceData = { +export type DeleteV1CompanyManagersUserIdData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Company ID + * User ID */ - company_id: UuidSlug; + user_id: string; }; query?: never; - url: '/v1/companies/{company_id}/product-prices'; + url: '/api/eor/v1/company-managers/{user_id}'; }; -export type GetIndexCompanyProductPriceErrors = { +export type DeleteV1CompanyManagersUserIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -14982,43 +15344,38 @@ export type GetIndexCompanyProductPriceErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetIndexCompanyProductPriceError = - GetIndexCompanyProductPriceErrors[keyof GetIndexCompanyProductPriceErrors]; +export type DeleteV1CompanyManagersUserIdError = + DeleteV1CompanyManagersUserIdErrors[keyof DeleteV1CompanyManagersUserIdErrors]; -export type GetIndexCompanyProductPriceResponses = { +export type DeleteV1CompanyManagersUserIdResponses = { /** * Success */ - 200: ListProductPricesResponse; + 200: SuccessResponse; }; -export type GetIndexCompanyProductPriceResponse = - GetIndexCompanyProductPriceResponses[keyof GetIndexCompanyProductPriceResponses]; +export type DeleteV1CompanyManagersUserIdResponse = + DeleteV1CompanyManagersUserIdResponses[keyof DeleteV1CompanyManagersUserIdResponses]; -export type GetShowCompanyData = { +export type GetV1CompanyManagersUserIdData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Company ID + * User ID */ - company_id: string; + user_id: string; }; query?: never; - url: '/v1/companies/{company_id}'; + url: '/api/eor/v1/company-managers/{user_id}'; }; -export type GetShowCompanyErrors = { +export type GetV1CompanyManagersUserIdErrors = { /** * Bad Request */ @@ -15041,24 +15398,60 @@ export type GetShowCompanyErrors = { 429: TooManyRequestsResponse; }; -export type GetShowCompanyError = - GetShowCompanyErrors[keyof GetShowCompanyErrors]; +export type GetV1CompanyManagersUserIdError = + GetV1CompanyManagersUserIdErrors[keyof GetV1CompanyManagersUserIdErrors]; -export type GetShowCompanyResponses = { +export type GetV1CompanyManagersUserIdResponses = { /** * Success */ - 200: CompanyResponse; + 200: CompanyManagerResponse; }; -export type GetShowCompanyResponse = - GetShowCompanyResponses[keyof GetShowCompanyResponses]; +export type GetV1CompanyManagersUserIdResponse = + GetV1CompanyManagersUserIdResponses[keyof GetV1CompanyManagersUserIdResponses]; + +export type GetV1EmploymentsEmploymentIdOnboardingStepsData = { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/onboarding-steps'; +}; -export type PatchUpdateCompany2Data = { +export type GetV1EmploymentsEmploymentIdOnboardingStepsErrors = { /** - * Update Company params + * Unauthorized */ - body?: UpdateCompanyParams; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1EmploymentsEmploymentIdOnboardingStepsError = + GetV1EmploymentsEmploymentIdOnboardingStepsErrors[keyof GetV1EmploymentsEmploymentIdOnboardingStepsErrors]; + +export type GetV1EmploymentsEmploymentIdOnboardingStepsResponses = { + /** + * Success + */ + 200: EmploymentOnboardingStepsResponse; +}; + +export type GetV1EmploymentsEmploymentIdOnboardingStepsResponse = + GetV1EmploymentsEmploymentIdOnboardingStepsResponses[keyof GetV1EmploymentsEmploymentIdOnboardingStepsResponses]; + +export type PostV1ContractAmendmentsAutomatableData = { + /** + * Contract Amendment + */ + body?: CreateContractAmendmentParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -15068,31 +15461,17 @@ export type PatchUpdateCompany2Data = { */ Authorization: string; }; - path: { - /** - * Company ID - * - */ - company_id: string; - }; + path?: never; query?: { /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; - /** - * Version of the bank_account_details form schema + * Version of the form schema */ - bank_account_details_json_schema_version?: number | 'latest'; + json_schema_version?: number | 'latest'; }; - url: '/v1/companies/{company_id}'; + url: '/api/eor/v1/contract-amendments/automatable'; }; -export type PatchUpdateCompany2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1ContractAmendmentsAutomatableErrors = { /** * Unauthorized */ @@ -15105,64 +15484,42 @@ export type PatchUpdateCompany2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateCompany2Error = - PatchUpdateCompany2Errors[keyof PatchUpdateCompany2Errors]; +export type PostV1ContractAmendmentsAutomatableError = + PostV1ContractAmendmentsAutomatableErrors[keyof PostV1ContractAmendmentsAutomatableErrors]; -export type PatchUpdateCompany2Responses = { +export type PostV1ContractAmendmentsAutomatableResponses = { /** * Success */ - 200: CompanyResponse; + 200: ContractAmendmentAutomatableResponse; }; -export type PatchUpdateCompany2Response = - PatchUpdateCompany2Responses[keyof PatchUpdateCompany2Responses]; +export type PostV1ContractAmendmentsAutomatableResponse = + PostV1ContractAmendmentsAutomatableResponses[keyof PostV1ContractAmendmentsAutomatableResponses]; -export type PatchUpdateCompanyData = { - /** - * Update Company params - */ - body?: UpdateCompanyParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { +export type GetV1PayrollRunsData = { + body?: never; + path?: never; + query?: { /** - * Company ID - * + * Filters payroll runs where period_start or period_end match the given date */ - company_id: string; - }; - query?: { + payroll_period?: Date; /** - * Version of the address_details form schema + * Starts fetching records after the given page */ - address_details_json_schema_version?: number | 'latest'; + page?: number; /** - * Version of the bank_account_details form schema + * Number of items per page */ - bank_account_details_json_schema_version?: number | 'latest'; + page_size?: number; }; - url: '/v1/companies/{company_id}'; + url: '/api/eor/v1/payroll-runs'; }; -export type PatchUpdateCompanyErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1PayrollRunsErrors = { /** * Unauthorized */ @@ -15175,42 +15532,29 @@ export type PatchUpdateCompanyErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateCompanyError = - PatchUpdateCompanyErrors[keyof PatchUpdateCompanyErrors]; +export type GetV1PayrollRunsError = + GetV1PayrollRunsErrors[keyof GetV1PayrollRunsErrors]; -export type PatchUpdateCompanyResponses = { +export type GetV1PayrollRunsResponses = { /** * Success */ - 200: CompanyResponse; + 200: ListPayrollRunResponse; }; -export type PatchUpdateCompanyResponse = - PatchUpdateCompanyResponses[keyof PatchUpdateCompanyResponses]; +export type GetV1PayrollRunsResponse = + GetV1PayrollRunsResponses[keyof GetV1PayrollRunsResponses]; -export type GetDownloadResignationLetterData = { +export type GetV1EmployeeIncentivesData = { body?: never; - path: { - /** - * Offboarding request ID - */ - offboarding_request_id: string; - }; + path?: never; query?: never; - url: '/v1/resignations/{offboarding_request_id}/resignation-letter'; + url: '/api/eor/v1/employee/incentives'; }; -export type GetDownloadResignationLetterErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmployeeIncentivesErrors = { /** * Unauthorized */ @@ -15223,34 +15567,35 @@ export type GetDownloadResignationLetterErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetDownloadResignationLetterError = - GetDownloadResignationLetterErrors[keyof GetDownloadResignationLetterErrors]; +export type GetV1EmployeeIncentivesError = + GetV1EmployeeIncentivesErrors[keyof GetV1EmployeeIncentivesErrors]; -export type GetDownloadResignationLetterResponses = { +export type GetV1EmployeeIncentivesResponses = { /** * Success */ - 200: GenericFile; + 200: SuccessResponse; }; -export type GetDownloadResignationLetterResponse = - GetDownloadResignationLetterResponses[keyof GetDownloadResignationLetterResponses]; +export type GetV1EmployeeIncentivesResponse = + GetV1EmployeeIncentivesResponses[keyof GetV1EmployeeIncentivesResponses]; -export type PutUpdateEmploymentFederalTaxesData = { +export type PatchV1SandboxEmploymentsEmploymentId2Data = { /** - * Employment federal taxes params + * Employment params */ - body?: EmploymentFederalTaxesParams; + body?: EmploymentUpdateParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** * Employment ID @@ -15258,18 +15603,18 @@ export type PutUpdateEmploymentFederalTaxesData = { employment_id: string; }; query?: never; - url: '/v1/employments/{employment_id}/federal-taxes'; + url: '/api/eor/v1/sandbox/employments/{employment_id}'; }; -export type PutUpdateEmploymentFederalTaxesErrors = { +export type PatchV1SandboxEmploymentsEmploymentId2Errors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -15283,26 +15628,29 @@ export type PutUpdateEmploymentFederalTaxesErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PutUpdateEmploymentFederalTaxesError = - PutUpdateEmploymentFederalTaxesErrors[keyof PutUpdateEmploymentFederalTaxesErrors]; +export type PatchV1SandboxEmploymentsEmploymentId2Error = + PatchV1SandboxEmploymentsEmploymentId2Errors[keyof PatchV1SandboxEmploymentsEmploymentId2Errors]; -export type PutUpdateEmploymentFederalTaxesResponses = { +export type PatchV1SandboxEmploymentsEmploymentId2Responses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentResponse; }; -export type PutUpdateEmploymentFederalTaxesResponse = - PutUpdateEmploymentFederalTaxesResponses[keyof PutUpdateEmploymentFederalTaxesResponses]; +export type PatchV1SandboxEmploymentsEmploymentId2Response = + PatchV1SandboxEmploymentsEmploymentId2Responses[keyof PatchV1SandboxEmploymentsEmploymentId2Responses]; -export type GetIndexContractAmendmentData = { - body?: never; +export type PatchV1SandboxEmploymentsEmploymentIdData = { + /** + * Employment params + */ + body?: EmploymentUpdateParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -15312,29 +15660,21 @@ export type GetIndexContractAmendmentData = { */ Authorization: string; }; - path?: never; - query?: { + path: { /** * Employment ID */ - employment_id?: string; - /** - * Contract Amendment status - */ - status?: ContractAmendmentStatus; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; + employment_id: string; }; - url: '/v1/contract-amendments'; + query?: never; + url: '/api/eor/v1/sandbox/employments/{employment_id}'; }; -export type GetIndexContractAmendmentErrors = { +export type PatchV1SandboxEmploymentsEmploymentIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15343,30 +15683,35 @@ export type GetIndexContractAmendmentErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetIndexContractAmendmentError = - GetIndexContractAmendmentErrors[keyof GetIndexContractAmendmentErrors]; +export type PatchV1SandboxEmploymentsEmploymentIdError = + PatchV1SandboxEmploymentsEmploymentIdErrors[keyof PatchV1SandboxEmploymentsEmploymentIdErrors]; -export type GetIndexContractAmendmentResponses = { +export type PatchV1SandboxEmploymentsEmploymentIdResponses = { /** * Success */ - 200: ListContractAmendmentResponse; + 200: EmploymentResponse; }; -export type GetIndexContractAmendmentResponse = - GetIndexContractAmendmentResponses[keyof GetIndexContractAmendmentResponses]; +export type PatchV1SandboxEmploymentsEmploymentIdResponse = + PatchV1SandboxEmploymentsEmploymentIdResponses[keyof PatchV1SandboxEmploymentsEmploymentIdResponses]; -export type PostCreateContractAmendmentData = { - /** - * Contract Amendment - */ - body?: CreateContractAmendmentParams; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -15376,17 +15721,22 @@ export type PostCreateContractAmendmentData = { */ Authorization: string; }; - path?: never; + path: { + /** + * Benefit Renewal Request Id + */ + benefit_renewal_request_id: UuidSlug; + }; query?: { /** * Version of the form schema */ json_schema_version?: number | 'latest'; }; - url: '/v1/contract-amendments'; + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema'; }; -export type PostCreateContractAmendmentErrors = { +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors = { /** * Unauthorized */ @@ -15401,72 +15751,41 @@ export type PostCreateContractAmendmentErrors = { 422: UnprocessableEntityResponse; }; -export type PostCreateContractAmendmentError = - PostCreateContractAmendmentErrors[keyof PostCreateContractAmendmentErrors]; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaError = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors]; -export type PostCreateContractAmendmentResponses = { - /** - * Success - */ - 200: ContractAmendmentResponse; -}; - -export type PostCreateContractAmendmentResponse = - PostCreateContractAmendmentResponses[keyof PostCreateContractAmendmentResponses]; - -export type GetShowPayrollRunData = { - body?: never; - path: { +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses = + { /** - * Payroll run ID + * Success */ - payroll_run_id: string; + 200: BenefitRenewalRequestsBenefitRenewalRequestFormResponse; }; - query?: never; - url: '/v1/payroll-runs/{payroll_run_id}'; -}; - -export type GetShowPayrollRunErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; -}; -export type GetShowPayrollRunError = - GetShowPayrollRunErrors[keyof GetShowPayrollRunErrors]; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponse = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses]; -export type GetShowPayrollRunResponses = { +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsData = { /** - * Success + * Employment billing address details params */ - 200: PayrollRunResponse; -}; - -export type GetShowPayrollRunResponse = - GetShowPayrollRunResponses[keyof GetShowPayrollRunResponses]; - -export type GetDownloadExpenseReceiptData = { - body?: never; + body?: EmploymentBillingAddressDetailsParams; path: { /** - * The expense ID + * Employment ID */ - expense_id: string; + employment_id: string; }; - query?: never; - url: '/v1/expenses/{expense_id}/receipt'; + query?: { + /** + * Version of the billing_address_details form schema + */ + billing_address_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v2/employments/{employment_id}/billing_address_details'; }; -export type GetDownloadExpenseReceiptErrors = { +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors = { /** * Bad Request */ @@ -15483,6 +15802,10 @@ export type GetDownloadExpenseReceiptErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -15493,32 +15816,45 @@ export type GetDownloadExpenseReceiptErrors = { 429: TooManyRequestsResponse; }; -export type GetDownloadExpenseReceiptError = - GetDownloadExpenseReceiptErrors[keyof GetDownloadExpenseReceiptErrors]; +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsError = + PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors[keyof PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors]; -export type GetDownloadExpenseReceiptResponses = { +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses = { /** * Success */ - 200: GenericFile; + 200: EmploymentResponse; }; -export type GetDownloadExpenseReceiptResponse = - GetDownloadExpenseReceiptResponses[keyof GetDownloadExpenseReceiptResponses]; +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsResponse = + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses[keyof PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses]; -export type GetShowTravelLetterRequestData = { +export type DeleteV1IncentivesIdData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * travel letter request ID + * Incentive ID */ - id: UuidSlug; + id: string; }; query?: never; - url: '/v1/travel-letter-requests/{id}'; + url: '/api/eor/v1/incentives/{id}'; }; -export type GetShowTravelLetterRequestErrors = { +export type DeleteV1IncentivesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15527,41 +15863,59 @@ export type GetShowTravelLetterRequestErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetShowTravelLetterRequestError = - GetShowTravelLetterRequestErrors[keyof GetShowTravelLetterRequestErrors]; +export type DeleteV1IncentivesIdError = + DeleteV1IncentivesIdErrors[keyof DeleteV1IncentivesIdErrors]; -export type GetShowTravelLetterRequestResponses = { +export type DeleteV1IncentivesIdResponses = { /** * Success */ - 200: TravelLetterResponse; + 200: SuccessResponse; }; -export type GetShowTravelLetterRequestResponse = - GetShowTravelLetterRequestResponses[keyof GetShowTravelLetterRequestResponses]; +export type DeleteV1IncentivesIdResponse = + DeleteV1IncentivesIdResponses[keyof DeleteV1IncentivesIdResponses]; -export type PatchUpdateTravelLetterRequest2Data = { - /** - * Travel letter Request - */ - body: UpdateTravelLetterRequestParams; +export type GetV1IncentivesIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Travel letter Request ID + * Incentive ID */ id: string; }; query?: never; - url: '/v1/travel-letter-requests/{id}'; + url: '/api/eor/v1/incentives/{id}'; }; -export type PatchUpdateTravelLetterRequest2Errors = { +export type GetV1IncentivesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15574,37 +15928,54 @@ export type PatchUpdateTravelLetterRequest2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PatchUpdateTravelLetterRequest2Error = - PatchUpdateTravelLetterRequest2Errors[keyof PatchUpdateTravelLetterRequest2Errors]; +export type GetV1IncentivesIdError = + GetV1IncentivesIdErrors[keyof GetV1IncentivesIdErrors]; -export type PatchUpdateTravelLetterRequest2Responses = { +export type GetV1IncentivesIdResponses = { /** * Success */ - 200: TravelLetterResponse; + 200: IncentiveResponse; }; -export type PatchUpdateTravelLetterRequest2Response = - PatchUpdateTravelLetterRequest2Responses[keyof PatchUpdateTravelLetterRequest2Responses]; +export type GetV1IncentivesIdResponse = + GetV1IncentivesIdResponses[keyof GetV1IncentivesIdResponses]; -export type PatchUpdateTravelLetterRequestData = { +export type PatchV1IncentivesId2Data = { /** - * Travel letter Request + * Incentive */ - body: UpdateTravelLetterRequestParams; + body?: UpdateIncentiveParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Travel letter Request ID + * Incentive ID */ id: string; }; query?: never; - url: '/v1/travel-letter-requests/{id}'; + url: '/api/eor/v1/incentives/{id}'; }; -export type PatchUpdateTravelLetterRequestErrors = { +export type PatchV1IncentivesId2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15613,27 +15984,38 @@ export type PatchUpdateTravelLetterRequestErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PatchUpdateTravelLetterRequestError = - PatchUpdateTravelLetterRequestErrors[keyof PatchUpdateTravelLetterRequestErrors]; +export type PatchV1IncentivesId2Error = + PatchV1IncentivesId2Errors[keyof PatchV1IncentivesId2Errors]; -export type PatchUpdateTravelLetterRequestResponses = { +export type PatchV1IncentivesId2Responses = { /** * Success */ - 200: TravelLetterResponse; + 200: IncentiveResponse; }; -export type PatchUpdateTravelLetterRequestResponse = - PatchUpdateTravelLetterRequestResponses[keyof PatchUpdateTravelLetterRequestResponses]; +export type PatchV1IncentivesId2Response = + PatchV1IncentivesId2Responses[keyof PatchV1IncentivesId2Responses]; -export type GetShowTimeoffBalanceData = { - body?: never; +export type PatchV1IncentivesIdData = { + /** + * Incentive + */ + body?: UpdateIncentiveParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -15645,15 +16027,15 @@ export type GetShowTimeoffBalanceData = { }; path: { /** - * Employment ID for which to show the time off balance + * Incentive ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/timeoff-balances/{employment_id}'; + url: '/api/eor/v1/incentives/{id}'; }; -export type GetShowTimeoffBalanceErrors = { +export type PatchV1IncentivesIdErrors = { /** * Bad Request */ @@ -15663,9 +16045,13 @@ export type GetShowTimeoffBalanceErrors = { */ 401: UnauthorizedResponse; /** - * TimeoffBalanceNotFoundResponse + * Not Found */ - 404: TimeoffBalanceNotFoundResponse; + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -15676,43 +16062,169 @@ export type GetShowTimeoffBalanceErrors = { 429: TooManyRequestsResponse; }; -export type GetShowTimeoffBalanceError = - GetShowTimeoffBalanceErrors[keyof GetShowTimeoffBalanceErrors]; +export type PatchV1IncentivesIdError = + PatchV1IncentivesIdErrors[keyof PatchV1IncentivesIdErrors]; -export type GetShowTimeoffBalanceResponses = { +export type PatchV1IncentivesIdResponses = { /** * Success */ - 200: TimeoffBalanceResponse; + 200: IncentiveResponse; }; -export type GetShowTimeoffBalanceResponse = - GetShowTimeoffBalanceResponses[keyof GetShowTimeoffBalanceResponses]; +export type PatchV1IncentivesIdResponse = + PatchV1IncentivesIdResponses[keyof PatchV1IncentivesIdResponses]; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData = + { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Legal entity ID + */ + legal_entity_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors]; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses = + { + /** + * ShowLegalEntityAdministrativeDetailsResponse + * + * Country specific json schema driven administrative details for legal entities + */ + 200: { + data: { + [key: string]: unknown; + }; + }; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses]; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData = + { + /** + * Legal entity administrative details params + */ + body?: AdministrativeDetailsParams; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Legal entity ID + */ + legal_entity_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + }; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; + }; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError = + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors[keyof PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors]; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses = + { + /** + * ShowLegalEntityAdministrativeDetailsResponse + * + * Country specific json schema driven administrative details for legal entities + */ + 200: { + data: { + [key: string]: unknown; + }; + }; + }; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse = + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses[keyof PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses]; -export type PutUpdateEmploymentBasicInformationData = { +export type PutV2EmploymentsEmploymentIdBankAccountDetailsData = { /** - * Employment basic information params + * Employment bank account details params */ - body?: EmploymentBasicInformationParams; + body?: EmploymentBankAccountDetailsParams; path: { /** * Employment ID */ employment_id: string; }; - query?: never; - url: '/v1/employments/{employment_id}/basic_information'; + query?: { + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v2/employments/{employment_id}/bank_account_details'; }; -export type PutUpdateEmploymentBasicInformationErrors = { +export type PutV2EmploymentsEmploymentIdBankAccountDetailsErrors = { /** * Bad Request */ 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; /** * Conflict */ @@ -15727,48 +16239,92 @@ export type PutUpdateEmploymentBasicInformationErrors = { 429: TooManyRequestsResponse; }; -export type PutUpdateEmploymentBasicInformationError = - PutUpdateEmploymentBasicInformationErrors[keyof PutUpdateEmploymentBasicInformationErrors]; +export type PutV2EmploymentsEmploymentIdBankAccountDetailsError = + PutV2EmploymentsEmploymentIdBankAccountDetailsErrors[keyof PutV2EmploymentsEmploymentIdBankAccountDetailsErrors]; -export type PutUpdateEmploymentBasicInformationResponses = { +export type PutV2EmploymentsEmploymentIdBankAccountDetailsResponses = { /** * Success */ 200: EmploymentResponse; }; -export type PutUpdateEmploymentBasicInformationResponse = - PutUpdateEmploymentBasicInformationResponses[keyof PutUpdateEmploymentBasicInformationResponses]; +export type PutV2EmploymentsEmploymentIdBankAccountDetailsResponse = + PutV2EmploymentsEmploymentIdBankAccountDetailsResponses[keyof PutV2EmploymentsEmploymentIdBankAccountDetailsResponses]; -export type GetCategoriesExpenseData = { +export type GetV1ContractorInvoicesData = { body?: never; path?: never; query?: { /** - * The employment ID for which to list categories. Required if expense_id is not provided. + * Filters contractor invoices by status matching the value. */ - employment_id?: string; + status?: ContractorInvoiceStatus; /** - * The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context. + * Filters contractor invoices by invoice schedule ID matching the value. */ - expense_id?: string; + contractor_invoice_schedule_id?: UuidSlug; /** - * Include un-selectable intermediate categories in the response + * Filters contractor invoices by date greater than or equal to the value. */ - include_parents?: boolean; + date_from?: Date; + /** + * Filters contractor invoices by date less than or equal to the value. + */ + date_to?: Date; + /** + * Filters contractor invoices by due date greater than or equal to the value. + */ + due_date_from?: Date; + /** + * Filters contractor invoices by due date less than or equal to the value. + */ + due_date_to?: Date; + /** + * Filters contractor invoices by approved date greater than or equal to the value. + */ + approved_date_from?: Date; + /** + * Filters contractor invoices by approved date less than or equal to the value. + */ + approved_date_to?: Date; + /** + * Filters contractor invoices by paid out date greater than or equal to the value. + */ + paid_out_date_from?: Date; + /** + * Filters contractor invoices by paid out date less than or equal to the value. + */ + paid_out_date_to?: Date; + /** + * Field to sort by + */ + sort_by?: 'date' | 'due_date' | 'approved_at' | 'paid_out_at'; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - url: '/v1/expenses/categories'; + url: '/api/eor/v1/contractor-invoices'; }; -export type GetCategoriesExpenseErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1ContractorInvoicesErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -15777,41 +16333,46 @@ export type GetCategoriesExpenseErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetCategoriesExpenseError = - GetCategoriesExpenseErrors[keyof GetCategoriesExpenseErrors]; +export type GetV1ContractorInvoicesError = + GetV1ContractorInvoicesErrors[keyof GetV1ContractorInvoicesErrors]; -export type GetCategoriesExpenseResponses = { +export type GetV1ContractorInvoicesResponses = { /** * Success */ - 200: ListExpenseCategoriesResponse; + 200: ListContractorInvoicesResponse; }; -export type GetCategoriesExpenseResponse = - GetCategoriesExpenseResponses[keyof GetCategoriesExpenseResponses]; +export type GetV1ContractorInvoicesResponse = + GetV1ContractorInvoicesResponses[keyof GetV1ContractorInvoicesResponses]; -export type PostCancelEmployeeTimeoffData = { - /** - * CancelTimeoff - */ - body: CancelTimeoffParams; - path: { +export type GetV1ExpensesCategoriesData = { + body?: never; + path?: never; + query?: { /** - * Timeoff ID + * The employment ID for which to list categories. Required if neither expense_id nor country_code is provided. */ - id: string; - }; - query?: never; - url: '/v1/employee/timeoff/{id}/cancel'; -}; + employment_id?: string; + /** + * The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context. + */ + expense_id?: string; + /** + * Include un-selectable intermediate categories in the response + */ + include_parents?: boolean; + /** + * Filter categories by country (ISO 3166-1 alpha-3 code, e.g. "GBR"). Only used when neither employment_id nor expense_id is provided. + */ + country_code?: string; + }; + url: '/api/eor/v1/expenses/categories'; +}; -export type PostCancelEmployeeTimeoffErrors = { +export type GetV1ExpensesCategoriesErrors = { /** * Bad Request */ @@ -15829,71 +16390,54 @@ export type PostCancelEmployeeTimeoffErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostCancelEmployeeTimeoffError = - PostCancelEmployeeTimeoffErrors[keyof PostCancelEmployeeTimeoffErrors]; +export type GetV1ExpensesCategoriesError = + GetV1ExpensesCategoriesErrors[keyof GetV1ExpensesCategoriesErrors]; -export type PostCancelEmployeeTimeoffResponses = { +export type GetV1ExpensesCategoriesResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ListExpenseCategoriesResponse; }; -export type PostCancelEmployeeTimeoffResponse = - PostCancelEmployeeTimeoffResponses[keyof PostCancelEmployeeTimeoffResponses]; +export type GetV1ExpensesCategoriesResponse = + GetV1ExpensesCategoriesResponses[keyof GetV1ExpensesCategoriesResponses]; -export type GetShowFormCountryData = { +export type GetV1EmploymentsEmploymentIdContractDocumentsData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Country code according to ISO 3-digit alphabetic codes - */ - country_code: string; - /** - * Name of the desired form + * Employment ID */ - form: string; + employment_id: string; }; query?: { /** - * Required for `contract_amendment` form + * Filter by contract document statuses */ - employment_id?: string; + statuses?: Array; /** - * FOR TESTING PURPOSES ONLY: Include scheduled benefit groups. + * Exclude contract documents with specific statuses */ - only_for_testing_include_scheduled_benefit_groups?: boolean; + except_statuses?: Array; /** - * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + * Starts fetching records after the given page */ - skip_benefits?: boolean; + page?: number; /** - * Version of the form schema + * Number of items per page */ - json_schema_version?: number | 'latest'; + page_size?: number; }; - url: '/v1/countries/{country_code}/{form}'; + url: '/api/eor/v1/employments/{employment_id}/contract-documents'; }; -export type GetShowFormCountryErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmploymentsEmploymentIdContractDocumentsErrors = { /** * Unauthorized */ @@ -15906,38 +16450,47 @@ export type GetShowFormCountryErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetShowFormCountryError = - GetShowFormCountryErrors[keyof GetShowFormCountryErrors]; +export type GetV1EmploymentsEmploymentIdContractDocumentsError = + GetV1EmploymentsEmploymentIdContractDocumentsErrors[keyof GetV1EmploymentsEmploymentIdContractDocumentsErrors]; -export type GetShowFormCountryResponses = { +export type GetV1EmploymentsEmploymentIdContractDocumentsResponses = { /** * Success */ - 200: CountryFormResponse; + 200: IndexContractDocumentsResponse; }; -export type GetShowFormCountryResponse = - GetShowFormCountryResponses[keyof GetShowFormCountryResponses]; +export type GetV1EmploymentsEmploymentIdContractDocumentsResponse = + GetV1EmploymentsEmploymentIdContractDocumentsResponses[keyof GetV1EmploymentsEmploymentIdContractDocumentsResponses]; -export type GetShowFileData = { +export type GetV1CountriesCountryCodeContractorContractDetailsData = { body?: never; path: { /** - * File ID + * Country code according to ISO 3-digit alphabetic codes */ - id: string; + country_code: string; }; - query?: never; - url: '/v1/files/{id}'; + query?: { + /** + * Employment ID + */ + employment_id?: string; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/countries/{country_code}/contractor-contract-details'; }; -export type GetShowFileErrors = { +export type GetV1CountriesCountryCodeContractorContractDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15950,103 +16503,95 @@ export type GetShowFileErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowFileError = GetShowFileErrors[keyof GetShowFileErrors]; +export type GetV1CountriesCountryCodeContractorContractDetailsError = + GetV1CountriesCountryCodeContractorContractDetailsErrors[keyof GetV1CountriesCountryCodeContractorContractDetailsErrors]; -export type GetShowFileResponses = { +export type GetV1CountriesCountryCodeContractorContractDetailsResponses = { /** * Success */ - 200: DownloadFileResponse; + 200: ContractorContractDetailsResponse; }; -export type GetShowFileResponse = - GetShowFileResponses[keyof GetShowFileResponses]; +export type GetV1CountriesCountryCodeContractorContractDetailsResponse = + GetV1CountriesCountryCodeContractorContractDetailsResponses[keyof GetV1CountriesCountryCodeContractorContractDetailsResponses]; -export type GetShowContractAmendmentData = { +export type GetV1ScimV2UsersIdData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Contract amendment request ID + * User ID (slug) */ id: string; }; query?: never; - url: '/v1/contract-amendments/{id}'; + url: '/api/eor/v1/scim/v2/Users/{id}'; }; -export type GetShowContractAmendmentErrors = { +export type GetV1ScimV2UsersIdErrors = { /** * Unauthorized */ - 401: UnauthorizedResponse; + 401: IntegrationsScimErrorResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: IntegrationsScimErrorResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: IntegrationsScimErrorResponse; }; -export type GetShowContractAmendmentError = - GetShowContractAmendmentErrors[keyof GetShowContractAmendmentErrors]; +export type GetV1ScimV2UsersIdError = + GetV1ScimV2UsersIdErrors[keyof GetV1ScimV2UsersIdErrors]; -export type GetShowContractAmendmentResponses = { +export type GetV1ScimV2UsersIdResponses = { /** * Success */ - 200: ContractAmendmentResponse; + 200: IntegrationsScimUser; }; -export type GetShowContractAmendmentResponse = - GetShowContractAmendmentResponses[keyof GetShowContractAmendmentResponses]; +export type GetV1ScimV2UsersIdResponse = + GetV1ScimV2UsersIdResponses[keyof GetV1ScimV2UsersIdResponses]; -export type GetIndexCompanyManagerData = { +export type GetV1EmploymentsEmploymentIdFilesData = { body?: never; - headers: { + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Employment ID */ - Authorization: string; + employment_id: string; }; - path?: never; query?: { /** - * A Company ID to filter the results (only applicable for Integration Partners). + * Filter by file type (optional) */ - company_id?: string; + type?: string; + /** + * Filter by file sub_type (optional) + */ + sub_type?: string; /** * Starts fetching records after the given page */ page?: number; /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * Number of items per page */ page_size?: number; }; - url: '/v1/company-managers'; + url: '/api/eor/v1/employments/{employment_id}/files'; }; -export type GetIndexCompanyManagerErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmploymentsEmploymentIdFilesErrors = { /** * Unauthorized */ @@ -16059,175 +16604,138 @@ export type GetIndexCompanyManagerErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetIndexCompanyManagerError = - GetIndexCompanyManagerErrors[keyof GetIndexCompanyManagerErrors]; +export type GetV1EmploymentsEmploymentIdFilesError = + GetV1EmploymentsEmploymentIdFilesErrors[keyof GetV1EmploymentsEmploymentIdFilesErrors]; -export type GetIndexCompanyManagerResponses = { +export type GetV1EmploymentsEmploymentIdFilesResponses = { /** * Success */ - 200: CompanyManagersResponse; + 200: ListFilesResponse; }; -export type GetIndexCompanyManagerResponse = - GetIndexCompanyManagerResponses[keyof GetIndexCompanyManagerResponses]; +export type GetV1EmploymentsEmploymentIdFilesResponse = + GetV1EmploymentsEmploymentIdFilesResponses[keyof GetV1EmploymentsEmploymentIdFilesResponses]; -export type PostCreateCompanyManagerData = { - /** - * Company Manager params - */ - body?: CompanyManagerParams; - headers: { +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Manage Contractor Plus subscription params */ - Authorization: string; + body: ManageContractorPlusSubscriptionOperationsParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-plus-subscription'; }; - path?: never; - query?: { + +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors = + { /** - * Complementary action(s) to perform when creating a company manager: - * - * - `no_invite` skips the email invitation step - * + * Bad Request */ - actions?: string; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; }; - url: '/v1/company-managers'; -}; - -export type PostCreateCompanyManagerErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; -}; - -export type PostCreateCompanyManagerError = - PostCreateCompanyManagerErrors[keyof PostCreateCompanyManagerErrors]; - -export type PostCreateCompanyManagerResponses = { - /** - * Success - */ - 201: CompanyManagerData; -}; -export type PostCreateCompanyManagerResponse = - PostCreateCompanyManagerResponses[keyof PostCreateCompanyManagerResponses]; +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionError = + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors]; -export type GetIndexCountryData = { - body?: never; - path?: never; - query?: { +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses = + { /** - * If the premium benefits should be included in the response + * Success */ - include_premium_benefits?: boolean; + 200: SuccessResponse; }; - url: '/v1/cost-calculator/countries'; -}; -export type GetIndexCountryResponses = { +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponse = + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses]; + +export type PostV1ContractorsEligibilityQuestionnaireData = { /** - * Success + * Eligibility questionnaire submission */ - 200: CostCalculatorListCountryResponse; -}; - -export type GetIndexCountryResponse = - GetIndexCountryResponses[keyof GetIndexCountryResponses]; - -export type PostDeclineIdentityVerificationData = { - body?: never; - path: { + body: SubmitEligibilityQuestionnaireRequest; + path?: never; + query?: { /** - * Employment ID + * Version of the form schema */ - employment_id: string; + json_schema_version?: number | 'latest'; }; - query?: never; - url: '/v1/identity-verification/{employment_id}/decline'; + url: '/api/eor/v1/contractors/eligibility-questionnaire'; }; -export type PostDeclineIdentityVerificationErrors = { +export type PostV1ContractorsEligibilityQuestionnaireErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictErrorResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type PostDeclineIdentityVerificationError = - PostDeclineIdentityVerificationErrors[keyof PostDeclineIdentityVerificationErrors]; +export type PostV1ContractorsEligibilityQuestionnaireError = + PostV1ContractorsEligibilityQuestionnaireErrors[keyof PostV1ContractorsEligibilityQuestionnaireErrors]; -export type PostDeclineIdentityVerificationResponses = { +export type PostV1ContractorsEligibilityQuestionnaireResponses = { /** - * Success + * Questionnaire submitted successfully */ - 200: SuccessResponse; + 201: EligibilityQuestionnaireResponse; }; -export type PostDeclineIdentityVerificationResponse = - PostDeclineIdentityVerificationResponses[keyof PostDeclineIdentityVerificationResponses]; +export type PostV1ContractorsEligibilityQuestionnaireResponse = + PostV1ContractorsEligibilityQuestionnaireResponses[keyof PostV1ContractorsEligibilityQuestionnaireResponses]; -export type GetShowEngagementAgreementDetailsCountryData = { - body?: never; +export type PutV1EmploymentsEmploymentIdBasicInformationData = { + /** + * Employment basic information params + */ + body?: EmploymentBasicInformationParams; path: { /** - * Country code according to ISO 3-digit alphabetic codes + * Employment ID */ - country_code: string; + employment_id: string; }; query?: never; - url: '/v1/countries/{country_code}/engagement-agreement-details'; + url: '/api/eor/v1/employments/{employment_id}/basic_information'; }; -export type GetShowEngagementAgreementDetailsCountryErrors = { +export type PutV1EmploymentsEmploymentIdBasicInformationErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -16238,49 +16746,96 @@ export type GetShowEngagementAgreementDetailsCountryErrors = { 429: TooManyRequestsResponse; }; -export type GetShowEngagementAgreementDetailsCountryError = - GetShowEngagementAgreementDetailsCountryErrors[keyof GetShowEngagementAgreementDetailsCountryErrors]; +export type PutV1EmploymentsEmploymentIdBasicInformationError = + PutV1EmploymentsEmploymentIdBasicInformationErrors[keyof PutV1EmploymentsEmploymentIdBasicInformationErrors]; -export type GetShowEngagementAgreementDetailsCountryResponses = { +export type PutV1EmploymentsEmploymentIdBasicInformationResponses = { /** * Success */ - 200: EngagementAgreementDetailsResponse; + 200: EmploymentResponse; }; -export type GetShowEngagementAgreementDetailsCountryResponse = - GetShowEngagementAgreementDetailsCountryResponses[keyof GetShowEngagementAgreementDetailsCountryResponses]; +export type PutV1EmploymentsEmploymentIdBasicInformationResponse = + PutV1EmploymentsEmploymentIdBasicInformationResponses[keyof PutV1EmploymentsEmploymentIdBasicInformationResponses]; -export type GetIndexBillingDocumentData = { - body?: never; - headers: { +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + /** + * Termination Request ID + */ + termination_request_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}'; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Forbidden */ - Authorization: string; + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; }; - path?: never; - query?: { + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdError = + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors[keyof GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors]; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses = + { /** - * The month for the billing documents (in ISO-8601 format) + * Success */ - period?: string; + 200: CorTerminationRequestResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponse = + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses[keyof GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses]; + +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesData = { + /** + * Create legal entity params + */ + body?: { /** - * Starts fetching records after the given page + * ISO 3166-1 alpha-3 country code */ - page?: number; + country_code: string; + }; + headers: { /** - * Number of items per page + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - page_size?: number; + Authorization: string; }; - url: '/v1/billing-documents'; + path: { + /** + * Company ID + */ + company_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/companies/{company_id}/legal-entities'; }; -export type GetIndexBillingDocumentErrors = { +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -16293,43 +16848,75 @@ export type GetIndexBillingDocumentErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetIndexBillingDocumentError = - GetIndexBillingDocumentErrors[keyof GetIndexBillingDocumentErrors]; +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesError = + PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors[keyof PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors]; -export type GetIndexBillingDocumentResponses = { +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses = { /** - * Success + * Legal entity created */ - 200: BillingDocumentsResponse; + 201: { + data?: { + /** + * Legal entity slug + */ + legal_entity_id?: string; + /** + * Legal entity name + */ + name?: string; + /** + * Legal entity status + */ + status?: string; + }; + }; }; -export type GetIndexBillingDocumentResponse = - GetIndexBillingDocumentResponses[keyof GetIndexBillingDocumentResponses]; +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesResponse = + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses[keyof PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses]; -export type DeleteDeleteWebhookCallbackData = { +export type GetV1WdGphPayDetailDataData = { body?: never; - headers: { + headers?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * The preferred language of the inquiring user in Workday */ - Authorization: string; + accept_language?: string; }; - path: { + path?: never; + query: { /** - * Webhook Callback ID + * The pay group ID for identifying the pay group at the vendor system */ - id: string; + payGroupExternalId: string; + /** + * The run type id provided in the paySummary API + */ + runTypeId: string; + /** + * The cycle type id, defaults to the main run if not provided + */ + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; }; - query?: never; - url: '/v1/webhook-callbacks/{id}'; + url: '/api/eor/v1/wd/gph/payDetailData'; }; -export type DeleteDeleteWebhookCallbackErrors = { +export type GetV1WdGphPayDetailDataErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -16338,96 +16925,85 @@ export type DeleteDeleteWebhookCallbackErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type DeleteDeleteWebhookCallbackError = - DeleteDeleteWebhookCallbackErrors[keyof DeleteDeleteWebhookCallbackErrors]; +export type GetV1WdGphPayDetailDataError = + GetV1WdGphPayDetailDataErrors[keyof GetV1WdGphPayDetailDataErrors]; -export type DeleteDeleteWebhookCallbackResponses = { +export type GetV1WdGphPayDetailDataResponses = { /** * Success */ - 200: SuccessResponse; + 200: PayDetailDataResponse; }; -export type DeleteDeleteWebhookCallbackResponse = - DeleteDeleteWebhookCallbackResponses[keyof DeleteDeleteWebhookCallbackResponses]; +export type GetV1WdGphPayDetailDataResponse = + GetV1WdGphPayDetailDataResponses[keyof GetV1WdGphPayDetailDataResponses]; -export type PatchUpdateWebhookCallbackData = { - /** - * WebhookCallback - */ - body?: UpdateWebhookCallbackParams; +export type GetV1CostCalculatorRegionsSlugFieldsData = { + body?: never; path: { /** - * Webhook Callback ID + * Slug */ - id: string; + slug: string; }; - query?: never; - url: '/v1/webhook-callbacks/{id}'; + query?: { + /** + * If the premium benefits should be included in the response + */ + include_premium_benefits?: boolean; + }; + url: '/api/eor/v1/cost-calculator/regions/{slug}/fields'; }; -export type PatchUpdateWebhookCallbackErrors = { +export type GetV1CostCalculatorRegionsSlugFieldsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity + * Internal Server Error */ - 422: UnprocessableEntityResponse; + 500: InternalServerErrorResponse; }; -export type PatchUpdateWebhookCallbackError = - PatchUpdateWebhookCallbackErrors[keyof PatchUpdateWebhookCallbackErrors]; +export type GetV1CostCalculatorRegionsSlugFieldsError = + GetV1CostCalculatorRegionsSlugFieldsErrors[keyof GetV1CostCalculatorRegionsSlugFieldsErrors]; -export type PatchUpdateWebhookCallbackResponses = { +export type GetV1CostCalculatorRegionsSlugFieldsResponses = { /** * Success */ - 200: WebhookCallbackResponse; + 200: JsonSchemaResponse; }; -export type PatchUpdateWebhookCallbackResponse = - PatchUpdateWebhookCallbackResponses[keyof PatchUpdateWebhookCallbackResponses]; +export type GetV1CostCalculatorRegionsSlugFieldsResponse = + GetV1CostCalculatorRegionsSlugFieldsResponses[keyof GetV1CostCalculatorRegionsSlugFieldsResponses]; -export type PutUpdateEmploymentPersonalDetailsData = { - /** - * Employment personal details params - */ - body?: EmploymentPersonalDetailsParams; +export type PostV1CancelOnboardingEmploymentIdData = { + body?: never; path: { /** * Employment ID */ employment_id: string; }; - query?: never; - url: '/v1/employments/{employment_id}/personal_details'; + query?: { + /** + * Whether the request should be performed async + * + */ + async?: boolean; + }; + url: '/api/eor/v1/cancel-onboarding/{employment_id}'; }; -export type PutUpdateEmploymentPersonalDetailsErrors = { +export type PostV1CancelOnboardingEmploymentIdErrors = { /** * Bad Request */ 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ @@ -16438,62 +17014,43 @@ export type PutUpdateEmploymentPersonalDetailsErrors = { 429: TooManyRequestsResponse; }; -export type PutUpdateEmploymentPersonalDetailsError = - PutUpdateEmploymentPersonalDetailsErrors[keyof PutUpdateEmploymentPersonalDetailsErrors]; +export type PostV1CancelOnboardingEmploymentIdError = + PostV1CancelOnboardingEmploymentIdErrors[keyof PostV1CancelOnboardingEmploymentIdErrors]; -export type PutUpdateEmploymentPersonalDetailsResponses = { +export type PostV1CancelOnboardingEmploymentIdResponses = { /** * Success */ - 200: EmploymentResponse; + 200: SuccessResponse; }; -export type PutUpdateEmploymentPersonalDetailsResponse = - PutUpdateEmploymentPersonalDetailsResponses[keyof PutUpdateEmploymentPersonalDetailsResponses]; +export type PostV1CancelOnboardingEmploymentIdResponse = + PostV1CancelOnboardingEmploymentIdResponses[keyof PostV1CancelOnboardingEmploymentIdResponses]; -export type GetIndexTravelLetterRequestData = { - body?: never; - path?: never; - query?: { - /** - * Filter results on the given status - */ - status?: - | 'pending' - | 'cancelled' - | 'declined_by_manager' - | 'declined_by_remote' - | 'approved_by_manager' - | 'approved_by_remote'; - /** - * Filter results on the given employment slug - */ - employment_id?: string; - /** - * Filter results on the given employee name - */ - employee_name?: string; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - /** - * Field to sort by - */ - sort_by?: 'submitted_at'; - /** - * Starts fetching records after the given page - */ - page?: number; +export type PostV1EmployeeTimeoffIdCancelData = { + /** + * CancelTimeoff + */ + body: CancelTimeoffParams; + path: { /** - * Number of items per page + * Timeoff ID */ - page_size?: number; + id: string; }; - url: '/v1/travel-letter-requests'; + query?: never; + url: '/api/eor/v1/employee/timeoff/{id}/cancel'; }; -export type GetIndexTravelLetterRequestErrors = { +export type PostV1EmployeeTimeoffIdCancelErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -16502,47 +17059,38 @@ export type GetIndexTravelLetterRequestErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexTravelLetterRequestError = - GetIndexTravelLetterRequestErrors[keyof GetIndexTravelLetterRequestErrors]; +export type PostV1EmployeeTimeoffIdCancelError = + PostV1EmployeeTimeoffIdCancelErrors[keyof PostV1EmployeeTimeoffIdCancelErrors]; -export type GetIndexTravelLetterRequestResponses = { +export type PostV1EmployeeTimeoffIdCancelResponses = { /** * Success */ - 200: ListTravelLettersResponse; + 200: TimeoffResponse; }; -export type GetIndexTravelLetterRequestResponse = - GetIndexTravelLetterRequestResponses[keyof GetIndexTravelLetterRequestResponses]; +export type PostV1EmployeeTimeoffIdCancelResponse = + PostV1EmployeeTimeoffIdCancelResponses[keyof PostV1EmployeeTimeoffIdCancelResponses]; -export type GetIndexBenefitRenewalRequestData = { +export type GetV1ExpensesExpenseIdReceiptData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Number of items per page + * The expense ID */ - page_size?: number; + expense_id: string; }; - url: '/v1/benefit-renewal-requests'; + query?: never; + url: '/api/eor/v1/expenses/{expense_id}/receipt'; }; -export type GetIndexBenefitRenewalRequestErrors = { +export type GetV1ExpensesExpenseIdReceiptErrors = { /** * Bad Request */ @@ -16551,6 +17099,10 @@ export type GetIndexBenefitRenewalRequestErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -16565,24 +17117,21 @@ export type GetIndexBenefitRenewalRequestErrors = { 429: TooManyRequestsResponse; }; -export type GetIndexBenefitRenewalRequestError = - GetIndexBenefitRenewalRequestErrors[keyof GetIndexBenefitRenewalRequestErrors]; +export type GetV1ExpensesExpenseIdReceiptError = + GetV1ExpensesExpenseIdReceiptErrors[keyof GetV1ExpensesExpenseIdReceiptErrors]; -export type GetIndexBenefitRenewalRequestResponses = { +export type GetV1ExpensesExpenseIdReceiptResponses = { /** * Success */ - 200: BenefitRenewalRequestsListBenefitRenewalRequestResponse; + 200: GenericFile; }; -export type GetIndexBenefitRenewalRequestResponse = - GetIndexBenefitRenewalRequestResponses[keyof GetIndexBenefitRenewalRequestResponses]; +export type GetV1ExpensesExpenseIdReceiptResponse = + GetV1ExpensesExpenseIdReceiptResponses[keyof GetV1ExpensesExpenseIdReceiptResponses]; -export type PostCreateWebhookCallbackData = { - /** - * WebhookCallback - */ - body?: CreateWebhookCallbackParams; +export type GetV1BenefitOffersCountrySummariesData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -16594,14 +17143,10 @@ export type PostCreateWebhookCallbackData = { }; path?: never; query?: never; - url: '/v1/webhook-callbacks'; + url: '/api/eor/v1/benefit-offers/country-summaries'; }; -export type PostCreateWebhookCallbackErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; +export type GetV1BenefitOffersCountrySummariesErrors = { /** * Not Found */ @@ -16612,32 +17157,32 @@ export type PostCreateWebhookCallbackErrors = { 422: UnprocessableEntityResponse; }; -export type PostCreateWebhookCallbackError = - PostCreateWebhookCallbackErrors[keyof PostCreateWebhookCallbackErrors]; +export type GetV1BenefitOffersCountrySummariesError = + GetV1BenefitOffersCountrySummariesErrors[keyof GetV1BenefitOffersCountrySummariesErrors]; -export type PostCreateWebhookCallbackResponses = { +export type GetV1BenefitOffersCountrySummariesResponses = { /** * Success */ - 200: WebhookCallbackResponse; + 200: CountrySummariesResponse; }; -export type PostCreateWebhookCallbackResponse = - PostCreateWebhookCallbackResponses[keyof PostCreateWebhookCallbackResponses]; +export type GetV1BenefitOffersCountrySummariesResponse = + GetV1BenefitOffersCountrySummariesResponses[keyof GetV1BenefitOffersCountrySummariesResponses]; -export type PostApproveTimesheetData = { +export type GetV1LeavePoliciesDetailsEmploymentIdData = { body?: never; path: { /** - * Timesheet ID + * Employment ID */ - timesheet_id: string; + employment_id: string; }; query?: never; - url: '/v1/timesheets/{timesheet_id}/approve'; + url: '/api/eor/v1/leave-policies/details/{employment_id}'; }; -export type PostApproveTimesheetErrors = { +export type GetV1LeavePoliciesDetailsEmploymentIdErrors = { /** * Unauthorized */ @@ -16652,49 +17197,115 @@ export type PostApproveTimesheetErrors = { 422: UnprocessableEntityResponse; }; -export type PostApproveTimesheetError = - PostApproveTimesheetErrors[keyof PostApproveTimesheetErrors]; +export type GetV1LeavePoliciesDetailsEmploymentIdError = + GetV1LeavePoliciesDetailsEmploymentIdErrors[keyof GetV1LeavePoliciesDetailsEmploymentIdErrors]; -export type PostApproveTimesheetResponses = { +export type GetV1LeavePoliciesDetailsEmploymentIdResponses = { /** * Success */ - 200: MinimalTimesheetResponse; + 200: ListLeavePoliciesDetailsResponse; }; -export type PostApproveTimesheetResponse = - PostApproveTimesheetResponses[keyof PostApproveTimesheetResponses]; +export type GetV1LeavePoliciesDetailsEmploymentIdResponse = + GetV1LeavePoliciesDetailsEmploymentIdResponses[keyof GetV1LeavePoliciesDetailsEmploymentIdResponses]; -export type GetShowPayslipData = { +export type GetV1WorkAuthorizationRequestsData = { body?: never; - headers: { + path?: never; + query?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Filter results on the given status */ - Authorization: string; - }; - path: { - /** - * Payslip ID + status?: + | 'pending' + | 'cancelled' + | 'declined_by_manager' + | 'declined_by_remote' + | 'approved_by_manager' + | 'approved_by_remote'; + /** + * Filter results on the given employment slug */ - id: string; + employment_id?: string; + /** + * Filter results on the given employee name + */ + employee_name?: string; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'submitted_at'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/payslips/{id}'; + url: '/api/eor/v1/work-authorization-requests'; }; -export type GetShowPayslipErrors = { +export type GetV1WorkAuthorizationRequestsErrors = { /** - * Bad Request + * Not Found */ - 400: BadRequestResponse; + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1WorkAuthorizationRequestsError = + GetV1WorkAuthorizationRequestsErrors[keyof GetV1WorkAuthorizationRequestsErrors]; + +export type GetV1WorkAuthorizationRequestsResponses = { + /** + * Success + */ + 200: ListWorkAuthorizationRequestsResponse; +}; + +export type GetV1WorkAuthorizationRequestsResponse = + GetV1WorkAuthorizationRequestsResponses[keyof GetV1WorkAuthorizationRequestsResponses]; + +export type GetV1EmploymentsEmploymentIdBenefitOffersData = { + body?: never; + path: { + /** + * Unique identifier of the employment + */ + employment_id: UuidSlug; + }; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employments/{employment_id}/benefit-offers'; +}; + +export type GetV1EmploymentsEmploymentIdBenefitOffersErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -16703,42 +17314,50 @@ export type GetShowPayslipErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetShowPayslipError = - GetShowPayslipErrors[keyof GetShowPayslipErrors]; +export type GetV1EmploymentsEmploymentIdBenefitOffersError = + GetV1EmploymentsEmploymentIdBenefitOffersErrors[keyof GetV1EmploymentsEmploymentIdBenefitOffersErrors]; -export type GetShowPayslipResponses = { +export type GetV1EmploymentsEmploymentIdBenefitOffersResponses = { /** * Success */ - 200: PayslipResponse; + 200: EmploymentsBenefitOffersListBenefitOffers; }; -export type GetShowPayslipResponse = - GetShowPayslipResponses[keyof GetShowPayslipResponses]; +export type GetV1EmploymentsEmploymentIdBenefitOffersResponse = + GetV1EmploymentsEmploymentIdBenefitOffersResponses[keyof GetV1EmploymentsEmploymentIdBenefitOffersResponses]; -export type GetIndexLeavePoliciesSummaryData = { - body?: never; +export type PutV1EmploymentsEmploymentIdBenefitOffersData = { + /** + * Upsert employment benefit offers request + */ + body: UnifiedEmploymentUpsertBenefitOffersRequest; path: { /** - * Employment ID + * Unique identifier of the employment */ - employment_id: string; + employment_id: UuidSlug; }; - query?: never; - url: '/v1/leave-policies/summary/{employment_id}'; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/employments/{employment_id}/benefit-offers'; }; -export type GetIndexLeavePoliciesSummaryErrors = { +export type PutV1EmploymentsEmploymentIdBenefitOffersErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -16749,31 +17368,61 @@ export type GetIndexLeavePoliciesSummaryErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexLeavePoliciesSummaryError = - GetIndexLeavePoliciesSummaryErrors[keyof GetIndexLeavePoliciesSummaryErrors]; +export type PutV1EmploymentsEmploymentIdBenefitOffersError = + PutV1EmploymentsEmploymentIdBenefitOffersErrors[keyof PutV1EmploymentsEmploymentIdBenefitOffersErrors]; -export type GetIndexLeavePoliciesSummaryResponses = { +export type PutV1EmploymentsEmploymentIdBenefitOffersResponses = { /** * Success */ - 200: ListLeavePoliciesSummaryResponse; + 200: SuccessResponse; }; -export type GetIndexLeavePoliciesSummaryResponse = - GetIndexLeavePoliciesSummaryResponses[keyof GetIndexLeavePoliciesSummaryResponses]; +export type PutV1EmploymentsEmploymentIdBenefitOffersResponse = + PutV1EmploymentsEmploymentIdBenefitOffersResponses[keyof PutV1EmploymentsEmploymentIdBenefitOffersResponses]; -export type GetIndexCompanyDepartmentData = { +export type GetV1EmploymentsData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; - query: { + query?: { /** * Company ID */ - company_id: string; + company_id?: string; /** - * Paginate option. Default: true. When true, paginates response; otherwise, does not. + * Filters the results by employments whose login email matches the value */ - paginate?: boolean; + email?: string; + /** + * Filters the results by employments whose status matches the value. + * Supports multiple values separated by commas. + * Also supports the value `incomplete` to get all employments that are not onboarded yet. + * + */ + status?: string; + /** + * Filters the results by employments whose employment product type matches the value + */ + employment_type?: string; + /** + * Filters the results by employments whose employment model matches the value. + * Possible values: `global_payroll`, `peo`, `eor` + * + */ + employment_model?: 'global_payroll' | 'peo' | 'eor'; + /** + * Filters the results by the employment's short ID. Returns at most one result. + */ + short_id?: string; /** * Starts fetching records after the given page */ @@ -16783,91 +17432,139 @@ export type GetIndexCompanyDepartmentData = { */ page_size?: number; }; - url: '/v1/company-departments'; + url: '/api/eor/v1/employments'; }; -export type GetIndexCompanyDepartmentErrors = { +export type GetV1EmploymentsErrors = { /** - * Not Found + * Bad Request */ - 404: NotFoundResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexCompanyDepartmentError = - GetIndexCompanyDepartmentErrors[keyof GetIndexCompanyDepartmentErrors]; +export type GetV1EmploymentsError = + GetV1EmploymentsErrors[keyof GetV1EmploymentsErrors]; -export type GetIndexCompanyDepartmentResponses = { +export type GetV1EmploymentsResponses = { /** * Success */ - 200: ListCompanyDepartmentsPaginatedResponse; + 200: ListEmploymentsResponse; }; -export type GetIndexCompanyDepartmentResponse = - GetIndexCompanyDepartmentResponses[keyof GetIndexCompanyDepartmentResponses]; +export type GetV1EmploymentsResponse = + GetV1EmploymentsResponses[keyof GetV1EmploymentsResponses]; -export type PostCreateCompanyDepartmentData = { +export type PostV1EmploymentsData = { /** - * Create Company Department request params + * Employment params */ - body: CreateCompanyDepartmentParams; + body?: EmploymentCreateParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; - query?: never; - url: '/v1/company-departments'; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/employments'; }; -export type PostCreateCompanyDepartmentErrors = { +export type PostV1EmploymentsErrors = { /** - * Not Found + * Bad Request */ - 404: NotFoundResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostCreateCompanyDepartmentError = - PostCreateCompanyDepartmentErrors[keyof PostCreateCompanyDepartmentErrors]; +export type PostV1EmploymentsError = + PostV1EmploymentsErrors[keyof PostV1EmploymentsErrors]; -export type PostCreateCompanyDepartmentResponses = { +export type PostV1EmploymentsResponses = { /** - * Created + * Success */ - 201: CompanyDepartmentCreatedResponse; + 200: EmploymentCreationResponse; }; -export type PostCreateCompanyDepartmentResponse = - PostCreateCompanyDepartmentResponses[keyof PostCreateCompanyDepartmentResponses]; +export type PostV1EmploymentsResponse = + PostV1EmploymentsResponses[keyof PostV1EmploymentsResponses]; -export type PostDeclineCancellationRequestData = { - /** - * Timeoff - */ - body: DeclineTimeoffParams; +export type GetV1TimeoffIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Time Off ID + * Timeoff ID */ - timeoff_id: string; + id: string; }; query?: never; - url: '/v1/timeoff/{timeoff_id}/cancel-request/decline'; + url: '/api/eor/v1/timeoff/{id}'; }; -export type PostDeclineCancellationRequestErrors = { +export type GetV1TimeoffIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ @@ -16878,41 +17575,52 @@ export type PostDeclineCancellationRequestErrors = { 429: TooManyRequestsResponse; }; -export type PostDeclineCancellationRequestError = - PostDeclineCancellationRequestErrors[keyof PostDeclineCancellationRequestErrors]; +export type GetV1TimeoffIdError = + GetV1TimeoffIdErrors[keyof GetV1TimeoffIdErrors]; -export type PostDeclineCancellationRequestResponses = { +export type GetV1TimeoffIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: TimeoffResponse; }; -export type PostDeclineCancellationRequestResponse = - PostDeclineCancellationRequestResponses[keyof PostDeclineCancellationRequestResponses]; +export type GetV1TimeoffIdResponse = + GetV1TimeoffIdResponses[keyof GetV1TimeoffIdResponses]; -export type GetShowSchemaData = { - body?: never; - path: { +export type PatchV1TimeoffId2Data = { + /** + * UpdateTimeoff + */ + body: UpdateApprovedTimeoffParams; + headers: { /** - * Unique identifier of the employment + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - employment_id: UuidSlug; + Authorization: string; }; - query?: { + path: { /** - * Version of the form schema + * Timeoff ID */ - json_schema_version?: number | 'latest'; + id: string; }; - url: '/v1/employments/{employment_id}/benefit-offers/schema'; + query?: never; + url: '/api/eor/v1/timeoff/{id}'; }; -export type GetShowSchemaErrors = { +export type PatchV1TimeoffId2Errors = { /** - * Forbidden + * Bad Request */ - 403: ForbiddenResponse; + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -16921,83 +17629,203 @@ export type GetShowSchemaErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowSchemaError = GetShowSchemaErrors[keyof GetShowSchemaErrors]; +export type PatchV1TimeoffId2Error = + PatchV1TimeoffId2Errors[keyof PatchV1TimeoffId2Errors]; -export type GetShowSchemaResponses = { +export type PatchV1TimeoffId2Responses = { /** * Success */ - 200: UnifiedEmploymentsBenefitOffersJsonSchemaResponse; + 200: TimeoffResponse; }; -export type GetShowSchemaResponse = - GetShowSchemaResponses[keyof GetShowSchemaResponses]; +export type PatchV1TimeoffId2Response = + PatchV1TimeoffId2Responses[keyof PatchV1TimeoffId2Responses]; -export type PostCreateEligibilityQuestionnaireData = { +export type PatchV1TimeoffIdData = { /** - * Eligibility questionnaire submission + * UpdateTimeoff */ - body: SubmitEligibilityQuestionnaireRequest; - path?: never; - query?: { + body: UpdateApprovedTimeoffParams; + headers: { /** - * Version of the form schema + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - json_schema_version?: number | 'latest'; + Authorization: string; }; - url: '/v1/contractors/eligibility-questionnaire'; + path: { + /** + * Timeoff ID + */ + id: string; + }; + query?: never; + url: '/api/eor/v1/timeoff/{id}'; }; -export type PostCreateEligibilityQuestionnaireErrors = { +export type PatchV1TimeoffIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: ForbiddenResponse; + 404: NotFoundResponse; /** - * Conflict + * Unprocessable Entity */ - 409: ConflictErrorResponse; + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PatchV1TimeoffIdError = + PatchV1TimeoffIdErrors[keyof PatchV1TimeoffIdErrors]; + +export type PatchV1TimeoffIdResponses = { + /** + * Success + */ + 200: TimeoffResponse; +}; + +export type PatchV1TimeoffIdResponse = + PatchV1TimeoffIdResponses[keyof PatchV1TimeoffIdResponses]; + +export type GetV1IdentityCurrentData = { + body?: never; + headers: { + /** + * This endpoint works with any of the access tokens provided. You can use an access + * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. + * + */ + Authorization: string; + }; + path?: never; + query?: never; + url: '/api/eor/v1/identity/current'; +}; + +export type GetV1IdentityCurrentErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostCreateEligibilityQuestionnaireError = - PostCreateEligibilityQuestionnaireErrors[keyof PostCreateEligibilityQuestionnaireErrors]; +export type GetV1IdentityCurrentError = + GetV1IdentityCurrentErrors[keyof GetV1IdentityCurrentErrors]; -export type PostCreateEligibilityQuestionnaireResponses = { +export type GetV1IdentityCurrentResponses = { /** - * Questionnaire submitted successfully + * Success */ - 201: EligibilityQuestionnaireResponse; + 201: IdentityCurrentResponse; }; -export type PostCreateEligibilityQuestionnaireResponse = - PostCreateEligibilityQuestionnaireResponses[keyof PostCreateEligibilityQuestionnaireResponses]; +export type GetV1IdentityCurrentResponse = + GetV1IdentityCurrentResponses[keyof GetV1IdentityCurrentResponses]; -export type GetIndexTimesheetData = { +export type GetV1WdGphPayVarianceData = { body?: never; + headers?: { + /** + * The preferred language of the inquiring user in Workday + */ + accept_language?: string; + }; path?: never; - query?: { + query: { /** - * Filter timesheets by their status + * The pay group ID for identifying the pay group at the vendor system */ - status?: TimesheetStatus; + payGroupExternalId: string; /** - * Sort order + * The run type id provided in the paySummary API */ - order?: 'asc' | 'desc'; + runTypeId: string; /** - * Field to sort by + * The cycle type id, defaults to the main run if not provided */ - sort_by?: 'submitted_at'; + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; + }; + url: '/api/eor/v1/wd/gph/payVariance'; +}; + +export type GetV1WdGphPayVarianceErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1WdGphPayVarianceError = + GetV1WdGphPayVarianceErrors[keyof GetV1WdGphPayVarianceErrors]; + +export type GetV1WdGphPayVarianceResponses = { + /** + * Success + */ + 200: PayVarianceResponse; +}; + +export type GetV1WdGphPayVarianceResponse = + GetV1WdGphPayVarianceResponses[keyof GetV1WdGphPayVarianceResponses]; + +export type GetV1PayrollCalendarsCycleData = { + body?: never; + path: { + /** + * The cycle for which to list the payroll calendars. Format: YYYY-MM + */ + cycle: string; + }; + query?: { /** * Starts fetching records after the given page */ @@ -17007,10 +17835,10 @@ export type GetIndexTimesheetData = { */ page_size?: number; }; - url: '/v1/timesheets'; + url: '/api/eor/v1/payroll-calendars/{cycle}'; }; -export type GetIndexTimesheetErrors = { +export type GetV1PayrollCalendarsCycleErrors = { /** * Unauthorized */ @@ -17025,53 +17853,82 @@ export type GetIndexTimesheetErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexTimesheetError = - GetIndexTimesheetErrors[keyof GetIndexTimesheetErrors]; +export type GetV1PayrollCalendarsCycleError = + GetV1PayrollCalendarsCycleErrors[keyof GetV1PayrollCalendarsCycleErrors]; -export type GetIndexTimesheetResponses = { +export type GetV1PayrollCalendarsCycleResponses = { /** * Success */ - 200: ListTimesheetsResponse; + 200: PayrollCalendarsResponse; }; -export type GetIndexTimesheetResponse = - GetIndexTimesheetResponses[keyof GetIndexTimesheetResponses]; +export type GetV1PayrollCalendarsCycleResponse = + GetV1PayrollCalendarsCycleResponses[keyof GetV1PayrollCalendarsCycleResponses]; -export type PostCreateLegalEntityCompanyData = { - /** - * Create legal entity params - */ - body?: { +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/terminate-cor-employment'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors = + { /** - * ISO 3166-1 alpha-3 country code + * Bad Request */ - country_code: string; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; - headers: { + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentError = + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors[keyof PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Success */ - Authorization: string; + 200: SuccessResponse; }; + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponse = + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses[keyof PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses]; + +export type PostV1TimesheetsTimesheetIdSendBackData = { + /** + * SendBackTimesheetParams + */ + body?: SendBackTimesheetParams; path: { /** - * Company ID + * Timesheet ID */ - company_id: string; + timesheet_id: string; }; query?: never; - url: '/v1/sandbox/companies/{company_id}/legal-entities'; + url: '/api/eor/v1/timesheets/{timesheet_id}/send-back'; }; -export type PostCreateLegalEntityCompanyErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1TimesheetsTimesheetIdSendBackErrors = { /** * Unauthorized */ @@ -17084,41 +17941,80 @@ export type PostCreateLegalEntityCompanyErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PostCreateLegalEntityCompanyError = - PostCreateLegalEntityCompanyErrors[keyof PostCreateLegalEntityCompanyErrors]; +export type PostV1TimesheetsTimesheetIdSendBackError = + PostV1TimesheetsTimesheetIdSendBackErrors[keyof PostV1TimesheetsTimesheetIdSendBackErrors]; -export type PostCreateLegalEntityCompanyResponses = { +export type PostV1TimesheetsTimesheetIdSendBackResponses = { /** - * Legal entity created + * Success */ - 201: { - data?: { - /** - * Legal entity slug - */ - legal_entity_id?: string; + 200: SentBackTimesheetResponse; +}; + +export type PostV1TimesheetsTimesheetIdSendBackResponse = + PostV1TimesheetsTimesheetIdSendBackResponses[keyof PostV1TimesheetsTimesheetIdSendBackResponses]; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData = + { + /** + * SignContractDocument + */ + body: SignContractDocument; + path: { /** - * Legal entity name + * Employment ID */ - name?: string; + employment_id: string; /** - * Legal entity status + * Pre-onboarding document ID */ - status?: string; + id: string; }; + query?: never; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign'; }; -}; -export type PostCreateLegalEntityCompanyResponse = - PostCreateLegalEntityCompanyResponses[keyof PostCreateLegalEntityCompanyResponses]; +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignError = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors]; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses = + { + /** + * Success + */ + 200: SuccessResponse; + }; -export type GetShowEmploymentData = { +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponse = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses]; + +export type GetV1BenefitRenewalRequestsData = { body?: never; headers: { /** @@ -17129,34 +18025,33 @@ export type GetShowEmploymentData = { */ Authorization: string; }; - path: { + path?: never; + query?: { /** - * Employment ID + * Starts fetching records after the given page */ - employment_id: string; - }; - query?: { + page?: number; /** - * Wether files should be excluded + * Number of items per page */ - exclude_files?: boolean; + page_size?: number; }; - url: '/v1/employments/{employment_id}'; + url: '/api/eor/v1/benefit-renewal-requests'; }; -export type GetShowEmploymentErrors = { +export type GetV1BenefitRenewalRequestsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ @@ -17167,303 +18062,321 @@ export type GetShowEmploymentErrors = { 429: TooManyRequestsResponse; }; -export type GetShowEmploymentError = - GetShowEmploymentErrors[keyof GetShowEmploymentErrors]; +export type GetV1BenefitRenewalRequestsError = + GetV1BenefitRenewalRequestsErrors[keyof GetV1BenefitRenewalRequestsErrors]; -export type GetShowEmploymentResponses = { +export type GetV1BenefitRenewalRequestsResponses = { /** * Success */ - 200: EmploymentShowResponse; + 200: BenefitRenewalRequestsListBenefitRenewalRequestResponse; }; -export type GetShowEmploymentResponse = - GetShowEmploymentResponses[keyof GetShowEmploymentResponses]; +export type GetV1BenefitRenewalRequestsResponse = + GetV1BenefitRenewalRequestsResponses[keyof GetV1BenefitRenewalRequestsResponses]; -export type PatchUpdateEmployment2Data = { - /** - * Employment params - */ - body?: EmploymentFullParams; - headers: { +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData = + { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Company ID + */ + company_id: string; + /** + * Legal Entity ID to set as the new default + */ + legal_entity_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}'; + }; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Bad Request */ - Authorization: string; - }; - path: { + 400: BadRequestResponse; /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; - /** - * Version of the administrative_details form schema - */ - administrative_details_json_schema_version?: number | 'latest'; - /** - * Version of the bank_account_details form schema - */ - bank_account_details_json_schema_version?: number | 'latest'; - /** - * Version of the employment_basic_information form schema + * Unauthorized */ - employment_basic_information_json_schema_version?: number | 'latest'; + 401: UnauthorizedResponse; /** - * Version of the billing_address_details form schema + * Not Found */ - billing_address_details_json_schema_version?: number | 'latest'; + 404: NotFoundResponse; /** - * Version of the contract_details form schema + * Unprocessable Entity */ - contract_details_json_schema_version?: number | 'latest'; + 422: UnprocessableEntityResponse; /** - * Version of the emergency_contact_details form schema + * Too many requests */ - emergency_contact_details_json_schema_version?: number | 'latest'; + 429: TooManyRequestsResponse; + }; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdError = + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors[keyof PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors]; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses = + { /** - * Version of the personal_details form schema + * Success */ - personal_details_json_schema_version?: number | 'latest'; + 200: SuccessResponse; + }; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponse = + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses[keyof PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses]; + +export type GetV1EmploymentContractsData = { + body?: never; + headers: { /** - * Version of the pricing_plan_details form schema + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - pricing_plan_details_json_schema_version?: number | 'latest'; + Authorization: string; + }; + path?: never; + query: { /** - * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + * Employment ID */ - skip_benefits?: boolean; + employment_id: string; /** - * Complementary action(s) to perform when creating an employment. + * Only Active */ - actions?: string; + only_active?: boolean; }; - url: '/v1/employments/{employment_id}'; + url: '/api/eor/v1/employment-contracts'; }; -export type PatchUpdateEmployment2Errors = { +export type GetV1EmploymentContractsErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ 403: ForbiddenResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateEmployment2Error = - PatchUpdateEmployment2Errors[keyof PatchUpdateEmployment2Errors]; +export type GetV1EmploymentContractsError = + GetV1EmploymentContractsErrors[keyof GetV1EmploymentContractsErrors]; -export type PatchUpdateEmployment2Responses = { +export type GetV1EmploymentContractsResponses = { /** * Success */ - 200: EmploymentResponse; + 200: ListEmploymentContractResponse; }; -export type PatchUpdateEmployment2Response = - PatchUpdateEmployment2Responses[keyof PatchUpdateEmployment2Responses]; +export type GetV1EmploymentContractsResponse = + GetV1EmploymentContractsResponses[keyof GetV1EmploymentContractsResponses]; -export type PatchUpdateEmploymentData = { - /** - * Employment params - */ - body?: EmploymentFullParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { - /** - * Employment ID - */ - employment_id: string; +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData = + { + body?: never; + path: { + /** + * Contract amendment request ID + */ + contract_amendment_request_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel'; }; - query?: { - /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; - /** - * Version of the administrative_details form schema - */ - administrative_details_json_schema_version?: number | 'latest'; - /** - * Version of the bank_account_details form schema - */ - bank_account_details_json_schema_version?: number | 'latest'; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors = + { /** - * Version of the employment_basic_information form schema + * Bad Request */ - employment_basic_information_json_schema_version?: number | 'latest'; + 400: BadRequestResponse; /** - * Version of the billing_address_details form schema + * Unauthorized */ - billing_address_details_json_schema_version?: number | 'latest'; + 401: UnauthorizedResponse; /** - * Version of the contract_details form schema + * Not Found */ - contract_details_json_schema_version?: number | 'latest'; + 404: NotFoundResponse; /** - * Version of the emergency_contact_details form schema + * Unprocessable Entity */ - emergency_contact_details_json_schema_version?: number | 'latest'; + 422: UnprocessableEntityResponse; /** - * Version of the personal_details form schema + * Too many requests */ - personal_details_json_schema_version?: number | 'latest'; + 429: TooManyRequestsResponse; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelError = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors]; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses = + { /** - * Version of the pricing_plan_details form schema + * Success */ - pricing_plan_details_json_schema_version?: number | 'latest'; + 200: SuccessResponse; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponse = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses]; + +export type GetV1PayslipsPayslipIdPdfData = { + body?: never; + headers: { /** - * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - skip_benefits?: boolean; + Authorization: string; + }; + path: { /** - * Complementary action(s) to perform when creating an employment. + * Payslip ID */ - actions?: string; + payslip_id: string; }; - url: '/v1/employments/{employment_id}'; + query?: never; + url: '/api/eor/v1/payslips/{payslip_id}/pdf'; }; -export type PatchUpdateEmploymentErrors = { +export type GetV1PayslipsPayslipIdPdfErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PatchUpdateEmploymentError = - PatchUpdateEmploymentErrors[keyof PatchUpdateEmploymentErrors]; +export type GetV1PayslipsPayslipIdPdfError = + GetV1PayslipsPayslipIdPdfErrors[keyof GetV1PayslipsPayslipIdPdfErrors]; -export type PatchUpdateEmploymentResponses = { +export type GetV1PayslipsPayslipIdPdfResponses = { /** * Success */ - 200: EmploymentResponse; + 200: PayslipDownloadResponse; }; -export type PatchUpdateEmploymentResponse = - PatchUpdateEmploymentResponses[keyof PatchUpdateEmploymentResponses]; +export type GetV1PayslipsPayslipIdPdfResponse = + GetV1PayslipsPayslipIdPdfResponses[keyof GetV1PayslipsPayslipIdPdfResponses]; -export type GetListUsersScimData = { - body?: never; - path?: never; - query?: { - /** - * 1-based index of the first result - */ - startIndex?: number; - /** - * Maximum number of results per page - */ - count?: number; +export type PostV1TimeoffTimeoffIdApproveData = { + /** + * ApproveTimeoff + */ + body: ApproveTimeoffParams; + path: { /** - * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + * Time Off ID */ - filter?: string; + timeoff_id: string; }; - url: '/v1/scim/v2/Users'; + query?: never; + url: '/api/eor/v1/timeoff/{timeoff_id}/approve'; }; -export type GetListUsersScimErrors = { +export type PostV1TimeoffTimeoffIdApproveErrors = { /** * Bad Request */ - 400: IntegrationsScimErrorResponse; + 400: BadRequestResponse; /** * Unauthorized */ - 401: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: IntegrationsScimErrorResponse; + 404: NotFoundResponse; /** - * Not Found + * Unprocessable Entity */ - 404: IntegrationsScimErrorResponse; + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetListUsersScimError = - GetListUsersScimErrors[keyof GetListUsersScimErrors]; +export type PostV1TimeoffTimeoffIdApproveError = + PostV1TimeoffTimeoffIdApproveErrors[keyof PostV1TimeoffTimeoffIdApproveErrors]; -export type GetListUsersScimResponses = { +export type PostV1TimeoffTimeoffIdApproveResponses = { /** * Success */ - 200: IntegrationsScimUserListResponse; + 200: TimeoffResponse; }; -export type GetListUsersScimResponse = - GetListUsersScimResponses[keyof GetListUsersScimResponses]; +export type PostV1TimeoffTimeoffIdApproveResponse = + PostV1TimeoffTimeoffIdApproveResponses[keyof PostV1TimeoffTimeoffIdApproveResponses]; -export type GetIndexPayrollCalendarData = { +export type GetV1CompaniesData = { body?: never; - path: { + headers: { /** - * The cycle for which to list the payroll calendars. Format: YYYY-MM + * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Client Credentials flow. + * */ - cycle: string; + Authorization: string; }; + path?: never; query?: { /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * External ID */ - page_size?: number; + external_id?: string; }; - url: '/v1/payroll-calendars/{cycle}'; + url: '/api/eor/v1/companies'; }; -export type GetIndexPayrollCalendarErrors = { +export type GetV1CompaniesErrors = { /** * Unauthorized */ @@ -17478,85 +18391,116 @@ export type GetIndexPayrollCalendarErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexPayrollCalendarError = - GetIndexPayrollCalendarErrors[keyof GetIndexPayrollCalendarErrors]; +export type GetV1CompaniesError = + GetV1CompaniesErrors[keyof GetV1CompaniesErrors]; -export type GetIndexPayrollCalendarResponses = { +export type GetV1CompaniesResponses = { /** * Success */ - 200: PayrollCalendarsResponse; + 200: CompaniesResponse; }; -export type GetIndexPayrollCalendarResponse = - GetIndexPayrollCalendarResponses[keyof GetIndexPayrollCalendarResponses]; +export type GetV1CompaniesResponse = + GetV1CompaniesResponses[keyof GetV1CompaniesResponses]; -export type GetShowAdministrativeDetailsData = { - body?: never; - path: { +export type PostV1CompaniesData = { + /** + * Create Company params + */ + body?: CreateCompanyParams; + headers: { /** - * Company ID + * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Client Credentials flow. + * */ - company_id: UuidSlug; + Authorization: string; + }; + path?: never; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + /** + * Complementary action(s) to perform when creating a company: + * + * - `get_oauth_access_tokens` returns the user's access and refresh tokens + * - `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only) + * + * If `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send) + * + */ + action?: string; + /** + * Whether the request should be performed async + * + */ + async?: boolean; /** - * Legal entity ID + * Scope of the access token + * */ - legal_entity_id: UuidSlug; + scope?: string; }; - query?: never; - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + url: '/api/eor/v1/companies'; }; -export type GetShowAdministrativeDetailsErrors = { +export type PostV1CompaniesErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: CompanyCreationConflictErrorResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowAdministrativeDetailsError = - GetShowAdministrativeDetailsErrors[keyof GetShowAdministrativeDetailsErrors]; +export type PostV1CompaniesError = + PostV1CompaniesErrors[keyof PostV1CompaniesErrors]; -export type GetShowAdministrativeDetailsResponses = { +export type PostV1CompaniesResponses = { /** - * ShowLegalEntityAdministrativeDetailsResponse - * - * Country specific json schema driven administrative details for legal entities + * Created */ - 200: { - data: { - [key: string]: unknown; - }; - }; + 201: CompanyCreationResponse; }; -export type GetShowAdministrativeDetailsResponse = - GetShowAdministrativeDetailsResponses[keyof GetShowAdministrativeDetailsResponses]; +export type PostV1CompaniesResponse = + PostV1CompaniesResponses[keyof PostV1CompaniesResponses]; -export type PutUpdateAdministrativeDetailsData = { - /** - * Legal entity administrative details params - */ - body?: AdministrativeDetailsParams; +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesData = { + body?: never; path: { /** - * Company ID - */ - company_id: UuidSlug; - /** - * Legal entity ID + * Employment ID */ - legal_entity_id: UuidSlug; + employment_id: string; }; query?: never; - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + url: '/api/eor/v1/employments/{employment_id}/company-structure-nodes'; }; -export type PutUpdateAdministrativeDetailsErrors = { +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors = { /** * Unauthorized */ @@ -17565,150 +18509,138 @@ export type PutUpdateAdministrativeDetailsErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PutUpdateAdministrativeDetailsError = - PutUpdateAdministrativeDetailsErrors[keyof PutUpdateAdministrativeDetailsErrors]; +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesError = + GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors[keyof GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors]; -export type PutUpdateAdministrativeDetailsResponses = { +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses = { /** - * ShowLegalEntityAdministrativeDetailsResponse - * - * Country specific json schema driven administrative details for legal entities + * Success */ - 200: { - data: { - [key: string]: unknown; - }; - }; + 200: CompanyStructureNodesResponse; }; -export type PutUpdateAdministrativeDetailsResponse = - PutUpdateAdministrativeDetailsResponses[keyof PutUpdateAdministrativeDetailsResponses]; +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesResponse = + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses[keyof GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses]; -export type GetShowRegionFieldData = { - body?: never; +export type PatchV2EmploymentsEmploymentId2Data = { + /** + * Employment params + */ + body?: EmploymentV2UpdateParams; path: { /** - * Slug - */ - slug: string; - }; - query?: { - /** - * If the premium benefits should be included in the response + * Employment ID */ - include_premium_benefits?: boolean; + employment_id: string; }; - url: '/v1/cost-calculator/regions/{slug}/fields'; + query?: never; + url: '/api/eor/v2/employments/{employment_id}'; }; -export type GetShowRegionFieldErrors = { +export type PatchV2EmploymentsEmploymentId2Errors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Internal Server Error + * Forbidden */ - 500: InternalServerErrorResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowRegionFieldError = - GetShowRegionFieldErrors[keyof GetShowRegionFieldErrors]; +export type PatchV2EmploymentsEmploymentId2Error = + PatchV2EmploymentsEmploymentId2Errors[keyof PatchV2EmploymentsEmploymentId2Errors]; -export type GetShowRegionFieldResponses = { +export type PatchV2EmploymentsEmploymentId2Responses = { /** * Success */ - 200: JsonSchemaResponse; + 200: EmploymentResponse; }; -export type GetShowRegionFieldResponse = - GetShowRegionFieldResponses[keyof GetShowRegionFieldResponses]; +export type PatchV2EmploymentsEmploymentId2Response = + PatchV2EmploymentsEmploymentId2Responses[keyof PatchV2EmploymentsEmploymentId2Responses]; -export type GetShowOffboardingData = { - body?: never; +export type PatchV2EmploymentsEmploymentIdData = { + /** + * Employment params + */ + body?: EmploymentV2UpdateParams; path: { /** - * Offboarding request ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/offboardings/{id}'; + url: '/api/eor/v2/employments/{employment_id}'; }; -export type GetShowOffboardingErrors = { +export type PatchV2EmploymentsEmploymentIdErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetShowOffboardingError = - GetShowOffboardingErrors[keyof GetShowOffboardingErrors]; +export type PatchV2EmploymentsEmploymentIdError = + PatchV2EmploymentsEmploymentIdErrors[keyof PatchV2EmploymentsEmploymentIdErrors]; -export type GetShowOffboardingResponses = { +export type PatchV2EmploymentsEmploymentIdResponses = { /** * Success */ - 200: OffboardingResponse; + 200: EmploymentResponse; }; -export type GetShowOffboardingResponse = - GetShowOffboardingResponses[keyof GetShowOffboardingResponses]; +export type PatchV2EmploymentsEmploymentIdResponse = + PatchV2EmploymentsEmploymentIdResponses[keyof PatchV2EmploymentsEmploymentIdResponses]; -export type GetEmployeeDetailsPayrollRunData = { - body?: never; - path: { - /** - * Payroll run ID - */ - payroll_run_id: string; - }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/payroll-runs/{payroll_run_id}/employee-details'; +export type PostV1ProbationCompletionLetterData = { + /** + * Work Authorization Request + */ + body: CreateProbationCompletionLetterParams; + path?: never; + query?: never; + url: '/api/eor/v1/probation-completion-letter'; }; -export type GetEmployeeDetailsPayrollRunErrors = { +export type PostV1ProbationCompletionLetterErrors = { /** * Unauthorized */ @@ -17723,49 +18655,30 @@ export type GetEmployeeDetailsPayrollRunErrors = { 422: UnprocessableEntityResponse; }; -export type GetEmployeeDetailsPayrollRunError = - GetEmployeeDetailsPayrollRunErrors[keyof GetEmployeeDetailsPayrollRunErrors]; +export type PostV1ProbationCompletionLetterError = + PostV1ProbationCompletionLetterErrors[keyof PostV1ProbationCompletionLetterErrors]; -export type GetEmployeeDetailsPayrollRunResponses = { +export type PostV1ProbationCompletionLetterResponses = { /** * Success */ - 200: EmployeeDetailsResponse; + 200: ProbationCompletionLetterResponse; }; -export type GetEmployeeDetailsPayrollRunResponse = - GetEmployeeDetailsPayrollRunResponses[keyof GetEmployeeDetailsPayrollRunResponses]; - -export type GetIndexBulkEmploymentRowData = { - body?: never; - path: { - /** - * Bulk employment job id - */ - job_id: string; - }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/bulk-employment-jobs/{job_id}/rows'; -}; +export type PostV1ProbationCompletionLetterResponse = + PostV1ProbationCompletionLetterResponses[keyof PostV1ProbationCompletionLetterResponses]; -export type GetIndexBulkEmploymentRowErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1CostCalculatorEstimationPdfData = { /** - * Forbidden + * Estimate params */ - 403: ForbiddenResponse; + body?: CostCalculatorEstimateParams; + path?: never; + query?: never; + url: '/api/eor/v1/cost-calculator/estimation-pdf'; +}; + +export type PostV1CostCalculatorEstimationPdfErrors = { /** * Not Found */ @@ -17773,42 +18686,33 @@ export type GetIndexBulkEmploymentRowErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetIndexBulkEmploymentRowError = - GetIndexBulkEmploymentRowErrors[keyof GetIndexBulkEmploymentRowErrors]; +export type PostV1CostCalculatorEstimationPdfError = + PostV1CostCalculatorEstimationPdfErrors[keyof PostV1CostCalculatorEstimationPdfErrors]; -export type GetIndexBulkEmploymentRowResponses = { +export type PostV1CostCalculatorEstimationPdfResponses = { /** * Success */ - 200: ImportJobRowsResponse; + 200: CostCalculatorEstimatePdfResponse; }; -export type GetIndexBulkEmploymentRowResponse = - GetIndexBulkEmploymentRowResponses[keyof GetIndexBulkEmploymentRowResponses]; +export type PostV1CostCalculatorEstimationPdfResponse = + PostV1CostCalculatorEstimationPdfResponses[keyof PostV1CostCalculatorEstimationPdfResponses]; -export type PostCreateEmploymentData = { +export type PostAuthOauth2Token2Data = { /** - * Employment params + * OAuth2Token */ - body?: EmploymentCreateParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body?: OAuth2TokenParams; path?: never; query?: never; - url: '/v1/sandbox/employments'; + url: '/api/eor/auth/oauth2/token'; }; -export type PostCreateEmploymentErrors = { +export type PostAuthOauth2Token2Errors = { /** * Bad Request */ @@ -17831,82 +18735,70 @@ export type PostCreateEmploymentErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateEmploymentError = - PostCreateEmploymentErrors[keyof PostCreateEmploymentErrors]; +export type PostAuthOauth2Token2Error = + PostAuthOauth2Token2Errors[keyof PostAuthOauth2Token2Errors]; -export type PostCreateEmploymentResponses = { +export type PostAuthOauth2Token2Responses = { /** * Success */ - 201: EmploymentCreationResponse; + 200: OAuth2Tokens; }; -export type PostCreateEmploymentResponse = - PostCreateEmploymentResponses[keyof PostCreateEmploymentResponses]; +export type PostAuthOauth2Token2Response = + PostAuthOauth2Token2Responses[keyof PostAuthOauth2Token2Responses]; -export type PostCreateContractEligibilityData = { - /** - * Contract Eligibility Create Parameters - */ - body: CreateContractEligibilityParams; +export type GetV1EmployeeDocumentsIdData = { + body?: never; path: { /** - * Employment ID + * Document ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/employments/{employment_id}/contract-eligibility'; + url: '/api/eor/v1/employee/documents/{id}'; }; -export type PostCreateContractEligibilityErrors = { +export type GetV1EmployeeDocumentsIdErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PostCreateContractEligibilityError = - PostCreateContractEligibilityErrors[keyof PostCreateContractEligibilityErrors]; +export type GetV1EmployeeDocumentsIdError = + GetV1EmployeeDocumentsIdErrors[keyof GetV1EmployeeDocumentsIdErrors]; -export type PostCreateContractEligibilityResponses = { +export type GetV1EmployeeDocumentsIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: DownloadDocumentResponse; }; -export type PostCreateContractEligibilityResponse = - PostCreateContractEligibilityResponses[keyof PostCreateContractEligibilityResponses]; +export type GetV1EmployeeDocumentsIdResponse = + GetV1EmployeeDocumentsIdResponses[keyof GetV1EmployeeDocumentsIdResponses]; -export type GetSupportedCountryData = { - body?: never; - headers: { - /** - * This endpoint works with any of the access tokens provided. You can use an access - * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. - * - */ - Authorization: string; - }; +export type PostV1WebhookEventsReplayData = { + /** + * WebhookEvent + */ + body: ReplayWebhookEventsParams; path?: never; query?: never; - url: '/v1/countries'; + url: '/api/eor/v1/webhook-events/replay'; }; -export type GetSupportedCountryErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1WebhookEventsReplayErrors = { /** * Unauthorized */ @@ -17919,43 +18811,32 @@ export type GetSupportedCountryErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetSupportedCountryError = - GetSupportedCountryErrors[keyof GetSupportedCountryErrors]; +export type PostV1WebhookEventsReplayError = + PostV1WebhookEventsReplayErrors[keyof PostV1WebhookEventsReplayErrors]; -export type GetSupportedCountryResponses = { +export type PostV1WebhookEventsReplayResponses = { /** * Success */ - 200: CountriesResponse; + 200: SuccessResponse; }; -export type GetSupportedCountryResponse = - GetSupportedCountryResponses[keyof GetSupportedCountryResponses]; +export type PostV1WebhookEventsReplayResponse = + PostV1WebhookEventsReplayResponses[keyof PostV1WebhookEventsReplayResponses]; -export type PostCreateTokenCompanyTokenData = { - body?: never; - path: { - /** - * The ID of the company - */ - company_id: string; - }; - query?: { - /** - * The scope of the token - */ - scope?: string; - }; - url: '/v1/companies/{company_id}/create-token'; +export type PostV1SandboxWebhookCallbacksTriggerData = { + /** + * Webhook Trigger Params + */ + body?: WebhookTriggerParams; + path?: never; + query?: never; + url: '/api/eor/v1/sandbox/webhook-callbacks/trigger'; }; -export type PostCreateTokenCompanyTokenErrors = { +export type PostV1SandboxWebhookCallbacksTriggerErrors = { /** * Unauthorized */ @@ -17970,84 +18851,85 @@ export type PostCreateTokenCompanyTokenErrors = { 422: UnprocessableEntityResponse; }; -export type PostCreateTokenCompanyTokenError = - PostCreateTokenCompanyTokenErrors[keyof PostCreateTokenCompanyTokenErrors]; +export type PostV1SandboxWebhookCallbacksTriggerError = + PostV1SandboxWebhookCallbacksTriggerErrors[keyof PostV1SandboxWebhookCallbacksTriggerErrors]; -export type PostCreateTokenCompanyTokenResponses = { +export type PostV1SandboxWebhookCallbacksTriggerResponses = { /** * Success */ - 200: CompanyTokenResponse; + 200: SuccessResponse; }; -export type PostCreateTokenCompanyTokenResponse = - PostCreateTokenCompanyTokenResponses[keyof PostCreateTokenCompanyTokenResponses]; +export type PostV1SandboxWebhookCallbacksTriggerResponse = + PostV1SandboxWebhookCallbacksTriggerResponses[keyof PostV1SandboxWebhookCallbacksTriggerResponses]; -export type GetIndexCompanyLegalEntitiesData = { +export type GetV1BulkEmploymentJobsJobIdData = { body?: never; path: { /** - * Company ID + * Bulk employment job id */ - company_id: UuidSlug; + job_id: string; }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/companies/{company_id}/legal-entities'; + query?: never; + url: '/api/eor/v1/bulk-employment-jobs/{job_id}'; }; -export type GetIndexCompanyLegalEntitiesErrors = { +export type GetV1BulkEmploymentJobsJobIdErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexCompanyLegalEntitiesError = - GetIndexCompanyLegalEntitiesErrors[keyof GetIndexCompanyLegalEntitiesErrors]; +export type GetV1BulkEmploymentJobsJobIdError = + GetV1BulkEmploymentJobsJobIdErrors[keyof GetV1BulkEmploymentJobsJobIdErrors]; -export type GetIndexCompanyLegalEntitiesResponses = { +export type GetV1BulkEmploymentJobsJobIdResponses = { /** * Success */ - 200: ListCompanyLegalEntitiesResponse; + 200: BulkEmploymentImportJobResponse; }; -export type GetIndexCompanyLegalEntitiesResponse = - GetIndexCompanyLegalEntitiesResponses[keyof GetIndexCompanyLegalEntitiesResponses]; +export type GetV1BulkEmploymentJobsJobIdResponse = + GetV1BulkEmploymentJobsJobIdResponses[keyof GetV1BulkEmploymentJobsJobIdResponses]; -export type PostCompleteOnboardingEmploymentData = { - /** - * Employment slug - */ - body?: CompleteOnboarding; - headers: { +export type GetV1BulkEmploymentJobsJobIdRowsData = { + body?: never; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Bulk employment job id */ - Authorization: string; + job_id: string; }; - path?: never; - query?: never; - url: '/v1/ready'; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/bulk-employment-jobs/{job_id}/rows'; }; -export type PostCompleteOnboardingEmploymentErrors = { +export type GetV1BulkEmploymentJobsJobIdRowsErrors = { /** * Bad Request */ @@ -18057,73 +18939,68 @@ export type PostCompleteOnboardingEmploymentErrors = { */ 403: ForbiddenResponse; /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PostCompleteOnboardingEmploymentError = - PostCompleteOnboardingEmploymentErrors[keyof PostCompleteOnboardingEmploymentErrors]; +export type GetV1BulkEmploymentJobsJobIdRowsError = + GetV1BulkEmploymentJobsJobIdRowsErrors[keyof GetV1BulkEmploymentJobsJobIdRowsErrors]; -export type PostCompleteOnboardingEmploymentResponses = { +export type GetV1BulkEmploymentJobsJobIdRowsResponses = { /** * Success */ - 200: EmploymentResponse; + 200: ImportJobRowsResponse; }; -export type PostCompleteOnboardingEmploymentResponse = - PostCompleteOnboardingEmploymentResponses[keyof PostCompleteOnboardingEmploymentResponses]; +export type GetV1BulkEmploymentJobsJobIdRowsResponse = + GetV1BulkEmploymentJobsJobIdRowsResponses[keyof GetV1BulkEmploymentJobsJobIdRowsResponses]; -export type GetIndexLeavePoliciesDetailsData = { - body?: never; - path: { +export type PostV1MagicLinkData = { + /** + * Magic links generator body + */ + body: MagicLinkParams; + headers: { /** - * Employment ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - employment_id: string; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/leave-policies/details/{employment_id}'; + url: '/api/eor/v1/magic-link'; }; -export type GetIndexLeavePoliciesDetailsErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; +export type PostV1MagicLinkErrors = { /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type GetIndexLeavePoliciesDetailsError = - GetIndexLeavePoliciesDetailsErrors[keyof GetIndexLeavePoliciesDetailsErrors]; +export type PostV1MagicLinkError = + PostV1MagicLinkErrors[keyof PostV1MagicLinkErrors]; -export type GetIndexLeavePoliciesDetailsResponses = { +export type PostV1MagicLinkResponses = { /** * Success */ - 200: ListLeavePoliciesDetailsResponse; + 200: MagicLinkResponse; }; -export type GetIndexLeavePoliciesDetailsResponse = - GetIndexLeavePoliciesDetailsResponses[keyof GetIndexLeavePoliciesDetailsResponses]; +export type PostV1MagicLinkResponse = + PostV1MagicLinkResponses[keyof PostV1MagicLinkResponses]; -export type GetTimeoffTypesTimeoffData = { +export type GetV1CompaniesCompanyIdData = { body?: never; headers: { /** @@ -18134,17 +19011,17 @@ export type GetTimeoffTypesTimeoffData = { */ Authorization: string; }; - path?: never; - query?: { + path: { /** - * Optional. Employment type to list time off types for: `contractor` or `full_time`. Omit for backward-compatible behavior (full-time types). + * Company ID */ - type?: TimeoffTypesEmploymentType; + company_id: string; }; - url: '/v1/timeoff/types'; + query?: never; + url: '/api/eor/v1/companies/{company_id}'; }; -export type GetTimeoffTypesTimeoffErrors = { +export type GetV1CompaniesCompanyIdErrors = { /** * Bad Request */ @@ -18162,35 +19039,67 @@ export type GetTimeoffTypesTimeoffErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetTimeoffTypesTimeoffError = - GetTimeoffTypesTimeoffErrors[keyof GetTimeoffTypesTimeoffErrors]; +export type GetV1CompaniesCompanyIdError = + GetV1CompaniesCompanyIdErrors[keyof GetV1CompaniesCompanyIdErrors]; -export type GetTimeoffTypesTimeoffResponses = { +export type GetV1CompaniesCompanyIdResponses = { /** * Success */ - 200: ListTimeoffTypesResponse; + 200: CompanyResponse; }; -export type GetTimeoffTypesTimeoffResponse = - GetTimeoffTypesTimeoffResponses[keyof GetTimeoffTypesTimeoffResponses]; +export type GetV1CompaniesCompanyIdResponse = + GetV1CompaniesCompanyIdResponses[keyof GetV1CompaniesCompanyIdResponses]; -export type PostCreateEstimationCsvData = { +export type PatchV1CompaniesCompanyId2Data = { /** - * Estimate params + * Update Company params */ - body?: CostCalculatorEstimateParams; - path?: never; - query?: never; - url: '/v1/cost-calculator/estimation-csv'; + body?: UpdateCompanyParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Company ID + * + */ + company_id: string; + }; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/companies/{company_id}'; }; -export type PostCreateEstimationCsvErrors = { +export type PatchV1CompaniesCompanyId2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -18199,89 +19108,116 @@ export type PostCreateEstimationCsvErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostCreateEstimationCsvError = - PostCreateEstimationCsvErrors[keyof PostCreateEstimationCsvErrors]; +export type PatchV1CompaniesCompanyId2Error = + PatchV1CompaniesCompanyId2Errors[keyof PatchV1CompaniesCompanyId2Errors]; -export type PostCreateEstimationCsvResponses = { +export type PatchV1CompaniesCompanyId2Responses = { /** * Success */ - 200: CostCalculatorEstimateCsvResponse; + 200: CompanyResponse; }; -export type PostCreateEstimationCsvResponse = - PostCreateEstimationCsvResponses[keyof PostCreateEstimationCsvResponses]; +export type PatchV1CompaniesCompanyId2Response = + PatchV1CompaniesCompanyId2Responses[keyof PatchV1CompaniesCompanyId2Responses]; -export type GetListGroupsScimData = { - body?: never; - path?: never; - query?: { +export type PatchV1CompaniesCompanyIdData = { + /** + * Update Company params + */ + body?: UpdateCompanyParams; + headers: { /** - * 1-based index of the first result + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - startIndex?: number; + Authorization: string; + }; + path: { /** - * Maximum number of results per page + * Company ID + * */ - count?: number; + company_id: string; + }; + query?: { /** - * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + * Version of the address_details form schema */ - filter?: string; + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; }; - url: '/v1/scim/v2/Groups'; + url: '/api/eor/v1/companies/{company_id}'; }; -export type GetListGroupsScimErrors = { +export type PatchV1CompaniesCompanyIdErrors = { /** * Bad Request */ - 400: IntegrationsScimErrorResponse; + 400: BadRequestResponse; /** * Unauthorized */ - 401: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: IntegrationsScimErrorResponse; + 404: NotFoundResponse; /** - * Not Found + * Unprocessable Entity */ - 404: IntegrationsScimErrorResponse; + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetListGroupsScimError = - GetListGroupsScimErrors[keyof GetListGroupsScimErrors]; +export type PatchV1CompaniesCompanyIdError = + PatchV1CompaniesCompanyIdErrors[keyof PatchV1CompaniesCompanyIdErrors]; -export type GetListGroupsScimResponses = { +export type PatchV1CompaniesCompanyIdResponses = { /** * Success */ - 200: IntegrationsScimGroupListResponse; + 200: CompanyResponse; }; -export type GetListGroupsScimResponse = - GetListGroupsScimResponses[keyof GetListGroupsScimResponses]; +export type PatchV1CompaniesCompanyIdResponse = + PatchV1CompaniesCompanyIdResponses[keyof PatchV1CompaniesCompanyIdResponses]; -export type PostCreateContractDocumentData = { - /** - * CreateContractDocumentParams - */ - body: CreateContractDocument; - path: { +export type GetV1CompaniesSchemaData = { + body?: never; + path?: never; + query: { /** - * Employment ID + * Country code according to ISO 3-digit alphabetic codes. */ - employment_id: string; + country_code: string; + /** + * Name of the desired form + */ + form: 'address_details'; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contract-documents'; + url: '/api/eor/v1/companies/schema'; }; -export type PostCreateContractDocumentErrors = { +export type GetV1CompaniesSchemaErrors = { /** * Unauthorized */ @@ -18296,30 +19232,27 @@ export type PostCreateContractDocumentErrors = { 422: UnprocessableEntityResponse; }; -export type PostCreateContractDocumentError = - PostCreateContractDocumentErrors[keyof PostCreateContractDocumentErrors]; +export type GetV1CompaniesSchemaError = + GetV1CompaniesSchemaErrors[keyof GetV1CompaniesSchemaErrors]; -export type PostCreateContractDocumentResponses = { +export type GetV1CompaniesSchemaResponses = { /** * Success */ - 200: CreateContractDocumentResponse; + 200: CompanyFormResponse; }; -export type PostCreateContractDocumentResponse = - PostCreateContractDocumentResponses[keyof PostCreateContractDocumentResponses]; +export type GetV1CompaniesSchemaResponse = + GetV1CompaniesSchemaResponses[keyof GetV1CompaniesSchemaResponses]; -export type PostTriggerWebhookCallbackData = { - /** - * Webhook Trigger Params - */ - body?: WebhookTriggerParams; +export type GetV1PricingPlanPartnerTemplatesData = { + body?: never; path?: never; query?: never; - url: '/v1/sandbox/webhook-callbacks/trigger'; + url: '/api/eor/v1/pricing-plan-partner-templates'; }; -export type PostTriggerWebhookCallbackErrors = { +export type GetV1PricingPlanPartnerTemplatesErrors = { /** * Unauthorized */ @@ -18334,41 +19267,32 @@ export type PostTriggerWebhookCallbackErrors = { 422: UnprocessableEntityResponse; }; -export type PostTriggerWebhookCallbackError = - PostTriggerWebhookCallbackErrors[keyof PostTriggerWebhookCallbackErrors]; +export type GetV1PricingPlanPartnerTemplatesError = + GetV1PricingPlanPartnerTemplatesErrors[keyof GetV1PricingPlanPartnerTemplatesErrors]; -export type PostTriggerWebhookCallbackResponses = { +export type GetV1PricingPlanPartnerTemplatesResponses = { /** * Success */ - 200: SuccessResponse; + 200: ListPricingPlanPartnerTemplatesResponse; }; -export type PostTriggerWebhookCallbackResponse = - PostTriggerWebhookCallbackResponses[keyof PostTriggerWebhookCallbackResponses]; +export type GetV1PricingPlanPartnerTemplatesResponse = + GetV1PricingPlanPartnerTemplatesResponses[keyof GetV1PricingPlanPartnerTemplatesResponses]; -export type GetDownloadPayslipPayslipData = { +export type GetV1CountriesCountryCodeEngagementAgreementDetailsData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Payslip ID + * Country code according to ISO 3-digit alphabetic codes */ - payslip_id: string; + country_code: string; }; query?: never; - url: '/v1/payslips/{payslip_id}/pdf'; + url: '/api/eor/v1/countries/{country_code}/engagement-agreement-details'; }; -export type GetDownloadPayslipPayslipErrors = { +export type GetV1CountriesCountryCodeEngagementAgreementDetailsErrors = { /** * Bad Request */ @@ -18386,88 +19310,105 @@ export type GetDownloadPayslipPayslipErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetDownloadPayslipPayslipError = - GetDownloadPayslipPayslipErrors[keyof GetDownloadPayslipPayslipErrors]; +export type GetV1CountriesCountryCodeEngagementAgreementDetailsError = + GetV1CountriesCountryCodeEngagementAgreementDetailsErrors[keyof GetV1CountriesCountryCodeEngagementAgreementDetailsErrors]; -export type GetDownloadPayslipPayslipResponses = { +export type GetV1CountriesCountryCodeEngagementAgreementDetailsResponses = { /** * Success */ - 200: PayslipDownloadResponse; + 200: EngagementAgreementDetailsResponse; }; -export type GetDownloadPayslipPayslipResponse = - GetDownloadPayslipPayslipResponses[keyof GetDownloadPayslipPayslipResponses]; +export type GetV1CountriesCountryCodeEngagementAgreementDetailsResponse = + GetV1CountriesCountryCodeEngagementAgreementDetailsResponses[keyof GetV1CountriesCountryCodeEngagementAgreementDetailsResponses]; -export type PostConvertWithSpreadCurrencyConverterData = { +export type PutV2EmploymentsEmploymentIdContractDetailsData = { /** - * Convert currency parameters + * Employment contract details params */ - body: ConvertCurrencyParams; - path?: never; - query?: never; - url: '/v1/currency-converter/effective'; + body?: EmploymentContractDetailsParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Version of the contract_details form schema + */ + contract_details_json_schema_version?: number | 'latest'; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; + }; + url: '/api/eor/v2/employments/{employment_id}/contract_details'; }; -export type PostConvertWithSpreadCurrencyConverterErrors = { +export type PutV2EmploymentsEmploymentIdContractDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostConvertWithSpreadCurrencyConverterError = - PostConvertWithSpreadCurrencyConverterErrors[keyof PostConvertWithSpreadCurrencyConverterErrors]; +export type PutV2EmploymentsEmploymentIdContractDetailsError = + PutV2EmploymentsEmploymentIdContractDetailsErrors[keyof PutV2EmploymentsEmploymentIdContractDetailsErrors]; -export type PostConvertWithSpreadCurrencyConverterResponses = { +export type PutV2EmploymentsEmploymentIdContractDetailsResponses = { /** * Success */ - 200: ConvertCurrencyResponse; + 200: EmploymentResponse; }; -export type PostConvertWithSpreadCurrencyConverterResponse = - PostConvertWithSpreadCurrencyConverterResponses[keyof PostConvertWithSpreadCurrencyConverterResponses]; +export type PutV2EmploymentsEmploymentIdContractDetailsResponse = + PutV2EmploymentsEmploymentIdContractDetailsResponses[keyof PutV2EmploymentsEmploymentIdContractDetailsResponses]; -export type GetShowTimeoffData = { +export type GetV1CompaniesCompanyIdProductPricesData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Timeoff ID + * Company ID */ - id: string; + company_id: UuidSlug; }; query?: never; - url: '/v1/timeoff/{id}'; + url: '/api/eor/v1/companies/{company_id}/product-prices'; }; -export type GetShowTimeoffErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CompaniesCompanyIdProductPricesErrors = { /** * Unauthorized */ @@ -18480,54 +19421,39 @@ export type GetShowTimeoffErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetShowTimeoffError = - GetShowTimeoffErrors[keyof GetShowTimeoffErrors]; +export type GetV1CompaniesCompanyIdProductPricesError = + GetV1CompaniesCompanyIdProductPricesErrors[keyof GetV1CompaniesCompanyIdProductPricesErrors]; -export type GetShowTimeoffResponses = { +export type GetV1CompaniesCompanyIdProductPricesResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ListProductPricesResponse; }; -export type GetShowTimeoffResponse = - GetShowTimeoffResponses[keyof GetShowTimeoffResponses]; +export type GetV1CompaniesCompanyIdProductPricesResponse = + GetV1CompaniesCompanyIdProductPricesResponses[keyof GetV1CompaniesCompanyIdProductPricesResponses]; -export type PatchUpdateTimeoff2Data = { - /** - * UpdateTimeoff - */ - body: UpdateApprovedTimeoffParams; - headers: { +export type PostV1CompaniesCompanyIdCreateTokenData = { + body?: never; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * The ID of the company */ - Authorization: string; + company_id: string; }; - path: { + query?: { /** - * Timeoff ID + * The scope of the token */ - id: string; + scope?: string; }; - query?: never; - url: '/v1/timeoff/{id}'; + url: '/api/eor/v1/companies/{company_id}/create-token'; }; -export type PatchUpdateTimeoff2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1CompaniesCompanyIdCreateTokenErrors = { /** * Unauthorized */ @@ -18540,54 +19466,34 @@ export type PatchUpdateTimeoff2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateTimeoff2Error = - PatchUpdateTimeoff2Errors[keyof PatchUpdateTimeoff2Errors]; +export type PostV1CompaniesCompanyIdCreateTokenError = + PostV1CompaniesCompanyIdCreateTokenErrors[keyof PostV1CompaniesCompanyIdCreateTokenErrors]; -export type PatchUpdateTimeoff2Responses = { +export type PostV1CompaniesCompanyIdCreateTokenResponses = { /** * Success */ - 200: TimeoffResponse; + 200: CompanyTokenResponse; }; -export type PatchUpdateTimeoff2Response = - PatchUpdateTimeoff2Responses[keyof PatchUpdateTimeoff2Responses]; +export type PostV1CompaniesCompanyIdCreateTokenResponse = + PostV1CompaniesCompanyIdCreateTokenResponses[keyof PostV1CompaniesCompanyIdCreateTokenResponses]; -export type PatchUpdateTimeoffData = { - /** - * UpdateTimeoff - */ - body: UpdateApprovedTimeoffParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; +export type GetV1IdentityVerificationEmploymentIdData = { + body?: never; path: { /** - * Timeoff ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/timeoff/{id}'; + url: '/api/eor/v1/identity-verification/{employment_id}'; }; -export type PatchUpdateTimeoffErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1IdentityVerificationEmploymentIdErrors = { /** * Unauthorized */ @@ -18600,41 +19506,38 @@ export type PatchUpdateTimeoffErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateTimeoffError = - PatchUpdateTimeoffErrors[keyof PatchUpdateTimeoffErrors]; +export type GetV1IdentityVerificationEmploymentIdError = + GetV1IdentityVerificationEmploymentIdErrors[keyof GetV1IdentityVerificationEmploymentIdErrors]; -export type PatchUpdateTimeoffResponses = { +export type GetV1IdentityVerificationEmploymentIdResponses = { /** * Success */ - 200: TimeoffResponse; + 200: IdentityVerificationResponse; }; -export type PatchUpdateTimeoffResponse = - PatchUpdateTimeoffResponses[keyof PatchUpdateTimeoffResponses]; +export type GetV1IdentityVerificationEmploymentIdResponse = + GetV1IdentityVerificationEmploymentIdResponses[keyof GetV1IdentityVerificationEmploymentIdResponses]; -export type PostCreateDeclineData = { - /** - * DeclineTimeoff - */ - body: DeclineTimeoffParams; +export type GetV1ExpensesExpenseIdReceiptsReceiptIdData = { + body?: never; path: { /** - * Time Off ID + * The expense ID */ - timeoff_id: string; + expense_id: string; + /** + * The receipt ID + */ + receipt_id: string; }; query?: never; - url: '/v1/timeoff/{timeoff_id}/decline'; + url: '/api/eor/v1/expenses/{expense_id}/receipts/{receipt_id}'; }; -export type PostCreateDeclineErrors = { +export type GetV1ExpensesExpenseIdReceiptsReceiptIdErrors = { /** * Bad Request */ @@ -18643,6 +19546,10 @@ export type PostCreateDeclineErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -18657,87 +19564,93 @@ export type PostCreateDeclineErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateDeclineError = - PostCreateDeclineErrors[keyof PostCreateDeclineErrors]; +export type GetV1ExpensesExpenseIdReceiptsReceiptIdError = + GetV1ExpensesExpenseIdReceiptsReceiptIdErrors[keyof GetV1ExpensesExpenseIdReceiptsReceiptIdErrors]; -export type PostCreateDeclineResponses = { +export type GetV1ExpensesExpenseIdReceiptsReceiptIdResponses = { /** * Success */ - 200: TimeoffResponse; + 200: GenericFile; }; -export type PostCreateDeclineResponse = - PostCreateDeclineResponses[keyof PostCreateDeclineResponses]; +export type GetV1ExpensesExpenseIdReceiptsReceiptIdResponse = + GetV1ExpensesExpenseIdReceiptsReceiptIdResponses[keyof GetV1ExpensesExpenseIdReceiptsReceiptIdResponses]; -export type PostAutomatableContractAmendmentData = { - /** - * Contract Amendment - */ - body?: CreateContractAmendmentParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; +export type GetV1ScimV2GroupsData = { + body?: never; path?: never; query?: { /** - * Version of the form schema + * 1-based index of the first result */ - json_schema_version?: number | 'latest'; + startIndex?: number; + /** + * Maximum number of results per page + */ + count?: number; + /** + * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + */ + filter?: string; }; - url: '/v1/contract-amendments/automatable'; + url: '/api/eor/v1/scim/v2/Groups'; }; -export type PostAutomatableContractAmendmentErrors = { +export type GetV1ScimV2GroupsErrors = { + /** + * Bad Request + */ + 400: IntegrationsScimErrorResponse; /** * Unauthorized */ - 401: UnauthorizedResponse; + 401: IntegrationsScimErrorResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: IntegrationsScimErrorResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: IntegrationsScimErrorResponse; }; -export type PostAutomatableContractAmendmentError = - PostAutomatableContractAmendmentErrors[keyof PostAutomatableContractAmendmentErrors]; +export type GetV1ScimV2GroupsError = + GetV1ScimV2GroupsErrors[keyof GetV1ScimV2GroupsErrors]; -export type PostAutomatableContractAmendmentResponses = { +export type GetV1ScimV2GroupsResponses = { /** * Success */ - 200: ContractAmendmentAutomatableResponse; + 200: IntegrationsScimGroupListResponse; }; -export type PostAutomatableContractAmendmentResponse = - PostAutomatableContractAmendmentResponses[keyof PostAutomatableContractAmendmentResponses]; +export type GetV1ScimV2GroupsResponse = + GetV1ScimV2GroupsResponses[keyof GetV1ScimV2GroupsResponses]; -export type PostCreateApprovalData = { - /** - * ApproveTimeoff - */ - body: ApproveTimeoffParams; +export type GetV1ExpensesIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Time Off ID + * Expense ID */ - timeoff_id: string; + id: string; }; query?: never; - url: '/v1/timeoff/{timeoff_id}/approve'; + url: '/api/eor/v1/expenses/{id}'; }; -export type PostCreateApprovalErrors = { +export type GetV1ExpensesIdErrors = { /** * Bad Request */ @@ -18755,54 +19668,44 @@ export type PostCreateApprovalErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostCreateApprovalError = - PostCreateApprovalErrors[keyof PostCreateApprovalErrors]; +export type GetV1ExpensesIdError = + GetV1ExpensesIdErrors[keyof GetV1ExpensesIdErrors]; -export type PostCreateApprovalResponses = { +export type GetV1ExpensesIdResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ExpenseResponse; }; -export type PostCreateApprovalResponse = - PostCreateApprovalResponses[keyof PostCreateApprovalResponses]; +export type GetV1ExpensesIdResponse = + GetV1ExpensesIdResponses[keyof GetV1ExpensesIdResponses]; -export type GetIndexEmploymentFileData = { - body?: never; +export type PatchV1ExpensesId2Data = { + /** + * Expenses + */ + body?: UpdateExpenseParams; path: { /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Filter by file type (optional) - */ - type?: string; - /** - * Filter by file sub_type (optional) - */ - sub_type?: string; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Expense ID */ - page_size?: number; + id: string; }; - url: '/v1/employments/{employment_id}/files'; + query?: never; + url: '/api/eor/v1/expenses/{id}'; }; -export type GetIndexEmploymentFileErrors = { +export type PatchV1ExpensesId2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -18811,42 +19714,53 @@ export type GetIndexEmploymentFileErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetIndexEmploymentFileError = - GetIndexEmploymentFileErrors[keyof GetIndexEmploymentFileErrors]; +export type PatchV1ExpensesId2Error = + PatchV1ExpensesId2Errors[keyof PatchV1ExpensesId2Errors]; -export type GetIndexEmploymentFileResponses = { +export type PatchV1ExpensesId2Responses = { /** * Success */ - 200: ListFilesResponse; + 200: ExpenseResponse; }; -export type GetIndexEmploymentFileResponse = - GetIndexEmploymentFileResponses[keyof GetIndexEmploymentFileResponses]; +export type PatchV1ExpensesId2Response = + PatchV1ExpensesId2Responses[keyof PatchV1ExpensesId2Responses]; -export type GetIndexEmploymentCustomFieldData = { - body?: never; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; +export type PatchV1ExpensesIdData = { + /** + * Expenses + */ + body?: UpdateExpenseParams; + path: { /** - * Number of items per page + * Expense ID */ - page_size?: number; + id: string; }; - url: '/v1/custom-fields'; + query?: never; + url: '/api/eor/v1/expenses/{id}'; }; -export type GetIndexEmploymentCustomFieldErrors = { +export type PatchV1ExpensesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -18855,95 +19769,102 @@ export type GetIndexEmploymentCustomFieldErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetIndexEmploymentCustomFieldError = - GetIndexEmploymentCustomFieldErrors[keyof GetIndexEmploymentCustomFieldErrors]; +export type PatchV1ExpensesIdError = + PatchV1ExpensesIdErrors[keyof PatchV1ExpensesIdErrors]; -export type GetIndexEmploymentCustomFieldResponses = { +export type PatchV1ExpensesIdResponses = { /** * Success */ - 200: ListEmploymentCustomFieldsResponse; + 200: ExpenseResponse; }; -export type GetIndexEmploymentCustomFieldResponse = - GetIndexEmploymentCustomFieldResponses[keyof GetIndexEmploymentCustomFieldResponses]; +export type PatchV1ExpensesIdResponse = + PatchV1ExpensesIdResponses[keyof PatchV1ExpensesIdResponses]; -export type PostCreateEmploymentCustomFieldData = { +export type PutV2EmploymentsEmploymentIdEmergencyContactData = { /** - * Custom Field Definition Create Parameters + * Employment emergency contact params */ - body: CreateCustomFieldDefinitionParams; - path?: never; - query?: never; - url: '/v1/custom-fields'; + body?: EmploymentEmergencyContactParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Version of the emergency_contact_details form schema + */ + emergency_contact_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v2/employments/{employment_id}/emergency_contact'; }; -export type PostCreateEmploymentCustomFieldErrors = { +export type PutV2EmploymentsEmploymentIdEmergencyContactErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; /** - * Unprocessable Entity + * Conflict */ - 422: UnprocessableEntityResponse; -}; - -export type PostCreateEmploymentCustomFieldError = - PostCreateEmploymentCustomFieldErrors[keyof PostCreateEmploymentCustomFieldErrors]; - -export type PostCreateEmploymentCustomFieldResponses = { + 409: ConflictResponse; /** - * Success + * Unprocessable Entity */ - 200: CreateEmploymentCustomFieldResponse; -}; - -export type PostCreateEmploymentCustomFieldResponse = - PostCreateEmploymentCustomFieldResponses[keyof PostCreateEmploymentCustomFieldResponses]; - -export type GetIndexCompanyCurrencyData = { - body?: never; - path?: never; - query?: never; - url: '/v1/company-currencies'; -}; - -export type GetIndexCompanyCurrencyErrors = { + 422: UnprocessableEntityResponse; /** - * Not Found + * Unprocessable Entity */ - 404: NotFoundResponse; + 429: TooManyRequestsResponse; }; -export type GetIndexCompanyCurrencyError = - GetIndexCompanyCurrencyErrors[keyof GetIndexCompanyCurrencyErrors]; +export type PutV2EmploymentsEmploymentIdEmergencyContactError = + PutV2EmploymentsEmploymentIdEmergencyContactErrors[keyof PutV2EmploymentsEmploymentIdEmergencyContactErrors]; -export type GetIndexCompanyCurrencyResponses = { +export type PutV2EmploymentsEmploymentIdEmergencyContactResponses = { /** * Success */ - 200: CompanyCurrenciesResponse; + 200: EmploymentResponse; }; -export type GetIndexCompanyCurrencyResponse = - GetIndexCompanyCurrencyResponses[keyof GetIndexCompanyCurrencyResponses]; +export type PutV2EmploymentsEmploymentIdEmergencyContactResponse = + PutV2EmploymentsEmploymentIdEmergencyContactResponses[keyof PutV2EmploymentsEmploymentIdEmergencyContactResponses]; -export type PatchUpdateEmployment4Data = { +export type PostV1SandboxBenefitRenewalRequestsData = { /** - * Employment params + * Benefit Renewal Request */ - body?: EmploymentUpdateParams; + body: BenefitRenewalRequestsCreateBenefitRenewalRequest; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -18953,17 +19874,12 @@ export type PatchUpdateEmployment4Data = { */ Authorization: string; }; - path: { - /** - * Employment ID - */ - employment_id: string; - }; + path?: never; query?: never; - url: '/v1/sandbox/employments/{employment_id}'; + url: '/api/eor/v1/sandbox/benefit-renewal-requests'; }; -export type PatchUpdateEmployment4Errors = { +export type PostV1SandboxBenefitRenewalRequestsErrors = { /** * Bad Request */ @@ -18972,51 +19888,34 @@ export type PatchUpdateEmployment4Errors = { * Unauthorized */ 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PatchUpdateEmployment4Error = - PatchUpdateEmployment4Errors[keyof PatchUpdateEmployment4Errors]; +export type PostV1SandboxBenefitRenewalRequestsError = + PostV1SandboxBenefitRenewalRequestsErrors[keyof PostV1SandboxBenefitRenewalRequestsErrors]; -export type PatchUpdateEmployment4Responses = { +export type PostV1SandboxBenefitRenewalRequestsResponses = { /** * Success */ - 200: EmploymentResponse; + 200: BenefitRenewalRequestsCreateBenefitRenewalRequestResponse; }; -export type PatchUpdateEmployment4Response = - PatchUpdateEmployment4Responses[keyof PatchUpdateEmployment4Responses]; +export type PostV1SandboxBenefitRenewalRequestsResponse = + PostV1SandboxBenefitRenewalRequestsResponses[keyof PostV1SandboxBenefitRenewalRequestsResponses]; -export type PatchUpdateEmployment3Data = { +export type PutV2EmploymentsEmploymentIdBasicInformationData = { /** - * Employment params + * Employment basic information params */ - body?: EmploymentUpdateParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body?: EmploymentBasicInformationParams; path: { /** * Employment ID @@ -19024,22 +19923,18 @@ export type PatchUpdateEmployment3Data = { employment_id: string; }; query?: never; - url: '/v1/sandbox/employments/{employment_id}'; + url: '/api/eor/v2/employments/{employment_id}/basic_information'; }; -export type PatchUpdateEmployment3Errors = { +export type PutV2EmploymentsEmploymentIdBasicInformationErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** * Conflict */ @@ -19049,35 +19944,26 @@ export type PatchUpdateEmployment3Errors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PatchUpdateEmployment3Error = - PatchUpdateEmployment3Errors[keyof PatchUpdateEmployment3Errors]; +export type PutV2EmploymentsEmploymentIdBasicInformationError = + PutV2EmploymentsEmploymentIdBasicInformationErrors[keyof PutV2EmploymentsEmploymentIdBasicInformationErrors]; -export type PatchUpdateEmployment3Responses = { +export type PutV2EmploymentsEmploymentIdBasicInformationResponses = { /** * Success */ 200: EmploymentResponse; }; -export type PatchUpdateEmployment3Response = - PatchUpdateEmployment3Responses[keyof PatchUpdateEmployment3Responses]; +export type PutV2EmploymentsEmploymentIdBasicInformationResponse = + PutV2EmploymentsEmploymentIdBasicInformationResponses[keyof PutV2EmploymentsEmploymentIdBasicInformationResponses]; -export type GetPendingChangesEmploymentContractData = { +export type GetV1LeavePoliciesSummaryEmploymentIdData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** * Employment ID @@ -19085,18 +19971,14 @@ export type GetPendingChangesEmploymentContractData = { employment_id: string; }; query?: never; - url: '/v1/employment-contracts/{employment_id}/pending-changes'; + url: '/api/eor/v1/leave-policies/summary/{employment_id}'; }; -export type GetPendingChangesEmploymentContractErrors = { +export type GetV1LeavePoliciesSummaryEmploymentIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -19107,32 +19989,35 @@ export type GetPendingChangesEmploymentContractErrors = { 422: UnprocessableEntityResponse; }; -export type GetPendingChangesEmploymentContractError = - GetPendingChangesEmploymentContractErrors[keyof GetPendingChangesEmploymentContractErrors]; +export type GetV1LeavePoliciesSummaryEmploymentIdError = + GetV1LeavePoliciesSummaryEmploymentIdErrors[keyof GetV1LeavePoliciesSummaryEmploymentIdErrors]; -export type GetPendingChangesEmploymentContractResponses = { +export type GetV1LeavePoliciesSummaryEmploymentIdResponses = { /** * Success */ - 200: EmploymentContractPendingChangesResponse; + 200: ListLeavePoliciesSummaryResponse; }; -export type GetPendingChangesEmploymentContractResponse = - GetPendingChangesEmploymentContractResponses[keyof GetPendingChangesEmploymentContractResponses]; +export type GetV1LeavePoliciesSummaryEmploymentIdResponse = + GetV1LeavePoliciesSummaryEmploymentIdResponses[keyof GetV1LeavePoliciesSummaryEmploymentIdResponses]; -export type GetShowResignationData = { - body?: never; +export type PostV1TimeoffTimeoffIdCancelData = { + /** + * CancelTimeoff + */ + body: CancelTimeoffParams; path: { /** - * Offboarding request ID + * Time Off ID */ - offboarding_request_id: string; + timeoff_id: string; }; query?: never; - url: '/v1/resignations/{offboarding_request_id}'; + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel'; }; -export type GetShowResignationErrors = { +export type PostV1TimeoffTimeoffIdCancelErrors = { /** * Bad Request */ @@ -19155,20 +20040,52 @@ export type GetShowResignationErrors = { 429: TooManyRequestsResponse; }; -export type GetShowResignationError = - GetShowResignationErrors[keyof GetShowResignationErrors]; +export type PostV1TimeoffTimeoffIdCancelError = + PostV1TimeoffTimeoffIdCancelErrors[keyof PostV1TimeoffTimeoffIdCancelErrors]; -export type GetShowResignationResponses = { +export type PostV1TimeoffTimeoffIdCancelResponses = { /** * Success */ - 200: ResignationResponse; + 200: TimeoffResponse; +}; + +export type PostV1TimeoffTimeoffIdCancelResponse = + PostV1TimeoffTimeoffIdCancelResponses[keyof PostV1TimeoffTimeoffIdCancelResponses]; + +export type GetV1HelpCenterArticlesIdData = { + body?: never; + path: { + /** + * Help Center Article Zendesk ID + */ + id: number; + }; + query?: never; + url: '/api/eor/v1/help-center-articles/{id}'; }; -export type GetShowResignationResponse = - GetShowResignationResponses[keyof GetShowResignationResponses]; +export type GetV1HelpCenterArticlesIdErrors = { + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1HelpCenterArticlesIdError = + GetV1HelpCenterArticlesIdErrors[keyof GetV1HelpCenterArticlesIdErrors]; + +export type GetV1HelpCenterArticlesIdResponses = { + /** + * Success + */ + 200: HelpCenterArticleResponse; +}; -export type PostUploadEmployeeFileFileData = { +export type GetV1HelpCenterArticlesIdResponse = + GetV1HelpCenterArticlesIdResponses[keyof GetV1HelpCenterArticlesIdResponses]; + +export type PostV1DocumentsData = { /** * File */ @@ -19183,10 +20100,10 @@ export type PostUploadEmployeeFileFileData = { }; path?: never; query?: never; - url: '/v1/documents'; + url: '/api/eor/v1/documents'; }; -export type PostUploadEmployeeFileFileErrors = { +export type PostV1DocumentsErrors = { /** * Unauthorized */ @@ -19201,30 +20118,21 @@ export type PostUploadEmployeeFileFileErrors = { 422: UnprocessableEntityResponse; }; -export type PostUploadEmployeeFileFileError = - PostUploadEmployeeFileFileErrors[keyof PostUploadEmployeeFileFileErrors]; +export type PostV1DocumentsError = + PostV1DocumentsErrors[keyof PostV1DocumentsErrors]; -export type PostUploadEmployeeFileFileResponses = { +export type PostV1DocumentsResponses = { /** * Success */ 200: UploadFileResponse; }; -export type PostUploadEmployeeFileFileResponse = - PostUploadEmployeeFileFileResponses[keyof PostUploadEmployeeFileFileResponses]; +export type PostV1DocumentsResponse = + PostV1DocumentsResponses[keyof PostV1DocumentsResponses]; -export type PostInviteEmploymentInvitationData = { +export type PostV1IdentityVerificationEmploymentIdVerifyData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** * Employment ID @@ -19232,67 +20140,54 @@ export type PostInviteEmploymentInvitationData = { employment_id: string; }; query?: never; - url: '/v1/employments/{employment_id}/invite'; + url: '/api/eor/v1/identity-verification/{employment_id}/verify'; }; -export type PostInviteEmploymentInvitationErrors = { +export type PostV1IdentityVerificationEmploymentIdVerifyErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostInviteEmploymentInvitationError = - PostInviteEmploymentInvitationErrors[keyof PostInviteEmploymentInvitationErrors]; +export type PostV1IdentityVerificationEmploymentIdVerifyError = + PostV1IdentityVerificationEmploymentIdVerifyErrors[keyof PostV1IdentityVerificationEmploymentIdVerifyErrors]; -export type PostInviteEmploymentInvitationResponses = { +export type PostV1IdentityVerificationEmploymentIdVerifyResponses = { /** * Success */ 200: SuccessResponse; }; -export type PostInviteEmploymentInvitationResponse = - PostInviteEmploymentInvitationResponses[keyof PostInviteEmploymentInvitationResponses]; +export type PostV1IdentityVerificationEmploymentIdVerifyResponse = + PostV1IdentityVerificationEmploymentIdVerifyResponses[keyof PostV1IdentityVerificationEmploymentIdVerifyResponses]; -export type GetShowExpenseData = { +export type GetV1CustomFieldsData = { body?: never; - headers: { + path?: never; + query?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Starts fetching records after the given page */ - Authorization: string; - }; - path: { + page?: number; /** - * Expense ID + * Number of items per page */ - id: string; + page_size?: number; }; - query?: never; - url: '/v1/expenses/{id}'; + url: '/api/eor/v1/custom-fields'; }; -export type GetShowExpenseErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CustomFieldsErrors = { /** * Unauthorized */ @@ -19305,45 +20200,32 @@ export type GetShowExpenseErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetShowExpenseError = - GetShowExpenseErrors[keyof GetShowExpenseErrors]; +export type GetV1CustomFieldsError = + GetV1CustomFieldsErrors[keyof GetV1CustomFieldsErrors]; -export type GetShowExpenseResponses = { +export type GetV1CustomFieldsResponses = { /** * Success */ - 200: ExpenseResponse; + 200: ListEmploymentCustomFieldsResponse; }; -export type GetShowExpenseResponse = - GetShowExpenseResponses[keyof GetShowExpenseResponses]; +export type GetV1CustomFieldsResponse = + GetV1CustomFieldsResponses[keyof GetV1CustomFieldsResponses]; -export type PatchUpdateExpense2Data = { +export type PostV1CustomFieldsData = { /** - * Expenses + * Custom Field Definition Create Parameters */ - body?: UpdateExpenseParams; - path: { - /** - * Expense ID - */ - id: string; - }; + body: CreateCustomFieldDefinitionParams; + path?: never; query?: never; - url: '/v1/expenses/{id}'; + url: '/api/eor/v1/custom-fields'; }; -export type PatchUpdateExpense2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1CustomFieldsErrors = { /** * Unauthorized */ @@ -19352,53 +20234,96 @@ export type PatchUpdateExpense2Errors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateExpense2Error = - PatchUpdateExpense2Errors[keyof PatchUpdateExpense2Errors]; +export type PostV1CustomFieldsError = + PostV1CustomFieldsErrors[keyof PostV1CustomFieldsErrors]; -export type PatchUpdateExpense2Responses = { +export type PostV1CustomFieldsResponses = { /** * Success */ - 200: ExpenseResponse; + 200: CreateEmploymentCustomFieldResponse; }; -export type PatchUpdateExpense2Response = - PatchUpdateExpense2Responses[keyof PatchUpdateExpense2Responses]; +export type PostV1CustomFieldsResponse = + PostV1CustomFieldsResponses[keyof PostV1CustomFieldsResponses]; + +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve'; + }; + +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; + }; + +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveError = + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors[keyof PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors]; -export type PatchUpdateExpenseData = { +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses = + { + /** + * Success + */ + 200: RiskReserveProofOfPaymentResponse; + }; + +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponse = + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses[keyof PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses]; + +export type PostV1WebhookCallbacksData = { /** - * Expenses + * WebhookCallback */ - body?: UpdateExpenseParams; - path: { + body?: CreateWebhookCallbackParams; + headers: { /** - * Expense ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/expenses/{id}'; + url: '/api/eor/v1/webhook-callbacks'; }; -export type PatchUpdateExpenseErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1WebhookCallbacksErrors = { /** * Unauthorized */ @@ -19407,55 +20332,37 @@ export type PatchUpdateExpenseErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateExpenseError = - PatchUpdateExpenseErrors[keyof PatchUpdateExpenseErrors]; +export type PostV1WebhookCallbacksError = + PostV1WebhookCallbacksErrors[keyof PostV1WebhookCallbacksErrors]; -export type PatchUpdateExpenseResponses = { +export type PostV1WebhookCallbacksResponses = { /** * Success */ - 200: ExpenseResponse; + 200: WebhookCallbackResponse; }; -export type PatchUpdateExpenseResponse = - PatchUpdateExpenseResponses[keyof PatchUpdateExpenseResponses]; +export type PostV1WebhookCallbacksResponse = + PostV1WebhookCallbacksResponses[keyof PostV1WebhookCallbacksResponses]; -export type GetShowBenefitRenewalRequestData = { +export type GetV1SsoConfigurationDetailsData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { - /** - * Benefit Renewal Request Id - */ - benefit_renewal_request_id: UuidSlug; - }; + path?: never; query?: never; - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; + url: '/api/eor/v1/sso-configuration/details'; }; -export type GetShowBenefitRenewalRequestErrors = { +export type GetV1SsoConfigurationDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -19467,128 +20374,196 @@ export type GetShowBenefitRenewalRequestErrors = { /** * Unprocessable Entity */ - 422: UnprocessableEntityResponse; + 429: TooManyRequestsResponse; }; -export type GetShowBenefitRenewalRequestError = - GetShowBenefitRenewalRequestErrors[keyof GetShowBenefitRenewalRequestErrors]; +export type GetV1SsoConfigurationDetailsError = + GetV1SsoConfigurationDetailsErrors[keyof GetV1SsoConfigurationDetailsErrors]; -export type GetShowBenefitRenewalRequestResponses = { +export type GetV1SsoConfigurationDetailsResponses = { /** * Success */ - 200: BenefitRenewalRequestsBenefitRenewalRequestResponse; + 200: SsoConfigurationDetailsResponse; }; -export type GetShowBenefitRenewalRequestResponse = - GetShowBenefitRenewalRequestResponses[keyof GetShowBenefitRenewalRequestResponses]; +export type GetV1SsoConfigurationDetailsResponse = + GetV1SsoConfigurationDetailsResponses[keyof GetV1SsoConfigurationDetailsResponses]; -export type PostUpdateBenefitRenewalRequestData = { - /** - * Benefit Renewal Request Response - */ - body?: BenefitRenewalRequestsUpdateBenefitRenewalRequest; - headers: { +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * SignContractDocument */ - Authorization: string; + body: SignContractDocument; + path: { + /** + * Employment ID + */ + employment_id: string; + /** + * Document ID + */ + contract_document_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign'; }; - path: { + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors = + { /** - * Benefit Renewal Request Id + * Bad Request */ - benefit_renewal_request_id: UuidSlug; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignError = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses = + { + /** + * Success + */ + 200: SuccessResponse; }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponse = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses]; + +export type GetV1PayItemsData = { + body?: never; + path?: never; query?: { /** - * Version of the form schema + * Filter by employment slug */ - json_schema_version?: number | 'latest'; + employment_slug?: UuidSlug; + /** + * Filter pay items with effective_date >= given date (YYYY-MM-DD) + */ + effective_from?: Date; + /** + * Filter pay items with effective_date <= given date (YYYY-MM-DD) + */ + effective_to?: Date; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; + url: '/api/eor/v1/pay-items'; }; -export type PostUpdateBenefitRenewalRequestErrors = { +export type GetV1PayItemsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Forbidden */ - 422: UnprocessableEntityResponse; + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PostUpdateBenefitRenewalRequestError = - PostUpdateBenefitRenewalRequestErrors[keyof PostUpdateBenefitRenewalRequestErrors]; +export type GetV1PayItemsError = GetV1PayItemsErrors[keyof GetV1PayItemsErrors]; -export type PostUpdateBenefitRenewalRequestResponses = { +export type GetV1PayItemsResponses = { /** * Success */ - 200: SuccessResponse; + 200: ListPayItemsResponse; }; -export type PostUpdateBenefitRenewalRequestResponse = - PostUpdateBenefitRenewalRequestResponses[keyof PostUpdateBenefitRenewalRequestResponses]; +export type GetV1PayItemsResponse = + GetV1PayItemsResponses[keyof GetV1PayItemsResponses]; -export type GetShowEmploymentOnboardingStepsData = { +export type GetV1ScimV2UsersData = { body?: never; - path: { + path?: never; + query?: { /** - * Employment ID + * 1-based index of the first result */ - employment_id: UuidSlug; + startIndex?: number; + /** + * Maximum number of results per page + */ + count?: number; + /** + * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + */ + filter?: string; }; - query?: never; - url: '/v1/employments/{employment_id}/onboarding-steps'; + url: '/api/eor/v1/scim/v2/Users'; }; -export type GetShowEmploymentOnboardingStepsErrors = { +export type GetV1ScimV2UsersErrors = { + /** + * Bad Request + */ + 400: IntegrationsScimErrorResponse; /** * Unauthorized */ - 401: UnauthorizedResponse; + 401: IntegrationsScimErrorResponse; + /** + * Forbidden + */ + 403: IntegrationsScimErrorResponse; /** * Not Found */ - 404: NotFoundResponse; + 404: IntegrationsScimErrorResponse; }; -export type GetShowEmploymentOnboardingStepsError = - GetShowEmploymentOnboardingStepsErrors[keyof GetShowEmploymentOnboardingStepsErrors]; +export type GetV1ScimV2UsersError = + GetV1ScimV2UsersErrors[keyof GetV1ScimV2UsersErrors]; -export type GetShowEmploymentOnboardingStepsResponses = { +export type GetV1ScimV2UsersResponses = { /** * Success */ - 200: EmploymentOnboardingStepsResponse; + 200: IntegrationsScimUserListResponse; }; -export type GetShowEmploymentOnboardingStepsResponse = - GetShowEmploymentOnboardingStepsResponses[keyof GetShowEmploymentOnboardingStepsResponses]; +export type GetV1ScimV2UsersResponse = + GetV1ScimV2UsersResponses[keyof GetV1ScimV2UsersResponses]; -export type GetIndexEmploymentCompanyStructureNodeData = { +export type GetV1ResignationsOffboardingRequestIdData = { body?: never; path: { /** - * Employment ID + * Offboarding request ID */ - employment_id: string; + offboarding_request_id: string; }; query?: never; - url: '/v1/employments/{employment_id}/company-structure-nodes'; + url: '/api/eor/v1/resignations/{offboarding_request_id}'; }; -export type GetIndexEmploymentCompanyStructureNodeErrors = { +export type GetV1ResignationsOffboardingRequestIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -19601,43 +20576,47 @@ export type GetIndexEmploymentCompanyStructureNodeErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexEmploymentCompanyStructureNodeError = - GetIndexEmploymentCompanyStructureNodeErrors[keyof GetIndexEmploymentCompanyStructureNodeErrors]; +export type GetV1ResignationsOffboardingRequestIdError = + GetV1ResignationsOffboardingRequestIdErrors[keyof GetV1ResignationsOffboardingRequestIdErrors]; -export type GetIndexEmploymentCompanyStructureNodeResponses = { +export type GetV1ResignationsOffboardingRequestIdResponses = { /** * Success */ - 200: CompanyStructureNodesResponse; + 200: ResignationResponse; }; -export type GetIndexEmploymentCompanyStructureNodeResponse = - GetIndexEmploymentCompanyStructureNodeResponses[keyof GetIndexEmploymentCompanyStructureNodeResponses]; +export type GetV1ResignationsOffboardingRequestIdResponse = + GetV1ResignationsOffboardingRequestIdResponses[keyof GetV1ResignationsOffboardingRequestIdResponses]; -export type GetIndexEmploymentCustomFieldValueData = { +export type GetV1BillingDocumentsBillingDocumentIdBreakdownData = { body?: never; path: { /** - * Employment ID + * The billing document's ID */ - employment_id: string; + billing_document_id: string; }; query?: { /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Filters the results by the type of the billing breakdown item. */ - page_size?: number; + type?: string; }; - url: '/v1/employments/{employment_id}/custom-fields'; + url: '/api/eor/v1/billing-documents/{billing_document_id}/breakdown'; }; -export type GetIndexEmploymentCustomFieldValueErrors = { +export type GetV1BillingDocumentsBillingDocumentIdBreakdownErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -19650,49 +20629,49 @@ export type GetIndexEmploymentCustomFieldValueErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexEmploymentCustomFieldValueError = - GetIndexEmploymentCustomFieldValueErrors[keyof GetIndexEmploymentCustomFieldValueErrors]; +export type GetV1BillingDocumentsBillingDocumentIdBreakdownError = + GetV1BillingDocumentsBillingDocumentIdBreakdownErrors[keyof GetV1BillingDocumentsBillingDocumentIdBreakdownErrors]; -export type GetIndexEmploymentCustomFieldValueResponses = { +export type GetV1BillingDocumentsBillingDocumentIdBreakdownResponses = { /** * Success */ - 200: ListEmploymentCustomFieldValuePaginatedResponse; + 200: BillingDocumentBreakdownResponse; }; -export type GetIndexEmploymentCustomFieldValueResponse = - GetIndexEmploymentCustomFieldValueResponses[keyof GetIndexEmploymentCustomFieldValueResponses]; +export type GetV1BillingDocumentsBillingDocumentIdBreakdownResponse = + GetV1BillingDocumentsBillingDocumentIdBreakdownResponses[keyof GetV1BillingDocumentsBillingDocumentIdBreakdownResponses]; -export type PutValidateResignationData = { +export type PostV1TimeoffTimeoffIdCancelRequestDeclineData = { /** - * ValidateResignation + * Timeoff */ - body: ValidateResignationRequestParams; + body: DeclineTimeoffParams; path: { /** - * Offboarding request ID + * Time Off ID */ - offboarding_request_id: string; + timeoff_id: string; }; query?: never; - url: '/v1/resignations/{offboarding_request_id}/validate'; + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/decline'; }; -export type PutValidateResignationErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1TimeoffTimeoffIdCancelRequestDeclineErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -19703,49 +20682,44 @@ export type PutValidateResignationErrors = { 429: TooManyRequestsResponse; }; -export type PutValidateResignationError = - PutValidateResignationErrors[keyof PutValidateResignationErrors]; +export type PostV1TimeoffTimeoffIdCancelRequestDeclineError = + PostV1TimeoffTimeoffIdCancelRequestDeclineErrors[keyof PostV1TimeoffTimeoffIdCancelRequestDeclineErrors]; -export type PutValidateResignationResponses = { +export type PostV1TimeoffTimeoffIdCancelRequestDeclineResponses = { /** * Success */ 200: SuccessResponse; }; -export type PutValidateResignationResponse = - PutValidateResignationResponses[keyof PutValidateResignationResponses]; +export type PostV1TimeoffTimeoffIdCancelRequestDeclineResponse = + PostV1TimeoffTimeoffIdCancelRequestDeclineResponses[keyof PostV1TimeoffTimeoffIdCancelRequestDeclineResponses]; -export type PutReassignDefaultEntityCompanyData = { +export type GetV1PayrollCalendarsData = { body?: never; - headers: { + path?: never; + query?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Filter payroll calendars by country code */ - Authorization: string; - }; - path: { + country_code?: string; /** - * Company ID + * Filter payroll calendars by year */ - company_id: string; + year?: string; + /** + * Starts fetching records after the given page + */ + page?: number; /** - * Legal Entity ID to set as the new default + * Number of items per page */ - legal_entity_id: string; + page_size?: number; }; - query?: never; - url: '/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}'; + url: '/api/eor/v1/payroll-calendars'; }; -export type PutReassignDefaultEntityCompanyErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1PayrollCalendarsErrors = { /** * Unauthorized */ @@ -19758,78 +20732,56 @@ export type PutReassignDefaultEntityCompanyErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PutReassignDefaultEntityCompanyError = - PutReassignDefaultEntityCompanyErrors[keyof PutReassignDefaultEntityCompanyErrors]; +export type GetV1PayrollCalendarsError = + GetV1PayrollCalendarsErrors[keyof GetV1PayrollCalendarsErrors]; -export type PutReassignDefaultEntityCompanyResponses = { +export type GetV1PayrollCalendarsResponses = { /** * Success */ - 200: SuccessResponse; + 200: PayrollCalendarsEorResponse; }; -export type PutReassignDefaultEntityCompanyResponse = - PutReassignDefaultEntityCompanyResponses[keyof PutReassignDefaultEntityCompanyResponses]; +export type GetV1PayrollCalendarsResponse = + GetV1PayrollCalendarsResponses[keyof GetV1PayrollCalendarsResponses]; -export type GetIndexWebhookCallbackData = { +export type GetV1WdGphPayDetailData = { body?: never; - path: { + headers?: { /** - * Company ID + * The preferred language of the inquiring user in Workday */ - company_id: string; + accept_language?: string; }; - query?: never; - url: '/v1/companies/{company_id}/webhook-callbacks'; -}; - -export type GetIndexWebhookCallbackErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; -}; - -export type GetIndexWebhookCallbackError = - GetIndexWebhookCallbackErrors[keyof GetIndexWebhookCallbackErrors]; - -export type GetIndexWebhookCallbackResponses = { - /** - * Success - */ - 200: ListWebhookCallbacksResponse; -}; - -export type GetIndexWebhookCallbackResponse = - GetIndexWebhookCallbackResponses[keyof GetIndexWebhookCallbackResponses]; - -export type GetContractorEligibilityCompanyLegalEntitiesData = { - body?: never; - path: { + path?: never; + query: { /** - * Company ID + * The pay group ID for identifying the pay group at the vendor system */ - company_id: UuidSlug; + payGroupExternalId: string; /** - * Legal entity ID + * The run type id provided in the paySummary API */ - legal_entity_id: UuidSlug; + runTypeId: string; + /** + * The cycle type id, defaults to the main run if not provided + */ + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; }; - query?: never; - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility'; + url: '/api/eor/v1/wd/gph/payDetail'; }; -export type GetContractorEligibilityCompanyLegalEntitiesErrors = { +export type GetV1WdGphPayDetailErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -19840,36 +20792,53 @@ export type GetContractorEligibilityCompanyLegalEntitiesErrors = { 404: NotFoundResponse; }; -export type GetContractorEligibilityCompanyLegalEntitiesError = - GetContractorEligibilityCompanyLegalEntitiesErrors[keyof GetContractorEligibilityCompanyLegalEntitiesErrors]; +export type GetV1WdGphPayDetailError = + GetV1WdGphPayDetailErrors[keyof GetV1WdGphPayDetailErrors]; -export type GetContractorEligibilityCompanyLegalEntitiesResponses = { +export type GetV1WdGphPayDetailResponses = { /** * Success */ - 200: ContractorEligibilityResponse; + 200: PayDetailResponse; }; -export type GetContractorEligibilityCompanyLegalEntitiesResponse = - GetContractorEligibilityCompanyLegalEntitiesResponses[keyof GetContractorEligibilityCompanyLegalEntitiesResponses]; +export type GetV1WdGphPayDetailResponse = + GetV1WdGphPayDetailResponses[keyof GetV1WdGphPayDetailResponses]; -export type GetShowEmploymentCustomFieldValueData = { +export type GetV1ContractAmendmentsSchemaData = { body?: never; - path: { + headers: { /** - * Custom field ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - custom_field_id: string; + Authorization: string; + }; + path?: never; + query: { /** - * Employment ID + * The ID of the employment concerned by the contract amendment request. */ employment_id: string; + /** + * Country code according to ISO 3-digit alphabetic codes. + */ + country_code: string; + /** + * Name of the desired form + */ + form?: 'contract_amendment'; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - query?: never; - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/api/eor/v1/contract-amendments/schema'; }; -export type GetShowEmploymentCustomFieldValueErrors = { +export type GetV1ContractAmendmentsSchemaErrors = { /** * Unauthorized */ @@ -19884,47 +20853,65 @@ export type GetShowEmploymentCustomFieldValueErrors = { 422: UnprocessableEntityResponse; }; -export type GetShowEmploymentCustomFieldValueError = - GetShowEmploymentCustomFieldValueErrors[keyof GetShowEmploymentCustomFieldValueErrors]; +export type GetV1ContractAmendmentsSchemaError = + GetV1ContractAmendmentsSchemaErrors[keyof GetV1ContractAmendmentsSchemaErrors]; -export type GetShowEmploymentCustomFieldValueResponses = { +export type GetV1ContractAmendmentsSchemaResponses = { /** * Success */ - 200: EmploymentCustomFieldValueResponse; + 200: ContractAmendmentFormResponse; +}; + +export type GetV1ContractAmendmentsSchemaResponse = + GetV1ContractAmendmentsSchemaResponses[keyof GetV1ContractAmendmentsSchemaResponses]; + +export type GetV1TestSchemaData = { + body?: never; + path?: never; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/test-schema'; +}; + +export type GetV1TestSchemaResponses = { + /** + * Success + */ + 200: CompanyFormResponse; }; -export type GetShowEmploymentCustomFieldValueResponse = - GetShowEmploymentCustomFieldValueResponses[keyof GetShowEmploymentCustomFieldValueResponses]; +export type GetV1TestSchemaResponse = + GetV1TestSchemaResponses[keyof GetV1TestSchemaResponses]; -export type PatchUpdateEmploymentCustomFieldValue2Data = { +export type PatchV1EmployeeTimeoffId2Data = { /** - * Custom Field Value Update Parameters + * UpdateTimeoff */ - body: UpdateEmploymentCustomFieldValueParams; + body: UpdateEmployeeTimeoffParams; path: { /** - * Custom field ID - */ - custom_field_id: string; - /** - * Employment ID + * Timeoff ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/api/eor/v1/employee/timeoff/{id}'; }; -export type PatchUpdateEmploymentCustomFieldValue2Errors = { +export type PatchV1EmployeeTimeoffId2Errors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -19933,49 +20920,49 @@ export type PatchUpdateEmploymentCustomFieldValue2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PatchUpdateEmploymentCustomFieldValue2Error = - PatchUpdateEmploymentCustomFieldValue2Errors[keyof PatchUpdateEmploymentCustomFieldValue2Errors]; +export type PatchV1EmployeeTimeoffId2Error = + PatchV1EmployeeTimeoffId2Errors[keyof PatchV1EmployeeTimeoffId2Errors]; -export type PatchUpdateEmploymentCustomFieldValue2Responses = { +export type PatchV1EmployeeTimeoffId2Responses = { /** * Success */ - 200: EmploymentCustomFieldValueResponse; + 200: TimeoffResponse; }; -export type PatchUpdateEmploymentCustomFieldValue2Response = - PatchUpdateEmploymentCustomFieldValue2Responses[keyof PatchUpdateEmploymentCustomFieldValue2Responses]; +export type PatchV1EmployeeTimeoffId2Response = + PatchV1EmployeeTimeoffId2Responses[keyof PatchV1EmployeeTimeoffId2Responses]; -export type PatchUpdateEmploymentCustomFieldValueData = { +export type PatchV1EmployeeTimeoffIdData = { /** - * Custom Field Value Update Parameters + * UpdateTimeoff */ - body: UpdateEmploymentCustomFieldValueParams; + body: UpdateEmployeeTimeoffParams; path: { /** - * Custom field ID - */ - custom_field_id: string; - /** - * Employment ID + * Timeoff ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/api/eor/v1/employee/timeoff/{id}'; }; -export type PatchUpdateEmploymentCustomFieldValueErrors = { +export type PatchV1EmployeeTimeoffIdErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -19984,82 +20971,103 @@ export type PatchUpdateEmploymentCustomFieldValueErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PatchUpdateEmploymentCustomFieldValueError = - PatchUpdateEmploymentCustomFieldValueErrors[keyof PatchUpdateEmploymentCustomFieldValueErrors]; +export type PatchV1EmployeeTimeoffIdError = + PatchV1EmployeeTimeoffIdErrors[keyof PatchV1EmployeeTimeoffIdErrors]; -export type PatchUpdateEmploymentCustomFieldValueResponses = { +export type PatchV1EmployeeTimeoffIdResponses = { /** * Success */ - 200: EmploymentCustomFieldValueResponse; + 200: TimeoffResponse; }; -export type PatchUpdateEmploymentCustomFieldValueResponse = - PatchUpdateEmploymentCustomFieldValueResponses[keyof PatchUpdateEmploymentCustomFieldValueResponses]; +export type PatchV1EmployeeTimeoffIdResponse = + PatchV1EmployeeTimeoffIdResponses[keyof PatchV1EmployeeTimeoffIdResponses]; -export type GetShowCorTerminationRequestSubscriptionData = { +export type GetV1ScimV2GroupsIdData = { body?: never; path: { /** - * Employment ID - */ - employment_id: string; - /** - * Termination Request ID + * Group ID (slug) */ - termination_request_id: string; + id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}'; + url: '/api/eor/v1/scim/v2/Groups/{id}'; }; -export type GetShowCorTerminationRequestSubscriptionErrors = { +export type GetV1ScimV2GroupsIdErrors = { + /** + * Unauthorized + */ + 401: IntegrationsScimErrorResponse; /** * Forbidden */ - 403: ForbiddenResponse; + 403: IntegrationsScimErrorResponse; /** * Not Found */ - 404: NotFoundResponse; + 404: IntegrationsScimErrorResponse; }; -export type GetShowCorTerminationRequestSubscriptionError = - GetShowCorTerminationRequestSubscriptionErrors[keyof GetShowCorTerminationRequestSubscriptionErrors]; +export type GetV1ScimV2GroupsIdError = + GetV1ScimV2GroupsIdErrors[keyof GetV1ScimV2GroupsIdErrors]; -export type GetShowCorTerminationRequestSubscriptionResponses = { +export type GetV1ScimV2GroupsIdResponses = { /** * Success */ - 200: CorTerminationRequestResponse; + 200: IntegrationsScimGroup; }; -export type GetShowCorTerminationRequestSubscriptionResponse = - GetShowCorTerminationRequestSubscriptionResponses[keyof GetShowCorTerminationRequestSubscriptionResponses]; +export type GetV1ScimV2GroupsIdResponse = + GetV1ScimV2GroupsIdResponses[keyof GetV1ScimV2GroupsIdResponses]; -export type PostTerminateContractorOfRecordEmploymentSubscriptionData = { +export type GetV1CountriesCountryCodeLegalEntityFormsFormData = { body?: never; path: { /** - * Employment ID + * Country code according to ISO 3-digit alphabetic codes */ - employment_id: string; + country_code: string; + /** + * Name of the desired form + */ + form: string; }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/terminate-cor-employment'; + query?: { + /** + * Product type. Default value is global_payroll. + */ + product_type?: 'peo' | 'global_payroll' | 'e2e_payroll'; + /** + * Legal entity id for admistrative_details of e2e payroll products in GBR + */ + legal_entity_id?: UuidSlug; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/countries/{country_code}/legal_entity_forms/{form}'; }; -export type PostTerminateContractorOfRecordEmploymentSubscriptionErrors = { +export type GetV1CountriesCountryCodeLegalEntityFormsFormErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -20068,116 +21076,150 @@ export type PostTerminateContractorOfRecordEmploymentSubscriptionErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostTerminateContractorOfRecordEmploymentSubscriptionError = - PostTerminateContractorOfRecordEmploymentSubscriptionErrors[keyof PostTerminateContractorOfRecordEmploymentSubscriptionErrors]; +export type GetV1CountriesCountryCodeLegalEntityFormsFormError = + GetV1CountriesCountryCodeLegalEntityFormsFormErrors[keyof GetV1CountriesCountryCodeLegalEntityFormsFormErrors]; -export type PostTerminateContractorOfRecordEmploymentSubscriptionResponses = { +export type GetV1CountriesCountryCodeLegalEntityFormsFormResponses = { /** * Success */ - 200: SuccessResponse; + 200: CountryFormResponse; }; -export type PostTerminateContractorOfRecordEmploymentSubscriptionResponse = - PostTerminateContractorOfRecordEmploymentSubscriptionResponses[keyof PostTerminateContractorOfRecordEmploymentSubscriptionResponses]; +export type GetV1CountriesCountryCodeLegalEntityFormsFormResponse = + GetV1CountriesCountryCodeLegalEntityFormsFormResponses[keyof GetV1CountriesCountryCodeLegalEntityFormsFormResponses]; -export type PostSignContractDocumentData = { - /** - * SignContractDocument - */ - body: SignContractDocument; +export type GetV1EmploymentContractsEmploymentIdPendingChangesData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** * Employment ID */ employment_id: string; - /** - * Document ID - */ - contract_document_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign'; + url: '/api/eor/v1/employment-contracts/{employment_id}/pending-changes'; }; -export type PostSignContractDocumentErrors = { +export type GetV1EmploymentContractsEmploymentIdPendingChangesErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type PostSignContractDocumentError = - PostSignContractDocumentErrors[keyof PostSignContractDocumentErrors]; +export type GetV1EmploymentContractsEmploymentIdPendingChangesError = + GetV1EmploymentContractsEmploymentIdPendingChangesErrors[keyof GetV1EmploymentContractsEmploymentIdPendingChangesErrors]; -export type PostSignContractDocumentResponses = { +export type GetV1EmploymentContractsEmploymentIdPendingChangesResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentContractPendingChangesResponse; }; -export type PostSignContractDocumentResponse = - PostSignContractDocumentResponses[keyof PostSignContractDocumentResponses]; +export type GetV1EmploymentContractsEmploymentIdPendingChangesResponse = + GetV1EmploymentContractsEmploymentIdPendingChangesResponses[keyof GetV1EmploymentContractsEmploymentIdPendingChangesResponses]; -export type GetCurrentIdentityData = { - body?: never; - headers: { - /** - * This endpoint works with any of the access tokens provided. You can use an access - * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. - * - */ - Authorization: string; - }; +export type PostV1SdkTelemetryErrorsData = { + /** + * SDK Error Report + */ + body: SdkErrorPayload; path?: never; query?: never; - url: '/v1/identity/current'; + url: '/api/eor/v1/sdk/telemetry-errors'; }; -export type GetCurrentIdentityErrors = { +export type PostV1SdkTelemetryErrorsErrors = { /** * Bad Request */ - 400: BadRequestResponse; + 400: ErrorResponse; /** - * Unauthorized + * Too Many Requests */ - 401: UnauthorizedResponse; + 429: RateLimitResponse; +}; + +export type PostV1SdkTelemetryErrorsError = + PostV1SdkTelemetryErrorsErrors[keyof PostV1SdkTelemetryErrorsErrors]; + +export type PostV1SdkTelemetryErrorsResponses = { /** - * Not Found + * No Content */ - 404: NotFoundResponse; + 204: unknown; +}; + +export type GetV1CompaniesCompanyIdComplianceProfileData = { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/compliance-profile'; +}; + +export type GetV1CompaniesCompanyIdComplianceProfileErrors = { /** - * Unprocessable Entity + * Unauthorized */ - 422: UnprocessableEntityResponse; + 401: UnauthorizedResponse; /** - * Too many requests + * Forbidden */ - 429: TooManyRequestsResponse; + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; }; -export type GetCurrentIdentityError = - GetCurrentIdentityErrors[keyof GetCurrentIdentityErrors]; +export type GetV1CompaniesCompanyIdComplianceProfileError = + GetV1CompaniesCompanyIdComplianceProfileErrors[keyof GetV1CompaniesCompanyIdComplianceProfileErrors]; -export type GetCurrentIdentityResponses = { +export type GetV1CompaniesCompanyIdComplianceProfileResponses = { /** * Success */ - 201: IdentityCurrentResponse; + 200: CompanyComplianceProfileResponse; }; -export type GetCurrentIdentityResponse = - GetCurrentIdentityResponses[keyof GetCurrentIdentityResponses]; +export type GetV1CompaniesCompanyIdComplianceProfileResponse = + GetV1CompaniesCompanyIdComplianceProfileResponses[keyof GetV1CompaniesCompanyIdComplianceProfileResponses]; -export type DeleteDeleteIncentiveData = { +export type GetV1PayslipsIdData = { body?: never; headers: { /** @@ -20190,15 +21232,15 @@ export type DeleteDeleteIncentiveData = { }; path: { /** - * Incentive ID + * Payslip ID */ id: string; }; query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/payslips/{id}'; }; -export type DeleteDeleteIncentiveErrors = { +export type GetV1PayslipsIdErrors = { /** * Bad Request */ @@ -20211,10 +21253,6 @@ export type DeleteDeleteIncentiveErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ @@ -20225,105 +21263,104 @@ export type DeleteDeleteIncentiveErrors = { 429: TooManyRequestsResponse; }; -export type DeleteDeleteIncentiveError = - DeleteDeleteIncentiveErrors[keyof DeleteDeleteIncentiveErrors]; +export type GetV1PayslipsIdError = + GetV1PayslipsIdErrors[keyof GetV1PayslipsIdErrors]; -export type DeleteDeleteIncentiveResponses = { +export type GetV1PayslipsIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: PayslipResponse; }; -export type DeleteDeleteIncentiveResponse = - DeleteDeleteIncentiveResponses[keyof DeleteDeleteIncentiveResponses]; +export type GetV1PayslipsIdResponse = + GetV1PayslipsIdResponses[keyof GetV1PayslipsIdResponses]; -export type GetShowIncentiveData = { +export type PostV1TimeoffTimeoffIdCancelRequestApproveData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path: { /** - * Incentive ID + * Time Off ID */ - id: string; + timeoff_id: string; }; query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/approve'; }; -export type GetShowIncentiveErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1TimeoffTimeoffIdCancelRequestApproveErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetShowIncentiveError = - GetShowIncentiveErrors[keyof GetShowIncentiveErrors]; +export type PostV1TimeoffTimeoffIdCancelRequestApproveError = + PostV1TimeoffTimeoffIdCancelRequestApproveErrors[keyof PostV1TimeoffTimeoffIdCancelRequestApproveErrors]; -export type GetShowIncentiveResponses = { +export type PostV1TimeoffTimeoffIdCancelRequestApproveResponses = { /** * Success */ - 200: IncentiveResponse; + 200: SuccessResponse; }; -export type GetShowIncentiveResponse = - GetShowIncentiveResponses[keyof GetShowIncentiveResponses]; +export type PostV1TimeoffTimeoffIdCancelRequestApproveResponse = + PostV1TimeoffTimeoffIdCancelRequestApproveResponses[keyof PostV1TimeoffTimeoffIdCancelRequestApproveResponses]; -export type PatchUpdateIncentive2Data = { - /** - * Incentive - */ - body?: UpdateIncentiveParams; - headers: { +export type GetV1WebhookEventsData = { + body?: never; + path?: never; + query?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Filter by webhook event type */ - Authorization: string; - }; - path: { + event_type?: string; /** - * Incentive ID + * Filter by delivery status (true = 200, false = 4xx/5xx) */ - id: string; + successfully_delivered?: boolean; + /** + * Filter by company ID + */ + company_id?: string; + /** + * Filter by date before (ISO 8601 format) + */ + before?: string; + /** + * Filter by date after (ISO 8601 format) + */ + after?: string; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'first_triggered_at'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/webhook-events'; }; -export type PatchUpdateIncentive2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1WebhookEventsErrors = { /** * Unauthorized */ @@ -20332,38 +21369,27 @@ export type PatchUpdateIncentive2Errors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchUpdateIncentive2Error = - PatchUpdateIncentive2Errors[keyof PatchUpdateIncentive2Errors]; +export type GetV1WebhookEventsError = + GetV1WebhookEventsErrors[keyof GetV1WebhookEventsErrors]; -export type PatchUpdateIncentive2Responses = { +export type GetV1WebhookEventsResponses = { /** * Success */ - 200: IncentiveResponse; + 200: ListWebhookEventsResponse; }; -export type PatchUpdateIncentive2Response = - PatchUpdateIncentive2Responses[keyof PatchUpdateIncentive2Responses]; +export type GetV1WebhookEventsResponse = + GetV1WebhookEventsResponses[keyof GetV1WebhookEventsResponses]; -export type PatchUpdateIncentiveData = { - /** - * Incentive - */ - body?: UpdateIncentiveParams; +export type GetV1TimeoffTypesData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -20373,17 +21399,17 @@ export type PatchUpdateIncentiveData = { */ Authorization: string; }; - path: { + path?: never; + query?: { /** - * Incentive ID + * Optional. Employment type to list time off types for: `contractor` or `full_time`. Omit for backward-compatible behavior (full-time types). */ - id: string; + type?: TimeoffTypesEmploymentType; }; - query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/timeoff/types'; }; -export type PatchUpdateIncentiveErrors = { +export type GetV1TimeoffTypesErrors = { /** * Bad Request */ @@ -20396,120 +21422,1151 @@ export type PatchUpdateIncentiveErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PatchUpdateIncentiveError = - PatchUpdateIncentiveErrors[keyof PatchUpdateIncentiveErrors]; +export type GetV1TimeoffTypesError = + GetV1TimeoffTypesErrors[keyof GetV1TimeoffTypesErrors]; -export type PatchUpdateIncentiveResponses = { +export type GetV1TimeoffTypesResponses = { /** * Success */ - 200: IncentiveResponse; + 200: ListTimeoffTypesResponse; }; -export type PatchUpdateIncentiveResponse = - PatchUpdateIncentiveResponses[keyof PatchUpdateIncentiveResponses]; +export type GetV1TimeoffTypesResponse = + GetV1TimeoffTypesResponses[keyof GetV1TimeoffTypesResponses]; -export type GetShowEligibilityQuestionnaireData = { +export type GetV1CompaniesCompanyIdLegalEntitiesData = { body?: never; - path?: never; - query: { + path: { /** - * Type of eligibility questionnaire + * Company ID */ - type: 'contractor_of_record'; + company_id: UuidSlug; + }; + query?: { /** - * Version of the form schema + * Starts fetching records after the given page */ - json_schema_version?: number | 'latest'; + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - url: '/v1/contractors/schemas/eligibility-questionnaire'; + url: '/api/eor/v1/companies/{company_id}/legal-entities'; }; -export type GetShowEligibilityQuestionnaireErrors = { +export type GetV1CompaniesCompanyIdLegalEntitiesErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: ForbiddenResponse; + 404: NotFoundResponse; +}; + +export type GetV1CompaniesCompanyIdLegalEntitiesError = + GetV1CompaniesCompanyIdLegalEntitiesErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesErrors]; + +export type GetV1CompaniesCompanyIdLegalEntitiesResponses = { + /** + * Success + */ + 200: ListCompanyLegalEntitiesResponse; +}; + +export type GetV1CompaniesCompanyIdLegalEntitiesResponse = + GetV1CompaniesCompanyIdLegalEntitiesResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesResponses]; + +export type PostV1EmploymentsEmploymentIdContractEligibilityData = { + /** + * Contract Eligibility Create Parameters + */ + body: CreateContractEligibilityParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/contract-eligibility'; +}; + +export type PostV1EmploymentsEmploymentIdContractEligibilityErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetShowEligibilityQuestionnaireError = - GetShowEligibilityQuestionnaireErrors[keyof GetShowEligibilityQuestionnaireErrors]; +export type PostV1EmploymentsEmploymentIdContractEligibilityError = + PostV1EmploymentsEmploymentIdContractEligibilityErrors[keyof PostV1EmploymentsEmploymentIdContractEligibilityErrors]; -export type GetShowEligibilityQuestionnaireResponses = { +export type PostV1EmploymentsEmploymentIdContractEligibilityResponses = { /** * Success */ - 200: EligibilityQuestionnaireJsonSchemaResponse; + 200: SuccessResponse; }; -export type GetShowEligibilityQuestionnaireResponse = - GetShowEligibilityQuestionnaireResponses[keyof GetShowEligibilityQuestionnaireResponses]; +export type PostV1EmploymentsEmploymentIdContractEligibilityResponse = + PostV1EmploymentsEmploymentIdContractEligibilityResponses[keyof PostV1EmploymentsEmploymentIdContractEligibilityResponses]; -export type GetIndexWorkAuthorizationRequestData = { +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData = { body?: never; - path?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: { /** - * Filter results on the given status + * Restrict to currencies which payout is guaranteed (default: true) */ - status?: - | 'pending' - | 'cancelled' - | 'declined_by_manager' - | 'declined_by_remote' - | 'approved_by_manager' - | 'approved_by_remote'; + restrict_to_guaranteed_pay_out_currencies?: boolean; + }; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-currencies'; +}; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors = + { /** - * Filter results on the given employment slug + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Internal Server Error + */ + 500: InternalServerErrorResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesError = + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors]; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses = + { + /** + * Success + */ + 200: ContractorCurrencyResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponse = + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses]; + +export type GetV1PayslipsData = { + body?: never; + path?: never; + query?: { + /** + * Employment ID */ employment_id?: string; /** - * Filter results on the given employee name + * Filters by payslips `issued_at` field, after or on the same day than the given date */ - employee_name?: string; + start_date?: string; /** - * Sort order + * Filters by payslips `issued_at` field, before or or the same day than the given date */ - order?: 'asc' | 'desc'; + end_date?: string; /** - * Field to sort by + * Filters by payslips `expected_payout_date` field, after or on the same day than the given date */ - sort_by?: 'submitted_at'; + expected_payout_start_date?: string; + /** + * Filters by payslips `expected_payout_date` field, before or or the same day than the given date + */ + expected_payout_end_date?: string; /** * Starts fetching records after the given page */ page?: number; /** - * Number of items per page + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; + }; + url: '/api/eor/v1/payslips'; +}; + +export type GetV1PayslipsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type GetV1PayslipsError = GetV1PayslipsErrors[keyof GetV1PayslipsErrors]; + +export type GetV1PayslipsResponses = { + /** + * Success + */ + 200: ListPayslipsResponse; +}; + +export type GetV1PayslipsResponse = + GetV1PayslipsResponses[keyof GetV1PayslipsResponses]; + +export type PostV1SandboxEmploymentsData = { + /** + * Employment params + */ + body?: EmploymentCreateParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path?: never; + query?: never; + url: '/api/eor/v1/sandbox/employments'; +}; + +export type PostV1SandboxEmploymentsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type PostV1SandboxEmploymentsError = + PostV1SandboxEmploymentsErrors[keyof PostV1SandboxEmploymentsErrors]; + +export type PostV1SandboxEmploymentsResponses = { + /** + * Success + */ + 201: EmploymentCreationResponse; +}; + +export type PostV1SandboxEmploymentsResponse = + PostV1SandboxEmploymentsResponses[keyof PostV1SandboxEmploymentsResponses]; + +export type GetV1PayrollRunsPayrollRunIdData = { + body?: never; + path: { + /** + * Payroll run ID + */ + payroll_run_id: string; + }; + query?: never; + url: '/api/eor/v1/payroll-runs/{payroll_run_id}'; +}; + +export type GetV1PayrollRunsPayrollRunIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1PayrollRunsPayrollRunIdError = + GetV1PayrollRunsPayrollRunIdErrors[keyof GetV1PayrollRunsPayrollRunIdErrors]; + +export type GetV1PayrollRunsPayrollRunIdResponses = { + /** + * Success + */ + 200: PayrollRunResponse; +}; + +export type GetV1PayrollRunsPayrollRunIdResponse = + GetV1PayrollRunsPayrollRunIdResponses[keyof GetV1PayrollRunsPayrollRunIdResponses]; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements'; + }; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsError = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors]; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses = + { + /** + * Success + */ + 200: IndexPreOnboardingDocumentRequirementsResponse; + }; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponse = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses]; + +export type GetV1OffboardingsIdData = { + body?: never; + path: { + /** + * Offboarding request ID + */ + id: string; + }; + query?: never; + url: '/api/eor/v1/offboardings/{id}'; +}; + +export type GetV1OffboardingsIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type GetV1OffboardingsIdError = + GetV1OffboardingsIdErrors[keyof GetV1OffboardingsIdErrors]; + +export type GetV1OffboardingsIdResponses = { + /** + * Success + */ + 200: OffboardingResponse; +}; + +export type GetV1OffboardingsIdResponse = + GetV1OffboardingsIdResponses[keyof GetV1OffboardingsIdResponses]; + +export type GetV1ExpensesData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path?: never; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; + }; + url: '/api/eor/v1/expenses'; +}; + +export type GetV1ExpensesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type GetV1ExpensesError = GetV1ExpensesErrors[keyof GetV1ExpensesErrors]; + +export type GetV1ExpensesResponses = { + /** + * Success + */ + 201: ListExpenseResponse; +}; + +export type GetV1ExpensesResponse = + GetV1ExpensesResponses[keyof GetV1ExpensesResponses]; + +export type PostV1ExpensesData = { + /** + * Expenses + */ + body?: ParamsToCreateExpense; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path?: never; + query?: never; + url: '/api/eor/v1/expenses'; +}; + +export type PostV1ExpensesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type PostV1ExpensesError = + PostV1ExpensesErrors[keyof PostV1ExpensesErrors]; + +export type PostV1ExpensesResponses = { + /** + * Success + */ + 201: ExpenseResponse; +}; + +export type PostV1ExpensesResponse = + PostV1ExpensesResponses[keyof PostV1ExpensesResponses]; + +export type GetV1EmployeePayslipFilesData = { + body?: never; + path?: never; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employee/payslip-files'; +}; + +export type GetV1EmployeePayslipFilesErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1EmployeePayslipFilesError = + GetV1EmployeePayslipFilesErrors[keyof GetV1EmployeePayslipFilesErrors]; + +export type GetV1EmployeePayslipFilesResponses = { + /** + * Success + */ + 200: ListPayslipFilesResponse; +}; + +export type GetV1EmployeePayslipFilesResponse = + GetV1EmployeePayslipFilesResponses[keyof GetV1EmployeePayslipFilesResponses]; + +export type PostV1EmploymentsEmploymentIdInviteData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/invite'; +}; + +export type PostV1EmploymentsEmploymentIdInviteErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PostV1EmploymentsEmploymentIdInviteError = + PostV1EmploymentsEmploymentIdInviteErrors[keyof PostV1EmploymentsEmploymentIdInviteErrors]; + +export type PostV1EmploymentsEmploymentIdInviteResponses = { + /** + * Success + */ + 200: SuccessResponse; +}; + +export type PostV1EmploymentsEmploymentIdInviteResponse = + PostV1EmploymentsEmploymentIdInviteResponses[keyof PostV1EmploymentsEmploymentIdInviteResponses]; + +export type PostV1ProbationExtensionsData = { + /** + * ProbationExtension + */ + body: CreateProbationExtensionParams; + path?: never; + query?: never; + url: '/api/eor/v1/probation-extensions'; +}; + +export type PostV1ProbationExtensionsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type PostV1ProbationExtensionsError = + PostV1ProbationExtensionsErrors[keyof PostV1ProbationExtensionsErrors]; + +export type PostV1ProbationExtensionsResponses = { + /** + * Success + */ + 200: ProbationExtensionResponse; +}; + +export type PostV1ProbationExtensionsResponse = + PostV1ProbationExtensionsResponses[keyof PostV1ProbationExtensionsResponses]; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData = + { + body?: never; + path: { + /** + * Contract amendment request ID + */ + contract_amendment_request_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve'; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveError = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors]; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses = + { + /** + * Success + */ + 200: ContractAmendmentResponse; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponse = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses]; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData = + { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Employment ID + */ + employment_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status'; + }; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusError = + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors[keyof GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors]; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses = + { + /** + * Success + */ + 200: OnboardingReservesStatusResponse; + }; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponse = + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses[keyof GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses]; + +export type GetV1ContractorInvoicesIdData = { + body?: never; + path: { + /** + * Resource unique identifier + */ + id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/contractor-invoices/{id}'; +}; + +export type GetV1ContractorInvoicesIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1ContractorInvoicesIdError = + GetV1ContractorInvoicesIdErrors[keyof GetV1ContractorInvoicesIdErrors]; + +export type GetV1ContractorInvoicesIdResponses = { + /** + * Success + */ + 200: ContractorInvoiceResponse; +}; + +export type GetV1ContractorInvoicesIdResponse = + GetV1ContractorInvoicesIdResponses[keyof GetV1ContractorInvoicesIdResponses]; + +export type GetV1WdGphPayProcessingFeatureData = { + body?: never; + path?: never; + query?: never; + url: '/api/eor/v1/wd/gph/payProcessingFeature'; +}; + +export type GetV1WdGphPayProcessingFeatureErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1WdGphPayProcessingFeatureError = + GetV1WdGphPayProcessingFeatureErrors[keyof GetV1WdGphPayProcessingFeatureErrors]; + +export type GetV1WdGphPayProcessingFeatureResponses = { + /** + * Success + */ + 200: PayProcessingFeatureResponse; +}; + +export type GetV1WdGphPayProcessingFeatureResponse = + GetV1WdGphPayProcessingFeatureResponses[keyof GetV1WdGphPayProcessingFeatureResponses]; + +export type GetV1WdGphPayProgressData = { + body?: never; + headers?: { + /** + * The preferred language of the inquiring user in Workday + */ + accept_language?: string; + }; + path?: never; + query: { + /** + * The pay group ID for identifying the pay group at the vendor system + */ + payGroupExternalId: string; + /** + * The run type id provided in the paySummary API + */ + runTypeId: string; + /** + * The cycle type id, defaults to the main run if not provided + */ + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; + }; + url: '/api/eor/v1/wd/gph/payProgress'; +}; + +export type GetV1WdGphPayProgressErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1WdGphPayProgressError = + GetV1WdGphPayProgressErrors[keyof GetV1WdGphPayProgressErrors]; + +export type GetV1WdGphPayProgressResponses = { + /** + * Success + */ + 200: PayProgressResponse; +}; + +export type GetV1WdGphPayProgressResponse = + GetV1WdGphPayProgressResponses[keyof GetV1WdGphPayProgressResponses]; + +export type GetV1CompanyCurrenciesData = { + body?: never; + path?: never; + query?: never; + url: '/api/eor/v1/company-currencies'; +}; + +export type GetV1CompanyCurrenciesErrors = { + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1CompanyCurrenciesError = + GetV1CompanyCurrenciesErrors[keyof GetV1CompanyCurrenciesErrors]; + +export type GetV1CompanyCurrenciesResponses = { + /** + * Success + */ + 200: CompanyCurrenciesResponse; +}; + +export type GetV1CompanyCurrenciesResponse = + GetV1CompanyCurrenciesResponses[keyof GetV1CompanyCurrenciesResponses]; + +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaData = { + body?: never; + path: { + /** + * Unique identifier of the employment + */ + employment_id: UuidSlug; + }; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/employments/{employment_id}/benefit-offers/schema'; +}; + +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors = { + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaError = + GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors[keyof GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors]; + +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses = { + /** + * Success + */ + 200: UnifiedEmploymentsBenefitOffersJsonSchemaResponse; +}; + +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponse = + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses[keyof GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses]; + +export type GetV1ContractorInvoiceSchedulesData = { + body?: never; + path?: never; + query?: { + /** + * Filters contractor invoice schedules by start date greater than or equal to the value. + */ + start_date_from?: Date; + /** + * Filters contractor invoice schedules by start date less than or equal to the value. + */ + start_date_to?: Date; + /** + * Filters contractor invoice schedules by next invoice date greater than or equal to the value. + */ + next_invoice_date_from?: Date; + /** + * Filters contractor invoice schedules by next invoice date less than or equal to the value. + */ + next_invoice_date_to?: Date; + /** + * Filters contractor invoice schedules by status matching the value. + */ + status?: ContractorInvoiceScheduleStatus; + /** + * Filters contractor invoice schedules by employment id matching the value. + */ + employment_id?: UuidSlug; + /** + * Filters contractor invoice schedules by periodicity matching the value. + */ + periodicity?: ContractorInvoiceSchedulePeriodicity; + /** + * Filters contractor invoice schedules by currency matching the value. + */ + currency?: string; + /** + * Field to sort by + */ + sort_by?: + | 'number' + | 'total_amount' + | 'next_invoice_at' + | 'start_date' + | 'nr_occurrences'; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/contractor-invoice-schedules'; +}; + +export type GetV1ContractorInvoiceSchedulesErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1ContractorInvoiceSchedulesError = + GetV1ContractorInvoiceSchedulesErrors[keyof GetV1ContractorInvoiceSchedulesErrors]; + +export type GetV1ContractorInvoiceSchedulesResponses = { + /** + * Success + */ + 200: ListContractorInvoiceSchedulesResponse; +}; + +export type GetV1ContractorInvoiceSchedulesResponse = + GetV1ContractorInvoiceSchedulesResponses[keyof GetV1ContractorInvoiceSchedulesResponses]; + +export type PostV1ContractorInvoiceSchedulesData = { + /** + * Bulk creation payload + */ + body: BulkContractorInvoiceScheduleCreateParams; + path?: never; + query?: never; + url: '/api/eor/v1/contractor-invoice-schedules'; +}; + +export type PostV1ContractorInvoiceSchedulesErrors = { + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * BulkContractorInvoiceScheduleCreateResponse + * + * Response containing the lists of succeeded and failed schedules. + */ + 422: { + data: { + failures: Array; + successes: Array; + }; + }; +}; + +export type PostV1ContractorInvoiceSchedulesError = + PostV1ContractorInvoiceSchedulesErrors[keyof PostV1ContractorInvoiceSchedulesErrors]; + +export type PostV1ContractorInvoiceSchedulesResponses = { + /** + * BulkContractorInvoiceScheduleCreateResponse + * + * Response containing the lists of succeeded and failed schedules. + */ + 201: { + data: { + failures: Array; + successes: Array; + }; + }; + /** + * BulkContractorInvoiceScheduleCreateResponse + * + * Response containing the lists of succeeded and failed schedules. + */ + 207: { + data: { + failures: Array; + successes: Array; + }; + }; +}; + +export type PostV1ContractorInvoiceSchedulesResponse = + PostV1ContractorInvoiceSchedulesResponses[keyof PostV1ContractorInvoiceSchedulesResponses]; + +export type GetV1WorkAuthorizationRequestsIdData = { + body?: never; + path: { + /** + * work authorization request ID */ - page_size?: number; + id: string; }; - url: '/v1/work-authorization-requests'; + query?: never; + url: '/api/eor/v1/work-authorization-requests/{id}'; }; -export type GetIndexWorkAuthorizationRequestErrors = { +export type GetV1WorkAuthorizationRequestsIdErrors = { /** * Not Found */ @@ -20520,40 +22577,39 @@ export type GetIndexWorkAuthorizationRequestErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexWorkAuthorizationRequestError = - GetIndexWorkAuthorizationRequestErrors[keyof GetIndexWorkAuthorizationRequestErrors]; +export type GetV1WorkAuthorizationRequestsIdError = + GetV1WorkAuthorizationRequestsIdErrors[keyof GetV1WorkAuthorizationRequestsIdErrors]; -export type GetIndexWorkAuthorizationRequestResponses = { +export type GetV1WorkAuthorizationRequestsIdResponses = { /** * Success */ - 200: ListWorkAuthorizationRequestsResponse; + 200: WorkAuthorizationRequestResponse; }; -export type GetIndexWorkAuthorizationRequestResponse = - GetIndexWorkAuthorizationRequestResponses[keyof GetIndexWorkAuthorizationRequestResponses]; +export type GetV1WorkAuthorizationRequestsIdResponse = + GetV1WorkAuthorizationRequestsIdResponses[keyof GetV1WorkAuthorizationRequestsIdResponses]; -export type GetShowBulkEmploymentData = { - body?: never; +export type PatchV1WorkAuthorizationRequestsId2Data = { + /** + * Work Authorization Request + */ + body: UpdateWorkAuthorizationRequestParams; path: { /** - * Bulk employment job id + * work authorization request ID */ - job_id: string; + id: string; }; query?: never; - url: '/v1/bulk-employment-jobs/{job_id}'; + url: '/api/eor/v1/work-authorization-requests/{id}'; }; -export type GetShowBulkEmploymentErrors = { +export type PatchV1WorkAuthorizationRequestsId2Errors = { /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -20561,59 +22617,42 @@ export type GetShowBulkEmploymentErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetShowBulkEmploymentError = - GetShowBulkEmploymentErrors[keyof GetShowBulkEmploymentErrors]; +export type PatchV1WorkAuthorizationRequestsId2Error = + PatchV1WorkAuthorizationRequestsId2Errors[keyof PatchV1WorkAuthorizationRequestsId2Errors]; -export type GetShowBulkEmploymentResponses = { +export type PatchV1WorkAuthorizationRequestsId2Responses = { /** * Success */ - 200: BulkEmploymentImportJobResponse; + 200: WorkAuthorizationRequestResponse; }; -export type GetShowBulkEmploymentResponse = - GetShowBulkEmploymentResponses[keyof GetShowBulkEmploymentResponses]; +export type PatchV1WorkAuthorizationRequestsId2Response = + PatchV1WorkAuthorizationRequestsId2Responses[keyof PatchV1WorkAuthorizationRequestsId2Responses]; -export type GetIndexPayItemsData = { - body?: never; - path?: never; - query?: { - /** - * Filter by employment slug - */ - employment_slug?: UuidSlug; - /** - * Filter pay items with effective_date >= given date (YYYY-MM-DD) - */ - effective_from?: Date; - /** - * Filter pay items with effective_date <= given date (YYYY-MM-DD) - */ - effective_to?: Date; - /** - * Starts fetching records after the given page - */ - page?: number; +export type PatchV1WorkAuthorizationRequestsIdData = { + /** + * Work Authorization Request + */ + body: UpdateWorkAuthorizationRequestParams; + path: { /** - * Number of items per page + * work authorization request ID */ - page_size?: number; + id: string; }; - url: '/v1/pay-items'; + query?: never; + url: '/api/eor/v1/work-authorization-requests/{id}'; }; -export type GetIndexPayItemsErrors = { +export type PatchV1WorkAuthorizationRequestsIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -20624,36 +22663,43 @@ export type GetIndexPayItemsErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexPayItemsError = - GetIndexPayItemsErrors[keyof GetIndexPayItemsErrors]; +export type PatchV1WorkAuthorizationRequestsIdError = + PatchV1WorkAuthorizationRequestsIdErrors[keyof PatchV1WorkAuthorizationRequestsIdErrors]; -export type GetIndexPayItemsResponses = { +export type PatchV1WorkAuthorizationRequestsIdResponses = { /** * Success */ - 200: ListPayItemsResponse; + 200: WorkAuthorizationRequestResponse; }; -export type GetIndexPayItemsResponse = - GetIndexPayItemsResponses[keyof GetIndexPayItemsResponses]; +export type PatchV1WorkAuthorizationRequestsIdResponse = + PatchV1WorkAuthorizationRequestsIdResponses[keyof PatchV1WorkAuthorizationRequestsIdResponses]; -export type GetIndexBenefitOffersCountrySummaryData = { - body?: never; - headers: { +export type PostV1TimeoffTimeoffIdDeclineData = { + /** + * DeclineTimeoff + */ + body: DeclineTimeoffParams; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Time Off ID */ - Authorization: string; + timeoff_id: string; }; - path?: never; query?: never; - url: '/v1/benefit-offers/country-summaries'; + url: '/api/eor/v1/timeoff/{timeoff_id}/decline'; }; -export type GetIndexBenefitOffersCountrySummaryErrors = { +export type PostV1TimeoffTimeoffIdDeclineErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -20662,70 +22708,80 @@ export type GetIndexBenefitOffersCountrySummaryErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexBenefitOffersCountrySummaryError = - GetIndexBenefitOffersCountrySummaryErrors[keyof GetIndexBenefitOffersCountrySummaryErrors]; +export type PostV1TimeoffTimeoffIdDeclineError = + PostV1TimeoffTimeoffIdDeclineErrors[keyof PostV1TimeoffTimeoffIdDeclineErrors]; -export type GetIndexBenefitOffersCountrySummaryResponses = { +export type PostV1TimeoffTimeoffIdDeclineResponses = { /** * Success */ - 200: CountrySummariesResponse; + 200: TimeoffResponse; }; -export type GetIndexBenefitOffersCountrySummaryResponse = - GetIndexBenefitOffersCountrySummaryResponses[keyof GetIndexBenefitOffersCountrySummaryResponses]; +export type PostV1TimeoffTimeoffIdDeclineResponse = + PostV1TimeoffTimeoffIdDeclineResponses[keyof PostV1TimeoffTimeoffIdDeclineResponses]; -export type GetIndexBenefitOffersByEmploymentData = { +export type GetV1ContractorsSchemasEligibilityQuestionnaireData = { body?: never; - headers: { + path?: never; + query: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Type of eligibility questionnaire */ - Authorization: string; + type: 'contractor_of_record'; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - path?: never; - query?: never; - url: '/v1/benefit-offers'; + url: '/api/eor/v1/contractors/schemas/eligibility-questionnaire'; }; -export type GetIndexBenefitOffersByEmploymentErrors = { +export type GetV1ContractorsSchemasEligibilityQuestionnaireErrors = { /** - * Not Found + * Unauthorized */ - 404: NotFoundResponse; + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type GetIndexBenefitOffersByEmploymentError = - GetIndexBenefitOffersByEmploymentErrors[keyof GetIndexBenefitOffersByEmploymentErrors]; +export type GetV1ContractorsSchemasEligibilityQuestionnaireError = + GetV1ContractorsSchemasEligibilityQuestionnaireErrors[keyof GetV1ContractorsSchemasEligibilityQuestionnaireErrors]; -export type GetIndexBenefitOffersByEmploymentResponses = { +export type GetV1ContractorsSchemasEligibilityQuestionnaireResponses = { /** * Success */ - 200: BenefitOfferByEmploymentResponse; + 200: EligibilityQuestionnaireJsonSchemaResponse; }; -export type GetIndexBenefitOffersByEmploymentResponse = - GetIndexBenefitOffersByEmploymentResponses[keyof GetIndexBenefitOffersByEmploymentResponses]; +export type GetV1ContractorsSchemasEligibilityQuestionnaireResponse = + GetV1ContractorsSchemasEligibilityQuestionnaireResponses[keyof GetV1ContractorsSchemasEligibilityQuestionnaireResponses]; -export type PutCancelContractAmendmentData = { - body?: never; - path: { - /** - * Contract amendment request ID - */ - contract_amendment_request_id: string; - }; +export type PostAuthOauth2TokenData = { + /** + * OAuth2Token + */ + body?: OAuth2TokenParams; + path?: never; query?: never; - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel'; + url: '/api/eor/oauth2/token'; }; -export type PutCancelContractAmendmentErrors = { +export type PostAuthOauth2TokenErrors = { /** * Bad Request */ @@ -20748,30 +22804,126 @@ export type PutCancelContractAmendmentErrors = { 429: TooManyRequestsResponse; }; -export type PutCancelContractAmendmentError = - PutCancelContractAmendmentErrors[keyof PutCancelContractAmendmentErrors]; +export type PostAuthOauth2TokenError = + PostAuthOauth2TokenErrors[keyof PostAuthOauth2TokenErrors]; -export type PutCancelContractAmendmentResponses = { +export type PostAuthOauth2TokenResponses = { /** * Success */ - 200: SuccessResponse; + 200: OAuth2Tokens; }; -export type PutCancelContractAmendmentResponse = - PutCancelContractAmendmentResponses[keyof PutCancelContractAmendmentResponses]; +export type PostAuthOauth2TokenResponse = + PostAuthOauth2TokenResponses[keyof PostAuthOauth2TokenResponses]; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + }; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError = + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors[keyof DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors]; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses = + { + /** + * No Content + */ + 204: unknown; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError = + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses = + { + /** + * Created + */ + 201: SuccessResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponse = + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses]; -export type PostCreateEmployeeTimeoffData = { +export type PutV2EmploymentsEmploymentIdPersonalDetailsData = { /** - * Timeoff + * Employment personal details params */ - body: CreateEmployeeTimeoffParams; - path?: never; + body?: EmploymentPersonalDetailsParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/employee/timeoff'; + url: '/api/eor/v2/employments/{employment_id}/personal_details'; }; -export type PostCreateEmployeeTimeoffErrors = { +export type PutV2EmploymentsEmploymentIdPersonalDetailsErrors = { /** * Bad Request */ @@ -20780,10 +22932,18 @@ export type PostCreateEmployeeTimeoffErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -20794,32 +22954,91 @@ export type PostCreateEmployeeTimeoffErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateEmployeeTimeoffError = - PostCreateEmployeeTimeoffErrors[keyof PostCreateEmployeeTimeoffErrors]; +export type PutV2EmploymentsEmploymentIdPersonalDetailsError = + PutV2EmploymentsEmploymentIdPersonalDetailsErrors[keyof PutV2EmploymentsEmploymentIdPersonalDetailsErrors]; -export type PostCreateEmployeeTimeoffResponses = { +export type PutV2EmploymentsEmploymentIdPersonalDetailsResponses = { /** - * Created + * Success */ - 201: TimeoffResponse; + 200: EmploymentResponse; }; -export type PostCreateEmployeeTimeoffResponse = - PostCreateEmployeeTimeoffResponses[keyof PostCreateEmployeeTimeoffResponses]; +export type PutV2EmploymentsEmploymentIdPersonalDetailsResponse = + PutV2EmploymentsEmploymentIdPersonalDetailsResponses[keyof PutV2EmploymentsEmploymentIdPersonalDetailsResponses]; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData = + { + /** + * FindOrCreatePreOnboardingDocumentParams + */ + body: FindOrCreatePreOnboardingDocumentParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents'; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsError = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors]; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses = + { + /** + * Success + */ + 200: CreatePreOnboardingDocumentResponse; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponse = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses]; -export type GetShowProbationExtensionData = { +export type GetV1ContractAmendmentsIdData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Probation Extension Request ID + * Contract amendment request ID */ id: string; }; query?: never; - url: '/v1/probation-extensions/{id}'; + url: '/api/eor/v1/contract-amendments/{id}'; }; -export type GetShowProbationExtensionErrors = { +export type GetV1ContractAmendmentsIdErrors = { /** * Unauthorized */ @@ -20834,60 +23053,32 @@ export type GetShowProbationExtensionErrors = { 422: UnprocessableEntityResponse; }; -export type GetShowProbationExtensionError = - GetShowProbationExtensionErrors[keyof GetShowProbationExtensionErrors]; +export type GetV1ContractAmendmentsIdError = + GetV1ContractAmendmentsIdErrors[keyof GetV1ContractAmendmentsIdErrors]; -export type GetShowProbationExtensionResponses = { +export type GetV1ContractAmendmentsIdResponses = { /** * Success */ - 200: ProbationExtensionResponse; + 200: ContractAmendmentResponse; }; -export type GetShowProbationExtensionResponse = - GetShowProbationExtensionResponses[keyof GetShowProbationExtensionResponses]; +export type GetV1ContractAmendmentsIdResponse = + GetV1ContractAmendmentsIdResponses[keyof GetV1ContractAmendmentsIdResponses]; -export type GetIndexPayslipData = { +export type PostV1IdentityVerificationEmploymentIdDeclineData = { body?: never; - path?: never; - query?: { + path: { /** * Employment ID */ - employment_id?: string; - /** - * Filters by payslips `issued_at` field, after or on the same day than the given date - */ - start_date?: string; - /** - * Filters by payslips `issued_at` field, before or or the same day than the given date - */ - end_date?: string; - /** - * Filters by payslips `expected_payout_date` field, after or on the same day than the given date - */ - expected_payout_start_date?: string; - /** - * Filters by payslips `expected_payout_date` field, before or or the same day than the given date - */ - expected_payout_end_date?: string; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Change the amount of records returned per page, defaults to 20, limited to 100 - */ - page_size?: number; + employment_id: string; }; - url: '/v1/payslips'; + query?: never; + url: '/api/eor/v1/identity-verification/{employment_id}/decline'; }; -export type GetIndexPayslipErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1IdentityVerificationEmploymentIdDeclineErrors = { /** * Unauthorized */ @@ -20900,46 +23091,38 @@ export type GetIndexPayslipErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetIndexPayslipError = - GetIndexPayslipErrors[keyof GetIndexPayslipErrors]; +export type PostV1IdentityVerificationEmploymentIdDeclineError = + PostV1IdentityVerificationEmploymentIdDeclineErrors[keyof PostV1IdentityVerificationEmploymentIdDeclineErrors]; -export type GetIndexPayslipResponses = { +export type PostV1IdentityVerificationEmploymentIdDeclineResponses = { /** * Success */ - 200: ListPayslipsResponse; + 200: SuccessResponse; }; -export type GetIndexPayslipResponse = - GetIndexPayslipResponses[keyof GetIndexPayslipResponses]; +export type PostV1IdentityVerificationEmploymentIdDeclineResponse = + PostV1IdentityVerificationEmploymentIdDeclineResponses[keyof PostV1IdentityVerificationEmploymentIdDeclineResponses]; -export type GetDownloadByIdExpenseReceiptData = { +export type GetV1EmployeeExpenseCategoriesData = { body?: never; - path: { + path?: never; + query?: { /** - * The expense ID + * Include parent (non-selectable) categories in addition to selectable leaves */ - expense_id: string; + include_parents?: boolean; /** - * The receipt ID + * Expense ID (slug) whose category should be included in the result, even if it is not selectable by default */ - receipt_id: string; + expense_id?: string; }; - query?: never; - url: '/v1/expenses/{expense_id}/receipts/{receipt_id}'; + url: '/api/eor/v1/employee/expense-categories'; }; -export type GetDownloadByIdExpenseReceiptErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmployeeExpenseCategoriesErrors = { /** * Unauthorized */ @@ -20952,48 +23135,32 @@ export type GetDownloadByIdExpenseReceiptErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetDownloadByIdExpenseReceiptError = - GetDownloadByIdExpenseReceiptErrors[keyof GetDownloadByIdExpenseReceiptErrors]; +export type GetV1EmployeeExpenseCategoriesError = + GetV1EmployeeExpenseCategoriesErrors[keyof GetV1EmployeeExpenseCategoriesErrors]; -export type GetDownloadByIdExpenseReceiptResponses = { +export type GetV1EmployeeExpenseCategoriesResponses = { /** * Success */ - 200: GenericFile; + 200: ListExpenseCategoriesResponse; }; -export type GetDownloadByIdExpenseReceiptResponse = - GetDownloadByIdExpenseReceiptResponses[keyof GetDownloadByIdExpenseReceiptResponses]; +export type GetV1EmployeeExpenseCategoriesResponse = + GetV1EmployeeExpenseCategoriesResponses[keyof GetV1EmployeeExpenseCategoriesResponses]; -export type PostTokenOAuth2TokenData = { +export type PostV1CostCalculatorEstimationCsvData = { /** - * OAuth2Token + * Estimate params */ - body?: OAuth2TokenParams; + body?: CostCalculatorEstimateParams; path?: never; query?: never; - url: '/auth/oauth2/token'; + url: '/api/eor/v1/cost-calculator/estimation-csv'; }; -export type PostTokenOAuth2TokenErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; +export type PostV1CostCalculatorEstimationCsvErrors = { /** * Not Found */ @@ -21002,59 +23169,98 @@ export type PostTokenOAuth2TokenErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PostTokenOAuth2TokenError = - PostTokenOAuth2TokenErrors[keyof PostTokenOAuth2TokenErrors]; +export type PostV1CostCalculatorEstimationCsvError = + PostV1CostCalculatorEstimationCsvErrors[keyof PostV1CostCalculatorEstimationCsvErrors]; -export type PostTokenOAuth2TokenResponses = { +export type PostV1CostCalculatorEstimationCsvResponses = { /** * Success */ - 200: OAuth2Tokens; + 200: CostCalculatorEstimateCsvResponse; }; -export type PostTokenOAuth2TokenResponse = - PostTokenOAuth2TokenResponses[keyof PostTokenOAuth2TokenResponses]; +export type PostV1CostCalculatorEstimationCsvResponse = + PostV1CostCalculatorEstimationCsvResponses[keyof PostV1CostCalculatorEstimationCsvResponses]; -export type GetShowLegalEntityFormCountryData = { - body?: never; - path: { +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + /** + * Pre-onboarding document ID + */ + id: string; + }; + query?: never; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}'; + }; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors = + { /** - * Country code according to ISO 3-digit alphabetic codes + * Unauthorized */ - country_code: string; + 401: UnauthorizedResponse; /** - * Name of the desired form + * Forbidden */ - form: string; + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdError = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors]; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses = + { + /** + * Success + */ + 200: ShowPreOnboardingDocumentResponse; + }; + +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponse = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses]; + +export type GetV1BillingDocumentsData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; }; + path?: never; query?: { /** - * Product type. Default value is global_payroll. + * The month for the billing documents (in ISO-8601 format) */ - product_type?: 'peo' | 'global_payroll' | 'e2e_payroll'; + period?: string; /** - * Legal entity id for admistrative_details of e2e payroll products in GBR + * Starts fetching records after the given page */ - legal_entity_id?: UuidSlug; + page?: number; /** - * Version of the form schema + * Number of items per page */ - json_schema_version?: number | 'latest'; + page_size?: number; }; - url: '/v1/countries/{country_code}/legal_entity_forms/{form}'; + url: '/api/eor/v1/billing-documents'; }; -export type GetShowLegalEntityFormCountryErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1BillingDocumentsErrors = { /** * Unauthorized */ @@ -21067,97 +23273,156 @@ export type GetShowLegalEntityFormCountryErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetShowLegalEntityFormCountryError = - GetShowLegalEntityFormCountryErrors[keyof GetShowLegalEntityFormCountryErrors]; +export type GetV1BillingDocumentsError = + GetV1BillingDocumentsErrors[keyof GetV1BillingDocumentsErrors]; -export type GetShowLegalEntityFormCountryResponses = { +export type GetV1BillingDocumentsResponses = { /** * Success */ - 200: CountryFormResponse; + 200: BillingDocumentsResponse; }; -export type GetShowLegalEntityFormCountryResponse = - GetShowLegalEntityFormCountryResponses[keyof GetShowLegalEntityFormCountryResponses]; +export type GetV1BillingDocumentsResponse = + GetV1BillingDocumentsResponses[keyof GetV1BillingDocumentsResponses]; -export type PostManageContractorPlusSubscriptionSubscriptionData = { - /** - * Manage Contractor Plus subscription params - */ - body: ManageContractorPlusSubscriptionOperationsParams; +export type GetV1BillingDocumentsBillingDocumentIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Employment ID + * The billing document's ID */ - employment_id: string; + billing_document_id: string; }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-plus-subscription'; + query?: { + /** + * When true, includes billing document items whose type is not part of the standard set for the invoice type. + */ + include_unrecognized_types?: boolean; + }; + url: '/api/eor/v1/billing-documents/{billing_document_id}'; }; -export type PostManageContractorPlusSubscriptionSubscriptionErrors = { +export type GetV1BillingDocumentsBillingDocumentIdErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostManageContractorPlusSubscriptionSubscriptionError = - PostManageContractorPlusSubscriptionSubscriptionErrors[keyof PostManageContractorPlusSubscriptionSubscriptionErrors]; +export type GetV1BillingDocumentsBillingDocumentIdError = + GetV1BillingDocumentsBillingDocumentIdErrors[keyof GetV1BillingDocumentsBillingDocumentIdErrors]; -export type PostManageContractorPlusSubscriptionSubscriptionResponses = { +export type GetV1BillingDocumentsBillingDocumentIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: BillingDocumentResponse; }; -export type PostManageContractorPlusSubscriptionSubscriptionResponse = - PostManageContractorPlusSubscriptionSubscriptionResponses[keyof PostManageContractorPlusSubscriptionSubscriptionResponses]; +export type GetV1BillingDocumentsBillingDocumentIdResponse = + GetV1BillingDocumentsBillingDocumentIdResponses[keyof GetV1BillingDocumentsBillingDocumentIdResponses]; -export type GetIndexTimeoffData = { +export type GetV1EmployeeDocumentsData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path?: never; query?: { /** - * Only show time off for a specific employment + * Starts fetching records after the given page */ - employment_id?: string; + page?: number; /** - * Filter time off by its type + * Number of items per page */ - timeoff_type?: TimeoffType; + page_size?: number; /** - * Filter time off by its status + * Filter documents by their description or file name, accepts full and partial case insensitive matches */ - status?: TimeoffStatus; + name?: string; /** - * Sort order + * Filters the results that were uploaded on or after a given date */ - order?: 'asc' | 'desc'; + inserted_after?: Date; + /** + * Filters the results that were uploaded before a given date + */ + inserted_before?: Date; /** * Field to sort by */ - sort_by?: 'timeoff_type' | 'status'; + sort_by?: + | 'description' + | 'document_source' + | 'inserted_at' + | 'name' + | 'type' + | 'uploaded_by_role' + | 'related_to' + | 'sub_type' + | 'uploaded_by'; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + }; + url: '/api/eor/v1/employee/documents'; +}; + +export type GetV1EmployeeDocumentsErrors = { + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1EmployeeDocumentsError = + GetV1EmployeeDocumentsErrors[keyof GetV1EmployeeDocumentsErrors]; + +export type GetV1EmployeeDocumentsResponses = { + /** + * Success + */ + 200: ListDocumentsResponse; +}; + +export type GetV1EmployeeDocumentsResponse = + GetV1EmployeeDocumentsResponses[keyof GetV1EmployeeDocumentsResponses]; + +export type GetV1EmployeeTimeoffData = { + body?: never; + path?: never; + query?: { /** * Starts fetching records after the given page */ @@ -21167,10 +23432,10 @@ export type GetIndexTimeoffData = { */ page_size?: number; }; - url: '/v1/timeoff'; + url: '/api/eor/v1/employee/timeoff'; }; -export type GetIndexTimeoffErrors = { +export type GetV1EmployeeTimeoffErrors = { /** * Bad Request */ @@ -21183,49 +23448,36 @@ export type GetIndexTimeoffErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; /** * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetIndexTimeoffError = - GetIndexTimeoffErrors[keyof GetIndexTimeoffErrors]; +export type GetV1EmployeeTimeoffError = + GetV1EmployeeTimeoffErrors[keyof GetV1EmployeeTimeoffErrors]; -export type GetIndexTimeoffResponses = { +export type GetV1EmployeeTimeoffResponses = { /** * Success */ 200: ListTimeoffResponse; }; -export type GetIndexTimeoffResponse = - GetIndexTimeoffResponses[keyof GetIndexTimeoffResponses]; +export type GetV1EmployeeTimeoffResponse = + GetV1EmployeeTimeoffResponses[keyof GetV1EmployeeTimeoffResponses]; -export type PostCreateTimeoffData = { +export type PostV1EmployeeTimeoffData = { /** * Timeoff */ - body: CreateApprovedTimeoffParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body: CreateEmployeeTimeoffParams; path?: never; query?: never; - url: '/v1/timeoff'; + url: '/api/eor/v1/employee/timeoff'; }; -export type PostCreateTimeoffErrors = { +export type PostV1EmployeeTimeoffErrors = { /** * Bad Request */ @@ -21248,40 +23500,83 @@ export type PostCreateTimeoffErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateTimeoffError = - PostCreateTimeoffErrors[keyof PostCreateTimeoffErrors]; +export type PostV1EmployeeTimeoffError = + PostV1EmployeeTimeoffErrors[keyof PostV1EmployeeTimeoffErrors]; -export type PostCreateTimeoffResponses = { +export type PostV1EmployeeTimeoffResponses = { /** * Created */ 201: TimeoffResponse; }; -export type PostCreateTimeoffResponse = - PostCreateTimeoffResponses[keyof PostCreateTimeoffResponses]; +export type PostV1EmployeeTimeoffResponse = + PostV1EmployeeTimeoffResponses[keyof PostV1EmployeeTimeoffResponses]; -export type GetIndexPayrollRunData = { - body?: never; - path?: never; - query?: { - /** - * Filters payroll runs where period_start or period_end match the given date - */ - payroll_period?: Date; +export type PutV1EmploymentsEmploymentIdPersonalDetailsData = { + /** + * Employment personal details params + */ + body?: EmploymentPersonalDetailsParams; + path: { /** - * Starts fetching records after the given page + * Employment ID */ - page?: number; + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/personal_details'; +}; + +export type PutV1EmploymentsEmploymentIdPersonalDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PutV1EmploymentsEmploymentIdPersonalDetailsError = + PutV1EmploymentsEmploymentIdPersonalDetailsErrors[keyof PutV1EmploymentsEmploymentIdPersonalDetailsErrors]; + +export type PutV1EmploymentsEmploymentIdPersonalDetailsResponses = { + /** + * Success + */ + 200: EmploymentResponse; +}; + +export type PutV1EmploymentsEmploymentIdPersonalDetailsResponse = + PutV1EmploymentsEmploymentIdPersonalDetailsResponses[keyof PutV1EmploymentsEmploymentIdPersonalDetailsResponses]; + +export type GetV1ProbationExtensionsIdData = { + body?: never; + path: { /** - * Number of items per page + * Probation Extension Request ID */ - page_size?: number; + id: string; }; - url: '/v1/payroll-runs'; + query?: never; + url: '/api/eor/v1/probation-extensions/{id}'; }; -export type GetIndexPayrollRunErrors = { +export type GetV1ProbationExtensionsIdErrors = { /** * Unauthorized */ @@ -21296,93 +23591,83 @@ export type GetIndexPayrollRunErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexPayrollRunError = - GetIndexPayrollRunErrors[keyof GetIndexPayrollRunErrors]; +export type GetV1ProbationExtensionsIdError = + GetV1ProbationExtensionsIdErrors[keyof GetV1ProbationExtensionsIdErrors]; -export type GetIndexPayrollRunResponses = { +export type GetV1ProbationExtensionsIdResponses = { /** * Success */ - 200: ListPayrollRunResponse; + 200: ProbationExtensionResponse; }; -export type GetIndexPayrollRunResponse = - GetIndexPayrollRunResponses[keyof GetIndexPayrollRunResponses]; +export type GetV1ProbationExtensionsIdResponse = + GetV1ProbationExtensionsIdResponses[keyof GetV1ProbationExtensionsIdResponses]; -export type GetGetGroupScimData = { +export type GetV1FilesIdData = { body?: never; path: { /** - * Group ID (slug) + * File ID */ id: string; }; query?: never; - url: '/v1/scim/v2/Groups/{id}'; + url: '/api/eor/v1/files/{id}'; }; -export type GetGetGroupScimErrors = { +export type GetV1FilesIdErrors = { /** * Unauthorized */ - 401: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: IntegrationsScimErrorResponse; + 404: NotFoundResponse; /** - * Not Found + * Unprocessable Entity */ - 404: IntegrationsScimErrorResponse; + 422: UnprocessableEntityResponse; }; -export type GetGetGroupScimError = - GetGetGroupScimErrors[keyof GetGetGroupScimErrors]; +export type GetV1FilesIdError = GetV1FilesIdErrors[keyof GetV1FilesIdErrors]; -export type GetGetGroupScimResponses = { +export type GetV1FilesIdResponses = { /** * Success */ - 200: IntegrationsScimGroup; + 200: DownloadFileResponse; }; -export type GetGetGroupScimResponse = - GetGetGroupScimResponses[keyof GetGetGroupScimResponses]; +export type GetV1FilesIdResponse = + GetV1FilesIdResponses[keyof GetV1FilesIdResponses]; -export type GetIndexEmploymentContractData = { +export type GetV1CompanyDepartmentsData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; path?: never; query: { /** - * Employment ID + * Company ID */ - employment_id: string; + company_id: string; /** - * Only Active + * Paginate option. Default: true. When true, paginates response; otherwise, does not. */ - only_active?: boolean; + paginate?: boolean; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - url: '/v1/employment-contracts'; + url: '/api/eor/v1/company-departments'; }; -export type GetIndexEmploymentContractErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; +export type GetV1CompanyDepartmentsErrors = { /** * Not Found */ @@ -21393,30 +23678,75 @@ export type GetIndexEmploymentContractErrors = { 422: UnprocessableEntityResponse; }; -export type GetIndexEmploymentContractError = - GetIndexEmploymentContractErrors[keyof GetIndexEmploymentContractErrors]; +export type GetV1CompanyDepartmentsError = + GetV1CompanyDepartmentsErrors[keyof GetV1CompanyDepartmentsErrors]; -export type GetIndexEmploymentContractResponses = { +export type GetV1CompanyDepartmentsResponses = { /** * Success */ - 200: ListEmploymentContractResponse; + 200: ListCompanyDepartmentsPaginatedResponse; }; -export type GetIndexEmploymentContractResponse = - GetIndexEmploymentContractResponses[keyof GetIndexEmploymentContractResponses]; +export type GetV1CompanyDepartmentsResponse = + GetV1CompanyDepartmentsResponses[keyof GetV1CompanyDepartmentsResponses]; -export type PostConvertWithSpreadCurrencyConverter2Data = { +export type PostV1CompanyDepartmentsData = { /** - * Convert currency parameters + * Create Company Department request params */ - body: ConvertCurrencyParams; + body: CreateCompanyDepartmentParams; path?: never; query?: never; - url: '/v1/currency-converter'; + url: '/api/eor/v1/company-departments'; +}; + +export type PostV1CompanyDepartmentsErrors = { + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type PostV1CompanyDepartmentsError = + PostV1CompanyDepartmentsErrors[keyof PostV1CompanyDepartmentsErrors]; + +export type PostV1CompanyDepartmentsResponses = { + /** + * Created + */ + 201: CompanyDepartmentCreatedResponse; +}; + +export type PostV1CompanyDepartmentsResponse = + PostV1CompanyDepartmentsResponses[keyof PostV1CompanyDepartmentsResponses]; + +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsData = { + body?: never; + path: { + /** + * Payroll run ID + */ + payroll_run_id: string; + }; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/payroll-runs/{payroll_run_id}/employee-details'; }; -export type PostConvertWithSpreadCurrencyConverter2Errors = { +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors = { /** * Unauthorized */ @@ -21431,117 +23761,151 @@ export type PostConvertWithSpreadCurrencyConverter2Errors = { 422: UnprocessableEntityResponse; }; -export type PostConvertWithSpreadCurrencyConverter2Error = - PostConvertWithSpreadCurrencyConverter2Errors[keyof PostConvertWithSpreadCurrencyConverter2Errors]; +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsError = + GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors[keyof GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors]; -export type PostConvertWithSpreadCurrencyConverter2Responses = { +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses = { /** * Success */ - 200: ConvertCurrencyResponse; + 200: EmployeeDetailsResponse; }; -export type PostConvertWithSpreadCurrencyConverter2Response = - PostConvertWithSpreadCurrencyConverter2Responses[keyof PostConvertWithSpreadCurrencyConverter2Responses]; +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponse = + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses[keyof GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses]; -export type GetIndexCompanyData = { +export type GetV1EmploymentsEmploymentIdData = { body?: never; headers: { /** - * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. * - * The refresh token needs to have been obtained through the Client Credentials flow. + * The refresh token needs to have been obtained through the Authorization Code flow. * */ Authorization: string; }; - path?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: { /** - * External ID + * Wether files should be excluded */ - external_id?: string; + exclude_files?: boolean; }; - url: '/v1/companies'; + url: '/api/eor/v1/employments/{employment_id}'; }; -export type GetIndexCompanyErrors = { +export type GetV1EmploymentsEmploymentIdErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexCompanyError = - GetIndexCompanyErrors[keyof GetIndexCompanyErrors]; +export type GetV1EmploymentsEmploymentIdError = + GetV1EmploymentsEmploymentIdErrors[keyof GetV1EmploymentsEmploymentIdErrors]; -export type GetIndexCompanyResponses = { +export type GetV1EmploymentsEmploymentIdResponses = { /** * Success */ - 200: CompaniesResponse; + 200: EmploymentShowResponse; }; -export type GetIndexCompanyResponse = - GetIndexCompanyResponses[keyof GetIndexCompanyResponses]; +export type GetV1EmploymentsEmploymentIdResponse = + GetV1EmploymentsEmploymentIdResponses[keyof GetV1EmploymentsEmploymentIdResponses]; -export type PostCreateCompanyData = { +export type PatchV1EmploymentsEmploymentId2Data = { /** - * Create Company params + * Employment params */ - body?: CreateCompanyParams; + body?: EmploymentFullParams; headers: { /** - * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. * - * The refresh token needs to have been obtained through the Client Credentials flow. + * The refresh token needs to have been obtained through the Authorization Code flow. * */ Authorization: string; }; - path?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: { /** * Version of the address_details form schema */ address_details_json_schema_version?: number | 'latest'; + /** + * Version of the administrative_details form schema + */ + administrative_details_json_schema_version?: number | 'latest'; /** * Version of the bank_account_details form schema */ bank_account_details_json_schema_version?: number | 'latest'; /** - * Complementary action(s) to perform when creating a company: - * - * - `get_oauth_access_tokens` returns the user's access and refresh tokens - * - `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only) - * - * If `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send) - * + * Version of the employment_basic_information form schema */ - action?: string; + employment_basic_information_json_schema_version?: number | 'latest'; /** - * Whether the request should be performed async - * + * Version of the billing_address_details form schema */ - async?: boolean; + billing_address_details_json_schema_version?: number | 'latest'; /** - * Scope of the access token - * + * Version of the contract_details form schema + */ + contract_details_json_schema_version?: number | 'latest'; + /** + * Version of the emergency_contact_details form schema + */ + emergency_contact_details_json_schema_version?: number | 'latest'; + /** + * Version of the personal_details form schema + */ + personal_details_json_schema_version?: number | 'latest'; + /** + * Version of the pricing_plan_details form schema + */ + pricing_plan_details_json_schema_version?: number | 'latest'; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; + /** + * Complementary action(s) to perform when creating an employment. */ - scope?: string; + actions?: string; }; - url: '/v1/companies'; + url: '/api/eor/v1/employments/{employment_id}'; }; -export type PostCreateCompanyErrors = { +export type PatchV1EmploymentsEmploymentId2Errors = { /** * Bad Request */ @@ -21553,7 +23917,7 @@ export type PostCreateCompanyErrors = { /** * Conflict */ - 409: CompanyCreationConflictErrorResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -21564,30 +23928,89 @@ export type PostCreateCompanyErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateCompanyError = - PostCreateCompanyErrors[keyof PostCreateCompanyErrors]; +export type PatchV1EmploymentsEmploymentId2Error = + PatchV1EmploymentsEmploymentId2Errors[keyof PatchV1EmploymentsEmploymentId2Errors]; -export type PostCreateCompanyResponses = { +export type PatchV1EmploymentsEmploymentId2Responses = { /** - * Created + * Success */ - 201: CompanyCreationResponse; + 200: EmploymentResponse; }; -export type PostCreateCompanyResponse = - PostCreateCompanyResponses[keyof PostCreateCompanyResponses]; +export type PatchV1EmploymentsEmploymentId2Response = + PatchV1EmploymentsEmploymentId2Responses[keyof PatchV1EmploymentsEmploymentId2Responses]; -export type PostCreateBulkEmploymentData = { +export type PatchV1EmploymentsEmploymentIdData = { /** - * Bulk employment params + * Employment params */ - body?: BulkEmploymentCreateParams; - path?: never; - query?: never; - url: '/v1/bulk-employment-jobs'; + body?: EmploymentFullParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the administrative_details form schema + */ + administrative_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + /** + * Version of the employment_basic_information form schema + */ + employment_basic_information_json_schema_version?: number | 'latest'; + /** + * Version of the billing_address_details form schema + */ + billing_address_details_json_schema_version?: number | 'latest'; + /** + * Version of the contract_details form schema + */ + contract_details_json_schema_version?: number | 'latest'; + /** + * Version of the emergency_contact_details form schema + */ + emergency_contact_details_json_schema_version?: number | 'latest'; + /** + * Version of the personal_details form schema + */ + personal_details_json_schema_version?: number | 'latest'; + /** + * Version of the pricing_plan_details form schema + */ + pricing_plan_details_json_schema_version?: number | 'latest'; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; + /** + * Complementary action(s) to perform when creating an employment. + */ + actions?: string; + }; + url: '/api/eor/v1/employments/{employment_id}'; }; -export type PostCreateBulkEmploymentErrors = { +export type PatchV1EmploymentsEmploymentIdErrors = { /** * Bad Request */ @@ -21596,6 +24019,10 @@ export type PostCreateBulkEmploymentErrors = { * Forbidden */ 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -21606,88 +24033,80 @@ export type PostCreateBulkEmploymentErrors = { 429: TooManyRequestsResponse; }; -export type PostCreateBulkEmploymentError = - PostCreateBulkEmploymentErrors[keyof PostCreateBulkEmploymentErrors]; +export type PatchV1EmploymentsEmploymentIdError = + PatchV1EmploymentsEmploymentIdErrors[keyof PatchV1EmploymentsEmploymentIdErrors]; -export type PostCreateBulkEmploymentResponses = { +export type PatchV1EmploymentsEmploymentIdResponses = { /** - * Accepted + * Success */ - 202: BulkEmploymentImportJobResponse; + 200: EmploymentResponse; }; -export type PostCreateBulkEmploymentResponse = - PostCreateBulkEmploymentResponses[keyof PostCreateBulkEmploymentResponses]; +export type PatchV1EmploymentsEmploymentIdResponse = + PatchV1EmploymentsEmploymentIdResponses[keyof PatchV1EmploymentsEmploymentIdResponses]; -export type PostSendBackTimesheetData = { - /** - * SendBackTimesheetParams - */ - body?: SendBackTimesheetParams; - path: { +export type GetV1EmployeeTimesheetsData = { + body?: never; + path?: never; + query?: { /** - * Timesheet ID + * Starts fetching records after the given page */ - timesheet_id: string; + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/timesheets/{timesheet_id}/send-back'; + url: '/api/eor/v1/employee/timesheets'; }; -export type PostSendBackTimesheetErrors = { +export type GetV1EmployeeTimesheetsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; }; -export type PostSendBackTimesheetError = - PostSendBackTimesheetErrors[keyof PostSendBackTimesheetErrors]; +export type GetV1EmployeeTimesheetsError = + GetV1EmployeeTimesheetsErrors[keyof GetV1EmployeeTimesheetsErrors]; -export type PostSendBackTimesheetResponses = { +export type GetV1EmployeeTimesheetsResponses = { /** * Success */ - 200: SentBackTimesheetResponse; + 200: SuccessResponse; }; -export type PostSendBackTimesheetResponse = - PostSendBackTimesheetResponses[keyof PostSendBackTimesheetResponses]; +export type GetV1EmployeeTimesheetsResponse = + GetV1EmployeeTimesheetsResponses[keyof GetV1EmployeeTimesheetsResponses]; -export type DeleteDeleteCompanyManagerData = { +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { body?: never; - headers: { + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Custom field ID */ - Authorization: string; - }; - path: { + custom_field_id: string; /** - * User ID + * Employment ID */ - user_id: string; + employment_id: string; }; query?: never; - url: '/v1/company-managers/{user_id}'; + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; -export type DeleteDeleteCompanyManagerErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { /** * Unauthorized */ @@ -21700,46 +24119,49 @@ export type DeleteDeleteCompanyManagerErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type DeleteDeleteCompanyManagerError = - DeleteDeleteCompanyManagerErrors[keyof DeleteDeleteCompanyManagerErrors]; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdError = + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors[keyof GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors]; -export type DeleteDeleteCompanyManagerResponses = { +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentCustomFieldValueResponse; }; -export type DeleteDeleteCompanyManagerResponse = - DeleteDeleteCompanyManagerResponses[keyof DeleteDeleteCompanyManagerResponses]; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse = + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses[keyof GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses]; -export type GetShowCompanyManagerData = { - body?: never; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data = { + /** + * Custom Field Value Update Parameters + */ + body: UpdateEmploymentCustomFieldValueParams; path: { /** - * User ID + * Custom field ID */ - user_id: string; + custom_field_id: string; + /** + * Employment ID + */ + employment_id: string; }; query?: never; - url: '/v1/company-managers/{user_id}'; + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; -export type GetShowCompanyManagerErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -21748,38 +24170,41 @@ export type GetShowCompanyManagerErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetShowCompanyManagerError = - GetShowCompanyManagerErrors[keyof GetShowCompanyManagerErrors]; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Error = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors]; -export type GetShowCompanyManagerResponses = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses = { /** * Success */ - 200: CompanyManagerResponse; + 200: EmploymentCustomFieldValueResponse; }; -export type GetShowCompanyManagerResponse = - GetShowCompanyManagerResponses[keyof GetShowCompanyManagerResponses]; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Response = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses]; -export type DeleteDeleteContractorCorSubscriptionSubscriptionData = { - body?: never; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { + /** + * Custom Field Value Update Parameters + */ + body: UpdateEmploymentCustomFieldValueParams; path: { + /** + * Custom field ID + */ + custom_field_id: string; /** * Employment ID */ employment_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; -export type DeleteDeleteContractorCorSubscriptionSubscriptionErrors = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { /** * Unauthorized */ @@ -21798,37 +24223,43 @@ export type DeleteDeleteContractorCorSubscriptionSubscriptionErrors = { 422: UnprocessableEntityResponse; }; -export type DeleteDeleteContractorCorSubscriptionSubscriptionError = - DeleteDeleteContractorCorSubscriptionSubscriptionErrors[keyof DeleteDeleteContractorCorSubscriptionSubscriptionErrors]; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdError = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors]; -export type DeleteDeleteContractorCorSubscriptionSubscriptionResponses = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses = { /** - * No Content + * Success */ - 204: unknown; + 200: EmploymentCustomFieldValueResponse; }; -export type PostManageContractorCorSubscriptionSubscriptionData = { - body?: never; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses]; + +export type PutV1ResignationsOffboardingRequestIdValidateData = { + /** + * ValidateResignation + */ + body: ValidateResignationRequestParams; path: { /** - * Employment ID + * Offboarding request ID */ - employment_id: string; + offboarding_request_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + url: '/api/eor/v1/resignations/{offboarding_request_id}/validate'; }; -export type PostManageContractorCorSubscriptionSubscriptionErrors = { +export type PutV1ResignationsOffboardingRequestIdValidateErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -21837,83 +24268,42 @@ export type PostManageContractorCorSubscriptionSubscriptionErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostManageContractorCorSubscriptionSubscriptionError = - PostManageContractorCorSubscriptionSubscriptionErrors[keyof PostManageContractorCorSubscriptionSubscriptionErrors]; +export type PutV1ResignationsOffboardingRequestIdValidateError = + PutV1ResignationsOffboardingRequestIdValidateErrors[keyof PutV1ResignationsOffboardingRequestIdValidateErrors]; -export type PostManageContractorCorSubscriptionSubscriptionResponses = { +export type PutV1ResignationsOffboardingRequestIdValidateResponses = { /** - * Created + * Success */ - 201: SuccessResponse; + 200: SuccessResponse; }; -export type PostManageContractorCorSubscriptionSubscriptionResponse = - PostManageContractorCorSubscriptionSubscriptionResponses[keyof PostManageContractorCorSubscriptionSubscriptionResponses]; +export type PutV1ResignationsOffboardingRequestIdValidateResponse = + PutV1ResignationsOffboardingRequestIdValidateResponses[keyof PutV1ResignationsOffboardingRequestIdValidateResponses]; -export type GetIndexScheduledContractorInvoiceData = { +export type GetV1ContractorInvoiceSchedulesIdData = { body?: never; - path?: never; - query?: { - /** - * Filters contractor invoice schedules by start date greater than or equal to the value. - */ - start_date_from?: Date; - /** - * Filters contractor invoice schedules by start date less than or equal to the value. - */ - start_date_to?: Date; - /** - * Filters contractor invoice schedules by next invoice date greater than or equal to the value. - */ - next_invoice_date_from?: Date; - /** - * Filters contractor invoice schedules by next invoice date less than or equal to the value. - */ - next_invoice_date_to?: Date; - /** - * Filters contractor invoice schedules by status matching the value. - */ - status?: ContractorInvoiceScheduleStatus; - /** - * Filters contractor invoice schedules by employment id matching the value. - */ - employment_id?: UuidSlug; - /** - * Filters contractor invoice schedules by periodicity matching the value. - */ - periodicity?: ContractorInvoiceSchedulePeriodicity; - /** - * Filters contractor invoice schedules by currency matching the value. - */ - currency?: string; - /** - * Field to sort by - */ - sort_by?: - | 'number' - | 'total_amount' - | 'next_invoice_at' - | 'start_date' - | 'nr_occurrences'; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Number of items per page + * Resource unique identifier */ - page_size?: number; + id: UuidSlug; }; - url: '/v1/contractor-invoice-schedules'; + query?: never; + url: '/api/eor/v1/contractor-invoice-schedules/{id}'; }; -export type GetIndexScheduledContractorInvoiceErrors = { +export type GetV1ContractorInvoiceSchedulesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -21926,32 +24316,49 @@ export type GetIndexScheduledContractorInvoiceErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetIndexScheduledContractorInvoiceError = - GetIndexScheduledContractorInvoiceErrors[keyof GetIndexScheduledContractorInvoiceErrors]; +export type GetV1ContractorInvoiceSchedulesIdError = + GetV1ContractorInvoiceSchedulesIdErrors[keyof GetV1ContractorInvoiceSchedulesIdErrors]; -export type GetIndexScheduledContractorInvoiceResponses = { +export type GetV1ContractorInvoiceSchedulesIdResponses = { /** * Success */ - 200: ListContractorInvoiceSchedulesResponse; + 200: ContractorInvoiceScheduleResponse; }; -export type GetIndexScheduledContractorInvoiceResponse = - GetIndexScheduledContractorInvoiceResponses[keyof GetIndexScheduledContractorInvoiceResponses]; +export type GetV1ContractorInvoiceSchedulesIdResponse = + GetV1ContractorInvoiceSchedulesIdResponses[keyof GetV1ContractorInvoiceSchedulesIdResponses]; -export type PostBulkCreateScheduledContractorInvoiceData = { +export type PatchV1ContractorInvoiceSchedulesId2Data = { /** - * Bulk creation payload + * Update parameters */ - body: BulkContractorInvoiceScheduleCreateParams; - path?: never; + body: UpdateScheduleContractorInvoiceParams; + path: { + /** + * Resource unique identifier + */ + id: UuidSlug; + }; query?: never; - url: '/v1/contractor-invoice-schedules'; + url: '/api/eor/v1/contractor-invoice-schedules/{id}'; }; -export type PostBulkCreateScheduledContractorInvoiceErrors = { +export type PatchV1ContractorInvoiceSchedulesId2Errors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ @@ -21961,66 +24368,44 @@ export type PostBulkCreateScheduledContractorInvoiceErrors = { */ 404: NotFoundResponse; /** - * BulkContractorInvoiceScheduleCreateResponse - * - * Response containing the lists of succeeded and failed schedules. + * Unprocessable Entity */ - 422: { - data: { - failures: Array; - successes: Array; - }; - }; + 422: UnprocessableEntityResponse; }; -export type PostBulkCreateScheduledContractorInvoiceError = - PostBulkCreateScheduledContractorInvoiceErrors[keyof PostBulkCreateScheduledContractorInvoiceErrors]; +export type PatchV1ContractorInvoiceSchedulesId2Error = + PatchV1ContractorInvoiceSchedulesId2Errors[keyof PatchV1ContractorInvoiceSchedulesId2Errors]; -export type PostBulkCreateScheduledContractorInvoiceResponses = { - /** - * BulkContractorInvoiceScheduleCreateResponse - * - * Response containing the lists of succeeded and failed schedules. - */ - 201: { - data: { - failures: Array; - successes: Array; - }; - }; +export type PatchV1ContractorInvoiceSchedulesId2Responses = { /** - * BulkContractorInvoiceScheduleCreateResponse - * - * Response containing the lists of succeeded and failed schedules. + * Success */ - 207: { - data: { - failures: Array; - successes: Array; - }; - }; + 200: ContractorInvoiceScheduleResponse; }; -export type PostBulkCreateScheduledContractorInvoiceResponse = - PostBulkCreateScheduledContractorInvoiceResponses[keyof PostBulkCreateScheduledContractorInvoiceResponses]; +export type PatchV1ContractorInvoiceSchedulesId2Response = + PatchV1ContractorInvoiceSchedulesId2Responses[keyof PatchV1ContractorInvoiceSchedulesId2Responses]; -export type GetShowEmploymentEngagementAgreementDetailsData = { - body?: never; +export type PatchV1ContractorInvoiceSchedulesIdData = { + /** + * Update parameters + */ + body: UpdateScheduleContractorInvoiceParams; path: { /** - * Employment ID + * Resource unique identifier */ - employment_id: string; + id: UuidSlug; }; query?: never; - url: '/v1/employments/{employment_id}/engagement-agreement-details'; + url: '/api/eor/v1/contractor-invoice-schedules/{id}'; }; -export type GetShowEmploymentEngagementAgreementDetailsErrors = { +export type PatchV1ContractorInvoiceSchedulesIdErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ @@ -22033,30 +24418,26 @@ export type GetShowEmploymentEngagementAgreementDetailsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetShowEmploymentEngagementAgreementDetailsError = - GetShowEmploymentEngagementAgreementDetailsErrors[keyof GetShowEmploymentEngagementAgreementDetailsErrors]; +export type PatchV1ContractorInvoiceSchedulesIdError = + PatchV1ContractorInvoiceSchedulesIdErrors[keyof PatchV1ContractorInvoiceSchedulesIdErrors]; -export type GetShowEmploymentEngagementAgreementDetailsResponses = { +export type PatchV1ContractorInvoiceSchedulesIdResponses = { /** * Success */ - 200: EmploymentEngagementAgreementDetailsResponse; + 200: ContractorInvoiceScheduleResponse; }; -export type GetShowEmploymentEngagementAgreementDetailsResponse = - GetShowEmploymentEngagementAgreementDetailsResponses[keyof GetShowEmploymentEngagementAgreementDetailsResponses]; +export type PatchV1ContractorInvoiceSchedulesIdResponse = + PatchV1ContractorInvoiceSchedulesIdResponses[keyof PatchV1ContractorInvoiceSchedulesIdResponses]; -export type PostUpdateEmploymentEngagementAgreementDetailsData = { +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsData = { /** - * Employment engagement agreement details params + * Employment pricing plan details params */ - body?: EmploymentEngagementAgreementDetailsParams; + body?: EmploymentPricingPlanDetailsParams; path: { /** * Employment ID @@ -22064,14 +24445,18 @@ export type PostUpdateEmploymentEngagementAgreementDetailsData = { employment_id: string; }; query?: never; - url: '/v1/employments/{employment_id}/engagement-agreement-details'; + url: '/api/eor/v2/employments/{employment_id}/pricing_plan_details'; }; -export type PostUpdateEmploymentEngagementAgreementDetailsErrors = { +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors = { /** * Bad Request */ 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ @@ -22094,41 +24479,30 @@ export type PostUpdateEmploymentEngagementAgreementDetailsErrors = { 429: TooManyRequestsResponse; }; -export type PostUpdateEmploymentEngagementAgreementDetailsError = - PostUpdateEmploymentEngagementAgreementDetailsErrors[keyof PostUpdateEmploymentEngagementAgreementDetailsErrors]; +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsError = + PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors[keyof PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors]; -export type PostUpdateEmploymentEngagementAgreementDetailsResponses = { +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentResponse; }; -export type PostUpdateEmploymentEngagementAgreementDetailsResponse = - PostUpdateEmploymentEngagementAgreementDetailsResponses[keyof PostUpdateEmploymentEngagementAgreementDetailsResponses]; - -export type GetGetBreakdownBillingDocumentData = { - body?: never; - path: { - /** - * The billing document's ID - */ - billing_document_id: string; - }; - query?: { - /** - * Filters the results by the type of the billing breakdown item. - */ - type?: string; - }; - url: '/v1/billing-documents/{billing_document_id}/breakdown'; -}; +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsResponse = + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses[keyof PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses]; -export type GetGetBreakdownBillingDocumentErrors = { +export type PostV1RiskReserveData = { /** - * Bad Request + * Risk Reserve */ - 400: BadRequestResponse; + body: CreateRiskReserveParams; + path?: never; + query?: never; + url: '/api/eor/v1/risk-reserve'; +}; + +export type PostV1RiskReserveErrors = { /** * Unauthorized */ @@ -22141,71 +24515,50 @@ export type GetGetBreakdownBillingDocumentErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetGetBreakdownBillingDocumentError = - GetGetBreakdownBillingDocumentErrors[keyof GetGetBreakdownBillingDocumentErrors]; +export type PostV1RiskReserveError = + PostV1RiskReserveErrors[keyof PostV1RiskReserveErrors]; -export type GetGetBreakdownBillingDocumentResponses = { +export type PostV1RiskReserveResponses = { /** * Success */ - 200: BillingDocumentBreakdownResponse; + 200: SuccessResponse; }; -export type GetGetBreakdownBillingDocumentResponse = - GetGetBreakdownBillingDocumentResponses[keyof GetGetBreakdownBillingDocumentResponses]; +export type PostV1RiskReserveResponse = + PostV1RiskReserveResponses[keyof PostV1RiskReserveResponses]; -export type GetIndexEmployeeDocumentData = { - body?: never; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - /** - * Filter documents by their description or file name, accepts full and partial case insensitive matches - */ - name?: string; - /** - * Filters the results that were uploaded on or after a given date - */ - inserted_after?: Date; - /** - * Filters the results that were uploaded before a given date - */ - inserted_before?: Date; +export type PutV2EmploymentsEmploymentIdAddressDetailsData = { + /** + * Employment address details params + */ + body?: EmploymentAddressDetailsParams; + path: { /** - * Field to sort by + * Employment ID */ - sort_by?: - | 'description' - | 'document_source' - | 'inserted_at' - | 'name' - | 'type' - | 'uploaded_by_role' - | 'related_to' - | 'sub_type' - | 'uploaded_by'; + employment_id: string; + }; + query?: { /** - * Sort order + * Version of the address_details form schema */ - order?: 'asc' | 'desc'; + address_details_json_schema_version?: number | 'latest'; }; - url: '/v1/employee/documents'; + url: '/api/eor/v2/employments/{employment_id}/address_details'; }; -export type GetIndexEmployeeDocumentErrors = { +export type PutV2EmploymentsEmploymentIdAddressDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ @@ -22214,38 +24567,10 @@ export type GetIndexEmployeeDocumentErrors = { * Not Found */ 404: NotFoundResponse; -}; - -export type GetIndexEmployeeDocumentError = - GetIndexEmployeeDocumentErrors[keyof GetIndexEmployeeDocumentErrors]; - -export type GetIndexEmployeeDocumentResponses = { - /** - * Success - */ - 200: ListDocumentsResponse; -}; - -export type GetIndexEmployeeDocumentResponse = - GetIndexEmployeeDocumentResponses[keyof GetIndexEmployeeDocumentResponses]; - -export type PostApproveCancellationRequestData = { - body?: never; - path: { - /** - * Time Off ID - */ - timeoff_id: string; - }; - query?: never; - url: '/v1/timeoff/{timeoff_id}/cancel-request/approve'; -}; - -export type PostApproveCancellationRequestErrors = { /** - * Unauthorized + * Conflict */ - 401: UnauthorizedResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -22256,32 +24581,36 @@ export type PostApproveCancellationRequestErrors = { 429: TooManyRequestsResponse; }; -export type PostApproveCancellationRequestError = - PostApproveCancellationRequestErrors[keyof PostApproveCancellationRequestErrors]; +export type PutV2EmploymentsEmploymentIdAddressDetailsError = + PutV2EmploymentsEmploymentIdAddressDetailsErrors[keyof PutV2EmploymentsEmploymentIdAddressDetailsErrors]; -export type PostApproveCancellationRequestResponses = { +export type PutV2EmploymentsEmploymentIdAddressDetailsResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentResponse; }; -export type PostApproveCancellationRequestResponse = - PostApproveCancellationRequestResponses[keyof PostApproveCancellationRequestResponses]; +export type PutV2EmploymentsEmploymentIdAddressDetailsResponse = + PutV2EmploymentsEmploymentIdAddressDetailsResponses[keyof PutV2EmploymentsEmploymentIdAddressDetailsResponses]; -export type PostVerifyIdentityVerificationData = { +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData = { body?: never; path: { /** * Employment ID */ employment_id: string; + /** + * Document ID + */ + id: string; }; query?: never; - url: '/v1/identity-verification/{employment_id}/verify'; + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{id}'; }; -export type PostVerifyIdentityVerificationErrors = { +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors = { /** * Unauthorized */ @@ -22296,64 +24625,107 @@ export type PostVerifyIdentityVerificationErrors = { 422: UnprocessableEntityResponse; }; -export type PostVerifyIdentityVerificationError = - PostVerifyIdentityVerificationErrors[keyof PostVerifyIdentityVerificationErrors]; +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdError = + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors]; -export type PostVerifyIdentityVerificationResponses = { - /** - * Success - */ - 200: SuccessResponse; -}; +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses = + { + /** + * Success + */ + 200: ContractDocumentResponse; + }; -export type PostVerifyIdentityVerificationResponse = - PostVerifyIdentityVerificationResponses[keyof PostVerifyIdentityVerificationResponses]; +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponse = + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses]; -export type GetDownloadPdfBillingDocumentData = { - body?: never; - headers: { +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Bad Request */ - Authorization: string; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; - path: { + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsError = + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors[keyof PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses = + { /** - * The billing document's ID + * Created */ - billing_document_id: string; + 201: CorTerminationRequestCreatedResponse; }; - query?: never; - url: '/v1/billing-documents/{billing_document_id}/pdf'; + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponse = + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses[keyof PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses]; + +export type GetV1EmployeePayslipsData = { + body?: never; + path?: never; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employee/payslips'; }; -export type GetDownloadPdfBillingDocumentErrors = { +export type GetV1EmployeePayslipsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; }; -export type GetDownloadPdfBillingDocumentError = - GetDownloadPdfBillingDocumentErrors[keyof GetDownloadPdfBillingDocumentErrors]; +export type GetV1EmployeePayslipsError = + GetV1EmployeePayslipsErrors[keyof GetV1EmployeePayslipsErrors]; -export type GetDownloadPdfBillingDocumentResponses = { +export type GetV1EmployeePayslipsResponses = { /** * Success */ - 200: GenericFile; + 200: ListEmployeePayslipsResponse; }; -export type GetDownloadPdfBillingDocumentResponse = - GetDownloadPdfBillingDocumentResponses[keyof GetDownloadPdfBillingDocumentResponses]; +export type GetV1EmployeePayslipsResponse = + GetV1EmployeePayslipsResponses[keyof GetV1EmployeePayslipsResponses]; From 855500527f707a503cad812ae2495ae1a996709c Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Fri, 15 May 2026 08:35:06 +0200 Subject: [PATCH 4/8] generate provisional types --- openapi-ts.config.ts | 2 +- src/client/client.gen.ts | 4 +- src/client/index.ts | 77 + src/client/sdk.gen.ts | 8057 +++++++++++------------- src/client/types.gen.ts | 12531 ++++++++++++++++++++----------------- 5 files changed, 10332 insertions(+), 10339 deletions(-) diff --git a/openapi-ts.config.ts b/openapi-ts.config.ts index 2ec3f1e51..77871dc17 100644 --- a/openapi-ts.config.ts +++ b/openapi-ts.config.ts @@ -2,7 +2,7 @@ import { defineConfig, defaultPlugins } from '@hey-api/openapi-ts'; export default defineConfig({ // local gateway http://localhost:4000/api/eor/openapi - input: 'https://gateway.remote.com/v1/docs/openapi.json', + input: 'http://localhost:4000/api/eor/openapi', output: 'src/client', plugins: defaultPlugins, }); diff --git a/src/client/client.gen.ts b/src/client/client.gen.ts index 5f44e28fd..0e7e8e27a 100644 --- a/src/client/client.gen.ts +++ b/src/client/client.gen.ts @@ -20,6 +20,4 @@ export type CreateClientConfig = ( override?: Config, ) => Config & T>; -export const client = createClient( - createConfig({ baseUrl: 'https://gateway.remote.com/' }), -); +export const client = createClient(createConfig()); diff --git a/src/client/index.ts b/src/client/index.ts index d63701e37..3b067e362 100644 --- a/src/client/index.ts +++ b/src/client/index.ts @@ -96,6 +96,8 @@ export { getV1LeavePoliciesSummaryEmploymentId, getV1Offboardings, getV1OffboardingsId, + getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsId, + getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirements, getV1PayItems, getV1PayrollCalendars, getV1PayrollCalendarsCycle, @@ -125,6 +127,12 @@ export { getV1TimesheetsId, getV1TravelLetterRequests, getV1TravelLetterRequestsId, + getV1WdGphPayDetail, + getV1WdGphPayDetailData, + getV1WdGphPayProcessingFeature, + getV1WdGphPayProgress, + getV1WdGphPaySummary, + getV1WdGphPayVariance, getV1WebhookEvents, getV1WorkAuthorizationRequests, getV1WorkAuthorizationRequestsId, @@ -156,6 +164,7 @@ export { patchV2EmploymentsEmploymentId, patchV2EmploymentsEmploymentId2, postAuthOauth2Token, + postAuthOauth2Token2, postV1BenefitRenewalRequestsBenefitRenewalRequestId, postV1BulkEmploymentJobs, postV1CancelOnboardingEmploymentId, @@ -198,6 +207,8 @@ export { postV1IncentivesRecurring, postV1MagicLink, postV1Offboardings, + postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocuments, + postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSign, postV1PayItemsBulk, postV1ProbationCompletionLetter, postV1ProbationExtensions, @@ -217,6 +228,7 @@ export { postV1TimeoffTimeoffIdCancelRequestApprove, postV1TimeoffTimeoffIdCancelRequestDecline, postV1TimeoffTimeoffIdDecline, + postV1Timesheets, postV1TimesheetsTimesheetIdApprove, postV1TimesheetsTimesheetIdSendBack, postV1WebhookCallbacks, @@ -407,6 +419,7 @@ export type { CreateGeneralCustomFieldDefinitionParams, CreateOffboardingParams, CreateOneTimeIncentiveParams, + CreatePreOnboardingDocumentResponse, CreatePricingPlanParams, CreatePricingPlanResponse, CreatePricingPlanWithoutPartnerTemplateParams, @@ -531,6 +544,7 @@ export type { ExpenseResponse, File, FileParams, + FindOrCreatePreOnboardingDocumentParams, ForbiddenResponse, GenericFile, GetV1BenefitOffersCountrySummariesData, @@ -981,6 +995,16 @@ export type { GetV1OffboardingsIdResponses, GetV1OffboardingsResponse, GetV1OffboardingsResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdError, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponse, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsError, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponse, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses, GetV1PayItemsData, GetV1PayItemsError, GetV1PayItemsErrors, @@ -1124,6 +1148,36 @@ export type { GetV1TravelLetterRequestsIdResponses, GetV1TravelLetterRequestsResponse, GetV1TravelLetterRequestsResponses, + GetV1WdGphPayDetailData, + GetV1WdGphPayDetailDataData, + GetV1WdGphPayDetailDataError, + GetV1WdGphPayDetailDataErrors, + GetV1WdGphPayDetailDataResponse, + GetV1WdGphPayDetailDataResponses, + GetV1WdGphPayDetailError, + GetV1WdGphPayDetailErrors, + GetV1WdGphPayDetailResponse, + GetV1WdGphPayDetailResponses, + GetV1WdGphPayProcessingFeatureData, + GetV1WdGphPayProcessingFeatureError, + GetV1WdGphPayProcessingFeatureErrors, + GetV1WdGphPayProcessingFeatureResponse, + GetV1WdGphPayProcessingFeatureResponses, + GetV1WdGphPayProgressData, + GetV1WdGphPayProgressError, + GetV1WdGphPayProgressErrors, + GetV1WdGphPayProgressResponse, + GetV1WdGphPayProgressResponses, + GetV1WdGphPaySummaryData, + GetV1WdGphPaySummaryError, + GetV1WdGphPaySummaryErrors, + GetV1WdGphPaySummaryResponse, + GetV1WdGphPaySummaryResponses, + GetV1WdGphPayVarianceData, + GetV1WdGphPayVarianceError, + GetV1WdGphPayVarianceErrors, + GetV1WdGphPayVarianceResponse, + GetV1WdGphPayVarianceResponses, GetV1WebhookEventsData, GetV1WebhookEventsError, GetV1WebhookEventsErrors, @@ -1171,6 +1225,7 @@ export type { IncentiveResponse, IndexContractDocuments, IndexContractDocumentsResponse, + IndexPreOnboardingDocumentRequirementsResponse, IntegrationsScimErrorResponse, IntegrationsScimGroup, IntegrationsScimGroupListResponse, @@ -1419,6 +1474,11 @@ export type { PayVarianceResponse, PeriodProperties, PersonalDetails, + PostAuthOauth2Token2Data, + PostAuthOauth2Token2Error, + PostAuthOauth2Token2Errors, + PostAuthOauth2Token2Response, + PostAuthOauth2Token2Responses, PostAuthOauth2TokenData, PostAuthOauth2TokenError, PostAuthOauth2TokenErrors, @@ -1633,6 +1693,16 @@ export type { PostV1OffboardingsErrors, PostV1OffboardingsResponse, PostV1OffboardingsResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsError, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignError, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponse, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponse, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses, PostV1PayItemsBulkData, PostV1PayItemsBulkError, PostV1PayItemsBulkErrors, @@ -1727,6 +1797,11 @@ export type { PostV1TimeoffTimeoffIdDeclineErrors, PostV1TimeoffTimeoffIdDeclineResponse, PostV1TimeoffTimeoffIdDeclineResponses, + PostV1TimesheetsData, + PostV1TimesheetsError, + PostV1TimesheetsErrors, + PostV1TimesheetsResponse, + PostV1TimesheetsResponses, PostV1TimesheetsTimesheetIdApproveData, PostV1TimesheetsTimesheetIdApproveError, PostV1TimesheetsTimesheetIdApproveErrors, @@ -1752,6 +1827,7 @@ export type { PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse, PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PreOnboardingDocumentRequirement, Price, PricingPlan, PricingPlanDetails, @@ -1891,6 +1967,7 @@ export type { SentBackTimesheetResponse, ShortId, ShowLegalEntityAdministrativeDetailsResponse, + ShowPreOnboardingDocumentResponse, Signatory, SignatoryStatus, SignatoryType, diff --git a/src/client/sdk.gen.ts b/src/client/sdk.gen.ts index 1599ea06d..5dce0bf6e 100644 --- a/src/client/sdk.gen.ts +++ b/src/client/sdk.gen.ts @@ -292,6 +292,12 @@ import type { GetV1OffboardingsIdErrors, GetV1OffboardingsIdResponses, GetV1OffboardingsResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses, GetV1PayItemsData, GetV1PayItemsErrors, GetV1PayItemsResponses, @@ -378,6 +384,24 @@ import type { GetV1TravelLetterRequestsIdErrors, GetV1TravelLetterRequestsIdResponses, GetV1TravelLetterRequestsResponses, + GetV1WdGphPayDetailData, + GetV1WdGphPayDetailDataData, + GetV1WdGphPayDetailDataErrors, + GetV1WdGphPayDetailDataResponses, + GetV1WdGphPayDetailErrors, + GetV1WdGphPayDetailResponses, + GetV1WdGphPayProcessingFeatureData, + GetV1WdGphPayProcessingFeatureErrors, + GetV1WdGphPayProcessingFeatureResponses, + GetV1WdGphPayProgressData, + GetV1WdGphPayProgressErrors, + GetV1WdGphPayProgressResponses, + GetV1WdGphPaySummaryData, + GetV1WdGphPaySummaryErrors, + GetV1WdGphPaySummaryResponses, + GetV1WdGphPayVarianceData, + GetV1WdGphPayVarianceErrors, + GetV1WdGphPayVarianceResponses, GetV1WebhookEventsData, GetV1WebhookEventsErrors, GetV1WebhookEventsResponses, @@ -465,6 +489,9 @@ import type { PatchV2EmploymentsEmploymentIdData, PatchV2EmploymentsEmploymentIdErrors, PatchV2EmploymentsEmploymentIdResponses, + PostAuthOauth2Token2Data, + PostAuthOauth2Token2Errors, + PostAuthOauth2Token2Responses, PostAuthOauth2TokenData, PostAuthOauth2TokenErrors, PostAuthOauth2TokenResponses, @@ -594,6 +621,12 @@ import type { PostV1OffboardingsData, PostV1OffboardingsErrors, PostV1OffboardingsResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses, PostV1PayItemsBulkData, PostV1PayItemsBulkErrors, PostV1PayItemsBulkResponses, @@ -651,6 +684,9 @@ import type { PostV1TimeoffTimeoffIdDeclineData, PostV1TimeoffTimeoffIdDeclineErrors, PostV1TimeoffTimeoffIdDeclineResponses, + PostV1TimesheetsData, + PostV1TimesheetsErrors, + PostV1TimesheetsResponses, PostV1TimesheetsTimesheetIdApproveData, PostV1TimesheetsTimesheetIdApproveErrors, PostV1TimesheetsTimesheetIdApproveResponses, @@ -744,241 +780,212 @@ export type Options< }; /** - * List Offboarding + * Update administrative details * - * Lists Offboarding requests. + * Updates employment's administrative details. * - * ## Scopes + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. * - */ -export const getV1Offboardings = ( - options?: Options, -) => - (options?.client ?? client).get< - GetV1OffboardingsResponses, - GetV1OffboardingsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/offboardings', - ...options, - }); - -/** - * Create Offboarding + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * - * Creates an Offboarding request. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage offboarding (`offboarding:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1Offboardings = ( - options?: Options, +export const putV2EmploymentsEmploymentIdAdministrativeDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdAdministrativeDetailsData, + ThrowOnError + >, ) => - (options?.client ?? client).post< - PostV1OffboardingsResponses, - PostV1OffboardingsErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses, + PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/offboardings', + url: '/api/eor/v2/employments/{employment_id}/administrative_details', ...options, headers: { 'Content-Type': 'application/json', - ...options?.headers, + ...options.headers, }, }); /** - * Show timesheet + * Get engagement agreement details * - * Shows a timesheet by its ID. + * Returns the engagement agreement details for an employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getV1TimesheetsId = ( - options: Options, +export const getV1EmploymentsEmploymentIdEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetV1TimesheetsIdResponses, - GetV1TimesheetsIdErrors, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets/{id}', + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details', ...options, }); /** - * Cancel onboarding + * Upsert engagement agreement details * - * Cancel onboarding. + * Creates or updates the engagement agreement details for an employment. * - * Requirements for the cancellation to succeed: + * This endpoint requires country-specific data. The exact required fields will vary depending on + * which country the employment is in. To see the list of parameters for each country, see the + * **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that compliance requirements for each country are subject to change according to local laws. + * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended + * to avoid compliance issues and to have the latest version of a country's requirements. * - * * Employment has to be in `invited`, `created`, `created_awaiting_reserve`, `created_reserve_paid`, `pre_hire` status - * * Employee must not have signed the employment contract * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage onboarding (`onboarding:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1CancelOnboardingEmploymentId = < +export const postV1EmploymentsEmploymentIdEngagementAgreementDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostV1CancelOnboardingEmploymentIdResponses, - PostV1CancelOnboardingEmploymentIdErrors, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cancel-onboarding/{employment_id}', + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show form schema - * - * Returns the json schema of the `contract_amendment` form for a specific employment. - * This endpoint requires a company access token, as forms are dependent on certain - * properties of companies and their current employments. + * Convert currency using dynamic rates * + * Convert currency using the rates Remote applies during employment creation and invoicing. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | + * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | * */ -export const getV1ContractAmendmentsSchema = < +export const postV1CurrencyConverterEffective2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetV1ContractAmendmentsSchemaResponses, - GetV1ContractAmendmentsSchemaErrors, + (options.client ?? client).post< + PostV1CurrencyConverterEffective2Responses, + PostV1CurrencyConverterEffective2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments/schema', + url: '/api/eor/v1/currency-converter', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Bulk Create Pay Items + * List contractor subscriptions * - * Bulk creates pay items for employments. Supports up to 500 items per request. - * Integration-specific fields (shift code, currency, pay amount, etc.) go in the `meta` object. - * Only Global Payroll employments are supported. Non-GP employments are returned as `employment_not_global_payroll`. + * Endpoint that can be used to list contractor subscriptions. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | - | Manage pay items (`pay_item:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const postV1PayItemsBulk = ( - options: Options, -) => - (options.client ?? client).post< - PostV1PayItemsBulkResponses, - PostV1PayItemsBulkErrors, +export const getV1ContractorsEmploymentsEmploymentIdContractorSubscriptions = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/pay-items/bulk', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); - -/** - * Get latest data sync events - * - * Get the latest data sync events for each data type that have passed - * - * - * @deprecated - */ -export const getV1DataSync = ( - options?: Options, + >, ) => - (options?.client ?? client).get< - GetV1DataSyncResponses, - GetV1DataSyncErrors, + (options.client ?? client).get< + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/data-sync', + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-subscriptions', ...options, }); /** - * Create test data sync job + * Convert currency using flat rates * - * Create Test Data Synchronization job that will sync test data to the database from production - * The job will be handled asynchronously and the response will be a 202 status code. + * Convert currency using FX rates used in Remoteā€™s estimation tools. + * These rates are not guaranteed to match final onboarding or contract rates. * - * **Heads up:** This endpoint is only available for specific usecases and should not be used for general data sync needs, - * if you need to request access to this endpoint, please contact the api-support@remote.com. + * ## Scopes * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | * - * @deprecated */ -export const postV1DataSync = ( - options: Options, +export const postV1CurrencyConverterRaw = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).post< - PostV1DataSyncResponses, - PostV1DataSyncErrors, + PostV1CurrencyConverterRawResponses, + PostV1CurrencyConverterRawErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/data-sync', + url: '/api/eor/v1/currency-converter/raw', ...options, headers: { 'Content-Type': 'application/json', @@ -987,67 +994,50 @@ export const postV1DataSync = ( }); /** - * List pricing plans - * - * List all pricing plans for a company. - * Currently the endpoint only returns the pricing plans for the EOR monthly product and the contractor products (Standard, Plus and COR). + * List Incentives * + * Lists all Incentives of a company * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * */ -export const getV1CompaniesCompanyIdPricingPlans = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1Incentives = ( + options: Options, ) => (options.client ?? client).get< - GetV1CompaniesCompanyIdPricingPlansResponses, - GetV1CompaniesCompanyIdPricingPlansErrors, + GetV1IncentivesResponses, + GetV1IncentivesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/pricing-plans', - ...options, - }); + >({ url: '/api/eor/v1/incentives', ...options }); /** - * Create a pricing plan for a company - * - * Create a pricing plan for a company, in order to do that we have 2 ways: + * Create Incentive * - * 1. Create a pricing plan from a partner template - * 2. Create a pricing plan from a product price + * Creates an Incentive. * - * The pricing plan is always created in the company's desired currency. + * Incentives use the currency of the employment specified provided in the `employment_id` field. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage pricing plans (`pricing_plan:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const postV1CompaniesCompanyIdPricingPlans = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1Incentives = ( + options: Options, ) => (options.client ?? client).post< - PostV1CompaniesCompanyIdPricingPlansResponses, - PostV1CompaniesCompanyIdPricingPlansErrors, + PostV1IncentivesResponses, + PostV1IncentivesErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}/pricing-plans', + url: '/api/eor/v1/incentives', ...options, headers: { 'Content-Type': 'application/json', @@ -1056,92 +1046,118 @@ export const postV1CompaniesCompanyIdPricingPlans = < }); /** - * Show probation completion letter + * List Benefit Offers By Employment + * + * List benefit offers by employment. * - * Show a single probation completion letter. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const getV1ProbationCompletionLetterId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1BenefitOffers = ( + options: Options, ) => (options.client ?? client).get< - GetV1ProbationCompletionLetterIdResponses, - GetV1ProbationCompletionLetterIdErrors, - ThrowOnError + GetV1BenefitOffersResponses, + GetV1BenefitOffersErrors, + ThrowOnError + >({ url: '/api/eor/v1/benefit-offers', ...options }); + +/** + * Complete onboarding + * + * Completes the employee onboarding. When all tasks are completed, the employee is marked as in `review` status + * + * @deprecated + */ +export const postV1Ready = ( + options: Options, +) => + (options.client ?? client).post< + PostV1ReadyResponses, + PostV1ReadyErrors, + ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-completion-letter/{id}', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/ready', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show Contractor Invoice + * Creates a cost estimation of employments + */ +export const postV1CostCalculatorEstimation = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).post< + PostV1CostCalculatorEstimationResponses, + PostV1CostCalculatorEstimationErrors, + ThrowOnError + >({ + url: '/api/eor/v1/cost-calculator/estimation', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List Recurring Incentive + * + * List all Recurring Incentives of a company. * - * Shows a single Contractor Invoice record. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * */ -export const getV1ContractorInvoicesId = ( - options: Options, +export const getV1IncentivesRecurring = ( + options: Options, ) => (options.client ?? client).get< - GetV1ContractorInvoicesIdResponses, - GetV1ContractorInvoicesIdErrors, + GetV1IncentivesRecurringResponses, + GetV1IncentivesRecurringErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoices/{id}', - ...options, - }); + >({ url: '/api/eor/v1/incentives/recurring', ...options }); /** - * Convert currency using flat rates + * Create Recurring Incentive + * + * Create a Recurring Incentive, that is, a monthly paid incentive. + * + * Incentives use the currency of the employment specified provided in the `employment_id` field. * - * Convert currency using FX rates used in Remoteā€™s estimation tools. - * These rates are not guaranteed to match final onboarding or contract rates. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const postV1CurrencyConverterRaw = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1IncentivesRecurring = ( + options: Options, ) => (options.client ?? client).post< - PostV1CurrencyConverterRawResponses, - PostV1CurrencyConverterRawErrors, + PostV1IncentivesRecurringResponses, + PostV1IncentivesRecurringErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/currency-converter/raw', + url: '/api/eor/v1/incentives/recurring', ...options, headers: { 'Content-Type': 'application/json', @@ -1150,151 +1166,120 @@ export const postV1CurrencyConverterRaw = < }); /** - * Show contractor contract details + * List timesheets * - * Returns the contract details JSON Schema for contractors given a country + * Lists all timesheets. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | * */ -export const getV1CountriesCountryCodeContractorContractDetails = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV1CountriesCountryCodeContractorContractDetailsData, - ThrowOnError - >, +export const getV1Timesheets = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1CountriesCountryCodeContractorContractDetailsResponses, - GetV1CountriesCountryCodeContractorContractDetailsErrors, + (options?.client ?? client).get< + GetV1TimesheetsResponses, + GetV1TimesheetsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/contractor-contract-details', - ...options, - }); + >({ url: '/api/eor/v1/timesheets', ...options }); /** - * List incentives for the authenticated employee + * Create timesheet * - * Returns all incentives for the authenticated employee. + * Creates a new timesheet. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | * */ -export const getV1EmployeeIncentives = ( - options?: Options, +export const postV1Timesheets = ( + options?: Options, ) => - (options?.client ?? client).get< - GetV1EmployeeIncentivesResponses, - GetV1EmployeeIncentivesErrors, + (options?.client ?? client).post< + PostV1TimesheetsResponses, + PostV1TimesheetsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/incentives', + url: '/api/eor/v1/timesheets', ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, }); /** - * List employments - * - * Lists all employments, except for the deleted ones. + * Approve timesheet * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * Approves the given timesheet. * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * ## Scopes * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + */ +export const postV1TimesheetsTimesheetIdApprove = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).post< + PostV1TimesheetsTimesheetIdApproveResponses, + PostV1TimesheetsTimesheetIdApproveErrors, + ThrowOnError + >({ url: '/api/eor/v1/timesheets/{timesheet_id}/approve', ...options }); + +/** + * Get latest data sync events * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * Get the latest data sync events for each data type that have passed * * + * @deprecated */ -export const getV1Employments = ( - options: Options, +export const getV1DataSync = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1EmploymentsResponses, - GetV1EmploymentsErrors, + (options?.client ?? client).get< + GetV1DataSyncResponses, + GetV1DataSyncErrors, ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employments', + url: '/api/eor/v1/data-sync', ...options, }); /** - * Create employment - * - * Creates an employment. We support creating employees and contractors. - * - * ## Global Payroll Employees - * - * To create a Global Payroll employee, pass `global_payroll_employee` as the `type` parameter, - * and provide the slug of the specific legal entity that the employee will be engaged by and billed to as the `engaged_by_entity_slug` parameter. - * - * ## HRIS Employees - * - * To create a HRIS employee, pass `hris` as the `type` parameter. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * + * Create test data sync job * + * Create Test Data Synchronization job that will sync test data to the database from production + * The job will be handled asynchronously and the response will be a 202 status code. * - * ## Scopes + * **Heads up:** This endpoint is only available for specific usecases and should not be used for general data sync needs, + * if you need to request access to this endpoint, please contact the api-support@remote.com. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * + * @deprecated */ -export const postV1Employments = ( - options: Options, +export const postV1DataSync = ( + options: Options, ) => (options.client ?? client).post< - PostV1EmploymentsResponses, - PostV1EmploymentsErrors, + PostV1DataSyncResponses, + PostV1DataSyncErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/data-sync', ...options, headers: { 'Content-Type': 'application/json', @@ -1303,159 +1288,154 @@ export const postV1Employments = ( }); /** - * Get Onboarding Reserves Status for Employment - * - * Returns the onboarding reserves status for a specific employment. - * - * The status is the same as the credit risk status but takes the onboarding reserves policies into account. + * Show probation completion letter * + * Show a single probation completion letter. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | * */ -export const getV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatus = - ( - options: Options< - GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData, - ThrowOnError - >, - ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses, - GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status', - ...options, - }); +export const getV1ProbationCompletionLetterId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1ProbationCompletionLetterIdResponses, + GetV1ProbationCompletionLetterIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/probation-completion-letter/{id}', ...options }); /** - * Get Help Center Article + * Show the current SSO Configuration * - * Get a help center article by its ID + * Shows the current SSO Configuration for the company. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View help articles (`help_center_article:read`) | - | + * | Manage company resources (`company_admin`) | View SSO configuration (`sso_configuration:read`) | Manage SSO (`sso_configuration:write`) | * */ -export const getV1HelpCenterArticlesId = ( - options: Options, +export const getV1SsoConfiguration = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1HelpCenterArticlesIdResponses, - GetV1HelpCenterArticlesIdErrors, + (options?.client ?? client).get< + GetV1SsoConfigurationResponses, + GetV1SsoConfigurationErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/help-center-articles/{id}', - ...options, - }); + >({ url: '/api/eor/v1/sso-configuration', ...options }); /** - * Get user by ID via SCIM v2.0 + * Create the SSO Configuration + * + * Creates the SSO Configuration for the company. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | * - * Retrieves a single user for the authenticated company by user ID */ -export const getV1ScimV2UsersId = ( - options: Options, +export const postV1SsoConfiguration = ( + options: Options, ) => - (options.client ?? client).get< - GetV1ScimV2UsersIdResponses, - GetV1ScimV2UsersIdErrors, + (options.client ?? client).post< + PostV1SsoConfigurationResponses, + PostV1SsoConfigurationErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Users/{id}', + url: '/api/eor/v1/sso-configuration', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Get engagement agreement details + * List Offboarding * - * Returns the engagement agreement details for an employment. + * Lists Offboarding requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | * */ -export const getV2EmploymentsEmploymentIdEngagementAgreementDetails = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData, +export const getV1Offboardings = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1OffboardingsResponses, + GetV1OffboardingsErrors, ThrowOnError - >, + >({ url: '/api/eor/v1/offboardings', ...options }); + +/** + * Create Offboarding + * + * Creates an Offboarding request. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage offboarding (`offboarding:write`) | + * + */ +export const postV1Offboardings = ( + options?: Options, ) => - (options.client ?? client).get< - GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, - GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + (options?.client ?? client).post< + PostV1OffboardingsResponses, + PostV1OffboardingsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/engagement-agreement-details', + url: '/api/eor/v1/offboardings', ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, }); /** - * Upsert engagement agreement details - * - * Creates or updates the engagement agreement details for an employment. - * - * This endpoint requires country-specific data. The exact required fields will vary depending on - * which country the employment is in. To see the list of parameters for each country, see the - * **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that compliance requirements for each country are subject to change according to local laws. - * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended - * to avoid compliance issues and to have the latest version of a country's requirements. + * Create a contract document for a contractor * + * Create a contract document for a contractor. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const postV2EmploymentsEmploymentIdEngagementAgreementDetails = < +export const postV1ContractorsEmploymentsEmploymentIdContractDocuments = < ThrowOnError extends boolean = false, >( options: Options< - PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData, ThrowOnError >, ) => (options.client ?? client).post< - PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, - PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/engagement-agreement-details', + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents', ...options, headers: { 'Content-Type': 'application/json', @@ -1464,76 +1444,112 @@ export const postV2EmploymentsEmploymentIdEngagementAgreementDetails = < }); /** - * Download a document for the employee + * Update federal taxes + * + * Updates employment's federal taxes. + * + * Requirements to update federal taxes successfully: + * * Employment should be Global Payroll + * * Employment should be in the post-enrollment state + * * Employment should belong to USA + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * + * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1EmployeeDocumentsId = ( - options: Options, +export const putV1EmploymentsEmploymentIdFederalTaxes = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).get< - GetV1EmployeeDocumentsIdResponses, - GetV1EmployeeDocumentsIdErrors, + (options.client ?? client).put< + PutV1EmploymentsEmploymentIdFederalTaxesResponses, + PutV1EmploymentsEmploymentIdFederalTaxesErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/documents/{id}', + url: '/api/eor/v1/employments/{employment_id}/federal-taxes', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Contractor Invoices + * List pricing plans + * + * List all pricing plans for a company. + * Currently the endpoint only returns the pricing plans for the EOR monthly product and the contractor products (Standard, Plus and COR). * - * Lists Contractor Invoice records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | * */ -export const getV1ContractorInvoices = ( - options?: Options, +export const getV1CompaniesCompanyIdPricingPlans = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options?.client ?? client).get< - GetV1ContractorInvoicesResponses, - GetV1ContractorInvoicesErrors, + (options.client ?? client).get< + GetV1CompaniesCompanyIdPricingPlansResponses, + GetV1CompaniesCompanyIdPricingPlansErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoices', - ...options, - }); + >({ url: '/api/eor/v1/companies/{company_id}/pricing-plans', ...options }); /** - * Report SDK errors + * Create a pricing plan for a company * - * Receives error telemetry from the frontend SDK. - * Errors are logged to observability backend for monitoring and debugging. + * Create a pricing plan for a company, in order to do that we have 2 ways: + * + * 1. Create a pricing plan from a partner template + * 2. Create a pricing plan from a product price + * + * The pricing plan is always created in the company's desired currency. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | - | Manage pricing plans (`pricing_plan:write`) | * */ -export const postV1SdkTelemetryErrors = ( - options: Options, +export const postV1CompaniesCompanyIdPricingPlans = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).post< - PostV1SdkTelemetryErrorsResponses, - PostV1SdkTelemetryErrorsErrors, + PostV1CompaniesCompanyIdPricingPlansResponses, + PostV1CompaniesCompanyIdPricingPlansErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sdk/telemetry-errors', + url: '/api/eor/v1/companies/{company_id}/pricing-plans', ...options, headers: { 'Content-Type': 'application/json', @@ -1542,55 +1558,51 @@ export const postV1SdkTelemetryErrors = ( }); /** - * Show the SSO Configuration Details + * Update federal taxes + * + * Updates employment's federal taxes. + * + * Requirements to update federal taxes successfully: + * * Employment should be Global Payroll + * * Employment should be in the post-enrollment state + * * Employment should belong to USA + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * * - * Shows the SSO Configuration details for the company. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1SsoConfigurationDetails = < - ThrowOnError extends boolean = false, ->( - options?: Options, -) => - (options?.client ?? client).get< - GetV1SsoConfigurationDetailsResponses, - GetV1SsoConfigurationDetailsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sso-configuration/details', - ...options, - }); - -/** - * Creates a cost estimation of employments - */ -export const postV1CostCalculatorEstimation = < +export const putV2EmploymentsEmploymentIdFederalTaxes = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostV1CostCalculatorEstimationResponses, - PostV1CostCalculatorEstimationErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdFederalTaxesResponses, + PutV2EmploymentsEmploymentIdFederalTaxesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/estimation', + url: '/api/eor/v2/employments/{employment_id}/federal-taxes', ...options, headers: { 'Content-Type': 'application/json', @@ -1599,75 +1611,91 @@ export const postV1CostCalculatorEstimation = < }); /** - * Show form schema - * - * Returns the json schema of the requested company form. - * Currently only supports the `address_details` form. + * List travel letter requests * + * List travel letter requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | - | View travel letters (`travel_letter:read`) | - | * */ -export const getV1CompaniesSchema = ( - options: Options, +export const getV1TravelLetterRequests = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1CompaniesSchemaResponses, - GetV1CompaniesSchemaErrors, + (options?.client ?? client).get< + GetV1TravelLetterRequestsResponses, + GetV1TravelLetterRequestsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/schema', - ...options, - }); + >({ url: '/api/eor/v1/travel-letter-requests', ...options }); /** - * Get employment benefit offers + * Get engagement agreement details + * + * Returns the engagement agreement details for an employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getV1EmploymentsEmploymentIdBenefitOffers = < +export const getV2EmploymentsEmploymentIdEngagementAgreementDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetV1EmploymentsEmploymentIdBenefitOffersResponses, - GetV1EmploymentsEmploymentIdBenefitOffersErrors, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/benefit-offers', + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details', ...options, }); /** - * Upserts employment benefit offers + * Upsert engagement agreement details + * + * Creates or updates the engagement agreement details for an employment. + * + * This endpoint requires country-specific data. The exact required fields will vary depending on + * which country the employment is in. To see the list of parameters for each country, see the + * **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that compliance requirements for each country are subject to change according to local laws. + * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended + * to avoid compliance issues and to have the latest version of a country's requirements. + * + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * */ -export const putV1EmploymentsEmploymentIdBenefitOffers = < +export const postV2EmploymentsEmploymentIdEngagementAgreementDetails = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PutV1EmploymentsEmploymentIdBenefitOffersResponses, - PutV1EmploymentsEmploymentIdBenefitOffersErrors, + (options.client ?? client).post< + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses, + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employments/{employment_id}/benefit-offers', + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details', ...options, headers: { 'Content-Type': 'application/json', @@ -1676,40 +1704,27 @@ export const putV1EmploymentsEmploymentIdBenefitOffers = < }); /** - * Get Employment Profile - * - * Gets necessary information to perform the identity verification of an employee. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employment documents (`employment_documents`) | View identity verification (`identity_verification:read`) | Manage identity verification (`identity_verification:write`) | + * Payroll processing summary API resource * + * API to retrieve summary data for processing pay groups */ -export const getV1IdentityVerificationEmploymentId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1WdGphPaySummary = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1IdentityVerificationEmploymentIdResponses, - GetV1IdentityVerificationEmploymentIdErrors, + (options?.client ?? client).get< + GetV1WdGphPaySummaryResponses, + GetV1WdGphPaySummaryErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity-verification/{employment_id}', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/paySummary', ...options, }); /** - * List contractor subscriptions + * Show employment job * - * Endpoint that can be used to list contractor subscriptions. + * Shows an employment job details. * * * ## Scopes @@ -1719,418 +1734,322 @@ export const getV1IdentityVerificationEmploymentId = < * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getV1ContractorsEmploymentsEmploymentIdContractorSubscriptions = < +export const getV1EmploymentsEmploymentIdJob = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).get< - GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses, - GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors, + GetV1EmploymentsEmploymentIdJobResponses, + GetV1EmploymentsEmploymentIdJobErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-subscriptions', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}/job', ...options }); /** - * List approved payslip files for the authenticated employee + * Create bulk employment job * - * Returns a paginated list of payslip files belonging to the current employee. + * Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1EmployeePayslips = ( - options?: Options, +export const postV1BulkEmploymentJobs = ( + options?: Options, ) => - (options?.client ?? client).get< - GetV1EmployeePayslipsResponses, - GetV1EmployeePayslipsErrors, + (options?.client ?? client).post< + PostV1BulkEmploymentJobsResponses, + PostV1BulkEmploymentJobsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/payslips', + url: '/api/eor/v1/bulk-employment-jobs', ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, }); /** - * List Webhook Events + * List Contract Amendment * - * List all webhook events + * List Contract Amendment requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | + * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | * */ -export const getV1WebhookEvents = ( - options?: Options, +export const getV1ContractAmendments = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1WebhookEventsResponses, - GetV1WebhookEventsErrors, + (options.client ?? client).get< + GetV1ContractAmendmentsResponses, + GetV1ContractAmendmentsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/webhook-events', - ...options, - }); + >({ url: '/api/eor/v1/contract-amendments', ...options }); /** - * Pass KYB - * - * Pass KYB and credit risk for a company without the intervention of a Remote admin. + * Create Contract Amendment * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * Creates a Contract Amendment request. * - */ -export const postV1SandboxCompaniesCompanyIdBypassEligibilityChecks = < - ThrowOnError extends boolean = false, ->( - options: Options< - PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData, - ThrowOnError - >, -) => - (options.client ?? client).post< - PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses, - PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/companies/{company_id}/bypass-eligibility-checks', - ...options, - }); - -/** - * Approve risk reserve proof of payment + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category. * - * Approves a risk reserve proof of payment without the intervention of a Remote admin. + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. * - * Triggers an `employment.cor_hiring.proof_of_payment_accepted` webhook event. + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * - */ -export const postV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApprove = - ( - options: Options< - PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData, - ThrowOnError - >, - ) => - (options.client ?? client).post< - PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses, - PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve', - ...options, - }); - -/** - * Get a mock JSON Schema + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. * - * Get a mock JSON Schema for testing purposes - */ -export const getV1TestSchema = ( - options?: Options, -) => - (options?.client ?? client).get< - GetV1TestSchemaResponses, - unknown, - ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/test-schema', - ...options, - }); - -/** - * List all holidays of a country * - * List all holidays of a country for a specific year. Optionally, it can be filtered by country subdivision. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | + * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | * */ -export const getV1CountriesCountryCodeHolidaysYear = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1ContractAmendments = ( + options: Options, ) => - (options.client ?? client).get< - GetV1CountriesCountryCodeHolidaysYearResponses, - GetV1CountriesCountryCodeHolidaysYearErrors, + (options.client ?? client).post< + PostV1ContractAmendmentsResponses, + PostV1ContractAmendmentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/holidays/{year}', + url: '/api/eor/v1/contract-amendments', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Cancel Time Off + * Delete a Recurring Incentive + * + * Delete a Recurring Incentive, that is, a monthly paid incentive. + * + * Internally, Remote schedules upcoming incentives. As such, when you attempt to + * delete a recurring incentive, Remote will **ONLY** delete scheduled incentives + * with the `pending` status. + * + * Incentives payments that are already scheduled and cannot be deleted will be + * included in the response, in case you need to reference them. * - * Cancel a time off request that was already approved. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const postV1TimeoffTimeoffIdCancel = < +export const deleteV1IncentivesRecurringId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostV1TimeoffTimeoffIdCancelResponses, - PostV1TimeoffTimeoffIdCancelErrors, + (options.client ?? client).delete< + DeleteV1IncentivesRecurringIdResponses, + DeleteV1IncentivesRecurringIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/cancel', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/incentives/recurring/{id}', ...options }); /** - * Show employment job - * - * Shows an employment job details. + * Show Benefit Renewal Request * + * Show Benefit Renewal Request details. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | * */ -export const getV1EmploymentsEmploymentIdJob = < +export const getV1BenefitRenewalRequestsBenefitRenewalRequestId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetV1EmploymentsEmploymentIdJobResponses, - GetV1EmploymentsEmploymentIdJobErrors, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/job', + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}', ...options, }); /** - * List pricing plan partner templates - * - * List all pricing plan partner templates. + * Updates a Benefit Renewal Request Response * + * Updates a Benefit Renewal Request with the given response. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) | * */ -export const getV1PricingPlanPartnerTemplates = < +export const postV1BenefitRenewalRequestsBenefitRenewalRequestId = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options< + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetV1PricingPlanPartnerTemplatesResponses, - GetV1PricingPlanPartnerTemplatesErrors, + (options.client ?? client).post< + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/pricing-plan-partner-templates', + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List EOR Payroll Calendar + * List all holidays of a country * - * List all active payroll calendars for EOR. + * List all holidays of a country for a specific year. Optionally, it can be filtered by country subdivision. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | + * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | * */ -export const getV1PayrollCalendars = ( - options?: Options, +export const getV1CountriesCountryCodeHolidaysYear = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options?.client ?? client).get< - GetV1PayrollCalendarsResponses, - GetV1PayrollCalendarsErrors, + (options.client ?? client).get< + GetV1CountriesCountryCodeHolidaysYearResponses, + GetV1CountriesCountryCodeHolidaysYearErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/payroll-calendars', + url: '/api/eor/v1/countries/{country_code}/holidays/{year}', ...options, }); /** - * Update Time Off as Employee + * List custom field value for an employment * - * Updates a Time Off record as Employee + * Returns a list of custom field values for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | * */ -export const patchV1EmployeeTimeoffId2 = ( - options: Options, +export const getV1EmploymentsEmploymentIdCustomFields = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).patch< - PatchV1EmployeeTimeoffId2Responses, - PatchV1EmployeeTimeoffId2Errors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdCustomFieldsResponses, + GetV1EmploymentsEmploymentIdCustomFieldsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff/{id}', + url: '/api/eor/v1/employments/{employment_id}/custom-fields', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Update Time Off as Employee + * Show timesheet * - * Updates a Time Off record as Employee + * Shows a timesheet by its ID. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | * */ -export const patchV1EmployeeTimeoffId = ( - options: Options, +export const getV1TimesheetsId = ( + options: Options, ) => - (options.client ?? client).put< - PatchV1EmployeeTimeoffIdResponses, - PatchV1EmployeeTimeoffIdErrors, + (options.client ?? client).get< + GetV1TimesheetsIdResponses, + GetV1TimesheetsIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/timesheets/{id}', ...options }); /** - * List Recurring Incentive + * List Company Managers * - * List all Recurring Incentives of a company. + * List all company managers of an integration. If filtered by the company_id param, + * it lists only company managers belonging to the specified company. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | * */ -export const getV1IncentivesRecurring = ( - options: Options, +export const getV1CompanyManagers = ( + options: Options, ) => (options.client ?? client).get< - GetV1IncentivesRecurringResponses, - GetV1IncentivesRecurringErrors, + GetV1CompanyManagersResponses, + GetV1CompanyManagersErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/recurring', - ...options, - }); + >({ url: '/api/eor/v1/company-managers', ...options }); /** - * Create Recurring Incentive - * - * Create a Recurring Incentive, that is, a monthly paid incentive. - * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * Create and invite a Company Manager * + * Create a Company Manager and sends the invitation email for signing in to the Remote Platform. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | * */ -export const postV1IncentivesRecurring = ( - options: Options, +export const postV1CompanyManagers = ( + options: Options, ) => (options.client ?? client).post< - PostV1IncentivesRecurringResponses, - PostV1IncentivesRecurringErrors, + PostV1CompanyManagersResponses, + PostV1CompanyManagersErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/recurring', + url: '/api/eor/v1/company-managers', ...options, headers: { 'Content-Type': 'application/json', @@ -2139,27 +2058,29 @@ export const postV1IncentivesRecurring = ( }); /** - * Creates a Benefit Renewal Request + * Bulk Create Pay Items * - * Creates a Benefit Renewal Request for a specific Benefit Group. - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * Bulk creates pay items for employments. Supports up to 500 items per request. + * Integration-specific fields (shift code, currency, pay amount, etc.) go in the `meta` object. + * Only Global Payroll employments are supported. Non-GP employments are returned as `employment_not_global_payroll`. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage payroll runs (`payroll`) | - | Manage pay items (`pay_item:write`) | * */ -export const postV1SandboxBenefitRenewalRequests = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1PayItemsBulk = ( + options: Options, ) => (options.client ?? client).post< - PostV1SandboxBenefitRenewalRequestsResponses, - PostV1SandboxBenefitRenewalRequestsErrors, + PostV1PayItemsBulkResponses, + PostV1PayItemsBulkErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/benefit-renewal-requests', + url: '/api/eor/v1/pay-items/bulk', ...options, headers: { 'Content-Type': 'application/json', @@ -2168,289 +2089,215 @@ export const postV1SandboxBenefitRenewalRequests = < }); /** - * Return a base64 encoded version of the contract document + * Show travel letter request + * + * Show a single travel letter request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | - | View travel letters (`travel_letter:read`) | - | * */ -export const getV1ContractorsEmploymentsEmploymentIdContractDocumentsId = < +export const getV1TravelLetterRequestsId = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).get< - GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses, - GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors, + GetV1TravelLetterRequestsIdResponses, + GetV1TravelLetterRequestsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contract-documents/{id}', - ...options, - }); + >({ url: '/api/eor/v1/travel-letter-requests/{id}', ...options }); /** - * List contract documents for an employment + * Updates a travel letter request * - * Only contractor employment types are supported. Lists contract documents for a specific employment with pagination, filtering by status, and sorted by updated_at descending (latest first). + * Updates a travel letter request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | - | - | Manage travel letters (`travel_letter:write`) | * */ -export const getV1EmploymentsEmploymentIdContractDocuments = < +export const patchV1TravelLetterRequestsId2 = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1EmploymentsEmploymentIdContractDocumentsData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetV1EmploymentsEmploymentIdContractDocumentsResponses, - GetV1EmploymentsEmploymentIdContractDocumentsErrors, + (options.client ?? client).patch< + PatchV1TravelLetterRequestsId2Responses, + PatchV1TravelLetterRequestsId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/contract-documents', + url: '/api/eor/v1/travel-letter-requests/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List expenses + * Updates a travel letter request * - * Lists all expenses records + * Updates a travel letter request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | - | - | Manage travel letters (`travel_letter:write`) | * */ -export const getV1Expenses = ( - options: Options, +export const patchV1TravelLetterRequestsId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).get< - GetV1ExpensesResponses, - GetV1ExpensesErrors, + (options.client ?? client).put< + PatchV1TravelLetterRequestsIdResponses, + PatchV1TravelLetterRequestsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses', + url: '/api/eor/v1/travel-letter-requests/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create expense + * Pass KYB * - * Creates an **approved** expense + * Pass KYB and credit risk for a company without the intervention of a Remote admin. * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const postV1Expenses = ( - options: Options, +export const postV1SandboxCompaniesCompanyIdBypassEligibilityChecks = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostV1ExpensesResponses, - PostV1ExpensesErrors, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses, + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses', + url: '/api/eor/v1/sandbox/companies/{company_id}/bypass-eligibility-checks', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Show the current SSO Configuration + * List Employee Leave Policies * - * Shows the current SSO Configuration for the company. + * List the leave policies for the current employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View SSO configuration (`sso_configuration:read`) | Manage SSO (`sso_configuration:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getV1SsoConfiguration = ( - options?: Options, +export const getV1EmployeeLeavePolicies = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => (options?.client ?? client).get< - GetV1SsoConfigurationResponses, - GetV1SsoConfigurationErrors, + GetV1EmployeeLeavePoliciesResponses, + GetV1EmployeeLeavePoliciesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sso-configuration', - ...options, - }); + >({ url: '/api/eor/v1/employee/leave-policies', ...options }); /** - * Create the SSO Configuration + * List Webhook Callbacks * - * Creates the SSO Configuration for the company. + * List callbacks for a given company * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | - * - */ -export const postV1SsoConfiguration = ( - options: Options, -) => - (options.client ?? client).post< - PostV1SsoConfigurationResponses, - PostV1SsoConfigurationErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sso-configuration', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); - -/** - * Approve Contract Amendment - * - * Approves a contract amendment request without the intervention of a Remote admin. - * Approvals done via this endpoint are effective immediately, - * regardless of the effective date entered on the contract amendment creation. - * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | * */ -export const putV1SandboxContractAmendmentsContractAmendmentRequestIdApprove = < +export const getV1CompaniesCompanyIdWebhookCallbacks = < ThrowOnError extends boolean = false, >( - options: Options< - PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).put< - PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses, - PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors, + (options.client ?? client).get< + GetV1CompaniesCompanyIdWebhookCallbacksResponses, + GetV1CompaniesCompanyIdWebhookCallbacksErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve', + url: '/api/eor/v1/companies/{company_id}/webhook-callbacks', ...options, }); /** - * List Employee Leave Policies + * Download a billing document PDF * - * List the leave policies for the current employee + * Downloads a billing document PDF * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const getV1EmployeeLeavePolicies = < +export const getV1BillingDocumentsBillingDocumentIdPdf = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options, ) => - (options?.client ?? client).get< - GetV1EmployeeLeavePoliciesResponses, - GetV1EmployeeLeavePoliciesErrors, + (options.client ?? client).get< + GetV1BillingDocumentsBillingDocumentIdPdfResponses, + GetV1BillingDocumentsBillingDocumentIdPdfErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/leave-policies', + url: '/api/eor/v1/billing-documents/{billing_document_id}/pdf', ...options, }); /** - * List all currencies for the contractor - * - * The currencies are listed in the following order: - * 1. billing currency of the company - * 2. currencies of contractorā€™s existing withdrawal methods - * 3. currency of the contractorā€™s country - * 4. the rest, alphabetical. + * Delete a Webhook Callback * + * Delete a callback previously registered for webhooks * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * */ -export const getV1ContractorsEmploymentsEmploymentIdContractorCurrencies = < +export const deleteV1WebhookCallbacksId = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses, - GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors, + (options.client ?? client).delete< + DeleteV1WebhookCallbacksIdResponses, + DeleteV1WebhookCallbacksIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-currencies', - ...options, - }); + >({ url: '/api/eor/v1/webhook-callbacks/{id}', ...options }); /** - * Replay Webhook Events + * Update a Webhook Callback * - * Replay webhook events + * Update a callback previously registered for webhooks * * ## Scopes * @@ -2459,16 +2306,15 @@ export const getV1ContractorsEmploymentsEmploymentIdContractorCurrencies = < * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * */ -export const postV1WebhookEventsReplay = ( - options: Options, +export const patchV1WebhookCallbacksId = ( + options: Options, ) => - (options.client ?? client).post< - PostV1WebhookEventsReplayResponses, - PostV1WebhookEventsReplayErrors, + (options.client ?? client).patch< + PatchV1WebhookCallbacksIdResponses, + PatchV1WebhookCallbacksIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/webhook-events/replay', + url: '/api/eor/v1/webhook-callbacks/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2477,161 +2323,147 @@ export const postV1WebhookEventsReplay = ( }); /** - * Create a contractor of record (COR) termination request + * List countries * - * Initiates a termination request for a Contractor of Record employment. - * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. - * Currently, only Contractor of Record employments can be terminated. + * Returns a list of all countries that are supported by Remote API alphabetically ordered. + * The supported list accounts for creating employment with basic information and it does not imply fully onboarding employment via JSON Schema. + * The countries present in the list are the ones where creating a company is allowed. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | * */ -export const postV1ContractorsEmploymentsEmploymentIdCorTerminationRequests = < - ThrowOnError extends boolean = false, ->( - options: Options< - PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData, - ThrowOnError - >, +export const getV1Countries = ( + options: Options, ) => - (options.client ?? client).post< - PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses, - PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors, + (options.client ?? client).get< + GetV1CountriesResponses, + GetV1CountriesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests', - ...options, - }); + >({ url: '/api/eor/v1/countries', ...options }); /** - * Show Background Check + * Show contractor eligibility and COR-supported countries for legal entity + * + * Returns which contractor products (standard, plus, cor) the legal entity is eligible to use, + * and the list of country codes where COR is supported for this legal entity. + * COR-supported countries exclude sanctioned and signup-prevented countries and apply entity rules (same-country, local-to-local). + * When the legal entity is not COR-eligible, `cor_supported_country_codes` is an empty list. * - * Show Background Check details for a given employment and background check request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View background checks (`background_check:read`) | - | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckId = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData, - ThrowOnError - >, -) => - (options.client ?? client).get< - GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses, - GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors, - ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employments/{employment_id}/background-checks/{background_check_id}', - ...options, - }); +export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibility = + ( + options: Options< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility', + ...options, + }); /** - * Show benefit renewal request schema - * - * Returns the json schema of the `benefit_renewal_request` form for a specific request. - * This endpoint requires a company access token, as forms are dependent on certain - * properties of companies and their current employments. + * Convert currency using dynamic rates * + * Convert currency using the rates Remote applies during employment creation and invoicing. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | * */ -export const getV1BenefitRenewalRequestsBenefitRenewalRequestIdSchema = < +export const postV1CurrencyConverterEffective = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses, - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors, + (options.client ?? client).post< + PostV1CurrencyConverterEffectiveResponses, + PostV1CurrencyConverterEffectiveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema', + url: '/api/eor/v1/currency-converter/effective', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Magic links generator - * - * Generates a magic link for a passwordless authentication. - * To create a magic link for a company admin, you need to provide the `user_id` parameter. - * To create a magic link for an employee, you need to provide the `employment_id` parameter. + * Show personal information for the authenticated employee * + * Returns personal information for the authenticated employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Create magic links (`magic_link:write`) | + * | Manage employments (`employments`) | View personal details (`personal_detail:read`) | - | * */ -export const postV1MagicLink = ( - options: Options, +export const getV1EmployeePersonalInformation = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => - (options.client ?? client).post< - PostV1MagicLinkResponses, - PostV1MagicLinkErrors, + (options?.client ?? client).get< + GetV1EmployeePersonalInformationResponses, + GetV1EmployeePersonalInformationErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/magic-link', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/employee/personal-information', ...options }); /** - * Update basic information - * - * Updates employment's basic information. - * - * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * Show form schema * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * Returns the json schema of a supported form. Possible form names are: + * ``` + * - address_details + * - administrative_details + * - bank_account_details + * - employment_basic_information + * - contractor_basic_information + * - contractor_contract_details + * - billing_address_details + * - contract_details + * - emergency_contact + * - emergency_contact_details + * - employment_document_details + * - personal_details + * - pricing_plan_details + * - company_basic_information + * - global_payroll_administrative_details + * - global_payroll_basic_information + * - global_payroll_contract_details + * - global_payroll_federal_taxes + * - global_payroll_personal_details + * - benefit_renewal_request + * - hris_personal_details * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * ``` * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * Most forms require a company access token, as they are dependent on certain + * properties of companies and their current employments. However, the `address_details` + * and `company_basic_information` forms can be accessed using client_credentials + * authentication (without a company). * * * @@ -2639,440 +2471,342 @@ export const postV1MagicLink = ( * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const putV2EmploymentsEmploymentIdBasicInformation = < +export const getV1CountriesCountryCodeForm = < ThrowOnError extends boolean = false, >( - options: Options< - PutV2EmploymentsEmploymentIdBasicInformationData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).put< - PutV2EmploymentsEmploymentIdBasicInformationResponses, - PutV2EmploymentsEmploymentIdBasicInformationErrors, + (options.client ?? client).get< + GetV1CountriesCountryCodeFormResponses, + GetV1CountriesCountryCodeFormErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/basic_information', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/countries/{country_code}/{form}', ...options }); /** - * Delete a Recurring Incentive - * - * Delete a Recurring Incentive, that is, a monthly paid incentive. - * - * Internally, Remote schedules upcoming incentives. As such, when you attempt to - * delete a recurring incentive, Remote will **ONLY** delete scheduled incentives - * with the `pending` status. - * - * Incentives payments that are already scheduled and cannot be deleted will be - * included in the response, in case you need to reference them. + * List Time Off * + * Lists all Time Off records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const deleteV1IncentivesRecurringId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1Timeoff = ( + options: Options, ) => - (options.client ?? client).delete< - DeleteV1IncentivesRecurringIdResponses, - DeleteV1IncentivesRecurringIdErrors, + (options.client ?? client).get< + GetV1TimeoffResponses, + GetV1TimeoffErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/recurring/{id}', - ...options, - }); + >({ url: '/api/eor/v1/timeoff', ...options }); /** - * List Incentives + * Create Time Off * - * Lists all Incentives of a company + * Creates a Time Off record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getV1Incentives = ( - options: Options, +export const postV1Timeoff = ( + options: Options, ) => - (options.client ?? client).get< - GetV1IncentivesResponses, - GetV1IncentivesErrors, + (options.client ?? client).post< + PostV1TimeoffResponses, + PostV1TimeoffErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives', + url: '/api/eor/v1/timeoff', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create Incentive + * List countries for Cost Calculator * - * Creates an Incentive. + * Lists active and processing countries + */ +export const getV1CostCalculatorCountries = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).get< + GetV1CostCalculatorCountriesResponses, + unknown, + ThrowOnError + >({ url: '/api/eor/v1/cost-calculator/countries', ...options }); + +/** + * Submit risk reserve proof of payment * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * Submits a proof of payment document for a risk reserve associated with an employment. + * + * Triggers an `employment.cor_hiring.proof_of_payment_submitted` webhook event. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | * */ -export const postV1Incentives = ( - options: Options, +export const postV1EmploymentsEmploymentIdRiskReserveProofOfPayments = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData, + ThrowOnError + >, ) => (options.client ?? client).post< - PostV1IncentivesResponses, - PostV1IncentivesErrors, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses, + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives', + ...formDataBodySerializer, + url: '/api/eor/v1/employments/{employment_id}/risk-reserve-proof-of-payments', ...options, headers: { - 'Content-Type': 'application/json', + 'Content-Type': null, ...options.headers, }, }); /** - * Create probation completion letter + * Show Background Check * - * Create a new probation completion letter request. + * Show Background Check details for a given employment and background check request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | + * | Manage employments (`employments`) | View background checks (`background_check:read`) | - | * */ -export const postV1ProbationCompletionLetter = < +export const getV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostV1ProbationCompletionLetterResponses, - PostV1ProbationCompletionLetterErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses, + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-completion-letter', + url: '/api/eor/v1/employments/{employment_id}/background-checks/{background_check_id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Show Contractor Invoice Schedule + * Show Time Off Balance + * + * Shows the time off balance for the given employment_id. + * + * Deprecated since February 2025 in favour of **[List Leave Policies Summary](#tag/Leave-Policies/operation/get_index_leave_policies_summary)** endpoint. * - * Shows a single Contractor Invoice Schedule record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * + * + * @deprecated */ -export const getV1ContractorInvoiceSchedulesId = < +export const getV1TimeoffBalancesEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1ContractorInvoiceSchedulesIdResponses, - GetV1ContractorInvoiceSchedulesIdErrors, + GetV1TimeoffBalancesEmploymentIdResponses, + GetV1TimeoffBalancesEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules/{id}', - ...options, - }); + >({ url: '/api/eor/v1/timeoff-balances/{employment_id}', ...options }); /** - * Updates Contractor Invoice Schedule + * List expenses for the authenticated employee * - * Updates a contractor invoice schedule record + * Returns a paginated list of expenses belonging to the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const patchV1ContractorInvoiceSchedulesId2 = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeeExpenses = ( + options?: Options, ) => - (options.client ?? client).patch< - PatchV1ContractorInvoiceSchedulesId2Responses, - PatchV1ContractorInvoiceSchedulesId2Errors, + (options?.client ?? client).get< + GetV1EmployeeExpensesResponses, + GetV1EmployeeExpensesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/employee/expenses', ...options }); /** - * Updates Contractor Invoice Schedule + * Create an expense for the authenticated employee * - * Updates a contractor invoice schedule record + * Creates a new expense record for the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const patchV1ContractorInvoiceSchedulesId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1EmployeeExpenses = ( + options?: Options, ) => - (options.client ?? client).put< - PatchV1ContractorInvoiceSchedulesIdResponses, - PatchV1ContractorInvoiceSchedulesIdErrors, + (options?.client ?? client).post< + PostV1EmployeeExpensesResponses, + PostV1EmployeeExpensesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules/{id}', + url: '/api/eor/v1/employee/expenses', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Show Billing Document - * - * Shows a billing document details. - * - * Please contact api-support@remote.com to request access to this endpoint. + * Download a resignation letter * + * Downloads a resignation letter from an employment request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage employment documents (`employment_documents`) | View resignation letters (`resignation_letter:read`) | - | * */ -export const getV1BillingDocumentsBillingDocumentId = < +export const getV1ResignationsOffboardingRequestIdResignationLetter = < ThrowOnError extends boolean = false, >( - options: Options, -) => - (options.client ?? client).get< - GetV1BillingDocumentsBillingDocumentIdResponses, - GetV1BillingDocumentsBillingDocumentIdErrors, + options: Options< + GetV1ResignationsOffboardingRequestIdResignationLetterData, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents/{billing_document_id}', - ...options, - }); - -/** - * Creates PDF cost estimation of employments - * - * Creates a PDF cost estimation of employments based on the provided parameters. - */ -export const postV1CostCalculatorEstimationPdf = < - ThrowOnError extends boolean = false, ->( - options?: Options, + >, ) => - (options?.client ?? client).post< - PostV1CostCalculatorEstimationPdfResponses, - PostV1CostCalculatorEstimationPdfErrors, + (options.client ?? client).get< + GetV1ResignationsOffboardingRequestIdResignationLetterResponses, + GetV1ResignationsOffboardingRequestIdResignationLetterErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/estimation-pdf', + url: '/api/eor/v1/resignations/{offboarding_request_id}/resignation-letter', ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, }); /** - * Show work authorization request + * Deletes a Company Manager user * - * Show a single work authorization request. + * Deletes a Company Manager user * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | + * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | * */ -export const getV1WorkAuthorizationRequestsId = < +export const deleteV1CompanyManagersUserId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetV1WorkAuthorizationRequestsIdResponses, - GetV1WorkAuthorizationRequestsIdErrors, + (options.client ?? client).delete< + DeleteV1CompanyManagersUserIdResponses, + DeleteV1CompanyManagersUserIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests/{id}', - ...options, - }); + >({ url: '/api/eor/v1/company-managers/{user_id}', ...options }); /** - * Update work authorization request + * Show company manager user * - * Updates a work authorization request. + * Shows a single company manager user * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | + * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | * */ -export const patchV1WorkAuthorizationRequestsId2 = < +export const getV1CompanyManagersUserId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).patch< - PatchV1WorkAuthorizationRequestsId2Responses, - PatchV1WorkAuthorizationRequestsId2Errors, + (options.client ?? client).get< + GetV1CompanyManagersUserIdResponses, + GetV1CompanyManagersUserIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/company-managers/{user_id}', ...options }); /** - * Update work authorization request + * Show onboarding steps for an employment * - * Updates a work authorization request. + * Returns onboarding steps and substeps in a hierarchical, ordered structure. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const patchV1WorkAuthorizationRequestsId = < +export const getV1EmploymentsEmploymentIdOnboardingSteps = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1EmploymentsEmploymentIdOnboardingStepsData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PatchV1WorkAuthorizationRequestsIdResponses, - PatchV1WorkAuthorizationRequestsIdErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdOnboardingStepsResponses, + GetV1EmploymentsEmploymentIdOnboardingStepsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests/{id}', + url: '/api/eor/v1/employments/{employment_id}/onboarding-steps', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Update federal taxes - * - * Updates employment's federal taxes. + * Automatable Contract Amendment * - * Requirements to update federal taxes successfully: - * * Employment should be Global Payroll - * * Employment should be in the post-enrollment state - * * Employment should belong to USA + * Check if a contract amendment request is automatable. + * If the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract + * and send them an updated document. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * see the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category. * * Please note that the compliance requirements for each country are subject to change according to local * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid @@ -3092,24 +2826,20 @@ export const patchV1WorkAuthorizationRequestsId = < * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | * */ -export const putV2EmploymentsEmploymentIdFederalTaxes = < +export const postV1ContractAmendmentsAutomatable = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).put< - PutV2EmploymentsEmploymentIdFederalTaxesResponses, - PutV2EmploymentsEmploymentIdFederalTaxesErrors, + (options.client ?? client).post< + PostV1ContractAmendmentsAutomatableResponses, + PostV1ContractAmendmentsAutomatableErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/federal-taxes', + url: '/api/eor/v1/contract-amendments/automatable', ...options, headers: { 'Content-Type': 'application/json', @@ -3118,30 +2848,70 @@ export const putV2EmploymentsEmploymentIdFederalTaxes = < }); /** - * Create Probation Extension + * List Company Payroll Runs * - * Create a probation extension request. + * Lists all payroll runs for a company * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | + * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | * */ -export const postV1ProbationExtensions = ( - options: Options, +export const getV1PayrollRuns = ( + options?: Options, ) => - (options.client ?? client).post< - PostV1ProbationExtensionsResponses, - PostV1ProbationExtensionsErrors, + (options?.client ?? client).get< + GetV1PayrollRunsResponses, + GetV1PayrollRunsErrors, + ThrowOnError + >({ url: '/api/eor/v1/payroll-runs', ...options }); + +/** + * List incentives for the authenticated employee + * + * Returns all incentives for the authenticated employee. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * + */ +export const getV1EmployeeIncentives = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1EmployeeIncentivesResponses, + GetV1EmployeeIncentivesErrors, + ThrowOnError + >({ url: '/api/eor/v1/employee/incentives', ...options }); + +/** + * Update employment + * + * Updates an employment. Use this endpoint to: + * - modify employment states for testing + * - Backdate employment start dates + * + * This endpoint will respond with a 404 outside of the Sandbox environment. + * + * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). + * + */ +export const patchV1SandboxEmploymentsEmploymentId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).patch< + PatchV1SandboxEmploymentsEmploymentId2Responses, + PatchV1SandboxEmploymentsEmploymentId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-extensions', + url: '/api/eor/v1/sandbox/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -3150,64 +2920,71 @@ export const postV1ProbationExtensions = ( }); /** - * Update billing address details - * - * Updates employment's billing address details. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * Update employment * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * Updates an employment. Use this endpoint to: + * - modify employment states for testing + * - Backdate employment start dates * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * This endpoint will respond with a 404 outside of the Sandbox environment. * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + */ +export const patchV1SandboxEmploymentsEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).put< + PatchV1SandboxEmploymentsEmploymentIdResponses, + PatchV1SandboxEmploymentsEmploymentIdErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/employments/{employment_id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Show benefit renewal request schema * + * Returns the json schema of the `benefit_renewal_request` form for a specific request. + * This endpoint requires a company access token, as forms are dependent on certain + * properties of companies and their current employments. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | * */ -export const putV2EmploymentsEmploymentIdBillingAddressDetails = < +export const getV1BenefitRenewalRequestsBenefitRenewalRequestIdSchema = < ThrowOnError extends boolean = false, >( options: Options< - PutV2EmploymentsEmploymentIdBillingAddressDetailsData, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData, ThrowOnError >, ) => - (options.client ?? client).put< - PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses, - PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors, + (options.client ?? client).get< + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses, + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/billing_address_details', + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Update address details + * Update billing address details * - * Updates employment's address details. + * Updates employment's billing address details. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -3234,24 +3011,20 @@ export const putV2EmploymentsEmploymentIdBillingAddressDetails = < * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const putV2EmploymentsEmploymentIdAddressDetails = < +export const putV2EmploymentsEmploymentIdBillingAddressDetails = < ThrowOnError extends boolean = false, >( options: Options< - PutV2EmploymentsEmploymentIdAddressDetailsData, + PutV2EmploymentsEmploymentIdBillingAddressDetailsData, ThrowOnError >, ) => (options.client ?? client).put< - PutV2EmploymentsEmploymentIdAddressDetailsResponses, - PutV2EmploymentsEmploymentIdAddressDetailsErrors, + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses, + PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/address_details', + url: '/api/eor/v2/employments/{employment_id}/billing_address_details', ...options, headers: { 'Content-Type': 'application/json', @@ -3260,146 +3033,122 @@ export const putV2EmploymentsEmploymentIdAddressDetails = < }); /** - * Create risk reserve + * Delete an Incentive + * + * Delete an incentive. + * + * `one_time` incentives that have the following status **CANNOT** be deleted: + * * `processing` + * * `paid` * - * Create a new risk reserve * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const postV1RiskReserve = ( - options: Options, +export const deleteV1IncentivesId = ( + options: Options, ) => - (options.client ?? client).post< - PostV1RiskReserveResponses, - PostV1RiskReserveErrors, + (options.client ?? client).delete< + DeleteV1IncentivesIdResponses, + DeleteV1IncentivesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/risk-reserve', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/incentives/{id}', ...options }); /** - * Submit risk reserve proof of payment - * - * Submits a proof of payment document for a risk reserve associated with an employment. - * - * Triggers an `employment.cor_hiring.proof_of_payment_submitted` webhook event. + * Show Incentive * + * Show an Incentive's details * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | + * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | * */ -export const postV1EmploymentsEmploymentIdRiskReserveProofOfPayments = < - ThrowOnError extends boolean = false, ->( - options: Options< - PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData, - ThrowOnError - >, +export const getV1IncentivesId = ( + options: Options, ) => - (options.client ?? client).post< - PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses, - PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors, + (options.client ?? client).get< + GetV1IncentivesIdResponses, + GetV1IncentivesIdErrors, ThrowOnError - >({ - ...formDataBodySerializer, - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/risk-reserve-proof-of-payments', - ...options, - headers: { - 'Content-Type': null, - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/incentives/{id}', ...options }); /** - * Get Company Compliance Profile + * Update Incentive * - * Returns the KYB and credit risk status for the company's default legal entity. + * Updates an Incentive. + * + * Incentives use the currency of the employment specified provided in the `employment_id` field. + * + * The API doesn't support updating paid incentives. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const getV1CompaniesCompanyIdComplianceProfile = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const patchV1IncentivesId2 = ( + options: Options, ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdComplianceProfileResponses, - GetV1CompaniesCompanyIdComplianceProfileErrors, + (options.client ?? client).patch< + PatchV1IncentivesId2Responses, + PatchV1IncentivesId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/compliance-profile', + url: '/api/eor/v1/incentives/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show product prices in the company's desired currency + * Update Incentive * - * list product prices in the company's desired currency. - * the endpoint currently only returns the product prices for the EOR monthly product and the contractor products (Standard, Plus and COR). - * the product prices are then used to create a pricing plan for the company. + * Updates an Incentive. + * + * Incentives use the currency of the employment specified provided in the `employment_id` field. + * + * The API doesn't support updating paid incentives. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | + * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | * */ -export const getV1CompaniesCompanyIdProductPrices = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const patchV1IncentivesId = ( + options: Options, ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdProductPricesResponses, - GetV1CompaniesCompanyIdProductPricesErrors, + (options.client ?? client).put< + PatchV1IncentivesIdResponses, + PatchV1IncentivesIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}/product-prices', + url: '/api/eor/v1/incentives/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show a company - * - * Given an ID, shows a company. + * Show Legal Entity Administrative details * - * If the used access token was issued by the OAuth 2.0 Authorization Code flow, - * then only the associated company can be accessed through the endpoint. + * Show administrative details of legal entity for the authorized company specified in the request. * * * ## Scopes @@ -3409,42 +3158,26 @@ export const getV1CompaniesCompanyIdProductPrices = < * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getV1CompaniesCompanyId = ( - options: Options, -) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdResponses, - GetV1CompaniesCompanyIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}', - ...options, - }); +export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails = + ( + options: Options< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + ...options, + }); /** - * Update a company - * - * Given an ID and a request object with new information, updates a company. - * - * ### Getting a company and its owner to `active` status - * If you created a company using the - * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required - * request body parameters, you can use this endpoint to provide the missing data. Once the company - * and its owner have all the necessary data, both their statuses will be set to `active` and the company - * onboarding will be marked as "completed". + * Update Legal Entity Administrative details * - * The following constitutes a company with "all the necessary data": - * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the - * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters - * are required). - * * Company `tax_number` or `registration_number` is not nil - * * Company `name` is not nil (already required when creating the company) - * * Company has a `desired_currency` in their bank account (already required when creating the company) - * * Company has accepted terms of service (already required when creating the company) + * Update administrative details of legal entity for the authorized company specified in the request. * * * ## Scopes @@ -3454,64 +3187,70 @@ export const getV1CompaniesCompanyId = ( * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | * */ -export const patchV1CompaniesCompanyId2 = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).patch< - PatchV1CompaniesCompanyId2Responses, - PatchV1CompaniesCompanyId2Errors, - ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); +export const putV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails = + ( + options: Options< + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, + ThrowOnError + >, + ) => + (options.client ?? client).put< + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); /** - * Update a company + * Update bank account details * - * Given an ID and a request object with new information, updates a company. + * Updates employment's bank account details. * - * ### Getting a company and its owner to `active` status - * If you created a company using the - * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required - * request body parameters, you can use this endpoint to provide the missing data. Once the company - * and its owner have all the necessary data, both their statuses will be set to `active` and the company - * onboarding will be marked as "completed". + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * - * The following constitutes a company with "all the necessary data": - * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the - * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters - * are required). - * * Company `tax_number` or `registration_number` is not nil - * * Company `name` is not nil (already required when creating the company) - * * Company has a `desired_currency` in their bank account (already required when creating the company) - * * Company has accepted terms of service (already required when creating the company) * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const patchV1CompaniesCompanyId = ( - options: Options, +export const putV2EmploymentsEmploymentIdBankAccountDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdBankAccountDetailsData, + ThrowOnError + >, ) => (options.client ?? client).put< - PatchV1CompaniesCompanyIdResponses, - PatchV1CompaniesCompanyIdErrors, + PutV2EmploymentsEmploymentIdBankAccountDetailsResponses, + PutV2EmploymentsEmploymentIdBankAccountDetailsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}', + url: '/api/eor/v2/employments/{employment_id}/bank_account_details', ...options, headers: { 'Content-Type': 'application/json', @@ -3520,297 +3259,209 @@ export const patchV1CompaniesCompanyId = ( }); /** - * Download a resignation letter + * List Contractor Invoices * - * Downloads a resignation letter from an employment request. + * Lists Contractor Invoice records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View resignation letters (`resignation_letter:read`) | - | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const getV1ResignationsOffboardingRequestIdResignationLetter = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV1ResignationsOffboardingRequestIdResignationLetterData, - ThrowOnError - >, +export const getV1ContractorInvoices = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1ResignationsOffboardingRequestIdResignationLetterResponses, - GetV1ResignationsOffboardingRequestIdResignationLetterErrors, + (options?.client ?? client).get< + GetV1ContractorInvoicesResponses, + GetV1ContractorInvoicesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/resignations/{offboarding_request_id}/resignation-letter', - ...options, - }); + >({ url: '/api/eor/v1/contractor-invoices', ...options }); /** - * Update federal taxes - * - * Updates employment's federal taxes. - * - * Requirements to update federal taxes successfully: - * * Employment should be Global Payroll - * * Employment should be in the post-enrollment state - * * Employment should belong to USA - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * List expense categories * + * Lists the effective hierarchy of expense categories. At least one of employment_id, expense_id, or country_code must be provided. */ -export const putV1EmploymentsEmploymentIdFederalTaxes = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1ExpensesCategories = ( + options?: Options, ) => - (options.client ?? client).put< - PutV1EmploymentsEmploymentIdFederalTaxesResponses, - PutV1EmploymentsEmploymentIdFederalTaxesErrors, + (options?.client ?? client).get< + GetV1ExpensesCategoriesResponses, + GetV1ExpensesCategoriesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/federal-taxes', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/expenses/categories', ...options }); /** - * List Contract Amendment + * List contract documents for an employment * - * List Contract Amendment requests. + * Only contractor employment types are supported. Lists contract documents for a specific employment with pagination, filtering by status, and sorted by updated_at descending (latest first). * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const getV1ContractAmendments = ( - options: Options, +export const getV1EmploymentsEmploymentIdContractDocuments = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentsEmploymentIdContractDocumentsData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetV1ContractAmendmentsResponses, - GetV1ContractAmendmentsErrors, + GetV1EmploymentsEmploymentIdContractDocumentsResponses, + GetV1EmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments', + url: '/api/eor/v1/employments/{employment_id}/contract-documents', ...options, }); /** - * Create Contract Amendment - * - * Creates a Contract Amendment request. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * + * Show contractor contract details * + * Returns the contract details JSON Schema for contractors given a country * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const postV1ContractAmendments = ( - options: Options, +export const getV1CountriesCountryCodeContractorContractDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1CountriesCountryCodeContractorContractDetailsData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostV1ContractAmendmentsResponses, - PostV1ContractAmendmentsErrors, + (options.client ?? client).get< + GetV1CountriesCountryCodeContractorContractDetailsResponses, + GetV1CountriesCountryCodeContractorContractDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments', + url: '/api/eor/v1/countries/{country_code}/contractor-contract-details', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Show Company Payroll Runs - * - * Given an ID, shows a payroll run. - * `employee_details` field is deprecated in favour of the `employee_details` endpoint and will be removed in the future. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | + * Get user by ID via SCIM v2.0 * + * Retrieves a single user for the authenticated company by user ID */ -export const getV1PayrollRunsPayrollRunId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1ScimV2UsersId = ( + options: Options, ) => (options.client ?? client).get< - GetV1PayrollRunsPayrollRunIdResponses, - GetV1PayrollRunsPayrollRunIdErrors, + GetV1ScimV2UsersIdResponses, + GetV1ScimV2UsersIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-runs/{payroll_run_id}', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Users/{id}', ...options, }); /** - * Download a receipt + * List employment files * - * Downloads an expense receipt. + * Lists files associated with a specific employment. * - * Deprecated since late February 2024 in favour of **[Download a receipt by id](#tag/Expenses/operation/get_download_by_id_expense_receipt)** endpoint. + * Supports filtering by file type and sub_type. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | - * + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * - * @deprecated */ -export const getV1ExpensesExpenseIdReceipt = < +export const getV1EmploymentsEmploymentIdFiles = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1ExpensesExpenseIdReceiptResponses, - GetV1ExpensesExpenseIdReceiptErrors, + GetV1EmploymentsEmploymentIdFilesResponses, + GetV1EmploymentsEmploymentIdFilesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{expense_id}/receipt', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}/files', ...options }); /** - * Show travel letter request + * Manage contractor plus subscription + * + * Endpoint that can be used to upgrade, assign or downgrade a contractor's subscription. + * This can be used when company admins desire to assign someone to the Contractor Plus plan, + * but also to change the contractor's subscription between Plus and Standard. * - * Show a single travel letter request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | - | View travel letters (`travel_letter:read`) | - | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1TravelLetterRequestsId = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetV1TravelLetterRequestsIdResponses, - GetV1TravelLetterRequestsIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests/{id}', - ...options, - }); +export const postV1ContractorsEmploymentsEmploymentIdContractorPlusSubscription = + ( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-plus-subscription', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); /** - * Updates a travel letter request + * Submit eligibility questionnaire + * + * Submits an eligibility questionnaire for a contractor employment. + * + * The questionnaire determines if the contractor is eligible for certain products or features. + * The responses are validated against the JSON schema for the questionnaire type. + * + * **Requirements:** + * - Employment must be of type `contractor` + * - Employment must be in `created` status + * - Responses must conform to the questionnaire JSON schema * - * Updates a travel letter request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | - | - | Manage travel letters (`travel_letter:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const patchV1TravelLetterRequestsId2 = < +export const postV1ContractorsEligibilityQuestionnaire = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).patch< - PatchV1TravelLetterRequestsId2Responses, - PatchV1TravelLetterRequestsId2Errors, + (options.client ?? client).post< + PostV1ContractorsEligibilityQuestionnaireResponses, + PostV1ContractorsEligibilityQuestionnaireErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests/{id}', + url: '/api/eor/v1/contractors/eligibility-questionnaire', ...options, headers: { 'Content-Type': 'application/json', @@ -3819,80 +3470,11 @@ export const patchV1TravelLetterRequestsId2 = < }); /** - * Updates a travel letter request - * - * Updates a travel letter request + * Update basic information * - * ## Scopes + * Updates employment's basic information. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | - | - | Manage travel letters (`travel_letter:write`) | - * - */ -export const patchV1TravelLetterRequestsId = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).put< - PatchV1TravelLetterRequestsIdResponses, - PatchV1TravelLetterRequestsIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); - -/** - * Show Time Off Balance - * - * Shows the time off balance for the given employment_id. - * - * Deprecated since February 2025 in favour of **[List Leave Policies Summary](#tag/Leave-Policies/operation/get_index_leave_policies_summary)** endpoint. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | - * - * - * @deprecated - */ -export const getV1TimeoffBalancesEmploymentId = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetV1TimeoffBalancesEmploymentIdResponses, - GetV1TimeoffBalancesEmploymentIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff-balances/{employment_id}', - ...options, - }); - -/** - * Update basic information - * - * Updates employment's basic information. - * - * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. + * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -3932,11 +3514,7 @@ export const putV1EmploymentsEmploymentIdBasicInformation = < PutV1EmploymentsEmploymentIdBasicInformationErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/basic_information', + url: '/api/eor/v1/employments/{employment_id}/basic_information', ...options, headers: { 'Content-Type': 'application/json', @@ -3945,26 +3523,130 @@ export const putV1EmploymentsEmploymentIdBasicInformation = < }); /** - * List expense categories + * Show a contractor of record (COR) termination request + * + * Retrieves a Contractor of Record termination request by ID. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * - * Lists the effective hierarchy of expense categories. At least one of employment_id, expense_id, or country_code must be provided. */ -export const getV1ExpensesCategories = ( - options?: Options, +export const getV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestId = + ( + options: Options< + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses, + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}', + ...options, + }); + +/** + * Create a legal entity + * + * Create a new legal entity for a company in a given country, with KYB automatically passed. + * + * The entity is created with active status and can be set as the company's default + * using the reassign default entity endpoint. + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * + */ +export const postV1SandboxCompaniesCompanyIdLegalEntities = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1SandboxCompaniesCompanyIdLegalEntitiesData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetV1ExpensesCategoriesResponses, - GetV1ExpensesCategoriesErrors, + (options.client ?? client).post< + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses, + PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/companies/{company_id}/legal-entities', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Payroll processing details data API resource + * + * API to retrieve the run details of a pay group + */ +export const getV1WdGphPayDetailData = ( + options: Options, +) => + (options.client ?? client).get< + GetV1WdGphPayDetailDataResponses, + GetV1WdGphPayDetailDataErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/categories', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payDetailData', ...options, }); +/** + * Show region fields + * + * Returns required fields JSON Schema for a given region. These are required in order to calculate + * the cost of employment for the region. These fields are based on employer contributions that are associated + * with the region or any of it's parent regions. + */ +export const getV1CostCalculatorRegionsSlugFields = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1CostCalculatorRegionsSlugFieldsResponses, + GetV1CostCalculatorRegionsSlugFieldsErrors, + ThrowOnError + >({ url: '/api/eor/v1/cost-calculator/regions/{slug}/fields', ...options }); + +/** + * Cancel onboarding + * + * Cancel onboarding. + * + * Requirements for the cancellation to succeed: + * + * * Employment has to be in `invited`, `created`, `created_awaiting_reserve`, `created_reserve_paid`, `pre_hire` status + * * Employee must not have signed the employment contract + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage onboarding (`onboarding:write`) | + * + */ +export const postV1CancelOnboardingEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).post< + PostV1CancelOnboardingEmploymentIdResponses, + PostV1CancelOnboardingEmploymentIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/cancel-onboarding/{employment_id}', ...options }); + /** * Cancel Time Off as Employee * @@ -3987,8 +3669,7 @@ export const postV1EmployeeTimeoffIdCancel = < PostV1EmployeeTimeoffIdCancelErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff/{id}/cancel', + url: '/api/eor/v1/employee/timeoff/{id}/cancel', ...options, headers: { 'Content-Type': 'application/json', @@ -3997,172 +3678,142 @@ export const postV1EmployeeTimeoffIdCancel = < }); /** - * Show form schema - * - * Returns the json schema of a supported form. Possible form names are: - * ``` - * - address_details - * - administrative_details - * - bank_account_details - * - employment_basic_information - * - contractor_basic_information - * - contractor_contract_details - * - billing_address_details - * - contract_details - * - emergency_contact - * - emergency_contact_details - * - employment_document_details - * - personal_details - * - pricing_plan_details - * - company_basic_information - * - global_payroll_administrative_details - * - global_payroll_basic_information - * - global_payroll_contract_details - * - global_payroll_federal_taxes - * - global_payroll_personal_details - * - benefit_renewal_request - * - hris_personal_details - * - * ``` + * Download a receipt * - * Most forms require a company access token, as they are dependent on certain - * properties of companies and their current employments. However, the `address_details` - * and `company_basic_information` forms can be accessed using client_credentials - * authentication (without a company). + * Downloads an expense receipt. * + * Deprecated since late February 2024 in favour of **[Download a receipt by id](#tag/Expenses/operation/get_download_by_id_expense_receipt)** endpoint. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * + * + * @deprecated */ -export const getV1CountriesCountryCodeForm = < +export const getV1ExpensesExpenseIdReceipt = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1CountriesCountryCodeFormResponses, - GetV1CountriesCountryCodeFormErrors, + GetV1ExpensesExpenseIdReceiptResponses, + GetV1ExpensesExpenseIdReceiptErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/{form}', - ...options, - }); + >({ url: '/api/eor/v1/expenses/{expense_id}/receipt', ...options }); /** - * Download file + * List Benefit Offers * - * Downloads a file. + * List benefit offers for each country. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const getV1FilesId = ( - options: Options, +export const getV1BenefitOffersCountrySummaries = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetV1FilesIdResponses, - GetV1FilesIdErrors, + GetV1BenefitOffersCountrySummariesResponses, + GetV1BenefitOffersCountrySummariesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/files/{id}', - ...options, - }); + >({ url: '/api/eor/v1/benefit-offers/country-summaries', ...options }); /** - * Show Contract Amendment + * List Leave Policies Details * - * Show a single Contract Amendment request. + * Describe the leave policies (custom or not) for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getV1ContractAmendmentsId = ( - options: Options, +export const getV1LeavePoliciesDetailsEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).get< - GetV1ContractAmendmentsIdResponses, - GetV1ContractAmendmentsIdErrors, + GetV1LeavePoliciesDetailsEmploymentIdResponses, + GetV1LeavePoliciesDetailsEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments/{id}', - ...options, - }); + >({ url: '/api/eor/v1/leave-policies/details/{employment_id}', ...options }); /** - * Update bank account details - * - * Updates employment's bank account details. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * List work authorization requests * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * List work authorization requests. * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * ## Scopes * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | * + */ +export const getV1WorkAuthorizationRequests = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).get< + GetV1WorkAuthorizationRequestsResponses, + GetV1WorkAuthorizationRequestsErrors, + ThrowOnError + >({ url: '/api/eor/v1/work-authorization-requests', ...options }); + +/** + * Get employment benefit offers * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const putV2EmploymentsEmploymentIdBankAccountDetails = < +export const getV1EmploymentsEmploymentIdBenefitOffers = < ThrowOnError extends boolean = false, >( - options: Options< - PutV2EmploymentsEmploymentIdBankAccountDetailsData, + options: Options, +) => + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdBenefitOffersResponses, + GetV1EmploymentsEmploymentIdBenefitOffersErrors, ThrowOnError - >, + >({ + url: '/api/eor/v1/employments/{employment_id}/benefit-offers', + ...options, + }); + +/** + * Upserts employment benefit offers + */ +export const putV1EmploymentsEmploymentIdBenefitOffers = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).put< - PutV2EmploymentsEmploymentIdBankAccountDetailsResponses, - PutV2EmploymentsEmploymentIdBankAccountDetailsErrors, + PutV1EmploymentsEmploymentIdBenefitOffersResponses, + PutV1EmploymentsEmploymentIdBenefitOffersErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/bank_account_details', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/employments/{employment_id}/benefit-offers', ...options, headers: { 'Content-Type': 'application/json', @@ -4171,60 +3822,89 @@ export const putV2EmploymentsEmploymentIdBankAccountDetails = < }); /** - * List Company Managers + * List employments * - * List all company managers of an integration. If filtered by the company_id param, - * it lists only company managers belonging to the specified company. + * Lists all employments, except for the deleted ones. * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * - * ## Scopes + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | * */ -export const getV1CompanyManagers = ( - options: Options, +export const getV1Employments = ( + options: Options, ) => (options.client ?? client).get< - GetV1CompanyManagersResponses, - GetV1CompanyManagersErrors, + GetV1EmploymentsResponses, + GetV1EmploymentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/employments', ...options, }); /** - * Create and invite a Company Manager + * Create employment + * + * Creates an employment. We support creating employees and contractors. + * + * ## Global Payroll Employees + * + * To create a Global Payroll employee, pass `global_payroll_employee` as the `type` parameter, + * and provide the slug of the specific legal entity that the employee will be engaged by and billed to as the `engaged_by_entity_slug` parameter. + * + * ## HRIS Employees + * + * To create a HRIS employee, pass `hris` as the `type` parameter. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * * - * Create a Company Manager and sends the invitation email for signing in to the Remote Platform. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1CompanyManagers = ( - options: Options, +export const postV1Employments = ( + options: Options, ) => (options.client ?? client).post< - PostV1CompanyManagersResponses, - PostV1CompanyManagersErrors, + PostV1EmploymentsResponses, + PostV1EmploymentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers', + url: '/api/eor/v1/employments', ...options, headers: { 'Content-Type': 'application/json', @@ -4233,261 +3913,203 @@ export const postV1CompanyManagers = ( }); /** - * List countries for Cost Calculator + * Show Time Off + * + * Shows a single Time Off record + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * - * Lists active and processing countries */ -export const getV1CostCalculatorCountries = < - ThrowOnError extends boolean = false, ->( - options?: Options, +export const getV1TimeoffId = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1CostCalculatorCountriesResponses, - unknown, + (options.client ?? client).get< + GetV1TimeoffIdResponses, + GetV1TimeoffIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/countries', - ...options, - }); + >({ url: '/api/eor/v1/timeoff/{id}', ...options }); /** - * Decline Identity Verification + * Update Time Off * - * Declines the identity verification of an employee. + * Updates a Time Off record. + * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. + * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postV1IdentityVerificationEmploymentIdDecline = < - ThrowOnError extends boolean = false, ->( - options: Options< - PostV1IdentityVerificationEmploymentIdDeclineData, - ThrowOnError - >, +export const patchV1TimeoffId2 = ( + options: Options, ) => - (options.client ?? client).post< - PostV1IdentityVerificationEmploymentIdDeclineResponses, - PostV1IdentityVerificationEmploymentIdDeclineErrors, + (options.client ?? client).patch< + PatchV1TimeoffId2Responses, + PatchV1TimeoffId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity-verification/{employment_id}/decline', + url: '/api/eor/v1/timeoff/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show engagement agreement details + * Update Time Off * - * Returns the engagement agreement details JSON Schema for a country. Only DEU country is supported for now. + * Updates a Time Off record. + * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. + * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getV1CountriesCountryCodeEngagementAgreementDetails = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV1CountriesCountryCodeEngagementAgreementDetailsData, - ThrowOnError - >, +export const patchV1TimeoffId = ( + options: Options, ) => - (options.client ?? client).get< - GetV1CountriesCountryCodeEngagementAgreementDetailsResponses, - GetV1CountriesCountryCodeEngagementAgreementDetailsErrors, + (options.client ?? client).put< + PatchV1TimeoffIdResponses, + PatchV1TimeoffIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/engagement-agreement-details', + url: '/api/eor/v1/timeoff/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Billing Documents - * - * List billing documents for a company + * Get token identity * - * ## Scopes + * Shows information about the entities that can be controlled by the current auth token. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + */ +export const getV1IdentityCurrent = ( + options: Options, +) => + (options.client ?? client).get< + GetV1IdentityCurrentResponses, + GetV1IdentityCurrentErrors, + ThrowOnError + >({ url: '/api/eor/v1/identity/current', ...options }); + +/** + * Payroll Variance Analysis API resource * + * API to retrieve the variance analysis data of a pay group */ -export const getV1BillingDocuments = ( - options: Options, +export const getV1WdGphPayVariance = ( + options: Options, ) => (options.client ?? client).get< - GetV1BillingDocumentsResponses, - GetV1BillingDocumentsErrors, + GetV1WdGphPayVarianceResponses, + GetV1WdGphPayVarianceErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payVariance', ...options, }); /** - * Delete a Webhook Callback + * List Company Payroll Calendar * - * Delete a callback previously registered for webhooks + * List all payroll calendars for the company within the requested cycle. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | * */ -export const deleteV1WebhookCallbacksId = < +export const getV1PayrollCalendarsCycle = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).delete< - DeleteV1WebhookCallbacksIdResponses, - DeleteV1WebhookCallbacksIdErrors, + (options.client ?? client).get< + GetV1PayrollCalendarsCycleResponses, + GetV1PayrollCalendarsCycleErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/webhook-callbacks/{id}', - ...options, - }); + >({ url: '/api/eor/v1/payroll-calendars/{cycle}', ...options }); /** - * Update a Webhook Callback - * - * Update a callback previously registered for webhooks - * - * ## Scopes + * Terminate contractor of record employment * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * **Deprecated.** Use `POST /contractors/employments/{employment_id}/cor-termination-requests` instead. * - */ -export const patchV1WebhookCallbacksId = ( - options: Options, -) => - (options.client ?? client).patch< - PatchV1WebhookCallbacksIdResponses, - PatchV1WebhookCallbacksIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/webhook-callbacks/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); - -/** - * List timesheets for the authenticated employee + * Initiates a termination request for a Contractor of Record employment. + * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. + * Currently, only Contractor of Record employments can be terminated. * - * Returns a paginated list of timesheets for the authenticated employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * * + * @deprecated */ -export const getV1EmployeeTimesheets = ( - options?: Options, +export const postV1ContractorsEmploymentsEmploymentIdTerminateCorEmployment = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetV1EmployeeTimesheetsResponses, - GetV1EmployeeTimesheetsErrors, + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses, + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timesheets', + url: '/api/eor/v1/contractors/employments/{employment_id}/terminate-cor-employment', ...options, }); /** - * Update personal details - * - * Updates employment's personal details. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. - * + * Send back a timesheet for review or modification * + * Sends the given timesheet back to the employee for review or modification. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | * */ -export const putV1EmploymentsEmploymentIdPersonalDetails = < +export const postV1TimesheetsTimesheetIdSendBack = < ThrowOnError extends boolean = false, >( - options: Options< - PutV1EmploymentsEmploymentIdPersonalDetailsData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).put< - PutV1EmploymentsEmploymentIdPersonalDetailsResponses, - PutV1EmploymentsEmploymentIdPersonalDetailsErrors, + (options.client ?? client).post< + PostV1TimesheetsTimesheetIdSendBackResponses, + PostV1TimesheetsTimesheetIdSendBackErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/personal_details', + url: '/api/eor/v1/timesheets/{timesheet_id}/send-back', ...options, headers: { 'Content-Type': 'application/json', @@ -4496,32 +4118,38 @@ export const putV1EmploymentsEmploymentIdPersonalDetails = < }); /** - * List travel letter requests + * Sign a pre-onboarding document + * + * Signs the latest contract document associated with the given pre-onboarding document on behalf + * of the company signatory. * - * List travel letter requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | - | View travel letters (`travel_letter:read`) | - | + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const getV1TravelLetterRequests = ( - options?: Options, -) => - (options?.client ?? client).get< - GetV1TravelLetterRequestsResponses, - GetV1TravelLetterRequestsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/travel-letter-requests', - ...options, - }); +export const postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSign = + ( + options: Options< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, + ThrowOnError + >({ + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); /** * List Benefit Renewal Requests @@ -4544,219 +4172,207 @@ export const getV1BenefitRenewalRequests = < GetV1BenefitRenewalRequestsResponses, GetV1BenefitRenewalRequestsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests', - ...options, - }); + >({ url: '/api/eor/v1/benefit-renewal-requests', ...options }); /** - * Create a Webhook Callback - * - * Register a callback to be used for webhooks + * Reassign default legal entity * - * ## Scopes + * Set a different legal entity as the company's default entity. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | + * The default entity is used when creating new employments without an explicit entity. + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const postV1WebhookCallbacks = ( - options: Options, +export const putV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityId = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostV1WebhookCallbacksResponses, - PostV1WebhookCallbacksErrors, + (options.client ?? client).put< + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses, + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/webhook-callbacks', + url: '/api/eor/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Approve timesheet + * List Employment Contract. * - * Approves the given timesheet. + * Get the employment contract history for a given employment. If `only_active` is true, it will return only the active or last active contract. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | + * | Manage employments (`employments`) | View contracts (`contract:read`) | - | * */ -export const postV1TimesheetsTimesheetIdApprove = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmploymentContracts = ( + options: Options, ) => - (options.client ?? client).post< - PostV1TimesheetsTimesheetIdApproveResponses, - PostV1TimesheetsTimesheetIdApproveErrors, + (options.client ?? client).get< + GetV1EmploymentContractsResponses, + GetV1EmploymentContractsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets/{timesheet_id}/approve', - ...options, - }); + >({ url: '/api/eor/v1/employment-contracts', ...options }); /** - * Show payslip - * - * Given an ID, shows a payslip. - * - * Please contact api-support@remote.com to request access to this endpoint. - * + * Cancel Contract Amendment * - * ## Scopes + * Use this endpoint to cancel an existing contract amendment request. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const getV1PayslipsId = ( - options: Options, +export const putV1SandboxContractAmendmentsContractAmendmentRequestIdCancel = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetV1PayslipsIdResponses, - GetV1PayslipsIdErrors, + (options.client ?? client).put< + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payslips/{id}', + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel', ...options, }); /** - * List Leave Policies Summary + * Download payslip in the PDF format + * + * Given a Payslip ID, downloads a payslip. + * It is important to note that each country has a different payslip format and they are not authored by Remote. * - * List all the data related to time off for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const getV1LeavePoliciesSummaryEmploymentId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1PayslipsPayslipIdPdf = ( + options: Options, ) => (options.client ?? client).get< - GetV1LeavePoliciesSummaryEmploymentIdResponses, - GetV1LeavePoliciesSummaryEmploymentIdErrors, + GetV1PayslipsPayslipIdPdfResponses, + GetV1PayslipsPayslipIdPdfErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/leave-policies/summary/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/payslips/{payslip_id}/pdf', ...options }); /** - * List expense categories for the authenticated employee + * Approve Time Off * - * Returns the flat list of expense categories applicable to the current employee. Only active categories are returned, filtered by the employee's country / legal-entity visibility rules. Leaf nodes have `is_selectable: true`; parent nodes are excluded unless `include_parents=true`. + * Approve a time off request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getV1EmployeeExpenseCategories = < +export const postV1TimeoffTimeoffIdApprove = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options, ) => - (options?.client ?? client).get< - GetV1EmployeeExpenseCategoriesResponses, - GetV1EmployeeExpenseCategoriesErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdApproveResponses, + PostV1TimeoffTimeoffIdApproveErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/expense-categories', + url: '/api/eor/v1/timeoff/{timeoff_id}/approve', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Company Departments - * - * Lists all departments for the authorized company specified in the request. + * List all companies * + * List all companies that authorized your integration to act on their behalf. In other words, these are all the companies that your integration can manage. Any company that has completed the authorization flow for your integration will be included in the response. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View departments (`company_department:read`) | Manage departments (`company_department:write`) | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getV1CompanyDepartments = ( - options: Options, +export const getV1Companies = ( + options: Options, ) => (options.client ?? client).get< - GetV1CompanyDepartmentsResponses, - GetV1CompanyDepartmentsErrors, + GetV1CompaniesResponses, + GetV1CompaniesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-departments', - ...options, - }); + >({ url: '/api/eor/v1/companies', ...options }); /** - * Create New Department + * Create a company + * + * Creates a new company. + * + * ### Creating a company with only the required request body parameters + * When you call this endpoint and omit all the optional parameters in the request body, + * the following resources get created upon a successful response: + * * A new company with status `pending`. + * * A company owner for the new company with status `initiated`. + * + * See the [update a company endpoint](#tag/Companies/operation/patch_update_company) for + * more details on how to get your company and its owner to `active` status. + * + * If you'd like to create a company and its owner with `active` status in a single request, + * please provide the optional `address_details` parameter as well. + * + * ### Accepting the Terms of Service + * + * A required step for creating a company in Remote is to accept our Terms of Service (ToS). + * + * Company managers need to be aware of our Terms of Service and Privacy Policy, + * hence **it's the responsibility of our partners to advise and ensure company managers read + * and accept the ToS**. The terms have to be accepted only once, before creating a company, + * and the Remote API will collect the acceptance timestamp as its confirmation. + * + * To ensure users read the most recent version of Remote's Terms of Service, their **acceptance + * must be done within the last fifteen minutes prior the company creation action**. + * + * To retrieve this information, partners can provide an element with any text and a description + * explaining that by performing that action they are accepting Remote's Term of Service. For + * instance, the partner can add a checkbox or a "Create Remote Account" button followed by a + * description saying "By creating an account, you agree to + * [Remote's Terms of Service](https://remote.com/terms-of-service). Also see Remote's + * [Privacy Policy](https://remote.com/privacy-policy)". * - * Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points). * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage departments (`company_department:write`) | + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | * */ -export const postV1CompanyDepartments = ( - options: Options, +export const postV1Companies = ( + options: Options, ) => (options.client ?? client).post< - PostV1CompanyDepartmentsResponses, - PostV1CompanyDepartmentsErrors, + PostV1CompaniesResponses, + PostV1CompaniesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-departments', + url: '/api/eor/v1/companies', ...options, headers: { 'Content-Type': 'application/json', @@ -4765,36 +4381,50 @@ export const postV1CompanyDepartments = ( }); /** - * Decline a time off cancellation request + * List company structure nodes * - * Decline a time off cancellation request. + * Shows all the company structure nodes of an employment. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage company resources (`company_admin`) | View company structure (`company_structure:read`) | - | * */ -export const postV1TimeoffTimeoffIdCancelRequestDecline = < +export const getV1EmploymentsEmploymentIdCompanyStructureNodes = < ThrowOnError extends boolean = false, >( options: Options< - PostV1TimeoffTimeoffIdCancelRequestDeclineData, + GetV1EmploymentsEmploymentIdCompanyStructureNodesData, ThrowOnError >, ) => - (options.client ?? client).post< - PostV1TimeoffTimeoffIdCancelRequestDeclineResponses, - PostV1TimeoffTimeoffIdCancelRequestDeclineErrors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses, + GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/cancel-request/decline', + url: '/api/eor/v1/employments/{employment_id}/company-structure-nodes', + ...options, + }); + +/** + * Update employment + */ +export const patchV2EmploymentsEmploymentId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).patch< + PatchV2EmploymentsEmploymentId2Responses, + PatchV2EmploymentsEmploymentId2Errors, + ThrowOnError + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v2/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4803,53 +4433,20 @@ export const postV1TimeoffTimeoffIdCancelRequestDecline = < }); /** - * Update administrative details - * - * Updates employment's administrative details. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. - * - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | - * + * Update employment */ -export const putV2EmploymentsEmploymentIdAdministrativeDetails = < +export const patchV2EmploymentsEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options< - PutV2EmploymentsEmploymentIdAdministrativeDetailsData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).put< - PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses, - PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors, + PatchV2EmploymentsEmploymentIdResponses, + PatchV2EmploymentsEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/administrative_details', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v2/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4858,191 +4455,154 @@ export const putV2EmploymentsEmploymentIdAdministrativeDetails = < }); /** - * Get a employment benefit offers JSON schema + * Create probation completion letter + * + * Create a new probation completion letter request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | * */ -export const getV1EmploymentsEmploymentIdBenefitOffersSchema = < +export const postV1ProbationCompletionLetter = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1EmploymentsEmploymentIdBenefitOffersSchemaData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses, - GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors, + (options.client ?? client).post< + PostV1ProbationCompletionLetterResponses, + PostV1ProbationCompletionLetterErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/benefit-offers/schema', + url: '/api/eor/v1/probation-completion-letter', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Submit eligibility questionnaire - * - * Submits an eligibility questionnaire for a contractor employment. - * - * The questionnaire determines if the contractor is eligible for certain products or features. - * The responses are validated against the JSON schema for the questionnaire type. - * - * **Requirements:** - * - Employment must be of type `contractor` - * - Employment must be in `created` status - * - Responses must conform to the questionnaire JSON schema - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * Creates PDF cost estimation of employments * + * Creates a PDF cost estimation of employments based on the provided parameters. */ -export const postV1ContractorsEligibilityQuestionnaire = < +export const postV1CostCalculatorEstimationPdf = < ThrowOnError extends boolean = false, >( - options: Options, + options?: Options, ) => - (options.client ?? client).post< - PostV1ContractorsEligibilityQuestionnaireResponses, - PostV1ContractorsEligibilityQuestionnaireErrors, + (options?.client ?? client).post< + PostV1CostCalculatorEstimationPdfResponses, + PostV1CostCalculatorEstimationPdfErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/eligibility-questionnaire', + url: '/api/eor/v1/cost-calculator/estimation-pdf', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Show personal information for the authenticated employee + * Token * - * Returns personal information for the authenticated employee. + * Endpoint to exchange tokens in the Authorization Code, Assertion Flow, Client Credentials and Refresh Token flows + */ +export const postAuthOauth2Token2 = ( + options?: Options, +) => + (options?.client ?? client).post< + PostAuthOauth2Token2Responses, + PostAuthOauth2Token2Errors, + ThrowOnError + >({ + url: '/api/eor/auth/oauth2/token', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, + }); + +/** + * Download a document for the employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View personal details (`personal_detail:read`) | - | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const getV1EmployeePersonalInformation = < - ThrowOnError extends boolean = false, ->( - options?: Options, +export const getV1EmployeeDocumentsId = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1EmployeePersonalInformationResponses, - GetV1EmployeePersonalInformationErrors, + (options.client ?? client).get< + GetV1EmployeeDocumentsIdResponses, + GetV1EmployeeDocumentsIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/personal-information', - ...options, - }); + >({ url: '/api/eor/v1/employee/documents/{id}', ...options }); /** - * List timesheets + * Replay Webhook Events * - * Lists all timesheets. + * Replay webhook events * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * */ -export const getV1Timesheets = ( - options?: Options, +export const postV1WebhookEventsReplay = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1TimesheetsResponses, - GetV1TimesheetsErrors, + (options.client ?? client).post< + PostV1WebhookEventsReplayResponses, + PostV1WebhookEventsReplayErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets', + url: '/api/eor/v1/webhook-events/replay', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create a legal entity - * - * Create a new legal entity for a company in a given country, with KYB automatically passed. + * Trigger a Webhook * - * The entity is created with active status and can be set as the company's default - * using the reassign default entity endpoint. - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * Triggers a callback previously registered for webhooks. Use this endpoint to + * emit a webhook for testing in the Sandbox environment. This endpoint will + * respond with a 404 outside of the Sandbox environment. * */ -export const postV1SandboxCompaniesCompanyIdLegalEntities = < +export const postV1SandboxWebhookCallbacksTrigger = < ThrowOnError extends boolean = false, >( - options: Options< - PostV1SandboxCompaniesCompanyIdLegalEntitiesData, - ThrowOnError - >, + options?: Options, ) => - (options.client ?? client).post< - PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses, - PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors, + (options?.client ?? client).post< + PostV1SandboxWebhookCallbacksTriggerResponses, + PostV1SandboxWebhookCallbacksTriggerErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/companies/{company_id}/legal-entities', + url: '/api/eor/v1/sandbox/webhook-callbacks/trigger', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Show employment - * - * Shows all the information of an employment. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. - * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. - * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. - * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. - * - * + * Show bulk employment job * * ## Scopes * @@ -5051,94 +4611,64 @@ export const postV1SandboxCompaniesCompanyIdLegalEntities = < * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getV1EmploymentsEmploymentId = < +export const getV1BulkEmploymentJobsJobId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1EmploymentsEmploymentIdResponses, - GetV1EmploymentsEmploymentIdErrors, + GetV1BulkEmploymentJobsJobIdResponses, + GetV1BulkEmploymentJobsJobIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/bulk-employment-jobs/{job_id}', ...options }); /** - * Update employment - * - * Updates an employment. - * - * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. - * - * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. - * - * **For `invited` employments:** You can update the work_email. - * - * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. - * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. - * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. - * Currently, these amendments can only be done through the Remote UI. - * - * It is possible to update the `external_id` of the employment for all employment statuses. - * - * ## Global Payroll Employees - * - * To update a Global Payment employment your input data must comply with the global payroll json schemas. - * - * **For `active` employments:** In addition to the above list, you can update personal_details. - * - * ## Direct Employees - * - * To update an HRIS employment your input data must comply with the HRIS json schemas. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * List bulk employment rows * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * Returns grouped bulk employment rows, including field-level validation errors in `errors`, row-level failures in `row_errors`, and submission-phase failures in `submission_errors`. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response. * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * ## Scopes * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * + */ +export const getV1BulkEmploymentJobsJobIdRows = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1BulkEmploymentJobsJobIdRowsResponses, + GetV1BulkEmploymentJobsJobIdRowsErrors, + ThrowOnError + >({ url: '/api/eor/v1/bulk-employment-jobs/{job_id}/rows', ...options }); + +/** + * Magic links generator * - * Please contact Remote if you need to update contractors via API since it's currently not supported. + * Generates a magic link for a passwordless authentication. + * To create a magic link for a company admin, you need to provide the `user_id` parameter. + * To create a magic link for an employee, you need to provide the `employment_id` parameter. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage company resources (`company_admin`) | - | Create magic links (`magic_link:write`) | * */ -export const patchV1EmploymentsEmploymentId2 = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1MagicLink = ( + options: Options, ) => - (options.client ?? client).patch< - PatchV1EmploymentsEmploymentId2Responses, - PatchV1EmploymentsEmploymentId2Errors, + (options.client ?? client).post< + PostV1MagicLinkResponses, + PostV1MagicLinkErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}', + url: '/api/eor/v1/magic-link', ...options, headers: { 'Content-Type': 'application/json', @@ -5147,75 +4677,70 @@ export const patchV1EmploymentsEmploymentId2 = < }); /** - * Update employment - * - * Updates an employment. - * - * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. - * - * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. - * - * **For `invited` employments:** You can update the work_email. - * - * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. - * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. - * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. - * Currently, these amendments can only be done through the Remote UI. - * - * It is possible to update the `external_id` of the employment for all employment statuses. - * - * ## Global Payroll Employees - * - * To update a Global Payment employment your input data must comply with the global payroll json schemas. - * - * **For `active` employments:** In addition to the above list, you can update personal_details. + * Show a company * - * ## Direct Employees + * Given an ID, shows a company. * - * To update an HRIS employment your input data must comply with the HRIS json schemas. + * If the used access token was issued by the OAuth 2.0 Authorization Code flow, + * then only the associated company can be accessed through the endpoint. * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * ## Scopes * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + */ +export const getV1CompaniesCompanyId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1CompaniesCompanyIdResponses, + GetV1CompaniesCompanyIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/companies/{company_id}', ...options }); + +/** + * Update a company * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * Given an ID and a request object with new information, updates a company. * + * ### Getting a company and its owner to `active` status + * If you created a company using the + * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required + * request body parameters, you can use this endpoint to provide the missing data. Once the company + * and its owner have all the necessary data, both their statuses will be set to `active` and the company + * onboarding will be marked as "completed". * - * Please contact Remote if you need to update contractors via API since it's currently not supported. + * The following constitutes a company with "all the necessary data": + * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the + * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters + * are required). + * * Company `tax_number` or `registration_number` is not nil + * * Company `name` is not nil (already required when creating the company) + * * Company has a `desired_currency` in their bank account (already required when creating the company) + * * Company has accepted terms of service (already required when creating the company) * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | * */ -export const patchV1EmploymentsEmploymentId = < +export const patchV1CompaniesCompanyId2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).put< - PatchV1EmploymentsEmploymentIdResponses, - PatchV1EmploymentsEmploymentIdErrors, + (options.client ?? client).patch< + PatchV1CompaniesCompanyId2Responses, + PatchV1CompaniesCompanyId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}', + url: '/api/eor/v1/companies/{company_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5224,122 +4749,126 @@ export const patchV1EmploymentsEmploymentId = < }); /** - * List users via SCIM v2.0 + * Update a company + * + * Given an ID and a request object with new information, updates a company. + * + * ### Getting a company and its owner to `active` status + * If you created a company using the + * [create a company endpoint](#tag/Companies/operation/post_create_company) without all the required + * request body parameters, you can use this endpoint to provide the missing data. Once the company + * and its owner have all the necessary data, both their statuses will be set to `active` and the company + * onboarding will be marked as "completed". + * + * The following constitutes a company with "all the necessary data": + * * Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the + * [show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters + * are required). + * * Company `tax_number` or `registration_number` is not nil + * * Company `name` is not nil (already required when creating the company) + * * Company has a `desired_currency` in their bank account (already required when creating the company) + * * Company has accepted terms of service (already required when creating the company) + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | * - * Retrieves a list of users for the authenticated company following SCIM 2.0 standard */ -export const getV1ScimV2Users = ( - options?: Options, +export const patchV1CompaniesCompanyId = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1ScimV2UsersResponses, - GetV1ScimV2UsersErrors, + (options.client ?? client).put< + PatchV1CompaniesCompanyIdResponses, + PatchV1CompaniesCompanyIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Users', + url: '/api/eor/v1/companies/{company_id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Company Payroll Calendar + * Show form schema + * + * Returns the json schema of the requested company form. + * Currently only supports the `address_details` form. * - * List all payroll calendars for the company within the requested cycle. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getV1PayrollCalendarsCycle = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1CompaniesSchema = ( + options: Options, ) => (options.client ?? client).get< - GetV1PayrollCalendarsCycleResponses, - GetV1PayrollCalendarsCycleErrors, + GetV1CompaniesSchemaResponses, + GetV1CompaniesSchemaErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-calendars/{cycle}', - ...options, - }); + >({ url: '/api/eor/v1/companies/schema', ...options }); /** - * Show Legal Entity Administrative details + * List pricing plan partner templates * - * Show administrative details of legal entity for the authorized company specified in the request. + * List all pricing plan partner templates. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | * */ -export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails = - ( - options: Options< - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, - ThrowOnError - >, - ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', - ...options, - }); +export const getV1PricingPlanPartnerTemplates = < + ThrowOnError extends boolean = false, +>( + options?: Options, +) => + (options?.client ?? client).get< + GetV1PricingPlanPartnerTemplatesResponses, + GetV1PricingPlanPartnerTemplatesErrors, + ThrowOnError + >({ url: '/api/eor/v1/pricing-plan-partner-templates', ...options }); /** - * Update Legal Entity Administrative details + * Show engagement agreement details * - * Update administrative details of legal entity for the authorized company specified in the request. + * Returns the engagement agreement details JSON Schema for a country. Only DEU country is supported for now. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const putV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetails = - ( - options: Options< - PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData, - ThrowOnError - >, - ) => - (options.client ?? client).put< - PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses, - PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); +export const getV1CountriesCountryCodeEngagementAgreementDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1CountriesCountryCodeEngagementAgreementDetailsData, + ThrowOnError + >, +) => + (options.client ?? client).get< + GetV1CountriesCountryCodeEngagementAgreementDetailsResponses, + GetV1CountriesCountryCodeEngagementAgreementDetailsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/countries/{country_code}/engagement-agreement-details', + ...options, + }); /** * Update contract details @@ -5384,11 +4913,7 @@ export const putV2EmploymentsEmploymentIdContractDetails = < PutV2EmploymentsEmploymentIdContractDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/contract_details', + url: '/api/eor/v2/employments/{employment_id}/contract_details', ...options, headers: { 'Content-Type': 'application/json', @@ -5397,312 +4922,261 @@ export const putV2EmploymentsEmploymentIdContractDetails = < }); /** - * Show region fields + * Show product prices in the company's desired currency + * + * list product prices in the company's desired currency. + * the endpoint currently only returns the product prices for the EOR monthly product and the contractor products (Standard, Plus and COR). + * the product prices are then used to create a pricing plan for the company. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) | * - * Returns required fields JSON Schema for a given region. These are required in order to calculate - * the cost of employment for the region. These fields are based on employer contributions that are associated - * with the region or any of it's parent regions. */ -export const getV1CostCalculatorRegionsSlugFields = < +export const getV1CompaniesCompanyIdProductPrices = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1CostCalculatorRegionsSlugFieldsResponses, - GetV1CostCalculatorRegionsSlugFieldsErrors, + GetV1CompaniesCompanyIdProductPricesResponses, + GetV1CompaniesCompanyIdProductPricesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/regions/{slug}/fields', - ...options, - }); + >({ url: '/api/eor/v1/companies/{company_id}/product-prices', ...options }); /** - * Show Offboarding - * - * Shows an Offboarding request. - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | + * Create a new token for a company * + * Creates new tokens for a given company */ -export const getV1OffboardingsId = ( - options: Options, +export const postV1CompaniesCompanyIdCreateToken = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).get< - GetV1OffboardingsIdResponses, - GetV1OffboardingsIdErrors, + (options.client ?? client).post< + PostV1CompaniesCompanyIdCreateTokenResponses, + PostV1CompaniesCompanyIdCreateTokenErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/offboardings/{id}', - ...options, - }); + >({ url: '/api/eor/v1/companies/{company_id}/create-token', ...options }); /** - * Get Employee Details for a Payroll Run + * Get Employment Profile + * + * Gets necessary information to perform the identity verification of an employee. * - * Gets the employee details for a payroll run * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | + * | Manage employment documents (`employment_documents`) | View identity verification (`identity_verification:read`) | Manage identity verification (`identity_verification:write`) | * */ -export const getV1PayrollRunsPayrollRunIdEmployeeDetails = < +export const getV1IdentityVerificationEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1PayrollRunsPayrollRunIdEmployeeDetailsData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).get< - GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses, - GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, + GetV1IdentityVerificationEmploymentIdResponses, + GetV1IdentityVerificationEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-runs/{payroll_run_id}/employee-details', - ...options, - }); + >({ url: '/api/eor/v1/identity-verification/{employment_id}', ...options }); /** - * List bulk employment rows + * Download a receipt by id * - * Returns grouped bulk employment rows, including field-level validation errors in `errors`, row-level failures in `row_errors`, and submission-phase failures in `submission_errors`. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response. + * Download a receipt by id. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const getV1BulkEmploymentJobsJobIdRows = < +export const getV1ExpensesExpenseIdReceiptsReceiptId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1BulkEmploymentJobsJobIdRowsResponses, - GetV1BulkEmploymentJobsJobIdRowsErrors, + GetV1ExpensesExpenseIdReceiptsReceiptIdResponses, + GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/bulk-employment-jobs/{job_id}/rows', + url: '/api/eor/v1/expenses/{expense_id}/receipts/{receipt_id}', ...options, }); /** - * Create employment - * - * Creates an employment without provisional_start_date validation. - * - * This endpoint is only available in Sandbox and allows creating employments which - * `provisional_start_date` is in the past. This is especially helpful for: - * * Testing the Timeoff Balance endpoints - * * Testing the Offboarding endpoints - * * Testing features around probation periods - * - * This endpoint will respond with a 404 outside of the Sandbox environment. - * - * For creating an employment's parameters outside of testing purposes, use [this - * Employment create endpoint](#operation/post_create_employment) + * List groups via SCIM v2.0 * + * Retrieves a list of groups (departments) for the authenticated company following SCIM 2.0 standard */ -export const postV1SandboxEmployments = ( - options: Options, +export const getV1ScimV2Groups = ( + options?: Options, ) => - (options.client ?? client).post< - PostV1SandboxEmploymentsResponses, - PostV1SandboxEmploymentsErrors, + (options?.client ?? client).get< + GetV1ScimV2GroupsResponses, + GetV1ScimV2GroupsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Groups', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Create contract eligibility - * - * Create contract eligibility for an employment. - * - * This will create a new contract eligibility for the employment. + * Show expense * + * Shows a single expense record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage contract eligibility (`contract_eligibility:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const postV1EmploymentsEmploymentIdContractEligibility = < - ThrowOnError extends boolean = false, ->( - options: Options< - PostV1EmploymentsEmploymentIdContractEligibilityData, - ThrowOnError - >, +export const getV1ExpensesId = ( + options: Options, ) => - (options.client ?? client).post< - PostV1EmploymentsEmploymentIdContractEligibilityResponses, - PostV1EmploymentsEmploymentIdContractEligibilityErrors, + (options.client ?? client).get< + GetV1ExpensesIdResponses, + GetV1ExpensesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/contract-eligibility', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/expenses/{id}', ...options }); /** - * List countries - * - * Returns a list of all countries that are supported by Remote API alphabetically ordered. - * The supported list accounts for creating employment with basic information and it does not imply fully onboarding employment via JSON Schema. - * The countries present in the list are the ones where creating a company is allowed. + * Update an expense * + * Updates an expense * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View countries (`country:read`) | - | + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const getV1Countries = ( - options: Options, +export const patchV1ExpensesId2 = ( + options: Options, ) => - (options.client ?? client).get< - GetV1CountriesResponses, - GetV1CountriesErrors, + (options.client ?? client).patch< + PatchV1ExpensesId2Responses, + PatchV1ExpensesId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries', + url: '/api/eor/v1/expenses/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List payslip files for the authenticated employee + * Update an expense * - * Returns a paginated list of payslip files belonging to the current employee. + * Updates an expense * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const getV1EmployeePayslipFiles = ( - options?: Options, +export const patchV1ExpensesId = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1EmployeePayslipFilesResponses, - GetV1EmployeePayslipFilesErrors, + (options.client ?? client).put< + PatchV1ExpensesIdResponses, + PatchV1ExpensesIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/payslip-files', + url: '/api/eor/v1/expenses/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Create a new token for a company + * Update emergency contact + * + * Updates the employment's emergency contact details. + * + * This endpoint requires country-specific data. Query the **Show form schema** endpoint + * passing the country code and `emergency_contact_details` as path parameters to see + * the required fields for a given country. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * - * Creates new tokens for a given company */ -export const postV1CompaniesCompanyIdCreateToken = < +export const putV2EmploymentsEmploymentIdEmergencyContact = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PutV2EmploymentsEmploymentIdEmergencyContactData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostV1CompaniesCompanyIdCreateTokenResponses, - PostV1CompaniesCompanyIdCreateTokenErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdEmergencyContactResponses, + PutV2EmploymentsEmploymentIdEmergencyContactErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies/{company_id}/create-token', + url: '/api/eor/v2/employments/{employment_id}/emergency_contact', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Company Legal Entities - * - * Lists all active legal entities for the authorized company specified in the request. - * - * - * ## Scopes + * Creates a Benefit Renewal Request * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * Creates a Benefit Renewal Request for a specific Benefit Group. + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const getV1CompaniesCompanyIdLegalEntities = < +export const postV1SandboxBenefitRenewalRequests = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdLegalEntitiesResponses, - GetV1CompaniesCompanyIdLegalEntitiesErrors, + (options.client ?? client).post< + PostV1SandboxBenefitRenewalRequestsResponses, + PostV1SandboxBenefitRenewalRequestsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities', + url: '/api/eor/v1/sandbox/benefit-renewal-requests', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Update personal details + * Update basic information * - * Updates employment's personal details. + * Updates employment's basic information. + * + * Supported employment statuses: `created`, `job_title_review`, `created_reserve_paid`, `created_awaiting_reserve`. * * This endpoint requires and returns country-specific data. The exact required and returned fields will * vary depending on which country the employment is in. To see the list of parameters for each country, @@ -5718,7 +5192,7 @@ export const getV1CompaniesCompanyIdLegalEntities = < * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. * * * @@ -5729,48 +5203,20 @@ export const getV1CompaniesCompanyIdLegalEntities = < * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const putV2EmploymentsEmploymentIdPersonalDetails = < +export const putV2EmploymentsEmploymentIdBasicInformation = < ThrowOnError extends boolean = false, >( options: Options< - PutV2EmploymentsEmploymentIdPersonalDetailsData, + PutV2EmploymentsEmploymentIdBasicInformationData, ThrowOnError >, ) => (options.client ?? client).put< - PutV2EmploymentsEmploymentIdPersonalDetailsResponses, - PutV2EmploymentsEmploymentIdPersonalDetailsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/personal_details', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); - -/** - * Complete onboarding - * - * Completes the employee onboarding. When all tasks are completed, the employee is marked as in `review` status - * - * @deprecated - */ -export const postV1Ready = ( - options: Options, -) => - (options.client ?? client).post< - PostV1ReadyResponses, - PostV1ReadyErrors, + PutV2EmploymentsEmploymentIdBasicInformationResponses, + PutV2EmploymentsEmploymentIdBasicInformationErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/ready', + url: '/api/eor/v2/employments/{employment_id}/basic_information', ...options, headers: { 'Content-Type': 'application/json', @@ -5779,9 +5225,9 @@ export const postV1Ready = ( }); /** - * List Leave Policies Details + * List Leave Policies Summary * - * Describe the leave policies (custom or not) for a given employment + * List all the data related to time off for a given employment * * ## Scopes * @@ -5790,108 +5236,74 @@ export const postV1Ready = ( * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getV1LeavePoliciesDetailsEmploymentId = < +export const getV1LeavePoliciesSummaryEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1LeavePoliciesDetailsEmploymentIdResponses, - GetV1LeavePoliciesDetailsEmploymentIdErrors, + GetV1LeavePoliciesSummaryEmploymentIdResponses, + GetV1LeavePoliciesSummaryEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/leave-policies/details/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/leave-policies/summary/{employment_id}', ...options }); /** - * List Time Off Types - * - * Lists all time off types that can be used for the `timeoff_type` parameter. - * - * **Backward compatibility:** Calling this endpoint without the `type` query parameter returns the same response as before (time off types for full-time employments). Existing integrations do not need to change. - * - * Optionally, pass `type=contractor` to get time off types for contractor employments, or `type=full_time` for full-time employments (same as omitting the parameter). + * Cancel Time Off * + * Cancel a time off request that was already approved. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | - * - */ -export const getV1TimeoffTypes = ( - options: Options, -) => - (options.client ?? client).get< - GetV1TimeoffTypesResponses, - GetV1TimeoffTypesErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/types', - ...options, - }); - -/** - * Creates a CSV cost estimation of employments + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * - * Creates CSV cost estimation of employments */ -export const postV1CostCalculatorEstimationCsv = < +export const postV1TimeoffTimeoffIdCancel = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options, ) => - (options?.client ?? client).post< - PostV1CostCalculatorEstimationCsvResponses, - PostV1CostCalculatorEstimationCsvErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdCancelResponses, + PostV1TimeoffTimeoffIdCancelErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/cost-calculator/estimation-csv', + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel', ...options, headers: { 'Content-Type': 'application/json', - ...options?.headers, + ...options.headers, }, }); /** - * List groups via SCIM v2.0 + * Get Help Center Article + * + * Get a help center article by its ID + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View help articles (`help_center_article:read`) | - | * - * Retrieves a list of groups (departments) for the authenticated company following SCIM 2.0 standard */ -export const getV1ScimV2Groups = ( - options?: Options, +export const getV1HelpCenterArticlesId = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1ScimV2GroupsResponses, - GetV1ScimV2GroupsErrors, + (options.client ?? client).get< + GetV1HelpCenterArticlesIdResponses, + GetV1HelpCenterArticlesIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Groups', - ...options, - }); + >({ url: '/api/eor/v1/help-center-articles/{id}', ...options }); /** - * Create a contract document for a contractor + * Upload file * - * Create a contract document for a contractor. + * Uploads a file associated with a specified employment. + * + * Please contact api-support@remote.com to request access to this endpoint. * * * ## Scopes @@ -5901,119 +5313,95 @@ export const getV1ScimV2Groups = ( * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const postV1ContractorsEmploymentsEmploymentIdContractDocuments = < - ThrowOnError extends boolean = false, ->( - options: Options< - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData, - ThrowOnError - >, +export const postV1Documents = ( + options: Options, ) => (options.client ?? client).post< - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses, - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors, + PostV1DocumentsResponses, + PostV1DocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contract-documents', + ...formDataBodySerializer, + url: '/api/eor/v1/documents', ...options, headers: { - 'Content-Type': 'application/json', + 'Content-Type': null, ...options.headers, }, }); /** - * Trigger a Webhook + * Verify Employment Identity * - * Triggers a callback previously registered for webhooks. Use this endpoint to - * emit a webhook for testing in the Sandbox environment. This endpoint will - * respond with a 404 outside of the Sandbox environment. + * Endpoint to confirms the employment profile is from the actual employee + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | * */ -export const postV1SandboxWebhookCallbacksTrigger = < +export const postV1IdentityVerificationEmploymentIdVerify = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options< + PostV1IdentityVerificationEmploymentIdVerifyData, + ThrowOnError + >, ) => - (options?.client ?? client).post< - PostV1SandboxWebhookCallbacksTriggerResponses, - PostV1SandboxWebhookCallbacksTriggerErrors, + (options.client ?? client).post< + PostV1IdentityVerificationEmploymentIdVerifyResponses, + PostV1IdentityVerificationEmploymentIdVerifyErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/webhook-callbacks/trigger', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, + >({ + url: '/api/eor/v1/identity-verification/{employment_id}/verify', + ...options, }); /** - * Download payslip in the PDF format - * - * Given a Payslip ID, downloads a payslip. - * It is important to note that each country has a different payslip format and they are not authored by Remote. + * Lists custom fields definitions * + * Returns custom fields definitions * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) | * */ -export const getV1PayslipsPayslipIdPdf = ( - options: Options, +export const getV1CustomFields = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1PayslipsPayslipIdPdfResponses, - GetV1PayslipsPayslipIdPdfErrors, + (options?.client ?? client).get< + GetV1CustomFieldsResponses, + GetV1CustomFieldsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payslips/{payslip_id}/pdf', - ...options, - }); + >({ url: '/api/eor/v1/custom-fields', ...options }); /** - * Convert currency using dynamic rates + * Create Custom Field Definition * - * Convert currency using the rates Remote applies during employment creation and invoicing. + * Creates a new custom field definition. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | + * | Manage employments (`employments`) | View custom fields (`custom_field:read`) | Manage custom fields (`custom_field:write`) | * */ -export const postV1CurrencyConverterEffective = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1CustomFields = ( + options: Options, ) => (options.client ?? client).post< - PostV1CurrencyConverterEffectiveResponses, - PostV1CurrencyConverterEffectiveErrors, + PostV1CustomFieldsResponses, + PostV1CustomFieldsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/currency-converter/effective', + url: '/api/eor/v1/custom-fields', ...options, headers: { 'Content-Type': 'application/json', @@ -6022,61 +5410,52 @@ export const postV1CurrencyConverterEffective = < }); /** - * Show Time Off + * Approve risk reserve proof of payment * - * Shows a single Time Off record + * Approves a risk reserve proof of payment without the intervention of a Remote admin. * - * ## Scopes + * Triggers an `employment.cor_hiring.proof_of_payment_accepted` webhook event. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const getV1TimeoffId = ( - options: Options, -) => - (options.client ?? client).get< - GetV1TimeoffIdResponses, - GetV1TimeoffIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{id}', - ...options, - }); +export const postV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApprove = + ( + options: Options< + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses, + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors, + ThrowOnError + >({ + url: '/api/eor/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve', + ...options, + }); /** - * Update Time Off - * - * Updates a Time Off record. - * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. - * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. + * Create a Webhook Callback * + * Register a callback to be used for webhooks * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) | * */ -export const patchV1TimeoffId2 = ( - options: Options, +export const postV1WebhookCallbacks = ( + options: Options, ) => - (options.client ?? client).patch< - PatchV1TimeoffId2Responses, - PatchV1TimeoffId2Errors, + (options.client ?? client).post< + PostV1WebhookCallbacksResponses, + PostV1WebhookCallbacksErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{id}', + url: '/api/eor/v1/webhook-callbacks', ...options, headers: { 'Content-Type': 'application/json', @@ -6085,132 +5464,154 @@ export const patchV1TimeoffId2 = ( }); /** - * Update Time Off - * - * Updates a Time Off record. - * Warning: Updating the status of a time off through this endpoint is deprecated and will be removed on January 13, 2025. - * To approve or cancel an approved time off, use the `/approve` and `/cancel` endpoints instead. + * Show the SSO Configuration Details * + * Shows the SSO Configuration details for the company. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) | * */ -export const patchV1TimeoffId = ( - options: Options, +export const getV1SsoConfigurationDetails = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => - (options.client ?? client).put< - PatchV1TimeoffIdResponses, - PatchV1TimeoffIdErrors, + (options?.client ?? client).get< + GetV1SsoConfigurationDetailsResponses, + GetV1SsoConfigurationDetailsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/sso-configuration/details', ...options }); /** - * Decline Time Off + * Sign a document for a contractor * - * Decline a time off request. Please note that only time off requests on the `requested` status can be declined. + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | + * + */ +export const postV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSign = + ( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses, + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * List Pay Items + * + * Lists pay items for a company with optional filtering by employment, date range, and pagination. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) | * */ -export const postV1TimeoffTimeoffIdDecline = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1PayItems = ( + options?: Options, ) => - (options.client ?? client).post< - PostV1TimeoffTimeoffIdDeclineResponses, - PostV1TimeoffTimeoffIdDeclineErrors, + (options?.client ?? client).get< + GetV1PayItemsResponses, + GetV1PayItemsErrors, + ThrowOnError + >({ url: '/api/eor/v1/pay-items', ...options }); + +/** + * List users via SCIM v2.0 + * + * Retrieves a list of users for the authenticated company following SCIM 2.0 standard + */ +export const getV1ScimV2Users = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1ScimV2UsersResponses, + GetV1ScimV2UsersErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/decline', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Users', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Automatable Contract Amendment - * - * Check if a contract amendment request is automatable. - * If the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract - * and send them an updated document. - * - * This endpoint requires and returns country-specific data. The exact required and returned fields will - * vary depending on which country the employment is in. To see the list of parameters for each country, - * see the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category. - * - * Please note that the compliance requirements for each country are subject to change according to local - * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid - * compliance issues and to have the latest version of a country requirements. + * Show Resignation * - * If you are using this endpoint to build an integration, make sure you are dynamically collecting or - * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * Shows the details of a resignation with status `submitted`. * - * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * ## Scopes * - * To learn how you can dynamically generate forms to display in your UI, see the documentation for - * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View resignations (`resignation:read`) | Manage resignations (`resignation:write`) | * + */ +export const getV1ResignationsOffboardingRequestId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1ResignationsOffboardingRequestIdResponses, + GetV1ResignationsOffboardingRequestIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/resignations/{offboarding_request_id}', ...options }); + +/** + * Get Billing Document Breakdown * + * Get billing document breakdown * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const postV1ContractAmendmentsAutomatable = < +export const getV1BillingDocumentsBillingDocumentIdBreakdown = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1BillingDocumentsBillingDocumentIdBreakdownData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostV1ContractAmendmentsAutomatableResponses, - PostV1ContractAmendmentsAutomatableErrors, + (options.client ?? client).get< + GetV1BillingDocumentsBillingDocumentIdBreakdownResponses, + GetV1BillingDocumentsBillingDocumentIdBreakdownErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contract-amendments/automatable', + url: '/api/eor/v1/billing-documents/{billing_document_id}/breakdown', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Approve Time Off + * Decline a time off cancellation request + * + * Decline a time off cancellation request. * - * Approve a time off request. * * ## Scopes * @@ -6219,21 +5620,20 @@ export const postV1ContractAmendmentsAutomatable = < * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postV1TimeoffTimeoffIdApprove = < +export const postV1TimeoffTimeoffIdCancelRequestDecline = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1TimeoffTimeoffIdCancelRequestDeclineData, + ThrowOnError + >, ) => - (options.client ?? client).post< - PostV1TimeoffTimeoffIdApproveResponses, - PostV1TimeoffTimeoffIdApproveErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdCancelRequestDeclineResponses, + PostV1TimeoffTimeoffIdCancelRequestDeclineErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/approve', + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/decline', ...options, headers: { 'Content-Type': 'application/json', @@ -6242,91 +5642,105 @@ export const postV1TimeoffTimeoffIdApprove = < }); /** - * List employment files - * - * Lists files associated with a specific employment. - * - * Supports filtering by file type and sub_type. + * List EOR Payroll Calendar * + * List all active payroll calendars for EOR. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - | * */ -export const getV1EmploymentsEmploymentIdFiles = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1PayrollCalendars = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1PayrollCalendarsResponses, + GetV1PayrollCalendarsErrors, + ThrowOnError + >({ url: '/api/eor/v1/payroll-calendars', ...options }); + +/** + * Payroll processing details API resource + * + * API to retrieve header details of a pay group + */ +export const getV1WdGphPayDetail = ( + options: Options, ) => (options.client ?? client).get< - GetV1EmploymentsEmploymentIdFilesResponses, - GetV1EmploymentsEmploymentIdFilesErrors, + GetV1WdGphPayDetailResponses, + GetV1WdGphPayDetailErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/files', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payDetail', ...options, }); /** - * Lists custom fields definitions + * Show form schema + * + * Returns the json schema of the `contract_amendment` form for a specific employment. + * This endpoint requires a company access token, as forms are dependent on certain + * properties of companies and their current employments. * - * Returns custom fields definitions * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) | + * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | * */ -export const getV1CustomFields = ( - options?: Options, +export const getV1ContractAmendmentsSchema = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1ContractAmendmentsSchemaResponses, + GetV1ContractAmendmentsSchemaErrors, + ThrowOnError + >({ url: '/api/eor/v1/contract-amendments/schema', ...options }); + +/** + * Get a mock JSON Schema + * + * Get a mock JSON Schema for testing purposes + */ +export const getV1TestSchema = ( + options?: Options, ) => (options?.client ?? client).get< - GetV1CustomFieldsResponses, - GetV1CustomFieldsErrors, + GetV1TestSchemaResponses, + unknown, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields', - ...options, - }); + >({ url: '/api/eor/v1/test-schema', ...options }); /** - * Create Custom Field Definition + * Update Time Off as Employee * - * Creates a new custom field definition. + * Updates a Time Off record as Employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View custom fields (`custom_field:read`) | Manage custom fields (`custom_field:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const postV1CustomFields = ( - options: Options, +export const patchV1EmployeeTimeoffId2 = ( + options: Options, ) => - (options.client ?? client).post< - PostV1CustomFieldsResponses, - PostV1CustomFieldsErrors, + (options.client ?? client).patch< + PatchV1EmployeeTimeoffId2Responses, + PatchV1EmployeeTimeoffId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields', + url: '/api/eor/v1/employee/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -6335,100 +5749,86 @@ export const postV1CustomFields = ( }); /** - * List company supported currencies + * Update Time Off as Employee * - * List company supported currencies + * Updates a Time Off record as Employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View company currencies (`company_currencies:read`) | - | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getV1CompanyCurrencies = ( - options?: Options, +export const patchV1EmployeeTimeoffId = ( + options: Options, ) => - (options?.client ?? client).get< - GetV1CompanyCurrenciesResponses, - GetV1CompanyCurrenciesErrors, + (options.client ?? client).put< + PatchV1EmployeeTimeoffIdResponses, + PatchV1EmployeeTimeoffIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-currencies', + url: '/api/eor/v1/employee/timeoff/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Update employment - * - * Updates an employment. Use this endpoint to: - * - modify employment states for testing - * - Backdate employment start dates - * - * This endpoint will respond with a 404 outside of the Sandbox environment. - * - * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). + * Get group by ID via SCIM v2.0 * + * Retrieves a single group (department) for the authenticated company by group ID */ -export const patchV1SandboxEmploymentsEmploymentId2 = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1ScimV2GroupsId = ( + options: Options, ) => - (options.client ?? client).patch< - PatchV1SandboxEmploymentsEmploymentId2Responses, - PatchV1SandboxEmploymentsEmploymentId2Errors, + (options.client ?? client).get< + GetV1ScimV2GroupsIdResponses, + GetV1ScimV2GroupsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments/{employment_id}', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/scim/v2/Groups/{id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Update employment + * Show legal entity administrative details form schema * - * Updates an employment. Use this endpoint to: - * - modify employment states for testing - * - Backdate employment start dates + * Returns the json schema of a supported form. Possible form names are: + * ``` + * - administrative_details + * ``` * - * This endpoint will respond with a 404 outside of the Sandbox environment. + * Most forms require a company access token, as they are dependent on certain + * properties of companies and their current employments. * - * For updating an employment's parameters outside of testing purposes, use [this Employment update endpoint](#operation/patch_update_employment). + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | * */ -export const patchV1SandboxEmploymentsEmploymentId = < +export const getV1CountriesCountryCodeLegalEntityFormsForm = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1CountriesCountryCodeLegalEntityFormsFormData, + ThrowOnError + >, ) => - (options.client ?? client).put< - PatchV1SandboxEmploymentsEmploymentIdResponses, - PatchV1SandboxEmploymentsEmploymentIdErrors, + (options.client ?? client).get< + GetV1CountriesCountryCodeLegalEntityFormsFormResponses, + GetV1CountriesCountryCodeLegalEntityFormsFormErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/employments/{employment_id}', + url: '/api/eor/v1/countries/{country_code}/legal_entity_forms/{form}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** @@ -6456,280 +5856,215 @@ export const getV1EmploymentContractsEmploymentIdPendingChanges = < GetV1EmploymentContractsEmploymentIdPendingChangesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employment-contracts/{employment_id}/pending-changes', + url: '/api/eor/v1/employment-contracts/{employment_id}/pending-changes', ...options, }); /** - * Show Resignation - * - * Shows the details of a resignation with status `submitted`. - * - * ## Scopes + * Report SDK errors * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View resignations (`resignation:read`) | Manage resignations (`resignation:write`) | + * Receives error telemetry from the frontend SDK. + * Errors are logged to observability backend for monitoring and debugging. * */ -export const getV1ResignationsOffboardingRequestId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1SdkTelemetryErrors = ( + options: Options, ) => - (options.client ?? client).get< - GetV1ResignationsOffboardingRequestIdResponses, - GetV1ResignationsOffboardingRequestIdErrors, + (options.client ?? client).post< + PostV1SdkTelemetryErrorsResponses, + PostV1SdkTelemetryErrorsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/resignations/{offboarding_request_id}', + url: '/api/eor/v1/sdk/telemetry-errors', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Upload file - * - * Uploads a file associated with a specified employment. + * Get Company Compliance Profile * - * Please contact api-support@remote.com to request access to this endpoint. + * Returns the KYB and credit risk status for the company's default legal entity. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const postV1Documents = ( - options: Options, +export const getV1CompaniesCompanyIdComplianceProfile = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).post< - PostV1DocumentsResponses, - PostV1DocumentsErrors, + (options.client ?? client).get< + GetV1CompaniesCompanyIdComplianceProfileResponses, + GetV1CompaniesCompanyIdComplianceProfileErrors, ThrowOnError >({ - ...formDataBodySerializer, - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/documents', + url: '/api/eor/v1/companies/{company_id}/compliance-profile', ...options, - headers: { - 'Content-Type': null, - ...options.headers, - }, }); /** - * Invite employment - * - * Invite an employment to start the self-enrollment. - * - * Requirements for the invitation to succeed: - * - * * Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details` - * * `provisional_start_date` must consider the minimum onboarding time of the employment's country - * - * If there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message. - * HTTP Status OK (200) is returned in case of success. + * Show payslip * - * In case of the following error message: - * `"Please reselect benefits - the previous selection is no longer available"` - * it means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema. + * Given an ID, shows a payslip. * - * In this case, reselect benefits by updating `contract_details` JSON Schema form. + * Please contact api-support@remote.com to request access to this endpoint. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const postV1EmploymentsEmploymentIdInvite = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1PayslipsId = ( + options: Options, ) => - (options.client ?? client).post< - PostV1EmploymentsEmploymentIdInviteResponses, - PostV1EmploymentsEmploymentIdInviteErrors, + (options.client ?? client).get< + GetV1PayslipsIdResponses, + GetV1PayslipsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/invite', - ...options, - }); + >({ url: '/api/eor/v1/payslips/{id}', ...options }); /** - * Show expense + * Approve a time off cancellation request + * + * Approve a time off cancellation request. + * In order to approve a time off cancellation request, the timeoff status must be `cancel_requested`. * - * Shows a single expense record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const getV1ExpensesId = ( - options: Options, +export const postV1TimeoffTimeoffIdCancelRequestApprove = < + ThrowOnError extends boolean = false, +>( + options: Options< + PostV1TimeoffTimeoffIdCancelRequestApproveData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetV1ExpensesIdResponses, - GetV1ExpensesIdErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdCancelRequestApproveResponses, + PostV1TimeoffTimeoffIdCancelRequestApproveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{id}', + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/approve', ...options, }); /** - * Update an expense + * List Webhook Events * - * Updates an expense + * List all webhook events * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | + * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | * */ -export const patchV1ExpensesId2 = ( - options: Options, +export const getV1WebhookEvents = ( + options?: Options, ) => - (options.client ?? client).patch< - PatchV1ExpensesId2Responses, - PatchV1ExpensesId2Errors, + (options?.client ?? client).get< + GetV1WebhookEventsResponses, + GetV1WebhookEventsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/webhook-events', ...options }); /** - * Update an expense + * List Time Off Types + * + * Lists all time off types that can be used for the `timeoff_type` parameter. + * + * **Backward compatibility:** Calling this endpoint without the `type` query parameter returns the same response as before (time off types for full-time employments). Existing integrations do not need to change. + * + * Optionally, pass `type=contractor` to get time off types for contractor employments, or `type=full_time` for full-time employments (same as omitting the parameter). * - * Updates an expense * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const patchV1ExpensesId = ( - options: Options, +export const getV1TimeoffTypes = ( + options: Options, ) => - (options.client ?? client).put< - PatchV1ExpensesIdResponses, - PatchV1ExpensesIdErrors, + (options.client ?? client).get< + GetV1TimeoffTypesResponses, + GetV1TimeoffTypesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/timeoff/types', ...options }); /** - * Show Benefit Renewal Request + * List Company Legal Entities + * + * Lists all active legal entities for the authorized company specified in the request. * - * Show Benefit Renewal Request details. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | * */ -export const getV1BenefitRenewalRequestsBenefitRenewalRequestId = < +export const getV1CompaniesCompanyIdLegalEntities = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).get< - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, + GetV1CompaniesCompanyIdLegalEntitiesResponses, + GetV1CompaniesCompanyIdLegalEntitiesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}', - ...options, - }); + >({ url: '/api/eor/v1/companies/{company_id}/legal-entities', ...options }); /** - * Updates a Benefit Renewal Request Response + * Create contract eligibility + * + * Create contract eligibility for an employment. + * + * This will create a new contract eligibility for the employment. * - * Updates a Benefit Renewal Request with the given response. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage contract eligibility (`contract_eligibility:write`) | * */ -export const postV1BenefitRenewalRequestsBenefitRenewalRequestId = < +export const postV1EmploymentsEmploymentIdContractEligibility = < ThrowOnError extends boolean = false, >( options: Options< - PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData, + PostV1EmploymentsEmploymentIdContractEligibilityData, ThrowOnError >, ) => (options.client ?? client).post< - PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses, - PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, + PostV1EmploymentsEmploymentIdContractEligibilityResponses, + PostV1EmploymentsEmploymentIdContractEligibilityErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}', + url: '/api/eor/v1/employments/{employment_id}/contract-eligibility', ...options, headers: { 'Content-Type': 'application/json', @@ -6738,9 +6073,14 @@ export const postV1BenefitRenewalRequestsBenefitRenewalRequestId = < }); /** - * Show onboarding steps for an employment + * List all currencies for the contractor + * + * The currencies are listed in the following order: + * 1. billing currency of the company + * 2. currencies of contractorā€™s existing withdrawal methods + * 3. currency of the contractorā€™s country + * 4. the rest, alphabetical. * - * Returns onboarding steps and substeps in a hierarchical, ordered structure. * * ## Scopes * @@ -6749,287 +6089,284 @@ export const postV1BenefitRenewalRequestsBenefitRenewalRequestId = < * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getV1EmploymentsEmploymentIdOnboardingSteps = < +export const getV1ContractorsEmploymentsEmploymentIdContractorCurrencies = < ThrowOnError extends boolean = false, >( options: Options< - GetV1EmploymentsEmploymentIdOnboardingStepsData, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData, ThrowOnError >, ) => (options.client ?? client).get< - GetV1EmploymentsEmploymentIdOnboardingStepsResponses, - GetV1EmploymentsEmploymentIdOnboardingStepsErrors, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses, + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/onboarding-steps', + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-currencies', ...options, }); /** - * List company structure nodes + * List payslips * - * Shows all the company structure nodes of an employment. + * Lists all payslips belonging to a company. Can also filter for a single employment belonging + * to that company. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View company structure (`company_structure:read`) | - | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const getV1EmploymentsEmploymentIdCompanyStructureNodes = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV1EmploymentsEmploymentIdCompanyStructureNodesData, +export const getV1Payslips = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1PayslipsResponses, + GetV1PayslipsErrors, ThrowOnError - >, + >({ url: '/api/eor/v1/payslips', ...options }); + +/** + * Create employment + * + * Creates an employment without provisional_start_date validation. + * + * This endpoint is only available in Sandbox and allows creating employments which + * `provisional_start_date` is in the past. This is especially helpful for: + * * Testing the Timeoff Balance endpoints + * * Testing the Offboarding endpoints + * * Testing features around probation periods + * + * This endpoint will respond with a 404 outside of the Sandbox environment. + * + * For creating an employment's parameters outside of testing purposes, use [this + * Employment create endpoint](#operation/post_create_employment) + * + */ +export const postV1SandboxEmployments = ( + options: Options, ) => - (options.client ?? client).get< - GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses, - GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors, + (options.client ?? client).post< + PostV1SandboxEmploymentsResponses, + PostV1SandboxEmploymentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/company-structure-nodes', + url: '/api/eor/v1/sandbox/employments', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List custom field value for an employment + * Show Company Payroll Runs + * + * Given an ID, shows a payroll run. + * `employee_details` field is deprecated in favour of the `employee_details` endpoint and will be removed in the future. * - * Returns a list of custom field values for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | + * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | * */ -export const getV1EmploymentsEmploymentIdCustomFields = < +export const getV1PayrollRunsPayrollRunId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1EmploymentsEmploymentIdCustomFieldsResponses, - GetV1EmploymentsEmploymentIdCustomFieldsErrors, + GetV1PayrollRunsPayrollRunIdResponses, + GetV1PayrollRunsPayrollRunIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/custom-fields', - ...options, - }); + >({ url: '/api/eor/v1/payroll-runs/{payroll_run_id}', ...options }); /** - * Validate resignation request + * List pre-onboarding document requirements for an employment + * + * Returns the list of pre-onboarding document requirements (e.g. master service agreements, + * individual labour agreements) that must be fulfilled before the given employment can be onboarded. * - * Validates a resignation employment request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage resignations (`resignation:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const putV1ResignationsOffboardingRequestIdValidate = < - ThrowOnError extends boolean = false, ->( - options: Options< - PutV1ResignationsOffboardingRequestIdValidateData, - ThrowOnError - >, -) => - (options.client ?? client).put< - PutV1ResignationsOffboardingRequestIdValidateResponses, - PutV1ResignationsOffboardingRequestIdValidateErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/resignations/{offboarding_request_id}/validate', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); +export const getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirements = + ( + options: Options< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData, + ThrowOnError + >, + ) => + (options.client ?? client).get< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, + ThrowOnError + >({ + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements', + ...options, + }); /** - * Reassign default legal entity + * Show Offboarding * - * Set a different legal entity as the company's default entity. + * Shows an Offboarding request. * - * The default entity is used when creating new employments without an explicit entity. - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) | * */ -export const putV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityId = < - ThrowOnError extends boolean = false, ->( - options: Options< - PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData, +export const getV1OffboardingsId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1OffboardingsIdResponses, + GetV1OffboardingsIdErrors, ThrowOnError - >, + >({ url: '/api/eor/v1/offboardings/{id}', ...options }); + +/** + * List expenses + * + * Lists all expenses records + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * + */ +export const getV1Expenses = ( + options: Options, ) => - (options.client ?? client).put< - PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses, - PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors, + (options.client ?? client).get< + GetV1ExpensesResponses, + GetV1ExpensesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}', - ...options, - }); + >({ url: '/api/eor/v1/expenses', ...options }); /** - * List Webhook Callbacks + * Create expense * - * List callbacks for a given company + * Creates an **approved** expense * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) | + * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | * */ -export const getV1CompaniesCompanyIdWebhookCallbacks = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const postV1Expenses = ( + options: Options, ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdWebhookCallbacksResponses, - GetV1CompaniesCompanyIdWebhookCallbacksErrors, + (options.client ?? client).post< + PostV1ExpensesResponses, + PostV1ExpensesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/webhook-callbacks', + url: '/api/eor/v1/expenses', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Show contractor eligibility and COR-supported countries for legal entity - * - * Returns which contractor products (standard, plus, cor) the legal entity is eligible to use, - * and the list of country codes where COR is supported for this legal entity. - * COR-supported countries exclude sanctioned and signup-prevented countries and apply entity rules (same-country, local-to-local). - * When the legal entity is not COR-eligible, `cor_supported_country_codes` is an empty list. + * List payslip files for the authenticated employee * + * Returns a paginated list of payslip files belonging to the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibility = - ( - options: Options< - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData, - ThrowOnError - >, - ) => - (options.client ?? client).get< - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses, - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility', - ...options, - }); +export const getV1EmployeePayslipFiles = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1EmployeePayslipFilesResponses, + GetV1EmployeePayslipFilesErrors, + ThrowOnError + >({ url: '/api/eor/v1/employee/payslip-files', ...options }); /** - * Show a custom field value + * Invite employment + * + * Invite an employment to start the self-enrollment. + * + * Requirements for the invitation to succeed: + * + * * Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details` + * * `provisional_start_date` must consider the minimum onboarding time of the employment's country + * + * If there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message. + * HTTP Status OK (200) is returned in case of success. + * + * In case of the following error message: + * `"Please reselect benefits - the previous selection is no longer available"` + * it means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema. + * + * In this case, reselect benefits by updating `contract_details` JSON Schema form. * - * Returns a custom field value for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1CustomFieldsCustomFieldIdValuesEmploymentId = < +export const postV1EmploymentsEmploymentIdInvite = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, - GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, + (options.client ?? client).post< + PostV1EmploymentsEmploymentIdInviteResponses, + PostV1EmploymentsEmploymentIdInviteErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', - ...options, - }); + >({ url: '/api/eor/v1/employments/{employment_id}/invite', ...options }); /** - * Update a Custom Field Value + * Create Probation Extension * - * Updates a custom field value for a given employment. + * Create a probation extension request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) | * */ -export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId2 = < - ThrowOnError extends boolean = false, ->( - options: Options< - PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data, - ThrowOnError - >, +export const postV1ProbationExtensions = ( + options: Options, ) => - (options.client ?? client).patch< - PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses, - PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors, + (options.client ?? client).post< + PostV1ProbationExtensionsResponses, + PostV1ProbationExtensionsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/api/eor/v1/probation-extensions', ...options, headers: { 'Content-Type': 'application/json', @@ -7038,46 +6375,38 @@ export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId2 = < }); /** - * Update a Custom Field Value - * - * Updates a custom field value for a given employment. + * Approve Contract Amendment * - * ## Scopes + * Approves a contract amendment request without the intervention of a Remote admin. + * Approvals done via this endpoint are effective immediately, + * regardless of the effective date entered on the contract amendment creation. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | + * This endpoint is only available in Sandbox, otherwise it will respond with a 404. * */ -export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId = < +export const putV1SandboxContractAmendmentsContractAmendmentRequestIdApprove = < ThrowOnError extends boolean = false, >( options: Options< - PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData, ThrowOnError >, ) => (options.client ?? client).put< - PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, - PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses, + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Show a contractor of record (COR) termination request + * Get Onboarding Reserves Status for Employment * - * Retrieves a Contractor of Record termination request by ID. + * Returns the onboarding reserves status for a specific employment. + * + * The status is the same as the credit risk status but takes the onboarding reserves policies into account. * * * ## Scopes @@ -7087,214 +6416,230 @@ export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId = < * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const getV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestId = +export const getV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatus = ( options: Options< - GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData, ThrowOnError >, ) => (options.client ?? client).get< - GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses, - GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses, + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}', + url: '/api/eor/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status', ...options, }); /** - * Terminate contractor of record employment - * - * **Deprecated.** Use `POST /contractors/employments/{employment_id}/cor-termination-requests` instead. - * - * Initiates a termination request for a Contractor of Record employment. - * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. - * Currently, only Contractor of Record employments can be terminated. + * Show Contractor Invoice * + * Shows a single Contractor Invoice record. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * + */ +export const getV1ContractorInvoicesId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1ContractorInvoicesIdResponses, + GetV1ContractorInvoicesIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/contractor-invoices/{id}', ...options }); + +/** + * Payroll Feature API resource * - * @deprecated + * API to retrieve feature properties from the vendor system */ -export const postV1ContractorsEmploymentsEmploymentIdTerminateCorEmployment = < +export const getV1WdGphPayProcessingFeature = < ThrowOnError extends boolean = false, >( - options: Options< - PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData, + options?: Options, +) => + (options?.client ?? client).get< + GetV1WdGphPayProcessingFeatureResponses, + GetV1WdGphPayProcessingFeatureErrors, ThrowOnError - >, + >({ + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payProcessingFeature', + ...options, + }); + +/** + * Payroll processing progress API resource + * + * API to retrieve the processing stages of a pay group + */ +export const getV1WdGphPayProgress = ( + options: Options, ) => - (options.client ?? client).post< - PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses, - PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors, + (options.client ?? client).get< + GetV1WdGphPayProgressResponses, + GetV1WdGphPayProgressErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/terminate-cor-employment', + security: [{ scheme: 'bearer', type: 'http' }], + url: '/api/eor/v1/wd/gph/payProgress', ...options, }); /** - * Sign a document for a contractor + * List company supported currencies + * + * List company supported currencies * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | + * | Manage company resources (`company_admin`) | View company currencies (`company_currencies:read`) | - | * */ -export const postV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSign = - ( - options: Options< - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData, - ThrowOnError - >, - ) => - (options.client ?? client).post< - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses, - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); +export const getV1CompanyCurrencies = ( + options?: Options, +) => + (options?.client ?? client).get< + GetV1CompanyCurrenciesResponses, + GetV1CompanyCurrenciesErrors, + ThrowOnError + >({ url: '/api/eor/v1/company-currencies', ...options }); /** - * Get token identity + * Get a employment benefit offers JSON schema * - * Shows information about the entities that can be controlled by the current auth token. + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | * */ -export const getV1IdentityCurrent = ( - options: Options, +export const getV1EmploymentsEmploymentIdBenefitOffersSchema = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1EmploymentsEmploymentIdBenefitOffersSchemaData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetV1IdentityCurrentResponses, - GetV1IdentityCurrentErrors, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses, + GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity/current', + url: '/api/eor/v1/employments/{employment_id}/benefit-offers/schema', ...options, }); /** - * Delete an Incentive - * - * Delete an incentive. - * - * `one_time` incentives that have the following status **CANNOT** be deleted: - * * `processing` - * * `paid` + * List Contractor Invoice Schedules * + * Lists Contractor Invoice Schedule records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const deleteV1IncentivesId = ( - options: Options, +export const getV1ContractorInvoiceSchedules = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => - (options.client ?? client).delete< - DeleteV1IncentivesIdResponses, - DeleteV1IncentivesIdErrors, + (options?.client ?? client).get< + GetV1ContractorInvoiceSchedulesResponses, + GetV1ContractorInvoiceSchedulesErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', - ...options, - }); + >({ url: '/api/eor/v1/contractor-invoice-schedules', ...options }); /** - * Show Incentive + * Create Contractor Invoice Schedules + * + * Creates many invoice schedules records. + * It's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted. * - * Show an Incentive's details * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) | + * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const getV1IncentivesId = ( - options: Options, +export const postV1ContractorInvoiceSchedules = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).get< - GetV1IncentivesIdResponses, - GetV1IncentivesIdErrors, + (options.client ?? client).post< + PostV1ContractorInvoiceSchedulesResponses, + PostV1ContractorInvoiceSchedulesErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', + url: '/api/eor/v1/contractor-invoice-schedules', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Update Incentive + * Show work authorization request * - * Updates an Incentive. + * Show a single work authorization request. * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * ## Scopes * - * The API doesn't support updating paid incentives. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | + * + */ +export const getV1WorkAuthorizationRequestsId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).get< + GetV1WorkAuthorizationRequestsIdResponses, + GetV1WorkAuthorizationRequestsIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/work-authorization-requests/{id}', ...options }); + +/** + * Update work authorization request * + * Updates a work authorization request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | * */ -export const patchV1IncentivesId2 = ( - options: Options, +export const patchV1WorkAuthorizationRequestsId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => (options.client ?? client).patch< - PatchV1IncentivesId2Responses, - PatchV1IncentivesId2Errors, + PatchV1WorkAuthorizationRequestsId2Responses, + PatchV1WorkAuthorizationRequestsId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', + url: '/api/eor/v1/work-authorization-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7303,35 +6648,58 @@ export const patchV1IncentivesId2 = ( }); /** - * Update Incentive + * Update work authorization request * - * Updates an Incentive. + * Updates a work authorization request. * - * Incentives use the currency of the employment specified provided in the `employment_id` field. + * ## Scopes * - * The API doesn't support updating paid incentives. + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) | + * + */ +export const patchV1WorkAuthorizationRequestsId = < + ThrowOnError extends boolean = false, +>( + options: Options, +) => + (options.client ?? client).put< + PatchV1WorkAuthorizationRequestsIdResponses, + PatchV1WorkAuthorizationRequestsIdErrors, + ThrowOnError + >({ + url: '/api/eor/v1/work-authorization-requests/{id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); + +/** + * Decline Time Off * + * Decline a time off request. Please note that only time off requests on the `requested` status can be declined. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) | + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * */ -export const patchV1IncentivesId = ( - options: Options, +export const postV1TimeoffTimeoffIdDecline = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).put< - PatchV1IncentivesIdResponses, - PatchV1IncentivesIdErrors, + (options.client ?? client).post< + PostV1TimeoffTimeoffIdDeclineResponses, + PostV1TimeoffTimeoffIdDeclineErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/incentives/{id}', + url: '/api/eor/v1/timeoff/{timeoff_id}/decline', ...options, headers: { 'Content-Type': 'application/json', @@ -7368,405 +6736,445 @@ export const getV1ContractorsSchemasEligibilityQuestionnaire = < GetV1ContractorsSchemasEligibilityQuestionnaireErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/schemas/eligibility-questionnaire', + url: '/api/eor/v1/contractors/schemas/eligibility-questionnaire', ...options, }); /** - * List work authorization requests + * Token + * + * Endpoint to exchange tokens in the Authorization Code, Assertion Flow, Client Credentials and Refresh Token flows + */ +export const postAuthOauth2Token = ( + options?: Options, +) => + (options?.client ?? client).post< + PostAuthOauth2TokenResponses, + PostAuthOauth2TokenErrors, + ThrowOnError + >({ + url: '/api/eor/oauth2/token', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options?.headers, + }, + }); + +/** + * Delete contractor of record subscription intent + * + * Deletes Contractor of Record subscription intent. * - * List work authorization requests. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1WorkAuthorizationRequests = < - ThrowOnError extends boolean = false, ->( - options?: Options, -) => - (options?.client ?? client).get< - GetV1WorkAuthorizationRequestsResponses, - GetV1WorkAuthorizationRequestsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/work-authorization-requests', - ...options, - }); +export const deleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = + ( + options: Options< + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + ThrowOnError + >, + ) => + (options.client ?? client).delete< + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + ...options, + }); /** - * Show bulk employment job + * Create contractor of record subscription intent + * + * Assigns Contractor of Record subscription in pending state to employment. + * Once risk analysis is performed, subscription may start upon contract signing, + * or might be denied. + * + * Requires a non-blocking eligibility questionnaire to be submitted before creating the subscription intent. + * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1BulkEmploymentJobsJobId = < - ThrowOnError extends boolean = false, ->( - options: Options, -) => - (options.client ?? client).get< - GetV1BulkEmploymentJobsJobIdResponses, - GetV1BulkEmploymentJobsJobIdErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/bulk-employment-jobs/{job_id}', - ...options, - }); +export const postV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = + ( + options: Options< + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, + ThrowOnError + >, + ) => + (options.client ?? client).post< + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, + ThrowOnError + >({ + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + ...options, + }); /** - * List Pay Items + * Update personal details + * + * Updates employment's personal details. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * * - * Lists pay items for a company with optional filtering by employment, date range, and pagination. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1PayItems = ( - options?: Options, +export const putV2EmploymentsEmploymentIdPersonalDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdPersonalDetailsData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetV1PayItemsResponses, - GetV1PayItemsErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdPersonalDetailsResponses, + PutV2EmploymentsEmploymentIdPersonalDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/pay-items', + url: '/api/eor/v2/employments/{employment_id}/personal_details', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Benefit Offers + * Find or create a pre-onboarding document for an employment * - * List benefit offers for each country. + * Finds an existing unsigned pre-onboarding document for the given requirement, or creates a new one. + * Idempotent: repeated calls with the same `pre_onboarding_document_requirement_slug` return the same + * document until it is signed. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage employment documents (`employment_documents`) | - | Manage documents (`document:write`) | * */ -export const getV1BenefitOffersCountrySummaries = < +export const postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocuments = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData, + ThrowOnError + >, ) => - (options.client ?? client).get< - GetV1BenefitOffersCountrySummariesResponses, - GetV1BenefitOffersCountrySummariesErrors, + (options.client ?? client).post< + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses, + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-offers/country-summaries', + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * List Benefit Offers By Employment - * - * List benefit offers by employment. + * Show Contract Amendment * + * Show a single Contract Amendment request. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) | + * | Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) | * */ -export const getV1BenefitOffers = ( - options: Options, +export const getV1ContractAmendmentsId = ( + options: Options, ) => (options.client ?? client).get< - GetV1BenefitOffersResponses, - GetV1BenefitOffersErrors, + GetV1ContractAmendmentsIdResponses, + GetV1ContractAmendmentsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/benefit-offers', - ...options, - }); + >({ url: '/api/eor/v1/contract-amendments/{id}', ...options }); /** - * Cancel Contract Amendment + * Decline Identity Verification * - * Use this endpoint to cancel an existing contract amendment request. + * Declines the identity verification of an employee. * - * This endpoint is only available in Sandbox, otherwise it will respond with a 404. + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | * */ -export const putV1SandboxContractAmendmentsContractAmendmentRequestIdCancel = < +export const postV1IdentityVerificationEmploymentIdDecline = < ThrowOnError extends boolean = false, >( options: Options< - PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData, + PostV1IdentityVerificationEmploymentIdDeclineData, ThrowOnError >, ) => - (options.client ?? client).put< - PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses, - PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors, + (options.client ?? client).post< + PostV1IdentityVerificationEmploymentIdDeclineResponses, + PostV1IdentityVerificationEmploymentIdDeclineErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel', + url: '/api/eor/v1/identity-verification/{employment_id}/decline', ...options, }); /** - * List employee time offs + * List expense categories for the authenticated employee * - * Lists the current employee's time off records + * Returns the flat list of expense categories applicable to the current employee. Only active categories are returned, filtered by the employee's country / legal-entity visibility rules. Leaf nodes have `is_selectable: true`; parent nodes are excluded unless `include_parents=true`. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | * */ -export const getV1EmployeeTimeoff = ( - options?: Options, +export const getV1EmployeeExpenseCategories = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => (options?.client ?? client).get< - GetV1EmployeeTimeoffResponses, - GetV1EmployeeTimeoffErrors, + GetV1EmployeeExpenseCategoriesResponses, + GetV1EmployeeExpenseCategoriesErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff', - ...options, - }); + >({ url: '/api/eor/v1/employee/expense-categories', ...options }); /** - * Create a Pending Time Off - * - * Creates a pending Time Off record - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * Creates a CSV cost estimation of employments * + * Creates CSV cost estimation of employments */ -export const postV1EmployeeTimeoff = ( - options: Options, +export const postV1CostCalculatorEstimationCsv = < + ThrowOnError extends boolean = false, +>( + options?: Options, ) => - (options.client ?? client).post< - PostV1EmployeeTimeoffResponses, - PostV1EmployeeTimeoffErrors, + (options?.client ?? client).post< + PostV1CostCalculatorEstimationCsvResponses, + PostV1CostCalculatorEstimationCsvErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/timeoff', + url: '/api/eor/v1/cost-calculator/estimation-csv', ...options, headers: { 'Content-Type': 'application/json', - ...options.headers, + ...options?.headers, }, }); /** - * Update employment + * Retrieve a pre-onboarding document with its rendered PDF content + * + * Returns the rendered contract PDF (base64-encoded) and the list of signatories for the given + * pre-onboarding document. The `content` field is prefixed with `data:application/pdf;base64,` so + * it can be embedded directly in a document viewer. + * + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * */ -export const patchV2EmploymentsEmploymentId2 = < +export const getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData, + ThrowOnError + >, ) => - (options.client ?? client).patch< - PatchV2EmploymentsEmploymentId2Responses, - PatchV2EmploymentsEmploymentId2Errors, + (options.client ?? client).get< + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses, + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v2/employments/{employment_id}', + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}', ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, }); /** - * Update employment + * List Billing Documents + * + * List billing documents for a company + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * */ -export const patchV2EmploymentsEmploymentId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1BillingDocuments = ( + options: Options, ) => - (options.client ?? client).put< - PatchV2EmploymentsEmploymentIdResponses, - PatchV2EmploymentsEmploymentIdErrors, + (options.client ?? client).get< + GetV1BillingDocumentsResponses, + GetV1BillingDocumentsErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v2/employments/{employment_id}', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/billing-documents', ...options }); /** - * Show Probation Extension + * Show Billing Document * - * Shows a Probation Extension Request. + * Shows a billing document details. + * + * Please contact api-support@remote.com to request access to this endpoint. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const getV1ProbationExtensionsId = < +export const getV1BillingDocumentsBillingDocumentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => (options.client ?? client).get< - GetV1ProbationExtensionsIdResponses, - GetV1ProbationExtensionsIdErrors, + GetV1BillingDocumentsBillingDocumentIdResponses, + GetV1BillingDocumentsBillingDocumentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/probation-extensions/{id}', - ...options, - }); + >({ url: '/api/eor/v1/billing-documents/{billing_document_id}', ...options }); /** - * List payslips - * - * Lists all payslips belonging to a company. Can also filter for a single employment belonging - * to that company. - * + * Indexes all the documents for the employee * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const getV1Payslips = ( - options?: Options, +export const getV1EmployeeDocuments = ( + options?: Options, ) => (options?.client ?? client).get< - GetV1PayslipsResponses, - GetV1PayslipsErrors, + GetV1EmployeeDocumentsResponses, + GetV1EmployeeDocumentsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payslips', - ...options, - }); + >({ url: '/api/eor/v1/employee/documents', ...options }); /** - * Download a receipt by id + * List employee time offs * - * Download a receipt by id. + * Lists the current employee's time off records * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | * */ -export const getV1ExpensesExpenseIdReceiptsReceiptId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeeTimeoff = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1ExpensesExpenseIdReceiptsReceiptIdResponses, - GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, + (options?.client ?? client).get< + GetV1EmployeeTimeoffResponses, + GetV1EmployeeTimeoffErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/expenses/{expense_id}/receipts/{receipt_id}', - ...options, - }); + >({ url: '/api/eor/v1/employee/timeoff', ...options }); /** - * Token + * Create a Pending Time Off + * + * Creates a pending Time Off record + * + * ## Scopes + * + * | Category | Read only Scope | Write only Scope (read access implicit) | + * |---|---|---| + * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | * - * Endpoint to exchange tokens in the Authorization Code, Assertion Flow, Client Credentials and Refresh Token flows */ -export const postAuthOauth2Token = ( - options?: Options, +export const postV1EmployeeTimeoff = ( + options: Options, ) => - (options?.client ?? client).post< - PostAuthOauth2TokenResponses, - PostAuthOauth2TokenErrors, + (options.client ?? client).post< + PostV1EmployeeTimeoffResponses, + PostV1EmployeeTimeoffErrors, ThrowOnError >({ - security: [{ scheme: 'basic', type: 'http' }], - url: '/auth/oauth2/token', + url: '/api/eor/v1/employee/timeoff', ...options, headers: { 'Content-Type': 'application/json', - ...options?.headers, + ...options.headers, }, }); /** - * Update pricing plan details + * Update personal details + * + * Updates employment's personal details. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. * - * Updates the pricing plan for an employment. The frequency determines how often Remote bills the - * employer for management fees. Annual billing typically offers a discount. * * * ## Scopes @@ -7776,24 +7184,20 @@ export const postAuthOauth2Token = ( * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const putV2EmploymentsEmploymentIdPricingPlanDetails = < +export const putV1EmploymentsEmploymentIdPersonalDetails = < ThrowOnError extends boolean = false, >( options: Options< - PutV2EmploymentsEmploymentIdPricingPlanDetailsData, + PutV1EmploymentsEmploymentIdPersonalDetailsData, ThrowOnError >, ) => (options.client ?? client).put< - PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses, - PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors, + PutV1EmploymentsEmploymentIdPersonalDetailsResponses, + PutV1EmploymentsEmploymentIdPersonalDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/pricing_plan_details', + url: '/api/eor/v1/employments/{employment_id}/personal_details', ...options, headers: { 'Content-Type': 'application/json', @@ -7802,139 +7206,94 @@ export const putV2EmploymentsEmploymentIdPricingPlanDetails = < }); /** - * Show legal entity administrative details form schema - * - * Returns the json schema of a supported form. Possible form names are: - * ``` - * - administrative_details - * ``` - * - * Most forms require a company access token, as they are dependent on certain - * properties of companies and their current employments. + * Show Probation Extension * + * Shows a Probation Extension Request. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View forms (`form:read`) | - | + * | Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) | * */ -export const getV1CountriesCountryCodeLegalEntityFormsForm = < +export const getV1ProbationExtensionsId = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1CountriesCountryCodeLegalEntityFormsFormData, - ThrowOnError - >, + options: Options, ) => (options.client ?? client).get< - GetV1CountriesCountryCodeLegalEntityFormsFormResponses, - GetV1CountriesCountryCodeLegalEntityFormsFormErrors, + GetV1ProbationExtensionsIdResponses, + GetV1ProbationExtensionsIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/countries/{country_code}/legal_entity_forms/{form}', - ...options, - }); + >({ url: '/api/eor/v1/probation-extensions/{id}', ...options }); /** - * Manage contractor plus subscription + * Download file * - * Endpoint that can be used to upgrade, assign or downgrade a contractor's subscription. - * This can be used when company admins desire to assign someone to the Contractor Plus plan, - * but also to change the contractor's subscription between Plus and Standard. + * Downloads a file. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const postV1ContractorsEmploymentsEmploymentIdContractorPlusSubscription = - ( - options: Options< - PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData, - ThrowOnError - >, - ) => - (options.client ?? client).post< - PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses, - PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-plus-subscription', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); +export const getV1FilesId = ( + options: Options, +) => + (options.client ?? client).get< + GetV1FilesIdResponses, + GetV1FilesIdErrors, + ThrowOnError + >({ url: '/api/eor/v1/files/{id}', ...options }); /** - * List Time Off + * List Company Departments + * + * Lists all departments for the authorized company specified in the request. * - * Lists all Time Off records. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) | + * | Manage company resources (`company_admin`) | View departments (`company_department:read`) | Manage departments (`company_department:write`) | * */ -export const getV1Timeoff = ( - options: Options, +export const getV1CompanyDepartments = ( + options: Options, ) => (options.client ?? client).get< - GetV1TimeoffResponses, - GetV1TimeoffErrors, + GetV1CompanyDepartmentsResponses, + GetV1CompanyDepartmentsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff', - ...options, - }); + >({ url: '/api/eor/v1/company-departments', ...options }); /** - * Create Time Off + * Create New Department * - * Creates a Time Off record + * Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points). * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage company resources (`company_admin`) | - | Manage departments (`company_department:write`) | * */ -export const postV1Timeoff = ( - options: Options, +export const postV1CompanyDepartments = ( + options: Options, ) => (options.client ?? client).post< - PostV1TimeoffResponses, - PostV1TimeoffErrors, + PostV1CompanyDepartmentsResponses, + PostV1CompanyDepartmentsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff', + url: '/api/eor/v1/company-departments', ...options, headers: { 'Content-Type': 'application/json', @@ -7943,9 +7302,9 @@ export const postV1Timeoff = ( }); /** - * List Company Payroll Runs + * Get Employee Details for a Payroll Run * - * Lists all payroll runs for a company + * Gets the employee details for a payroll run * * ## Scopes * @@ -7954,182 +7313,130 @@ export const postV1Timeoff = ( * | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | * */ -export const getV1PayrollRuns = ( - options?: Options, -) => - (options?.client ?? client).get< - GetV1PayrollRunsResponses, - GetV1PayrollRunsErrors, +export const getV1PayrollRunsPayrollRunIdEmployeeDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + GetV1PayrollRunsPayrollRunIdEmployeeDetailsData, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/payroll-runs', - ...options, - }); - -/** - * Get group by ID via SCIM v2.0 - * - * Retrieves a single group (department) for the authenticated company by group ID - */ -export const getV1ScimV2GroupsId = ( - options: Options, + >, ) => (options.client ?? client).get< - GetV1ScimV2GroupsIdResponses, - GetV1ScimV2GroupsIdErrors, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses, + GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/scim/v2/Groups/{id}', + url: '/api/eor/v1/payroll-runs/{payroll_run_id}/employee-details', ...options, }); /** - * List Employment Contract. + * Show employment * - * Get the employment contract history for a given employment. If `only_active` is true, it will return only the active or last active contract. + * Shows all the information of an employment. * - * ## Scopes + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | View contracts (`contract:read`) | - | + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. * - */ -export const getV1EmploymentContracts = ( - options: Options, -) => - (options.client ?? client).get< - GetV1EmploymentContractsResponses, - GetV1EmploymentContractsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employment-contracts', - ...options, - }); - -/** - * Convert currency using dynamic rates * - * Convert currency using the rates Remote applies during employment creation and invoicing. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - | + * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | * */ -export const postV1CurrencyConverterEffective2 = < +export const getV1EmploymentsEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostV1CurrencyConverterEffective2Responses, - PostV1CurrencyConverterEffective2Errors, + (options.client ?? client).get< + GetV1EmploymentsEmploymentIdResponses, + GetV1EmploymentsEmploymentIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/currency-converter', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options.headers, - }, - }); + >({ url: '/api/eor/v1/employments/{employment_id}', ...options }); /** - * List all companies + * Update employment * - * List all companies that authorized your integration to act on their behalf. In other words, these are all the companies that your integration can manage. Any company that has completed the authorization flow for your integration will be included in the response. + * Updates an employment. * - * ## Scopes + * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) | + * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. * - */ -export const getV1Companies = ( - options: Options, -) => - (options.client ?? client).get< - GetV1CompaniesResponses, - GetV1CompaniesErrors, - ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies', - ...options, - }); - -/** - * Create a company + * **For `invited` employments:** You can update the work_email. * - * Creates a new company. + * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. + * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. + * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. + * Currently, these amendments can only be done through the Remote UI. * - * ### Creating a company with only the required request body parameters - * When you call this endpoint and omit all the optional parameters in the request body, - * the following resources get created upon a successful response: - * * A new company with status `pending`. - * * A company owner for the new company with status `initiated`. + * It is possible to update the `external_id` of the employment for all employment statuses. * - * See the [update a company endpoint](#tag/Companies/operation/patch_update_company) for - * more details on how to get your company and its owner to `active` status. + * ## Global Payroll Employees + * + * To update a Global Payment employment your input data must comply with the global payroll json schemas. + * + * **For `active` employments:** In addition to the above list, you can update personal_details. + * + * ## Direct Employees + * + * To update an HRIS employment your input data must comply with the HRIS json schemas. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. * - * If you'd like to create a company and its owner with `active` status in a single request, - * please provide the optional `address_details` parameter as well. + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. * - * ### Accepting the Terms of Service + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. * - * A required step for creating a company in Remote is to accept our Terms of Service (ToS). + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. * - * Company managers need to be aware of our Terms of Service and Privacy Policy, - * hence **it's the responsibility of our partners to advise and ensure company managers read - * and accept the ToS**. The terms have to be accepted only once, before creating a company, - * and the Remote API will collect the acceptance timestamp as its confirmation. + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. * - * To ensure users read the most recent version of Remote's Terms of Service, their **acceptance - * must be done within the last fifteen minutes prior the company creation action**. * - * To retrieve this information, partners can provide an element with any text and a description - * explaining that by performing that action they are accepting Remote's Term of Service. For - * instance, the partner can add a checkbox or a "Create Remote Account" button followed by a - * description saying "By creating an account, you agree to - * [Remote's Terms of Service](https://remote.com/terms-of-service). Also see Remote's - * [Privacy Policy](https://remote.com/privacy-policy)". + * Please contact Remote if you need to update contractors via API since it's currently not supported. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage companies (`company_management`) | - | Manage companies (`company:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1Companies = ( - options: Options, +export const patchV1EmploymentsEmploymentId2 = < + ThrowOnError extends boolean = false, +>( + options: Options, ) => - (options.client ?? client).post< - PostV1CompaniesResponses, - PostV1CompaniesErrors, + (options.client ?? client).patch< + PatchV1EmploymentsEmploymentId2Responses, + PatchV1EmploymentsEmploymentId2Errors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/companies', + url: '/api/eor/v1/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -8138,64 +7445,71 @@ export const postV1Companies = ( }); /** - * Create bulk employment job + * Update employment * - * Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country. + * Updates an employment. * - * ## Scopes + * **For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information. * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * **For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email. * - */ -export const postV1BulkEmploymentJobs = ( - options?: Options, -) => - (options?.client ?? client).post< - PostV1BulkEmploymentJobsResponses, - PostV1BulkEmploymentJobsErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/bulk-employment-jobs', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, - }); - -/** - * Send back a timesheet for review or modification + * **For `invited` employments:** You can update the work_email. + * + * After onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`. + * If you want to provide additional information for an employment, please make sure to do so **before** the employee is invited. + * We block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details. + * Currently, these amendments can only be done through the Remote UI. + * + * It is possible to update the `external_id` of the employment for all employment statuses. + * + * ## Global Payroll Employees + * + * To update a Global Payment employment your input data must comply with the global payroll json schemas. + * + * **For `active` employments:** In addition to the above list, you can update personal_details. + * + * ## Direct Employees + * + * To update an HRIS employment your input data must comply with the HRIS json schemas. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool. + * + * + * Please contact Remote if you need to update contractors via API since it's currently not supported. * - * Sends the given timesheet back to the employee for review or modification. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timesheets (`timesheet:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1TimesheetsTimesheetIdSendBack = < +export const patchV1EmploymentsEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostV1TimesheetsTimesheetIdSendBackResponses, - PostV1TimesheetsTimesheetIdSendBackErrors, + (options.client ?? client).put< + PatchV1EmploymentsEmploymentIdResponses, + PatchV1EmploymentsEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timesheets/{timesheet_id}/send-back', + url: '/api/eor/v1/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -8204,100 +7518,81 @@ export const postV1TimesheetsTimesheetIdSendBack = < }); /** - * Deletes a Company Manager user + * List timesheets for the authenticated employee * - * Deletes a Company Manager user + * Returns a paginated list of timesheets for the authenticated employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) | + * | Manage timeoffs (`time_and_attendance`) | View timesheets (`timesheet:read`) | Manage timesheets (`timesheet:write`) | * */ -export const deleteV1CompanyManagersUserId = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeeTimesheets = ( + options?: Options, ) => - (options.client ?? client).delete< - DeleteV1CompanyManagersUserIdResponses, - DeleteV1CompanyManagersUserIdErrors, + (options?.client ?? client).get< + GetV1EmployeeTimesheetsResponses, + GetV1EmployeeTimesheetsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers/{user_id}', - ...options, - }); + >({ url: '/api/eor/v1/employee/timesheets', ...options }); /** - * Show company manager user + * Show a custom field value * - * Shows a single company manager user + * Returns a custom field value for a given employment * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) | + * | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) | * */ -export const getV1CompanyManagersUserId = < +export const getV1CustomFieldsCustomFieldIdValuesEmploymentId = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options< + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData, + ThrowOnError + >, ) => (options.client ?? client).get< - GetV1CompanyManagersUserIdResponses, - GetV1CompanyManagersUserIdErrors, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/company-managers/{user_id}', + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, }); /** - * Update emergency contact - * - * Updates the employment's emergency contact details. - * - * This endpoint requires country-specific data. Query the **Show form schema** endpoint - * passing the country code and `emergency_contact_details` as path parameters to see - * the required fields for a given country. + * Update a Custom Field Value * + * Updates a custom field value for a given employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | * */ -export const putV2EmploymentsEmploymentIdEmergencyContact = < +export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId2 = < ThrowOnError extends boolean = false, >( options: Options< - PutV2EmploymentsEmploymentIdEmergencyContactData, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data, ThrowOnError >, ) => - (options.client ?? client).put< - PutV2EmploymentsEmploymentIdEmergencyContactResponses, - PutV2EmploymentsEmploymentIdEmergencyContactErrors, + (options.client ?? client).patch< + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v2/employments/{employment_id}/emergency_contact', + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -8306,165 +7601,98 @@ export const putV2EmploymentsEmploymentIdEmergencyContact = < }); /** - * List expenses for the authenticated employee + * Update a Custom Field Value * - * Returns a paginated list of expenses belonging to the current employee. + * Updates a custom field value for a given employment. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) | + * | Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) | * */ -export const getV1EmployeeExpenses = ( - options?: Options, -) => - (options?.client ?? client).get< - GetV1EmployeeExpensesResponses, - GetV1EmployeeExpensesErrors, +export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId = < + ThrowOnError extends boolean = false, +>( + options: Options< + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/expenses', - ...options, - }); - -/** - * Create an expense for the authenticated employee - * - * Creates a new expense record for the current employee. - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) | - * - */ -export const postV1EmployeeExpenses = ( - options?: Options, + >, ) => - (options?.client ?? client).post< - PostV1EmployeeExpensesResponses, - PostV1EmployeeExpensesErrors, + (options.client ?? client).put< + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses, + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, ThrowOnError - >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/expenses', - ...options, - headers: { - 'Content-Type': 'application/json', - ...options?.headers, - }, - }); - -/** - * Delete contractor of record subscription intent - * - * Deletes Contractor of Record subscription intent. - * - * - * ## Scopes - * - * | Category | Read only Scope | Write only Scope (read access implicit) | - * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | - * - */ -export const deleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = - ( - options: Options< - DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, - ThrowOnError - >, - ) => - (options.client ?? client).delete< - DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, - DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription', - ...options, - }); + >({ + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); /** - * Create contractor of record subscription intent - * - * Assigns Contractor of Record subscription in pending state to employment. - * Once risk analysis is performed, subscription may start upon contract signing, - * or might be denied. - * - * Requires a non-blocking eligibility questionnaire to be submitted before creating the subscription intent. + * Validate resignation request * + * Validates a resignation employment request * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | + * | Manage employments (`employments`) | - | Manage resignations (`resignation:write`) | * */ -export const postV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = - ( - options: Options< - PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData, - ThrowOnError - >, - ) => - (options.client ?? client).post< - PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses, - PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, - ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription', - ...options, - }); +export const putV1ResignationsOffboardingRequestIdValidate = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV1ResignationsOffboardingRequestIdValidateData, + ThrowOnError + >, +) => + (options.client ?? client).put< + PutV1ResignationsOffboardingRequestIdValidateResponses, + PutV1ResignationsOffboardingRequestIdValidateErrors, + ThrowOnError + >({ + url: '/api/eor/v1/resignations/{offboarding_request_id}/validate', + ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, + }); /** - * List Contractor Invoice Schedules + * Show Contractor Invoice Schedule * - * Lists Contractor Invoice Schedule records. + * Shows a single Contractor Invoice Schedule record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | + * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | * */ -export const getV1ContractorInvoiceSchedules = < +export const getV1ContractorInvoiceSchedulesId = < ThrowOnError extends boolean = false, >( - options?: Options, + options: Options, ) => - (options?.client ?? client).get< - GetV1ContractorInvoiceSchedulesResponses, - GetV1ContractorInvoiceSchedulesErrors, + (options.client ?? client).get< + GetV1ContractorInvoiceSchedulesIdResponses, + GetV1ContractorInvoiceSchedulesIdErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules', - ...options, - }); + >({ url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options }); /** - * Create Contractor Invoice Schedules - * - * Creates many invoice schedules records. - * It's supposed to return two lists: one containing created records, and another one containing the schedules that failed to be inserted. + * Updates Contractor Invoice Schedule * + * Updates a contractor invoice schedule record * * ## Scopes * @@ -8473,21 +7701,17 @@ export const getV1ContractorInvoiceSchedules = < * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const postV1ContractorInvoiceSchedules = < +export const patchV1ContractorInvoiceSchedulesId2 = < ThrowOnError extends boolean = false, >( - options: Options, + options: Options, ) => - (options.client ?? client).post< - PostV1ContractorInvoiceSchedulesResponses, - PostV1ContractorInvoiceSchedulesErrors, + (options.client ?? client).patch< + PatchV1ContractorInvoiceSchedulesId2Responses, + PatchV1ContractorInvoiceSchedulesId2Errors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/contractor-invoice-schedules', + url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -8496,51 +7720,40 @@ export const postV1ContractorInvoiceSchedules = < }); /** - * Get engagement agreement details + * Updates Contractor Invoice Schedule * - * Returns the engagement agreement details for an employment. + * Updates a contractor invoice schedule record * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) | + * | Manage invoices (`invoices`) | - | Manage invoices (`invoices:write`) | * */ -export const getV1EmploymentsEmploymentIdEngagementAgreementDetails = < +export const patchV1ContractorInvoiceSchedulesId = < ThrowOnError extends boolean = false, >( - options: Options< - GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData, - ThrowOnError - >, + options: Options, ) => - (options.client ?? client).get< - GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, - GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + (options.client ?? client).put< + PatchV1ContractorInvoiceSchedulesIdResponses, + PatchV1ContractorInvoiceSchedulesIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/engagement-agreement-details', + url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Upsert engagement agreement details - * - * Creates or updates the engagement agreement details for an employment. - * - * This endpoint requires country-specific data. The exact required fields will vary depending on - * which country the employment is in. To see the list of parameters for each country, see the - * **Show form schema** endpoint under the [Countries](#tag/Countries) category. - * - * Please note that compliance requirements for each country are subject to change according to local laws. - * Using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) is recommended - * to avoid compliance issues and to have the latest version of a country's requirements. + * Update pricing plan details * + * Updates the pricing plan for an employment. The frequency determines how often Remote bills the + * employer for management fees. Annual billing typically offers a discount. * * * ## Scopes @@ -8550,24 +7763,20 @@ export const getV1EmploymentsEmploymentIdEngagementAgreementDetails = < * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1EmploymentsEmploymentIdEngagementAgreementDetails = < +export const putV2EmploymentsEmploymentIdPricingPlanDetails = < ThrowOnError extends boolean = false, >( options: Options< - PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData, + PutV2EmploymentsEmploymentIdPricingPlanDetailsData, ThrowOnError >, ) => - (options.client ?? client).post< - PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses, - PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses, + PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/employments/{employment_id}/engagement-agreement-details', + url: '/api/eor/v2/employments/{employment_id}/pricing_plan_details', ...options, headers: { 'Content-Type': 'application/json', @@ -8576,156 +7785,160 @@ export const postV1EmploymentsEmploymentIdEngagementAgreementDetails = < }); /** - * Get Billing Document Breakdown + * Create risk reserve * - * Get billing document breakdown + * Create a new risk reserve * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage company resources (`company_admin`) | - | Manage risk reserves (`risk_reserve:write`) | * */ -export const getV1BillingDocumentsBillingDocumentIdBreakdown = < - ThrowOnError extends boolean = false, ->( - options: Options< - GetV1BillingDocumentsBillingDocumentIdBreakdownData, - ThrowOnError - >, +export const postV1RiskReserve = ( + options: Options, ) => - (options.client ?? client).get< - GetV1BillingDocumentsBillingDocumentIdBreakdownResponses, - GetV1BillingDocumentsBillingDocumentIdBreakdownErrors, + (options.client ?? client).post< + PostV1RiskReserveResponses, + PostV1RiskReserveErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents/{billing_document_id}/breakdown', + url: '/api/eor/v1/risk-reserve', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Indexes all the documents for the employee + * Update address details + * + * Updates employment's address details. + * + * This endpoint requires and returns country-specific data. The exact required and returned fields will + * vary depending on which country the employment is in. To see the list of parameters for each country, + * see the **Show form schema** endpoint under the [Countries](#tag/Countries) category. + * + * Please note that the compliance requirements for each country are subject to change according to local + * laws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid + * compliance issues and to have the latest version of a country requirements. + * + * If you are using this endpoint to build an integration, make sure you are dynamically collecting or + * displaying the latest parameters for each country by querying the _"Show form schema"_ endpoint. + * + * For more information on JSON Schemas, see the **How JSON Schemas work** documentation. + * + * To learn how you can dynamically generate forms to display in your UI, see the documentation for + * the [json-schema-form](https://developer.remote.com/docs/how-json-schemas-form) tool. + * + * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const getV1EmployeeDocuments = ( - options?: Options, +export const putV2EmploymentsEmploymentIdAddressDetails = < + ThrowOnError extends boolean = false, +>( + options: Options< + PutV2EmploymentsEmploymentIdAddressDetailsData, + ThrowOnError + >, ) => - (options?.client ?? client).get< - GetV1EmployeeDocumentsResponses, - GetV1EmployeeDocumentsErrors, + (options.client ?? client).put< + PutV2EmploymentsEmploymentIdAddressDetailsResponses, + PutV2EmploymentsEmploymentIdAddressDetailsErrors, ThrowOnError >({ - security: [{ scheme: 'bearer', type: 'http' }], - url: '/v1/employee/documents', + url: '/api/eor/v2/employments/{employment_id}/address_details', ...options, + headers: { + 'Content-Type': 'application/json', + ...options.headers, + }, }); /** - * Approve a time off cancellation request - * - * Approve a time off cancellation request. - * In order to approve a time off cancellation request, the timeoff status must be `cancel_requested`. - * + * Return a base64 encoded version of the contract document * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage timeoffs (`time_and_attendance`) | - | Manage timeoffs (`timeoff:write`) | + * | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) | * */ -export const postV1TimeoffTimeoffIdCancelRequestApprove = < +export const getV1ContractorsEmploymentsEmploymentIdContractDocumentsId = < ThrowOnError extends boolean = false, >( options: Options< - PostV1TimeoffTimeoffIdCancelRequestApproveData, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData, ThrowOnError >, ) => - (options.client ?? client).post< - PostV1TimeoffTimeoffIdCancelRequestApproveResponses, - PostV1TimeoffTimeoffIdCancelRequestApproveErrors, + (options.client ?? client).get< + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses, + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/timeoff/{timeoff_id}/cancel-request/approve', + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{id}', ...options, }); /** - * Verify Employment Identity + * Create a contractor of record (COR) termination request * - * Endpoint to confirms the employment profile is from the actual employee + * Initiates a termination request for a Contractor of Record employment. + * When a termination request is sent, a stop work order is issued and the contractor remains active until a final invoice is paid or waived. + * Currently, only Contractor of Record employments can be terminated. * * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage employment documents (`employment_documents`) | - | Manage identity verification (`identity_verification:write`) | + * | Manage employments (`employments`) | - | Manage employments (`employment:write`) | * */ -export const postV1IdentityVerificationEmploymentIdVerify = < +export const postV1ContractorsEmploymentsEmploymentIdCorTerminationRequests = < ThrowOnError extends boolean = false, >( options: Options< - PostV1IdentityVerificationEmploymentIdVerifyData, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData, ThrowOnError >, ) => (options.client ?? client).post< - PostV1IdentityVerificationEmploymentIdVerifyResponses, - PostV1IdentityVerificationEmploymentIdVerifyErrors, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses, + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors, ThrowOnError >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/identity-verification/{employment_id}/verify', + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests', ...options, }); /** - * Download a billing document PDF + * List approved payslip files for the authenticated employee * - * Downloads a billing document PDF + * Returns a paginated list of payslip files belonging to the current employee. * * ## Scopes * * | Category | Read only Scope | Write only Scope (read access implicit) | * |---|---|---| - * | Manage invoices (`invoices`) | View invoices (`invoices:read`) | Manage invoices (`invoices:write`) | + * | Manage payroll runs (`payroll`) | View payslips (`payslip:read`) | - | * */ -export const getV1BillingDocumentsBillingDocumentIdPdf = < - ThrowOnError extends boolean = false, ->( - options: Options, +export const getV1EmployeePayslips = ( + options?: Options, ) => - (options.client ?? client).get< - GetV1BillingDocumentsBillingDocumentIdPdfResponses, - GetV1BillingDocumentsBillingDocumentIdPdfErrors, + (options?.client ?? client).get< + GetV1EmployeePayslipsResponses, + GetV1EmployeePayslipsErrors, ThrowOnError - >({ - security: [ - { scheme: 'bearer', type: 'http' }, - { scheme: 'bearer', type: 'http' }, - ], - url: '/v1/billing-documents/{billing_document_id}/pdf', - ...options, - }); + >({ url: '/api/eor/v1/employee/payslips', ...options }); diff --git a/src/client/types.gen.ts b/src/client/types.gen.ts index 465b40eb3..0cd4d31f3 100644 --- a/src/client/types.gen.ts +++ b/src/client/types.gen.ts @@ -1,10 +1,7 @@ // This file is auto-generated by @hey-api/openapi-ts export type ClientOptions = { - baseUrl: - | 'https://gateway.remote.com/' - | 'https://gateway.remote-sandbox.com/' - | (string & {}); + baseUrl: string; }; /** @@ -54,6 +51,19 @@ export type CreateEmployeeTimeoffParams = { timezone: Timezone; }; +/** + * CreatePreOnboardingDocumentResponse + * + * Returns the slug of the found-or-created pre-onboarding document. + */ +export type CreatePreOnboardingDocumentResponse = { + data: { + pre_onboarding_document: { + id: UuidSlug; + }; + }; +}; + /** * CreateCurrencyCustomFieldDefinitionParams * @@ -1046,6 +1056,51 @@ export type CreateRiskReserveParams = { employment_slug: string; }; +/** + * PreOnboardingDocumentRequirement + * + * A pre-onboarding document requirement that must be fulfilled before an employee can be onboarded. + */ +export type PreOnboardingDocumentRequirement = { + /** + * The requirement that must be fulfilled before this one becomes available (if any). + */ + depends_on_requirement?: PreOnboardingDocumentRequirement | null; + /** + * Human-readable description of the requirement. + */ + description: string; + /** + * Timestamp when the customer acknowledged the constraints (if any). + */ + document_constraints_ack_at?: string | null; + /** + * Whether the employment data is frozen because a document for this requirement exists. + */ + freeze_employment_data?: boolean | null; + /** + * Human-readable name of the requirement. + */ + name: string; + /** + * Whether the customer must acknowledge the hiring constraints of the country before creating a document. + */ + needs_constraints_ack: boolean; + /** + * Email address to contact for help with redlining when supported. + */ + redlining_help_email?: string | null; + slug: UuidSlug; + /** + * Current status of this requirement for the given employment. + */ + status?: 'blocked' | 'awaiting_signatures' | 'finished' | 'revised'; + /** + * Whether the requirement supports redlining (collaborative editing) of the generated document. + */ + supports_redlining: boolean; +}; + /** * HolidaysResponse * @@ -3853,6 +3908,31 @@ export type BulkEmploymentImportJob = { updated_at: DateTime; }; +/** + * ShowPreOnboardingDocumentResponse + * + * Returns the rendered contract PDF (base64) and signatories for a pre-onboarding document. + */ +export type ShowPreOnboardingDocumentResponse = { + data: { + pre_onboarding_document: { + /** + * Base64-encoded PDF, prefixed with `data:application/pdf;base64,`. + */ + content: Blob | File; + /** + * File name of the rendered document. + */ + name: string; + /** + * Parties that must sign or have signed the document. + */ + signatories: Array; + status: ContractorContractDocumentStatus; + }; + }; +}; + /** * JSONSchema * @@ -5491,8 +5571,8 @@ export type ResourceErrorResponse = { | 'parameter_value_unknown' | 'request_body_empty' | 'request_internal_server_error' - | 'parameter_one_of_required_missing' | 'parameter_required_missing' + | 'parameter_one_of_required_missing' | 'parameter_too_many' | 'parameter_unknown' | 'parameter_map_empty' @@ -8535,6 +8615,15 @@ export type IdentityCompany = { name: string; }; +/** + * IndexPreOnboardingDocumentRequirementsResponse + * + * List of pre-onboarding document requirements for an employment. + */ +export type IndexPreOnboardingDocumentRequirementsResponse = { + data: Array; +}; + /** * CreateGeneralCustomFieldDefinitionParams * @@ -11811,6 +11900,19 @@ export type BillingDocumentAmountItem = { */ export type EmploymentId = string; +/** + * FindOrCreatePreOnboardingDocumentParams + * + * Parameters to find an existing unsigned pre-onboarding document or create a new one. + */ +export type FindOrCreatePreOnboardingDocumentParams = { + /** + * Timestamp when the customer acknowledged the hiring constraints. Required when the requirement has `needs_constraints_ack: true`. + */ + constraints_ack_at?: string | null; + pre_onboarding_document_requirement_slug: UuidSlug; +}; + /** * ContractAmendmentResponse * @@ -11868,37 +11970,22 @@ export type ContractorInvoiceScheduleCreateResponseSuccess = { start_date: string; }; -export type GetV1OffboardingsData = { - body?: never; - path?: never; - query?: { - /** - * Filter by Employment ID - */ - employment_id?: string; - /** - * Filter by offboarding type - */ - type?: string; - /** - * By default, the results do not include confidential termination requests. - * Send `include_confidential=true` to include confidential requests in the response. - * - */ - include_confidential?: string; - /** - * Starts fetching records after the given page - */ - page?: number; +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsData = { + /** + * Employment administrative details params + */ + body?: EmploymentAdministrativeDetailsParams; + path: { /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/offboardings'; + query?: never; + url: '/api/eor/v2/employments/{employment_id}/administrative_details'; }; -export type GetV1OffboardingsErrors = { +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors = { /** * Bad Request */ @@ -11907,52 +11994,62 @@ export type GetV1OffboardingsErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetV1OffboardingsError = - GetV1OffboardingsErrors[keyof GetV1OffboardingsErrors]; +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsError = + PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors[keyof PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors]; -export type GetV1OffboardingsResponses = { +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses = { /** * Success */ - 200: ListOffboardingResponse; + 200: EmploymentResponse; }; -export type GetV1OffboardingsResponse = - GetV1OffboardingsResponses[keyof GetV1OffboardingsResponses]; +export type PutV2EmploymentsEmploymentIdAdministrativeDetailsResponse = + PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses[keyof PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses]; -export type PostV1OffboardingsData = { - /** - * Offboarding - */ - body?: CreateOffboardingParams; - path?: never; +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/offboardings'; + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details'; }; -export type PostV1OffboardingsErrors = { +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** * Not Found */ @@ -11962,148 +12059,171 @@ export type PostV1OffboardingsErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; - /** - * Internal Server Error - */ - 500: RequestError; }; -export type PostV1OffboardingsError = - PostV1OffboardingsErrors[keyof PostV1OffboardingsErrors]; +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsError = + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type PostV1OffboardingsResponses = { +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 201: OffboardingResponse; + 200: EmploymentEngagementAgreementDetailsResponse; }; -export type PostV1OffboardingsResponse = - PostV1OffboardingsResponses[keyof PostV1OffboardingsResponses]; +export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type GetV1TimesheetsIdData = { - body?: never; +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { + /** + * Employment engagement agreement details params + */ + body?: EmploymentEngagementAgreementDetailsParams; path: { /** - * Timesheet ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/timesheets/{id}'; + url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details'; }; -export type GetV1TimesheetsIdErrors = { +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1TimesheetsIdError = - GetV1TimesheetsIdErrors[keyof GetV1TimesheetsIdErrors]; +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsError = + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type GetV1TimesheetsIdResponses = { +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 200: TimesheetResponse; + 200: SuccessResponse; }; -export type GetV1TimesheetsIdResponse = - GetV1TimesheetsIdResponses[keyof GetV1TimesheetsIdResponses]; +export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type PostV1CancelOnboardingEmploymentIdData = { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Whether the request should be performed async - * - */ - async?: boolean; - }; - url: '/v1/cancel-onboarding/{employment_id}'; +export type PostV1CurrencyConverterEffective2Data = { + /** + * Convert currency parameters + */ + body: ConvertCurrencyParams; + path?: never; + query?: never; + url: '/api/eor/v1/currency-converter'; }; -export type PostV1CancelOnboardingEmploymentIdErrors = { +export type PostV1CurrencyConverterEffective2Errors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PostV1CancelOnboardingEmploymentIdError = - PostV1CancelOnboardingEmploymentIdErrors[keyof PostV1CancelOnboardingEmploymentIdErrors]; +export type PostV1CurrencyConverterEffective2Error = + PostV1CurrencyConverterEffective2Errors[keyof PostV1CurrencyConverterEffective2Errors]; -export type PostV1CancelOnboardingEmploymentIdResponses = { +export type PostV1CurrencyConverterEffective2Responses = { /** * Success */ - 200: SuccessResponse; + 200: ConvertCurrencyResponse; }; -export type PostV1CancelOnboardingEmploymentIdResponse = - PostV1CancelOnboardingEmploymentIdResponses[keyof PostV1CancelOnboardingEmploymentIdResponses]; +export type PostV1CurrencyConverterEffective2Response = + PostV1CurrencyConverterEffective2Responses[keyof PostV1CurrencyConverterEffective2Responses]; -export type GetV1ContractAmendmentsSchemaData = { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-subscriptions'; }; - path?: never; - query: { + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors = + { /** - * The ID of the employment concerned by the contract amendment request. + * Unauthorized */ - employment_id: string; + 401: UnauthorizedResponse; /** - * Country code according to ISO 3-digit alphabetic codes. + * Forbidden */ - country_code: string; + 403: ForbiddenResponse; /** - * Name of the desired form + * Not Found */ - form?: 'contract_amendment'; + 404: NotFoundResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsError = + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors]; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses = + { /** - * Version of the form schema + * Success */ - json_schema_version?: number | 'latest'; + 200: ContractorSubscriptionSummariesResponse; }; - url: '/v1/contract-amendments/schema'; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponse = + GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses]; + +export type PostV1CurrencyConverterRawData = { + /** + * Convert currency parameters + */ + body: ConvertCurrencyParams; + path?: never; + query?: never; + url: '/api/eor/v1/currency-converter/raw'; }; -export type GetV1ContractAmendmentsSchemaErrors = { +export type PostV1CurrencyConverterRawErrors = { /** * Unauthorized */ @@ -12118,73 +12238,112 @@ export type GetV1ContractAmendmentsSchemaErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1ContractAmendmentsSchemaError = - GetV1ContractAmendmentsSchemaErrors[keyof GetV1ContractAmendmentsSchemaErrors]; +export type PostV1CurrencyConverterRawError = + PostV1CurrencyConverterRawErrors[keyof PostV1CurrencyConverterRawErrors]; -export type GetV1ContractAmendmentsSchemaResponses = { +export type PostV1CurrencyConverterRawResponses = { /** * Success */ - 200: ContractAmendmentFormResponse; + 200: ConvertCurrencyResponse; }; -export type GetV1ContractAmendmentsSchemaResponse = - GetV1ContractAmendmentsSchemaResponses[keyof GetV1ContractAmendmentsSchemaResponses]; +export type PostV1CurrencyConverterRawResponse = + PostV1CurrencyConverterRawResponses[keyof PostV1CurrencyConverterRawResponses]; -export type PostV1PayItemsBulkData = { - /** - * Pay Items - */ - body: BulkCreatePayItemsParams; +export type GetV1IncentivesData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; - query?: never; - url: '/v1/pay-items/bulk'; + query?: { + /** + * Filter by Employment ID + */ + employment_id?: string; + /** + * Filter by Incentive status + */ + status?: string; + /** + * Filter by Recurring Incentive id + */ + recurring_incentive_id?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; + }; + url: '/api/eor/v1/incentives'; }; -export type PostV1PayItemsBulkErrors = { +export type GetV1IncentivesErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostV1PayItemsBulkError = - PostV1PayItemsBulkErrors[keyof PostV1PayItemsBulkErrors]; +export type GetV1IncentivesError = + GetV1IncentivesErrors[keyof GetV1IncentivesErrors]; -export type PostV1PayItemsBulkResponses = { +export type GetV1IncentivesResponses = { /** * Success */ - 200: BulkCreatePayItemsResponse; + 200: ListIncentivesResponse; }; -export type PostV1PayItemsBulkResponse = - PostV1PayItemsBulkResponses[keyof PostV1PayItemsBulkResponses]; +export type GetV1IncentivesResponse = + GetV1IncentivesResponses[keyof GetV1IncentivesResponses]; -export type GetV1DataSyncData = { - body?: never; +export type PostV1IncentivesData = { + /** + * Incentive + */ + body?: CreateOneTimeIncentiveParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; query?: never; - url: '/v1/data-sync'; + url: '/api/eor/v1/incentives'; }; -export type GetV1DataSyncErrors = { +export type PostV1IncentivesErrors = { /** * Bad Request */ @@ -12194,46 +12353,88 @@ export type GetV1DataSyncErrors = { */ 401: UnauthorizedResponse; /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetV1DataSyncError = GetV1DataSyncErrors[keyof GetV1DataSyncErrors]; +export type PostV1IncentivesError = + PostV1IncentivesErrors[keyof PostV1IncentivesErrors]; -export type GetV1DataSyncResponses = { +export type PostV1IncentivesResponses = { /** * Success */ - 200: ListDataSyncEventsResponse; + 201: IncentiveResponse; }; -export type GetV1DataSyncResponse = - GetV1DataSyncResponses[keyof GetV1DataSyncResponses]; +export type PostV1IncentivesResponse = + PostV1IncentivesResponses[keyof PostV1IncentivesResponses]; -export type PostV1DataSyncData = { +export type GetV1BenefitOffersData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path?: never; + query?: never; + url: '/api/eor/v1/benefit-offers'; +}; + +export type GetV1BenefitOffersErrors = { /** - * DataSync + * Not Found */ - body: CreateDataSyncParams; + 404: NotFoundResponse; +}; + +export type GetV1BenefitOffersError = + GetV1BenefitOffersErrors[keyof GetV1BenefitOffersErrors]; + +export type GetV1BenefitOffersResponses = { + /** + * Success + */ + 200: BenefitOfferByEmploymentResponse; +}; + +export type GetV1BenefitOffersResponse = + GetV1BenefitOffersResponses[keyof GetV1BenefitOffersResponses]; + +export type PostV1ReadyData = { + /** + * Employment slug + */ + body?: CompleteOnboarding; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; query?: never; - url: '/v1/data-sync'; + url: '/api/eor/v1/ready'; }; -export type PostV1DataSyncErrors = { +export type PostV1ReadyErrors = { /** * Bad Request */ @@ -12245,7 +12446,7 @@ export type PostV1DataSyncErrors = { /** * Conflict */ - 409: ConflictErrorResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -12256,33 +12457,29 @@ export type PostV1DataSyncErrors = { 429: TooManyRequestsResponse; }; -export type PostV1DataSyncError = - PostV1DataSyncErrors[keyof PostV1DataSyncErrors]; +export type PostV1ReadyError = PostV1ReadyErrors[keyof PostV1ReadyErrors]; -export type PostV1DataSyncResponses = { +export type PostV1ReadyResponses = { /** - * Accepted + * Success */ - 202: unknown; + 200: EmploymentResponse; }; -export type GetV1CompaniesCompanyIdPricingPlansData = { - body?: never; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - }; - query?: never; - url: '/v1/companies/{company_id}/pricing-plans'; -}; +export type PostV1ReadyResponse = + PostV1ReadyResponses[keyof PostV1ReadyResponses]; -export type GetV1CompaniesCompanyIdPricingPlansErrors = { +export type PostV1CostCalculatorEstimationData = { /** - * Unauthorized + * Estimate params */ - 401: UnauthorizedResponse; + body: CostCalculatorEstimateParams; + path?: never; + query?: never; + url: '/api/eor/v1/cost-calculator/estimation'; +}; + +export type PostV1CostCalculatorEstimationErrors = { /** * Not Found */ @@ -12293,35 +12490,61 @@ export type GetV1CompaniesCompanyIdPricingPlansErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1CompaniesCompanyIdPricingPlansError = - GetV1CompaniesCompanyIdPricingPlansErrors[keyof GetV1CompaniesCompanyIdPricingPlansErrors]; - -export type GetV1CompaniesCompanyIdPricingPlansResponses = { +export type PostV1CostCalculatorEstimationError = + PostV1CostCalculatorEstimationErrors[keyof PostV1CostCalculatorEstimationErrors]; + +export type PostV1CostCalculatorEstimationResponses = { /** * Success */ - 200: ListCompanyPricingPlansResponse; + 200: CostCalculatorEstimateResponse; }; -export type GetV1CompaniesCompanyIdPricingPlansResponse = - GetV1CompaniesCompanyIdPricingPlansResponses[keyof GetV1CompaniesCompanyIdPricingPlansResponses]; +export type PostV1CostCalculatorEstimationResponse = + PostV1CostCalculatorEstimationResponses[keyof PostV1CostCalculatorEstimationResponses]; -export type PostV1CompaniesCompanyIdPricingPlansData = { - /** - * Create Pricing Plan parameters - */ - body: CreatePricingPlanParams; - path: { +export type GetV1IncentivesRecurringData = { + body?: never; + headers: { /** - * Company ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - company_id: UuidSlug; + Authorization: string; }; - query?: never; - url: '/v1/companies/{company_id}/pricing-plans'; + path?: never; + query?: { + /** + * Filter by recurring incentive status: active or deactive. + */ + status?: string; + /** + * Filter by recurring incentive type. + */ + type?: string; + /** + * Filter by recurring incentives that contain the value in their notes. + */ + note?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; + }; + url: '/api/eor/v1/incentives/recurring'; }; -export type PostV1CompaniesCompanyIdPricingPlansErrors = { +export type GetV1IncentivesRecurringErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12334,34 +12557,49 @@ export type PostV1CompaniesCompanyIdPricingPlansErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostV1CompaniesCompanyIdPricingPlansError = - PostV1CompaniesCompanyIdPricingPlansErrors[keyof PostV1CompaniesCompanyIdPricingPlansErrors]; +export type GetV1IncentivesRecurringError = + GetV1IncentivesRecurringErrors[keyof GetV1IncentivesRecurringErrors]; -export type PostV1CompaniesCompanyIdPricingPlansResponses = { +export type GetV1IncentivesRecurringResponses = { /** * Success */ - 200: CreatePricingPlanResponse; + 201: ListRecurringIncentivesResponse; }; -export type PostV1CompaniesCompanyIdPricingPlansResponse = - PostV1CompaniesCompanyIdPricingPlansResponses[keyof PostV1CompaniesCompanyIdPricingPlansResponses]; +export type GetV1IncentivesRecurringResponse = + GetV1IncentivesRecurringResponses[keyof GetV1IncentivesRecurringResponses]; -export type GetV1ProbationCompletionLetterIdData = { - body?: never; - path: { +export type PostV1IncentivesRecurringData = { + /** + * RecurringIncentive + */ + body?: CreateRecurringIncentiveParams; + headers: { /** - * probation completion letter ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/probation-completion-letter/{id}'; + url: '/api/eor/v1/incentives/recurring'; }; -export type GetV1ProbationCompletionLetterIdErrors = { +export type PostV1IncentivesRecurringErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12374,42 +12612,58 @@ export type GetV1ProbationCompletionLetterIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1ProbationCompletionLetterIdError = - GetV1ProbationCompletionLetterIdErrors[keyof GetV1ProbationCompletionLetterIdErrors]; +export type PostV1IncentivesRecurringError = + PostV1IncentivesRecurringErrors[keyof PostV1IncentivesRecurringErrors]; -export type GetV1ProbationCompletionLetterIdResponses = { +export type PostV1IncentivesRecurringResponses = { /** * Success */ - 200: ProbationCompletionLetterResponse; + 201: RecurringIncentiveResponse; }; -export type GetV1ProbationCompletionLetterIdResponse = - GetV1ProbationCompletionLetterIdResponses[keyof GetV1ProbationCompletionLetterIdResponses]; +export type PostV1IncentivesRecurringResponse = + PostV1IncentivesRecurringResponses[keyof PostV1IncentivesRecurringResponses]; -export type GetV1ContractorInvoicesIdData = { +export type GetV1TimesheetsData = { body?: never; - path: { + path?: never; + query?: { /** - * Resource unique identifier + * Filter timesheets by their status */ - id: UuidSlug; + status?: TimesheetStatus; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'submitted_at'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/contractor-invoices/{id}'; + url: '/api/eor/v1/timesheets'; }; -export type GetV1ContractorInvoicesIdErrors = { +export type GetV1TimesheetsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -12420,30 +12674,34 @@ export type GetV1ContractorInvoicesIdErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1ContractorInvoicesIdError = - GetV1ContractorInvoicesIdErrors[keyof GetV1ContractorInvoicesIdErrors]; +export type GetV1TimesheetsError = + GetV1TimesheetsErrors[keyof GetV1TimesheetsErrors]; -export type GetV1ContractorInvoicesIdResponses = { +export type GetV1TimesheetsResponses = { /** * Success */ - 200: ContractorInvoiceResponse; + 200: ListTimesheetsResponse; }; -export type GetV1ContractorInvoicesIdResponse = - GetV1ContractorInvoicesIdResponses[keyof GetV1ContractorInvoicesIdResponses]; +export type GetV1TimesheetsResponse = + GetV1TimesheetsResponses[keyof GetV1TimesheetsResponses]; -export type PostV1CurrencyConverterRawData = { +export type PostV1TimesheetsData = { /** - * Convert currency parameters + * Timesheet */ - body: ConvertCurrencyParams; + body?: CreateTimesheetParams; path?: never; query?: never; - url: '/v1/currency-converter/raw'; + url: '/api/eor/v1/timesheets'; }; -export type PostV1CurrencyConverterRawErrors = { +export type PostV1TimesheetsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12458,45 +12716,32 @@ export type PostV1CurrencyConverterRawErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1CurrencyConverterRawError = - PostV1CurrencyConverterRawErrors[keyof PostV1CurrencyConverterRawErrors]; +export type PostV1TimesheetsError = + PostV1TimesheetsErrors[keyof PostV1TimesheetsErrors]; -export type PostV1CurrencyConverterRawResponses = { +export type PostV1TimesheetsResponses = { /** * Success */ - 200: ConvertCurrencyResponse; + 200: TimesheetResponse; }; -export type PostV1CurrencyConverterRawResponse = - PostV1CurrencyConverterRawResponses[keyof PostV1CurrencyConverterRawResponses]; +export type PostV1TimesheetsResponse = + PostV1TimesheetsResponses[keyof PostV1TimesheetsResponses]; -export type GetV1CountriesCountryCodeContractorContractDetailsData = { +export type PostV1TimesheetsTimesheetIdApproveData = { body?: never; path: { /** - * Country code according to ISO 3-digit alphabetic codes - */ - country_code: string; - }; - query?: { - /** - * Employment ID - */ - employment_id?: string; - /** - * Version of the form schema + * Timesheet ID */ - json_schema_version?: number | 'latest'; + timesheet_id: string; }; - url: '/v1/countries/{country_code}/contractor-contract-details'; + query?: never; + url: '/api/eor/v1/timesheets/{timesheet_id}/approve'; }; -export type GetV1CountriesCountryCodeContractorContractDetailsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1TimesheetsTimesheetIdApproveErrors = { /** * Unauthorized */ @@ -12509,33 +12754,33 @@ export type GetV1CountriesCountryCodeContractorContractDetailsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetV1CountriesCountryCodeContractorContractDetailsError = - GetV1CountriesCountryCodeContractorContractDetailsErrors[keyof GetV1CountriesCountryCodeContractorContractDetailsErrors]; +export type PostV1TimesheetsTimesheetIdApproveError = + PostV1TimesheetsTimesheetIdApproveErrors[keyof PostV1TimesheetsTimesheetIdApproveErrors]; -export type GetV1CountriesCountryCodeContractorContractDetailsResponses = { +export type PostV1TimesheetsTimesheetIdApproveResponses = { /** * Success */ - 200: ContractorContractDetailsResponse; + 200: MinimalTimesheetResponse; }; -export type GetV1CountriesCountryCodeContractorContractDetailsResponse = - GetV1CountriesCountryCodeContractorContractDetailsResponses[keyof GetV1CountriesCountryCodeContractorContractDetailsResponses]; +export type PostV1TimesheetsTimesheetIdApproveResponse = + PostV1TimesheetsTimesheetIdApproveResponses[keyof PostV1TimesheetsTimesheetIdApproveResponses]; -export type GetV1EmployeeIncentivesData = { +export type GetV1DataSyncData = { body?: never; path?: never; query?: never; - url: '/v1/employee/incentives'; + url: '/api/eor/v1/data-sync'; }; -export type GetV1EmployeeIncentivesErrors = { +export type GetV1DataSyncErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12545,139 +12790,42 @@ export type GetV1EmployeeIncentivesErrors = { */ 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmployeeIncentivesError = - GetV1EmployeeIncentivesErrors[keyof GetV1EmployeeIncentivesErrors]; +export type GetV1DataSyncError = GetV1DataSyncErrors[keyof GetV1DataSyncErrors]; -export type GetV1EmployeeIncentivesResponses = { +export type GetV1DataSyncResponses = { /** * Success */ - 200: SuccessResponse; + 200: ListDataSyncEventsResponse; }; -export type GetV1EmployeeIncentivesResponse = - GetV1EmployeeIncentivesResponses[keyof GetV1EmployeeIncentivesResponses]; +export type GetV1DataSyncResponse = + GetV1DataSyncResponses[keyof GetV1DataSyncResponses]; -export type GetV1EmploymentsData = { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: { - /** - * Company ID - */ - company_id?: string; - /** - * Filters the results by employments whose login email matches the value - */ - email?: string; - /** - * Filters the results by employments whose status matches the value. - * Supports multiple values separated by commas. - * Also supports the value `incomplete` to get all employments that are not onboarded yet. - * - */ - status?: string; - /** - * Filters the results by employments whose employment product type matches the value - */ - employment_type?: string; - /** - * Filters the results by employments whose employment model matches the value. - * Possible values: `global_payroll`, `peo`, `eor` - * - */ - employment_model?: 'global_payroll' | 'peo' | 'eor'; - /** - * Filters the results by the employment's short ID. Returns at most one result. - */ - short_id?: string; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/employments'; -}; - -export type GetV1EmploymentsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; -}; - -export type GetV1EmploymentsError = - GetV1EmploymentsErrors[keyof GetV1EmploymentsErrors]; - -export type GetV1EmploymentsResponses = { - /** - * Success - */ - 200: ListEmploymentsResponse; -}; - -export type GetV1EmploymentsResponse = - GetV1EmploymentsResponses[keyof GetV1EmploymentsResponses]; - -export type PostV1EmploymentsData = { +export type PostV1DataSyncData = { /** - * Employment params + * DataSync */ - body?: EmploymentCreateParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body: CreateDataSyncParams; path?: never; - query?: { - /** - * Version of the form schema - */ - json_schema_version?: number | 'latest'; - }; - url: '/v1/employments'; + query?: never; + url: '/api/eor/v1/data-sync'; }; -export type PostV1EmploymentsErrors = { +export type PostV1DataSyncErrors = { /** * Bad Request */ @@ -12689,7 +12837,7 @@ export type PostV1EmploymentsErrors = { /** * Conflict */ - 409: ConflictResponse; + 409: ConflictErrorResponse; /** * Unprocessable Entity */ @@ -12700,163 +12848,122 @@ export type PostV1EmploymentsErrors = { 429: TooManyRequestsResponse; }; -export type PostV1EmploymentsError = - PostV1EmploymentsErrors[keyof PostV1EmploymentsErrors]; +export type PostV1DataSyncError = + PostV1DataSyncErrors[keyof PostV1DataSyncErrors]; -export type PostV1EmploymentsResponses = { +export type PostV1DataSyncResponses = { /** - * Success + * Accepted */ - 200: EmploymentCreationResponse; + 202: unknown; }; -export type PostV1EmploymentsResponse = - PostV1EmploymentsResponses[keyof PostV1EmploymentsResponses]; - -export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData = - { - body?: never; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - /** - * Employment ID - */ - employment_id: UuidSlug; - }; - query?: never; - url: '/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status'; - }; - -export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors = - { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - }; - -export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusError = - GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors[keyof GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors]; - -export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses = - { - /** - * Success - */ - 200: OnboardingReservesStatusResponse; - }; - -export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponse = - GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses[keyof GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses]; - -export type GetV1HelpCenterArticlesIdData = { +export type GetV1ProbationCompletionLetterIdData = { body?: never; path: { /** - * Help Center Article Zendesk ID + * probation completion letter ID */ - id: number; + id: string; }; query?: never; - url: '/v1/help-center-articles/{id}'; + url: '/api/eor/v1/probation-completion-letter/{id}'; }; -export type GetV1HelpCenterArticlesIdErrors = { +export type GetV1ProbationCompletionLetterIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type GetV1HelpCenterArticlesIdError = - GetV1HelpCenterArticlesIdErrors[keyof GetV1HelpCenterArticlesIdErrors]; +export type GetV1ProbationCompletionLetterIdError = + GetV1ProbationCompletionLetterIdErrors[keyof GetV1ProbationCompletionLetterIdErrors]; -export type GetV1HelpCenterArticlesIdResponses = { +export type GetV1ProbationCompletionLetterIdResponses = { /** * Success */ - 200: HelpCenterArticleResponse; + 200: ProbationCompletionLetterResponse; }; -export type GetV1HelpCenterArticlesIdResponse = - GetV1HelpCenterArticlesIdResponses[keyof GetV1HelpCenterArticlesIdResponses]; +export type GetV1ProbationCompletionLetterIdResponse = + GetV1ProbationCompletionLetterIdResponses[keyof GetV1ProbationCompletionLetterIdResponses]; -export type GetV1ScimV2UsersIdData = { +export type GetV1SsoConfigurationData = { body?: never; - path: { - /** - * User ID (slug) - */ - id: string; - }; + path?: never; query?: never; - url: '/v1/scim/v2/Users/{id}'; + url: '/api/eor/v1/sso-configuration'; }; -export type GetV1ScimV2UsersIdErrors = { +export type GetV1SsoConfigurationErrors = { /** - * Unauthorized + * Bad Request */ - 401: IntegrationsScimErrorResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** * Not Found */ - 404: IntegrationsScimErrorResponse; + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1ScimV2UsersIdError = - GetV1ScimV2UsersIdErrors[keyof GetV1ScimV2UsersIdErrors]; +export type GetV1SsoConfigurationError = + GetV1SsoConfigurationErrors[keyof GetV1SsoConfigurationErrors]; -export type GetV1ScimV2UsersIdResponses = { +export type GetV1SsoConfigurationResponses = { /** * Success */ - 200: IntegrationsScimUser; + 200: SsoConfigurationResponse; }; -export type GetV1ScimV2UsersIdResponse = - GetV1ScimV2UsersIdResponses[keyof GetV1ScimV2UsersIdResponses]; +export type GetV1SsoConfigurationResponse = + GetV1SsoConfigurationResponses[keyof GetV1SsoConfigurationResponses]; -export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; +export type PostV1SsoConfigurationData = { + /** + * CreateSSOConfiguration + */ + body: CreateSsoConfigurationParams; + path?: never; query?: never; - url: '/v2/employments/{employment_id}/engagement-agreement-details'; + url: '/api/eor/v1/sso-configuration'; }; -export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { +export type PostV1SsoConfigurationErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -12867,87 +12974,100 @@ export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { 429: TooManyRequestsResponse; }; -export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsError = - GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; +export type PostV1SsoConfigurationError = + PostV1SsoConfigurationErrors[keyof PostV1SsoConfigurationErrors]; -export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { +export type PostV1SsoConfigurationResponses = { /** - * Success + * Created */ - 200: EmploymentEngagementAgreementDetailsResponse; + 201: CreateSsoConfigurationResponse; }; -export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse = - GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; +export type PostV1SsoConfigurationResponse = + PostV1SsoConfigurationResponses[keyof PostV1SsoConfigurationResponses]; -export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { - /** - * Employment engagement agreement details params - */ - body?: EmploymentEngagementAgreementDetailsParams; - path: { +export type GetV1OffboardingsData = { + body?: never; + path?: never; + query?: { /** - * Employment ID + * Filter by Employment ID */ - employment_id: string; + employment_id?: string; + /** + * Filter by offboarding type + */ + type?: string; + /** + * By default, the results do not include confidential termination requests. + * Send `include_confidential=true` to include confidential requests in the response. + * + */ + include_confidential?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; }; - query?: never; - url: '/v2/employments/{employment_id}/engagement-agreement-details'; + url: '/api/eor/v1/offboardings'; }; -export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { +export type GetV1OffboardingsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsError = - PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; +export type GetV1OffboardingsError = + GetV1OffboardingsErrors[keyof GetV1OffboardingsErrors]; -export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { +export type GetV1OffboardingsResponses = { /** * Success */ - 200: SuccessResponse; + 200: ListOffboardingResponse; }; -export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse = - PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; +export type GetV1OffboardingsResponse = + GetV1OffboardingsResponses[keyof GetV1OffboardingsResponses]; -export type GetV1EmployeeDocumentsIdData = { - body?: never; - path: { - /** - * Document ID - */ - id: string; - }; +export type PostV1OffboardingsData = { + /** + * Offboarding + */ + body?: CreateOffboardingParams; + path?: never; query?: never; - url: '/v1/employee/documents/{id}'; + url: '/api/eor/v1/offboardings'; }; -export type GetV1EmployeeDocumentsIdErrors = { +export type PostV1OffboardingsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -12960,94 +13080,49 @@ export type GetV1EmployeeDocumentsIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; + /** + * Internal Server Error + */ + 500: RequestError; }; -export type GetV1EmployeeDocumentsIdError = - GetV1EmployeeDocumentsIdErrors[keyof GetV1EmployeeDocumentsIdErrors]; +export type PostV1OffboardingsError = + PostV1OffboardingsErrors[keyof PostV1OffboardingsErrors]; -export type GetV1EmployeeDocumentsIdResponses = { +export type PostV1OffboardingsResponses = { /** * Success */ - 200: DownloadDocumentResponse; + 201: OffboardingResponse; }; -export type GetV1EmployeeDocumentsIdResponse = - GetV1EmployeeDocumentsIdResponses[keyof GetV1EmployeeDocumentsIdResponses]; +export type PostV1OffboardingsResponse = + PostV1OffboardingsResponses[keyof PostV1OffboardingsResponses]; -export type GetV1ContractorInvoicesData = { - body?: never; - path?: never; - query?: { - /** - * Filters contractor invoices by status matching the value. - */ - status?: ContractorInvoiceStatus; - /** - * Filters contractor invoices by invoice schedule ID matching the value. - */ - contractor_invoice_schedule_id?: UuidSlug; - /** - * Filters contractor invoices by date greater than or equal to the value. - */ - date_from?: Date; - /** - * Filters contractor invoices by date less than or equal to the value. - */ - date_to?: Date; - /** - * Filters contractor invoices by due date greater than or equal to the value. - */ - due_date_from?: Date; - /** - * Filters contractor invoices by due date less than or equal to the value. - */ - due_date_to?: Date; - /** - * Filters contractor invoices by approved date greater than or equal to the value. - */ - approved_date_from?: Date; - /** - * Filters contractor invoices by approved date less than or equal to the value. - */ - approved_date_to?: Date; - /** - * Filters contractor invoices by paid out date greater than or equal to the value. - */ - paid_out_date_from?: Date; - /** - * Filters contractor invoices by paid out date less than or equal to the value. - */ - paid_out_date_to?: Date; - /** - * Field to sort by - */ - sort_by?: 'date' | 'due_date' | 'approved_at' | 'paid_out_at'; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - /** - * Starts fetching records after the given page - */ - page?: number; +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData = { + /** + * CreateContractDocumentParams + */ + body: CreateContractDocument; + path: { /** - * Number of items per page + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/contractor-invoices'; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents'; }; -export type GetV1ContractorInvoicesErrors = { +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -13058,100 +13133,92 @@ export type GetV1ContractorInvoicesErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1ContractorInvoicesError = - GetV1ContractorInvoicesErrors[keyof GetV1ContractorInvoicesErrors]; +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsError = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors]; -export type GetV1ContractorInvoicesResponses = { - /** - * Success - */ - 200: ListContractorInvoicesResponse; -}; +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses = + { + /** + * Success + */ + 200: CreateContractDocumentResponse; + }; -export type GetV1ContractorInvoicesResponse = - GetV1ContractorInvoicesResponses[keyof GetV1ContractorInvoicesResponses]; +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponse = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses]; -export type PostV1SdkTelemetryErrorsData = { +export type PutV1EmploymentsEmploymentIdFederalTaxesData = { /** - * SDK Error Report + * Employment federal taxes params */ - body: SdkErrorPayload; - path?: never; + body?: EmploymentFederalTaxesParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/sdk/telemetry-errors'; + url: '/api/eor/v1/employments/{employment_id}/federal-taxes'; }; -export type PostV1SdkTelemetryErrorsErrors = { +export type PutV1EmploymentsEmploymentIdFederalTaxesErrors = { /** * Bad Request */ - 400: ErrorResponse; - /** - * Too Many Requests - */ - 429: RateLimitResponse; -}; - -export type PostV1SdkTelemetryErrorsError = - PostV1SdkTelemetryErrorsErrors[keyof PostV1SdkTelemetryErrorsErrors]; - -export type PostV1SdkTelemetryErrorsResponses = { + 400: BadRequestResponse; /** - * No Content + * Forbidden */ - 204: unknown; -}; - -export type GetV1SsoConfigurationDetailsData = { - body?: never; - path?: never; - query?: never; - url: '/v1/sso-configuration/details'; -}; - -export type GetV1SsoConfigurationDetailsErrors = { + 403: ForbiddenResponse; /** - * Bad Request + * Not Found */ - 400: BadRequestResponse; + 404: NotFoundResponse; /** - * Unauthorized + * Conflict */ - 401: UnauthorizedResponse; + 409: ConflictResponse; /** - * Not Found + * Unprocessable Entity */ - 404: NotFoundResponse; + 422: UnprocessableEntityResponse; /** * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetV1SsoConfigurationDetailsError = - GetV1SsoConfigurationDetailsErrors[keyof GetV1SsoConfigurationDetailsErrors]; +export type PutV1EmploymentsEmploymentIdFederalTaxesError = + PutV1EmploymentsEmploymentIdFederalTaxesErrors[keyof PutV1EmploymentsEmploymentIdFederalTaxesErrors]; -export type GetV1SsoConfigurationDetailsResponses = { +export type PutV1EmploymentsEmploymentIdFederalTaxesResponses = { /** * Success */ - 200: SsoConfigurationDetailsResponse; + 200: SuccessResponse; }; -export type GetV1SsoConfigurationDetailsResponse = - GetV1SsoConfigurationDetailsResponses[keyof GetV1SsoConfigurationDetailsResponses]; +export type PutV1EmploymentsEmploymentIdFederalTaxesResponse = + PutV1EmploymentsEmploymentIdFederalTaxesResponses[keyof PutV1EmploymentsEmploymentIdFederalTaxesResponses]; -export type PostV1CostCalculatorEstimationData = { - /** - * Estimate params - */ - body: CostCalculatorEstimateParams; - path?: never; +export type GetV1CompaniesCompanyIdPricingPlansData = { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + }; query?: never; - url: '/v1/cost-calculator/estimation'; + url: '/api/eor/v1/companies/{company_id}/pricing-plans'; }; -export type PostV1CostCalculatorEstimationErrors = { +export type GetV1CompaniesCompanyIdPricingPlansErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -13162,40 +13229,35 @@ export type PostV1CostCalculatorEstimationErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1CostCalculatorEstimationError = - PostV1CostCalculatorEstimationErrors[keyof PostV1CostCalculatorEstimationErrors]; +export type GetV1CompaniesCompanyIdPricingPlansError = + GetV1CompaniesCompanyIdPricingPlansErrors[keyof GetV1CompaniesCompanyIdPricingPlansErrors]; -export type PostV1CostCalculatorEstimationResponses = { +export type GetV1CompaniesCompanyIdPricingPlansResponses = { /** * Success */ - 200: CostCalculatorEstimateResponse; + 200: ListCompanyPricingPlansResponse; }; -export type PostV1CostCalculatorEstimationResponse = - PostV1CostCalculatorEstimationResponses[keyof PostV1CostCalculatorEstimationResponses]; +export type GetV1CompaniesCompanyIdPricingPlansResponse = + GetV1CompaniesCompanyIdPricingPlansResponses[keyof GetV1CompaniesCompanyIdPricingPlansResponses]; -export type GetV1CompaniesSchemaData = { - body?: never; - path?: never; - query: { - /** - * Country code according to ISO 3-digit alphabetic codes. - */ - country_code: string; - /** - * Name of the desired form - */ - form: 'address_details'; +export type PostV1CompaniesCompanyIdPricingPlansData = { + /** + * Create Pricing Plan parameters + */ + body: CreatePricingPlanParams; + path: { /** - * Version of the form schema + * Company ID */ - json_schema_version?: number | 'latest'; + company_id: UuidSlug; }; - url: '/v1/companies/schema'; + query?: never; + url: '/api/eor/v1/companies/{company_id}/pricing-plans'; }; -export type GetV1CompaniesSchemaErrors = { +export type PostV1CompaniesCompanyIdPricingPlansErrors = { /** * Unauthorized */ @@ -13210,28 +13272,104 @@ export type GetV1CompaniesSchemaErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1CompaniesSchemaError = - GetV1CompaniesSchemaErrors[keyof GetV1CompaniesSchemaErrors]; +export type PostV1CompaniesCompanyIdPricingPlansError = + PostV1CompaniesCompanyIdPricingPlansErrors[keyof PostV1CompaniesCompanyIdPricingPlansErrors]; -export type GetV1CompaniesSchemaResponses = { +export type PostV1CompaniesCompanyIdPricingPlansResponses = { /** * Success */ - 200: CompanyFormResponse; + 200: CreatePricingPlanResponse; }; -export type GetV1CompaniesSchemaResponse = - GetV1CompaniesSchemaResponses[keyof GetV1CompaniesSchemaResponses]; +export type PostV1CompaniesCompanyIdPricingPlansResponse = + PostV1CompaniesCompanyIdPricingPlansResponses[keyof PostV1CompaniesCompanyIdPricingPlansResponses]; -export type GetV1EmploymentsEmploymentIdBenefitOffersData = { - body?: never; +export type PutV2EmploymentsEmploymentIdFederalTaxesData = { + /** + * Employment federal taxes params + */ + body?: EmploymentFederalTaxesParams; path: { /** - * Unique identifier of the employment + * Employment ID */ - employment_id: UuidSlug; + employment_id: string; }; + query?: never; + url: '/api/eor/v2/employments/{employment_id}/federal-taxes'; +}; + +export type PutV2EmploymentsEmploymentIdFederalTaxesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PutV2EmploymentsEmploymentIdFederalTaxesError = + PutV2EmploymentsEmploymentIdFederalTaxesErrors[keyof PutV2EmploymentsEmploymentIdFederalTaxesErrors]; + +export type PutV2EmploymentsEmploymentIdFederalTaxesResponses = { + /** + * Success + */ + 200: SuccessResponse; +}; + +export type PutV2EmploymentsEmploymentIdFederalTaxesResponse = + PutV2EmploymentsEmploymentIdFederalTaxesResponses[keyof PutV2EmploymentsEmploymentIdFederalTaxesResponses]; + +export type GetV1TravelLetterRequestsData = { + body?: never; + path?: never; query?: { + /** + * Filter results on the given status + */ + status?: + | 'pending' + | 'cancelled' + | 'declined_by_manager' + | 'declined_by_remote' + | 'approved_by_manager' + | 'approved_by_remote'; + /** + * Filter results on the given employment slug + */ + employment_id?: string; + /** + * Filter results on the given employee name + */ + employee_name?: string; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'submitted_at'; /** * Starts fetching records after the given page */ @@ -13241,18 +13379,10 @@ export type GetV1EmploymentsEmploymentIdBenefitOffersData = { */ page_size?: number; }; - url: '/v1/employments/{employment_id}/benefit-offers'; + url: '/api/eor/v1/travel-letter-requests'; }; -export type GetV1EmploymentsEmploymentIdBenefitOffersErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; +export type GetV1TravelLetterRequestsErrors = { /** * Not Found */ @@ -13263,44 +13393,36 @@ export type GetV1EmploymentsEmploymentIdBenefitOffersErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1EmploymentsEmploymentIdBenefitOffersError = - GetV1EmploymentsEmploymentIdBenefitOffersErrors[keyof GetV1EmploymentsEmploymentIdBenefitOffersErrors]; +export type GetV1TravelLetterRequestsError = + GetV1TravelLetterRequestsErrors[keyof GetV1TravelLetterRequestsErrors]; -export type GetV1EmploymentsEmploymentIdBenefitOffersResponses = { +export type GetV1TravelLetterRequestsResponses = { /** * Success */ - 200: EmploymentsBenefitOffersListBenefitOffers; + 200: ListTravelLettersResponse; }; -export type GetV1EmploymentsEmploymentIdBenefitOffersResponse = - GetV1EmploymentsEmploymentIdBenefitOffersResponses[keyof GetV1EmploymentsEmploymentIdBenefitOffersResponses]; +export type GetV1TravelLetterRequestsResponse = + GetV1TravelLetterRequestsResponses[keyof GetV1TravelLetterRequestsResponses]; -export type PutV1EmploymentsEmploymentIdBenefitOffersData = { - /** - * Upsert employment benefit offers request - */ - body: UnifiedEmploymentUpsertBenefitOffersRequest; +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { + body?: never; path: { /** - * Unique identifier of the employment - */ - employment_id: UuidSlug; - }; - query?: { - /** - * Version of the form schema + * Employment ID */ - json_schema_version?: number | 'latest'; + employment_id: string; }; - url: '/v1/employments/{employment_id}/benefit-offers'; + query?: never; + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details'; }; -export type PutV1EmploymentsEmploymentIdBenefitOffersErrors = { +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** * Forbidden */ @@ -13313,23 +13435,30 @@ export type PutV1EmploymentsEmploymentIdBenefitOffersErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PutV1EmploymentsEmploymentIdBenefitOffersError = - PutV1EmploymentsEmploymentIdBenefitOffersErrors[keyof PutV1EmploymentsEmploymentIdBenefitOffersErrors]; +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsError = + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type PutV1EmploymentsEmploymentIdBenefitOffersResponses = { +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentEngagementAgreementDetailsResponse; }; -export type PutV1EmploymentsEmploymentIdBenefitOffersResponse = - PutV1EmploymentsEmploymentIdBenefitOffersResponses[keyof PutV1EmploymentsEmploymentIdBenefitOffersResponses]; +export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof GetV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type GetV1IdentityVerificationEmploymentIdData = { - body?: never; +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { + /** + * Employment engagement agreement details params + */ + body?: EmploymentEngagementAgreementDetailsParams; path: { /** * Employment ID @@ -13337,156 +13466,202 @@ export type GetV1IdentityVerificationEmploymentIdData = { employment_id: string; }; query?: never; - url: '/v1/identity-verification/{employment_id}'; + url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details'; }; -export type GetV1IdentityVerificationEmploymentIdErrors = { +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1IdentityVerificationEmploymentIdError = - GetV1IdentityVerificationEmploymentIdErrors[keyof GetV1IdentityVerificationEmploymentIdErrors]; +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsError = + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; -export type GetV1IdentityVerificationEmploymentIdResponses = { +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { /** * Success */ - 200: IdentityVerificationResponse; + 200: SuccessResponse; }; -export type GetV1IdentityVerificationEmploymentIdResponse = - GetV1IdentityVerificationEmploymentIdResponses[keyof GetV1IdentityVerificationEmploymentIdResponses]; +export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponse = + PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof PostV2EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; -export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData = - { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-subscriptions'; - }; - -export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors = - { +export type GetV1WdGphPaySummaryData = { + body?: never; + headers?: { /** - * Unauthorized + * The preferred language of the inquiring user in Workday */ - 401: UnauthorizedResponse; + accept_language?: string; + }; + path?: never; + query?: { /** - * Forbidden + * The pay group ids to lookup (comma separated). Returns all pay groups if not provided */ - 403: ForbiddenResponse; + payGroupExternalId?: string; /** - * Not Found + * Optional country filter (ISO 3166 alpha-2, comma separated) */ - 404: NotFoundResponse; + countryCode?: string; }; + url: '/api/eor/v1/wd/gph/paySummary'; +}; -export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsError = - GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors]; +export type GetV1WdGphPaySummaryErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; -export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses = - { - /** - * Success - */ - 200: ContractorSubscriptionSummariesResponse; - }; +export type GetV1WdGphPaySummaryError = + GetV1WdGphPaySummaryErrors[keyof GetV1WdGphPaySummaryErrors]; -export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponse = - GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsResponses]; +export type GetV1WdGphPaySummaryResponses = { + /** + * Success + */ + 200: PaySummaryResponse; +}; -export type GetV1EmployeePayslipsData = { +export type GetV1WdGphPaySummaryResponse = + GetV1WdGphPaySummaryResponses[keyof GetV1WdGphPaySummaryResponses]; + +export type GetV1EmploymentsEmploymentIdJobData = { body?: never; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Number of items per page + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/employee/payslips'; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/job'; }; -export type GetV1EmployeePayslipsErrors = { +export type GetV1EmploymentsEmploymentIdJobErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1EmploymentsEmploymentIdJobError = + GetV1EmploymentsEmploymentIdJobErrors[keyof GetV1EmploymentsEmploymentIdJobErrors]; + +export type GetV1EmploymentsEmploymentIdJobResponses = { + /** + * Success + */ + 200: EmploymentJobResponse; +}; + +export type GetV1EmploymentsEmploymentIdJobResponse = + GetV1EmploymentsEmploymentIdJobResponses[keyof GetV1EmploymentsEmploymentIdJobResponses]; + +export type PostV1BulkEmploymentJobsData = { + /** + * Bulk employment params + */ + body?: BulkEmploymentCreateParams; + path?: never; + query?: never; + url: '/api/eor/v1/bulk-employment-jobs'; +}; + +export type PostV1BulkEmploymentJobsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Forbidden */ 403: ForbiddenResponse; /** - * Not Found + * Unprocessable Entity */ - 404: NotFoundResponse; + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmployeePayslipsError = - GetV1EmployeePayslipsErrors[keyof GetV1EmployeePayslipsErrors]; +export type PostV1BulkEmploymentJobsError = + PostV1BulkEmploymentJobsErrors[keyof PostV1BulkEmploymentJobsErrors]; -export type GetV1EmployeePayslipsResponses = { +export type PostV1BulkEmploymentJobsResponses = { /** - * Success + * Accepted */ - 200: ListEmployeePayslipsResponse; + 202: BulkEmploymentImportJobResponse; }; -export type GetV1EmployeePayslipsResponse = - GetV1EmployeePayslipsResponses[keyof GetV1EmployeePayslipsResponses]; +export type PostV1BulkEmploymentJobsResponse = + PostV1BulkEmploymentJobsResponses[keyof PostV1BulkEmploymentJobsResponses]; -export type GetV1WebhookEventsData = { +export type GetV1ContractAmendmentsData = { body?: never; - path?: never; - query?: { - /** - * Filter by webhook event type - */ - event_type?: string; - /** - * Filter by delivery status (true = 200, false = 4xx/5xx) - */ - successfully_delivered?: boolean; - /** - * Filter by company ID - */ - company_id?: string; - /** - * Filter by date before (ISO 8601 format) - */ - before?: string; + headers: { /** - * Filter by date after (ISO 8601 format) + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - after?: string; + Authorization: string; + }; + path?: never; + query?: { /** - * Sort order + * Employment ID */ - order?: 'asc' | 'desc'; + employment_id?: string; /** - * Field to sort by + * Contract Amendment status */ - sort_by?: 'first_triggered_at'; + status?: ContractAmendmentStatus; /** * Starts fetching records after the given page */ @@ -13496,10 +13671,10 @@ export type GetV1WebhookEventsData = { */ page_size?: number; }; - url: '/v1/webhook-events'; + url: '/api/eor/v1/contract-amendments'; }; -export type GetV1WebhookEventsErrors = { +export type GetV1ContractAmendmentsErrors = { /** * Unauthorized */ @@ -13514,20 +13689,72 @@ export type GetV1WebhookEventsErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1WebhookEventsError = - GetV1WebhookEventsErrors[keyof GetV1WebhookEventsErrors]; +export type GetV1ContractAmendmentsError = + GetV1ContractAmendmentsErrors[keyof GetV1ContractAmendmentsErrors]; -export type GetV1WebhookEventsResponses = { +export type GetV1ContractAmendmentsResponses = { /** * Success */ - 200: ListWebhookEventsResponse; + 200: ListContractAmendmentResponse; }; -export type GetV1WebhookEventsResponse = - GetV1WebhookEventsResponses[keyof GetV1WebhookEventsResponses]; +export type GetV1ContractAmendmentsResponse = + GetV1ContractAmendmentsResponses[keyof GetV1ContractAmendmentsResponses]; -export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData = { +export type PostV1ContractAmendmentsData = { + /** + * Contract Amendment + */ + body?: CreateContractAmendmentParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path?: never; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/contract-amendments'; +}; + +export type PostV1ContractAmendmentsErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type PostV1ContractAmendmentsError = + PostV1ContractAmendmentsErrors[keyof PostV1ContractAmendmentsErrors]; + +export type PostV1ContractAmendmentsResponses = { + /** + * Success + */ + 200: ContractAmendmentResponse; +}; + +export type PostV1ContractAmendmentsResponse = + PostV1ContractAmendmentsResponses[keyof PostV1ContractAmendmentsResponses]; + +export type DeleteV1IncentivesRecurringIdData = { body?: never; headers: { /** @@ -13540,15 +13767,15 @@ export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData = { }; path: { /** - * Company ID + * Recurring Incentive ID */ - company_id: string; + id: string; }; query?: never; - url: '/v1/sandbox/companies/{company_id}/bypass-eligibility-checks'; + url: '/api/eor/v1/incentives/recurring/{id}'; }; -export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors = { +export type DeleteV1IncentivesRecurringIdErrors = { /** * Bad Request */ @@ -13571,91 +13798,124 @@ export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors = { 429: TooManyRequestsResponse; }; -export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksError = - PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors[keyof PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors]; +export type DeleteV1IncentivesRecurringIdError = + DeleteV1IncentivesRecurringIdErrors[keyof DeleteV1IncentivesRecurringIdErrors]; -export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses = { +export type DeleteV1IncentivesRecurringIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: DeleteRecurringIncentiveResponse; }; -export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponse = - PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses[keyof PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses]; +export type DeleteV1IncentivesRecurringIdResponse = + DeleteV1IncentivesRecurringIdResponses[keyof DeleteV1IncentivesRecurringIdResponses]; -export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData = - { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: never; - url: '/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve'; - }; - -export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors = - { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { + body?: never; + headers: { /** - * Unprocessable Entity + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - 422: UnprocessableEntityResponse; + Authorization: string; + }; + path: { /** - * Too many requests + * Benefit Renewal Request Id */ - 429: TooManyRequestsResponse; + benefit_renewal_request_id: UuidSlug; }; + query?: never; + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; +}; -export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveError = - PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors[keyof PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors]; +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; -export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses = - { +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdError = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors]; + +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses = { + /** + * Success + */ + 200: BenefitRenewalRequestsBenefitRenewalRequestResponse; +}; + +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses]; + +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { + /** + * Benefit Renewal Request Response + */ + body?: BenefitRenewalRequestsUpdateBenefitRenewalRequest; + headers: { /** - * Success + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - 200: RiskReserveProofOfPaymentResponse; + Authorization: string; + }; + path: { + /** + * Benefit Renewal Request Id + */ + benefit_renewal_request_id: UuidSlug; }; - -export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponse = - PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses[keyof PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses]; - -export type GetV1TestSchemaData = { - body?: never; - path?: never; query?: { /** * Version of the form schema */ json_schema_version?: number | 'latest'; }; - url: '/v1/test-schema'; + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; }; -export type GetV1TestSchemaResponses = { +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdError = + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors[keyof PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors]; + +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses = { /** * Success */ - 200: CompanyFormResponse; + 200: SuccessResponse; }; -export type GetV1TestSchemaResponse = - GetV1TestSchemaResponses[keyof GetV1TestSchemaResponses]; +export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse = + PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses[keyof PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses]; export type GetV1CountriesCountryCodeHolidaysYearData = { body?: never; @@ -13684,7 +13944,7 @@ export type GetV1CountriesCountryCodeHolidaysYearData = { */ country_subdivision_code?: string; }; - url: '/v1/countries/{country_code}/holidays/{year}'; + url: '/api/eor/v1/countries/{country_code}/holidays/{year}'; }; export type GetV1CountriesCountryCodeHolidaysYearErrors = { @@ -13715,26 +13975,28 @@ export type GetV1CountriesCountryCodeHolidaysYearResponses = { export type GetV1CountriesCountryCodeHolidaysYearResponse = GetV1CountriesCountryCodeHolidaysYearResponses[keyof GetV1CountriesCountryCodeHolidaysYearResponses]; -export type PostV1TimeoffTimeoffIdCancelData = { - /** - * CancelTimeoff - */ - body: CancelTimeoffParams; +export type GetV1EmploymentsEmploymentIdCustomFieldsData = { + body?: never; path: { /** - * Time Off ID + * Employment ID */ - timeoff_id: string; + employment_id: string; }; - query?: never; - url: '/v1/timeoff/{timeoff_id}/cancel'; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employments/{employment_id}/custom-fields'; }; -export type PostV1TimeoffTimeoffIdCancelErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmploymentsEmploymentIdCustomFieldsErrors = { /** * Unauthorized */ @@ -13747,73 +14009,34 @@ export type PostV1TimeoffTimeoffIdCancelErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostV1TimeoffTimeoffIdCancelError = - PostV1TimeoffTimeoffIdCancelErrors[keyof PostV1TimeoffTimeoffIdCancelErrors]; +export type GetV1EmploymentsEmploymentIdCustomFieldsError = + GetV1EmploymentsEmploymentIdCustomFieldsErrors[keyof GetV1EmploymentsEmploymentIdCustomFieldsErrors]; -export type PostV1TimeoffTimeoffIdCancelResponses = { +export type GetV1EmploymentsEmploymentIdCustomFieldsResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ListEmploymentCustomFieldValuePaginatedResponse; }; -export type PostV1TimeoffTimeoffIdCancelResponse = - PostV1TimeoffTimeoffIdCancelResponses[keyof PostV1TimeoffTimeoffIdCancelResponses]; +export type GetV1EmploymentsEmploymentIdCustomFieldsResponse = + GetV1EmploymentsEmploymentIdCustomFieldsResponses[keyof GetV1EmploymentsEmploymentIdCustomFieldsResponses]; -export type GetV1EmploymentsEmploymentIdJobData = { +export type GetV1TimesheetsIdData = { body?: never; path: { /** - * Employment ID + * Timesheet ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/employments/{employment_id}/job'; -}; - -export type GetV1EmploymentsEmploymentIdJobErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; -}; - -export type GetV1EmploymentsEmploymentIdJobError = - GetV1EmploymentsEmploymentIdJobErrors[keyof GetV1EmploymentsEmploymentIdJobErrors]; - -export type GetV1EmploymentsEmploymentIdJobResponses = { - /** - * Success - */ - 200: EmploymentJobResponse; -}; - -export type GetV1EmploymentsEmploymentIdJobResponse = - GetV1EmploymentsEmploymentIdJobResponses[keyof GetV1EmploymentsEmploymentIdJobResponses]; - -export type GetV1PricingPlanPartnerTemplatesData = { - body?: never; - path?: never; - query?: never; - url: '/v1/pricing-plan-partner-templates'; + url: '/api/eor/v1/timesheets/{id}'; }; -export type GetV1PricingPlanPartnerTemplatesErrors = { +export type GetV1TimesheetsIdErrors = { /** * Unauthorized */ @@ -13828,44 +14051,53 @@ export type GetV1PricingPlanPartnerTemplatesErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1PricingPlanPartnerTemplatesError = - GetV1PricingPlanPartnerTemplatesErrors[keyof GetV1PricingPlanPartnerTemplatesErrors]; +export type GetV1TimesheetsIdError = + GetV1TimesheetsIdErrors[keyof GetV1TimesheetsIdErrors]; -export type GetV1PricingPlanPartnerTemplatesResponses = { +export type GetV1TimesheetsIdResponses = { /** * Success */ - 200: ListPricingPlanPartnerTemplatesResponse; + 200: TimesheetResponse; }; -export type GetV1PricingPlanPartnerTemplatesResponse = - GetV1PricingPlanPartnerTemplatesResponses[keyof GetV1PricingPlanPartnerTemplatesResponses]; +export type GetV1TimesheetsIdResponse = + GetV1TimesheetsIdResponses[keyof GetV1TimesheetsIdResponses]; -export type GetV1PayrollCalendarsData = { +export type GetV1CompanyManagersData = { body?: never; - path?: never; - query?: { + headers: { /** - * Filter payroll calendars by country code + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - country_code?: string; + Authorization: string; + }; + path?: never; + query?: { /** - * Filter payroll calendars by year + * A Company ID to filter the results (only applicable for Integration Partners). */ - year?: string; + company_id?: string; /** * Starts fetching records after the given page */ page?: number; /** - * Number of items per page + * Change the amount of records returned per page, defaults to 20, limited to 100 */ page_size?: number; }; - url: '/v1/payroll-calendars'; + url: '/api/eor/v1/company-managers'; }; -export type GetV1PayrollCalendarsErrors = { +export type GetV1CompanyManagersErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -13878,37 +14110,53 @@ export type GetV1PayrollCalendarsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1PayrollCalendarsError = - GetV1PayrollCalendarsErrors[keyof GetV1PayrollCalendarsErrors]; - -export type GetV1PayrollCalendarsResponses = { +export type GetV1CompanyManagersError = + GetV1CompanyManagersErrors[keyof GetV1CompanyManagersErrors]; + +export type GetV1CompanyManagersResponses = { /** * Success */ - 200: PayrollCalendarsEorResponse; + 200: CompanyManagersResponse; }; -export type GetV1PayrollCalendarsResponse = - GetV1PayrollCalendarsResponses[keyof GetV1PayrollCalendarsResponses]; +export type GetV1CompanyManagersResponse = + GetV1CompanyManagersResponses[keyof GetV1CompanyManagersResponses]; -export type PatchV1EmployeeTimeoffId2Data = { +export type PostV1CompanyManagersData = { /** - * UpdateTimeoff + * Company Manager params */ - body: UpdateEmployeeTimeoffParams; - path: { + body?: CompanyManagerParams; + headers: { /** - * Timeoff ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; - query?: never; - url: '/v1/employee/timeoff/{id}'; + path?: never; + query?: { + /** + * Complementary action(s) to perform when creating a company manager: + * + * - `no_invite` skips the email invitation step + * + */ + actions?: string; + }; + url: '/api/eor/v1/company-managers'; }; -export type PatchV1EmployeeTimeoffId2Errors = { +export type PostV1CompanyManagersErrors = { /** * Bad Request */ @@ -13926,52 +14174,47 @@ export type PatchV1EmployeeTimeoffId2Errors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PatchV1EmployeeTimeoffId2Error = - PatchV1EmployeeTimeoffId2Errors[keyof PatchV1EmployeeTimeoffId2Errors]; +export type PostV1CompanyManagersError = + PostV1CompanyManagersErrors[keyof PostV1CompanyManagersErrors]; -export type PatchV1EmployeeTimeoffId2Responses = { +export type PostV1CompanyManagersResponses = { /** * Success */ - 200: TimeoffResponse; + 201: CompanyManagerData; }; -export type PatchV1EmployeeTimeoffId2Response = - PatchV1EmployeeTimeoffId2Responses[keyof PatchV1EmployeeTimeoffId2Responses]; +export type PostV1CompanyManagersResponse = + PostV1CompanyManagersResponses[keyof PostV1CompanyManagersResponses]; -export type PatchV1EmployeeTimeoffIdData = { +export type PostV1PayItemsBulkData = { /** - * UpdateTimeoff + * Pay Items */ - body: UpdateEmployeeTimeoffParams; - path: { - /** - * Timeoff ID - */ - id: string; - }; + body: BulkCreatePayItemsParams; + path?: never; query?: never; - url: '/v1/employee/timeoff/{id}'; + url: '/api/eor/v1/pay-items/bulk'; }; -export type PatchV1EmployeeTimeoffIdErrors = { +export type PostV1PayItemsBulkErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -13982,61 +14225,32 @@ export type PatchV1EmployeeTimeoffIdErrors = { 429: TooManyRequestsResponse; }; -export type PatchV1EmployeeTimeoffIdError = - PatchV1EmployeeTimeoffIdErrors[keyof PatchV1EmployeeTimeoffIdErrors]; +export type PostV1PayItemsBulkError = + PostV1PayItemsBulkErrors[keyof PostV1PayItemsBulkErrors]; -export type PatchV1EmployeeTimeoffIdResponses = { +export type PostV1PayItemsBulkResponses = { /** * Success */ - 200: TimeoffResponse; + 200: BulkCreatePayItemsResponse; }; -export type PatchV1EmployeeTimeoffIdResponse = - PatchV1EmployeeTimeoffIdResponses[keyof PatchV1EmployeeTimeoffIdResponses]; +export type PostV1PayItemsBulkResponse = + PostV1PayItemsBulkResponses[keyof PostV1PayItemsBulkResponses]; -export type GetV1IncentivesRecurringData = { +export type GetV1TravelLetterRequestsIdData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: { - /** - * Filter by recurring incentive status: active or deactive. - */ - status?: string; - /** - * Filter by recurring incentive type. - */ - type?: string; - /** - * Filter by recurring incentives that contain the value in their notes. - */ - note?: string; - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * travel letter request ID */ - page_size?: number; + id: UuidSlug; }; - url: '/v1/incentives/recurring'; + query?: never; + url: '/api/eor/v1/travel-letter-requests/{id}'; }; -export type GetV1IncentivesRecurringErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1TravelLetterRequestsIdErrors = { /** * Unauthorized */ @@ -14049,49 +14263,37 @@ export type GetV1IncentivesRecurringErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetV1IncentivesRecurringError = - GetV1IncentivesRecurringErrors[keyof GetV1IncentivesRecurringErrors]; +export type GetV1TravelLetterRequestsIdError = + GetV1TravelLetterRequestsIdErrors[keyof GetV1TravelLetterRequestsIdErrors]; -export type GetV1IncentivesRecurringResponses = { +export type GetV1TravelLetterRequestsIdResponses = { /** * Success */ - 201: ListRecurringIncentivesResponse; + 200: TravelLetterResponse; }; -export type GetV1IncentivesRecurringResponse = - GetV1IncentivesRecurringResponses[keyof GetV1IncentivesRecurringResponses]; +export type GetV1TravelLetterRequestsIdResponse = + GetV1TravelLetterRequestsIdResponses[keyof GetV1TravelLetterRequestsIdResponses]; -export type PostV1IncentivesRecurringData = { +export type PatchV1TravelLetterRequestsId2Data = { /** - * RecurringIncentive + * Travel letter Request */ - body?: CreateRecurringIncentiveParams; - headers: { + body: UpdateTravelLetterRequestParams; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Travel letter Request ID */ - Authorization: string; + id: string; }; - path?: never; query?: never; - url: '/v1/incentives/recurring'; + url: '/api/eor/v1/travel-letter-requests/{id}'; }; -export type PostV1IncentivesRecurringErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PatchV1TravelLetterRequestsId2Errors = { /** * Unauthorized */ @@ -14104,93 +14306,90 @@ export type PostV1IncentivesRecurringErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PostV1IncentivesRecurringError = - PostV1IncentivesRecurringErrors[keyof PostV1IncentivesRecurringErrors]; +export type PatchV1TravelLetterRequestsId2Error = + PatchV1TravelLetterRequestsId2Errors[keyof PatchV1TravelLetterRequestsId2Errors]; -export type PostV1IncentivesRecurringResponses = { +export type PatchV1TravelLetterRequestsId2Responses = { /** * Success */ - 201: RecurringIncentiveResponse; + 200: TravelLetterResponse; }; -export type PostV1IncentivesRecurringResponse = - PostV1IncentivesRecurringResponses[keyof PostV1IncentivesRecurringResponses]; +export type PatchV1TravelLetterRequestsId2Response = + PatchV1TravelLetterRequestsId2Responses[keyof PatchV1TravelLetterRequestsId2Responses]; -export type PostV1SandboxBenefitRenewalRequestsData = { +export type PatchV1TravelLetterRequestsIdData = { /** - * Benefit Renewal Request + * Travel letter Request */ - body: BenefitRenewalRequestsCreateBenefitRenewalRequest; - headers: { + body: UpdateTravelLetterRequestParams; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Travel letter Request ID */ - Authorization: string; + id: string; }; - path?: never; query?: never; - url: '/v1/sandbox/benefit-renewal-requests'; + url: '/api/eor/v1/travel-letter-requests/{id}'; }; -export type PostV1SandboxBenefitRenewalRequestsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PatchV1TravelLetterRequestsIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PostV1SandboxBenefitRenewalRequestsError = - PostV1SandboxBenefitRenewalRequestsErrors[keyof PostV1SandboxBenefitRenewalRequestsErrors]; +export type PatchV1TravelLetterRequestsIdError = + PatchV1TravelLetterRequestsIdErrors[keyof PatchV1TravelLetterRequestsIdErrors]; -export type PostV1SandboxBenefitRenewalRequestsResponses = { +export type PatchV1TravelLetterRequestsIdResponses = { /** * Success */ - 200: BenefitRenewalRequestsCreateBenefitRenewalRequestResponse; + 200: TravelLetterResponse; }; -export type PostV1SandboxBenefitRenewalRequestsResponse = - PostV1SandboxBenefitRenewalRequestsResponses[keyof PostV1SandboxBenefitRenewalRequestsResponses]; +export type PatchV1TravelLetterRequestsIdResponse = + PatchV1TravelLetterRequestsIdResponses[keyof PatchV1TravelLetterRequestsIdResponses]; -export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData = { +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData = { body?: never; - path: { + headers: { /** - * Employment ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - employment_id: string; + Authorization: string; + }; + path: { /** - * Document ID + * Company ID */ - id: string; + company_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/contract-documents/{id}'; + url: '/api/eor/v1/sandbox/companies/{company_id}/bypass-eligibility-checks'; }; -export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors = { +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -14203,52 +14402,69 @@ export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdError = - GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors]; +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksError = + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors[keyof PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors]; -export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses = - { - /** - * Success - */ - 200: ContractDocumentResponse; - }; +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses = { + /** + * Success + */ + 200: SuccessResponse; +}; -export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponse = - GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses]; +export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponse = + PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses[keyof PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksResponses]; -export type GetV1EmploymentsEmploymentIdContractDocumentsData = { +export type GetV1EmployeeLeavePoliciesData = { + body?: never; + path?: never; + query?: never; + url: '/api/eor/v1/employee/leave-policies'; +}; + +export type GetV1EmployeeLeavePoliciesErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1EmployeeLeavePoliciesError = + GetV1EmployeeLeavePoliciesErrors[keyof GetV1EmployeeLeavePoliciesErrors]; + +export type GetV1EmployeeLeavePoliciesResponses = { + /** + * Success + */ + 200: ListLeavePoliciesDetailsResponse; +}; + +export type GetV1EmployeeLeavePoliciesResponse = + GetV1EmployeeLeavePoliciesResponses[keyof GetV1EmployeeLeavePoliciesResponses]; + +export type GetV1CompaniesCompanyIdWebhookCallbacksData = { body?: never; path: { /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Filter by contract document statuses - */ - statuses?: Array; - /** - * Exclude contract documents with specific statuses - */ - except_statuses?: Array; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Company ID */ - page_size?: number; + company_id: string; }; - url: '/v1/employments/{employment_id}/contract-documents'; + query?: never; + url: '/api/eor/v1/companies/{company_id}/webhook-callbacks'; }; -export type GetV1EmploymentsEmploymentIdContractDocumentsErrors = { +export type GetV1CompaniesCompanyIdWebhookCallbacksErrors = { /** * Unauthorized */ @@ -14257,26 +14473,22 @@ export type GetV1EmploymentsEmploymentIdContractDocumentsErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type GetV1EmploymentsEmploymentIdContractDocumentsError = - GetV1EmploymentsEmploymentIdContractDocumentsErrors[keyof GetV1EmploymentsEmploymentIdContractDocumentsErrors]; +export type GetV1CompaniesCompanyIdWebhookCallbacksError = + GetV1CompaniesCompanyIdWebhookCallbacksErrors[keyof GetV1CompaniesCompanyIdWebhookCallbacksErrors]; -export type GetV1EmploymentsEmploymentIdContractDocumentsResponses = { +export type GetV1CompaniesCompanyIdWebhookCallbacksResponses = { /** * Success */ - 200: IndexContractDocumentsResponse; + 200: ListWebhookCallbacksResponse; }; -export type GetV1EmploymentsEmploymentIdContractDocumentsResponse = - GetV1EmploymentsEmploymentIdContractDocumentsResponses[keyof GetV1EmploymentsEmploymentIdContractDocumentsResponses]; +export type GetV1CompaniesCompanyIdWebhookCallbacksResponse = + GetV1CompaniesCompanyIdWebhookCallbacksResponses[keyof GetV1CompaniesCompanyIdWebhookCallbacksResponses]; -export type GetV1ExpensesData = { +export type GetV1BillingDocumentsBillingDocumentIdPdfData = { body?: never; headers: { /** @@ -14287,25 +14499,17 @@ export type GetV1ExpensesData = { */ Authorization: string; }; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * The billing document's ID */ - page_size?: number; + billing_document_id: string; }; - url: '/v1/expenses'; + query?: never; + url: '/api/eor/v1/billing-documents/{billing_document_id}/pdf'; }; -export type GetV1ExpensesErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1BillingDocumentsBillingDocumentIdPdfErrors = { /** * Unauthorized */ @@ -14318,29 +14522,23 @@ export type GetV1ExpensesErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetV1ExpensesError = GetV1ExpensesErrors[keyof GetV1ExpensesErrors]; +export type GetV1BillingDocumentsBillingDocumentIdPdfError = + GetV1BillingDocumentsBillingDocumentIdPdfErrors[keyof GetV1BillingDocumentsBillingDocumentIdPdfErrors]; -export type GetV1ExpensesResponses = { +export type GetV1BillingDocumentsBillingDocumentIdPdfResponses = { /** * Success */ - 201: ListExpenseResponse; + 200: GenericFile; }; -export type GetV1ExpensesResponse = - GetV1ExpensesResponses[keyof GetV1ExpensesResponses]; +export type GetV1BillingDocumentsBillingDocumentIdPdfResponse = + GetV1BillingDocumentsBillingDocumentIdPdfResponses[keyof GetV1BillingDocumentsBillingDocumentIdPdfResponses]; -export type PostV1ExpensesData = { - /** - * Expenses - */ - body?: ParamsToCreateExpense; +export type DeleteV1WebhookCallbacksIdData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -14350,16 +14548,17 @@ export type PostV1ExpensesData = { */ Authorization: string; }; - path?: never; + path: { + /** + * Webhook Callback ID + */ + id: string; + }; query?: never; - url: '/v1/expenses'; + url: '/api/eor/v1/webhook-callbacks/{id}'; }; -export type PostV1ExpensesErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type DeleteV1WebhookCallbacksIdErrors = { /** * Unauthorized */ @@ -14372,37 +14571,37 @@ export type PostV1ExpensesErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PostV1ExpensesError = - PostV1ExpensesErrors[keyof PostV1ExpensesErrors]; +export type DeleteV1WebhookCallbacksIdError = + DeleteV1WebhookCallbacksIdErrors[keyof DeleteV1WebhookCallbacksIdErrors]; -export type PostV1ExpensesResponses = { +export type DeleteV1WebhookCallbacksIdResponses = { /** * Success */ - 201: ExpenseResponse; + 200: SuccessResponse; }; -export type PostV1ExpensesResponse = - PostV1ExpensesResponses[keyof PostV1ExpensesResponses]; +export type DeleteV1WebhookCallbacksIdResponse = + DeleteV1WebhookCallbacksIdResponses[keyof DeleteV1WebhookCallbacksIdResponses]; -export type GetV1SsoConfigurationData = { - body?: never; - path?: never; +export type PatchV1WebhookCallbacksIdData = { + /** + * WebhookCallback + */ + body?: UpdateWebhookCallbackParams; + path: { + /** + * Webhook Callback ID + */ + id: string; + }; query?: never; - url: '/v1/sso-configuration'; + url: '/api/eor/v1/webhook-callbacks/{id}'; }; -export type GetV1SsoConfigurationErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PatchV1WebhookCallbacksIdErrors = { /** * Unauthorized */ @@ -14414,33 +14613,38 @@ export type GetV1SsoConfigurationErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1SsoConfigurationError = - GetV1SsoConfigurationErrors[keyof GetV1SsoConfigurationErrors]; +export type PatchV1WebhookCallbacksIdError = + PatchV1WebhookCallbacksIdErrors[keyof PatchV1WebhookCallbacksIdErrors]; -export type GetV1SsoConfigurationResponses = { +export type PatchV1WebhookCallbacksIdResponses = { /** * Success */ - 200: SsoConfigurationResponse; + 200: WebhookCallbackResponse; }; -export type GetV1SsoConfigurationResponse = - GetV1SsoConfigurationResponses[keyof GetV1SsoConfigurationResponses]; +export type PatchV1WebhookCallbacksIdResponse = + PatchV1WebhookCallbacksIdResponses[keyof PatchV1WebhookCallbacksIdResponses]; -export type PostV1SsoConfigurationData = { - /** - * CreateSSOConfiguration - */ - body: CreateSsoConfigurationParams; +export type GetV1CountriesData = { + body?: never; + headers: { + /** + * This endpoint works with any of the access tokens provided. You can use an access + * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. + * + */ + Authorization: string; + }; path?: never; query?: never; - url: '/v1/sso-configuration'; + url: '/api/eor/v1/countries'; }; -export type PostV1SsoConfigurationErrors = { +export type GetV1CountriesErrors = { /** * Bad Request */ @@ -14453,52 +14657,48 @@ export type PostV1SsoConfigurationErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostV1SsoConfigurationError = - PostV1SsoConfigurationErrors[keyof PostV1SsoConfigurationErrors]; +export type GetV1CountriesError = + GetV1CountriesErrors[keyof GetV1CountriesErrors]; -export type PostV1SsoConfigurationResponses = { +export type GetV1CountriesResponses = { /** - * Created + * Success */ - 201: CreateSsoConfigurationResponse; + 200: CountriesResponse; }; -export type PostV1SsoConfigurationResponse = - PostV1SsoConfigurationResponses[keyof PostV1SsoConfigurationResponses]; +export type GetV1CountriesResponse = + GetV1CountriesResponses[keyof GetV1CountriesResponses]; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData = +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData = { body?: never; path: { /** - * Contract amendment request ID + * Company ID */ - contract_amendment_request_id: string; + company_id: UuidSlug; + /** + * Legal entity ID + */ + legal_entity_id: UuidSlug; }; query?: never; - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve'; + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility'; }; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors = +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; /** * Unauthorized */ @@ -14507,38 +14707,33 @@ export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveError * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveError = - PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors]; +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityError = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors]; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses = +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses = { /** * Success */ - 200: ContractAmendmentResponse; + 200: ContractorEligibilityResponse; }; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponse = - PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses]; +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponse = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses]; -export type GetV1EmployeeLeavePoliciesData = { - body?: never; +export type PostV1CurrencyConverterEffectiveData = { + /** + * Convert currency parameters + */ + body: ConvertCurrencyParams; path?: never; query?: never; - url: '/v1/employee/leave-policies'; + url: '/api/eor/v1/currency-converter/effective'; }; -export type GetV1EmployeeLeavePoliciesErrors = { +export type PostV1CurrencyConverterEffectiveErrors = { /** * Unauthorized */ @@ -14547,205 +14742,61 @@ export type GetV1EmployeeLeavePoliciesErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type GetV1EmployeeLeavePoliciesError = - GetV1EmployeeLeavePoliciesErrors[keyof GetV1EmployeeLeavePoliciesErrors]; +export type PostV1CurrencyConverterEffectiveError = + PostV1CurrencyConverterEffectiveErrors[keyof PostV1CurrencyConverterEffectiveErrors]; -export type GetV1EmployeeLeavePoliciesResponses = { +export type PostV1CurrencyConverterEffectiveResponses = { /** * Success */ - 200: ListLeavePoliciesDetailsResponse; + 200: ConvertCurrencyResponse; }; -export type GetV1EmployeeLeavePoliciesResponse = - GetV1EmployeeLeavePoliciesResponses[keyof GetV1EmployeeLeavePoliciesResponses]; +export type PostV1CurrencyConverterEffectiveResponse = + PostV1CurrencyConverterEffectiveResponses[keyof PostV1CurrencyConverterEffectiveResponses]; -export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData = { +export type GetV1EmployeePersonalInformationData = { body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Restrict to currencies which payout is guaranteed (default: true) - */ - restrict_to_guaranteed_pay_out_currencies?: boolean; - }; - url: '/v1/contractors/employments/{employment_id}/contractor-currencies'; -}; - -export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors = - { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Internal Server Error - */ - 500: InternalServerErrorResponse; - }; - -export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesError = - GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors]; - -export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses = - { - /** - * Success - */ - 200: ContractorCurrencyResponse; - }; - -export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponse = - GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses]; - -export type PostV1WebhookEventsReplayData = { - /** - * WebhookEvent - */ - body: ReplayWebhookEventsParams; path?: never; query?: never; - url: '/v1/webhook-events/replay'; + url: '/api/eor/v1/employee/personal-information'; }; -export type PostV1WebhookEventsReplayErrors = { +export type GetV1EmployeePersonalInformationErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; }; -export type PostV1WebhookEventsReplayError = - PostV1WebhookEventsReplayErrors[keyof PostV1WebhookEventsReplayErrors]; +export type GetV1EmployeePersonalInformationError = + GetV1EmployeePersonalInformationErrors[keyof GetV1EmployeePersonalInformationErrors]; -export type PostV1WebhookEventsReplayResponses = { +export type GetV1EmployeePersonalInformationResponses = { /** * Success */ 200: SuccessResponse; }; -export type PostV1WebhookEventsReplayResponse = - PostV1WebhookEventsReplayResponses[keyof PostV1WebhookEventsReplayResponses]; - -export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData = - { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests'; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors = - { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsError = - PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors[keyof PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors]; - -export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses = - { - /** - * Created - */ - 201: CorTerminationRequestCreatedResponse; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponse = - PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses[keyof PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses]; - -export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData = - { - body?: never; - path: { - /** - * Employment Id - */ - employment_id: UuidSlug; - /** - * Background Check Id - */ - background_check_id: UuidSlug; - }; - query?: never; - url: '/v1/employments/{employment_id}/background-checks/{background_check_id}'; - }; - -export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors = - { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - }; - -export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdError = - GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors[keyof GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors]; - -export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses = - { - /** - * Success - */ - 200: BackgroundChecksBackgroundCheckResponse; - }; - -export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponse = - GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses[keyof GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses]; +export type GetV1EmployeePersonalInformationResponse = + GetV1EmployeePersonalInformationResponses[keyof GetV1EmployeePersonalInformationResponses]; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData = { +export type GetV1CountriesCountryCodeFormData = { body?: never; headers: { /** @@ -14758,20 +14809,40 @@ export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData = { }; path: { /** - * Benefit Renewal Request Id + * Country code according to ISO 3-digit alphabetic codes */ - benefit_renewal_request_id: UuidSlug; + country_code: string; + /** + * Name of the desired form + */ + form: string; }; query?: { + /** + * Required for `contract_amendment` form + */ + employment_id?: string; + /** + * FOR TESTING PURPOSES ONLY: Include scheduled benefit groups. + */ + only_for_testing_include_scheduled_benefit_groups?: boolean; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; /** * Version of the form schema */ json_schema_version?: number | 'latest'; }; - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema'; + url: '/api/eor/v1/countries/{country_code}/{form}'; }; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors = { +export type GetV1CountriesCountryCodeFormErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -14784,113 +14855,26 @@ export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaError = - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors]; - -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses = - { - /** - * Success - */ - 200: BenefitRenewalRequestsBenefitRenewalRequestFormResponse; - }; - -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponse = - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses]; +export type GetV1CountriesCountryCodeFormError = + GetV1CountriesCountryCodeFormErrors[keyof GetV1CountriesCountryCodeFormErrors]; -export type PostV1MagicLinkData = { +export type GetV1CountriesCountryCodeFormResponses = { /** - * Magic links generator body + * Success */ - body: MagicLinkParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: never; - url: '/v1/magic-link'; -}; - -export type PostV1MagicLinkErrors = { - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; -}; - -export type PostV1MagicLinkError = - PostV1MagicLinkErrors[keyof PostV1MagicLinkErrors]; - -export type PostV1MagicLinkResponses = { - /** - * Success - */ - 200: MagicLinkResponse; -}; - -export type PostV1MagicLinkResponse = - PostV1MagicLinkResponses[keyof PostV1MagicLinkResponses]; - -export type PutV2EmploymentsEmploymentIdBasicInformationData = { - /** - * Employment basic information params - */ - body?: EmploymentBasicInformationParams; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: never; - url: '/v2/employments/{employment_id}/basic_information'; -}; - -export type PutV2EmploymentsEmploymentIdBasicInformationErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; -}; - -export type PutV2EmploymentsEmploymentIdBasicInformationError = - PutV2EmploymentsEmploymentIdBasicInformationErrors[keyof PutV2EmploymentsEmploymentIdBasicInformationErrors]; - -export type PutV2EmploymentsEmploymentIdBasicInformationResponses = { - /** - * Success - */ - 200: EmploymentResponse; + 200: CountryFormResponse; }; -export type PutV2EmploymentsEmploymentIdBasicInformationResponse = - PutV2EmploymentsEmploymentIdBasicInformationResponses[keyof PutV2EmploymentsEmploymentIdBasicInformationResponses]; +export type GetV1CountriesCountryCodeFormResponse = + GetV1CountriesCountryCodeFormResponses[keyof GetV1CountriesCountryCodeFormResponses]; -export type DeleteV1IncentivesRecurringIdData = { +export type GetV1TimeoffData = { body?: never; headers: { /** @@ -14901,90 +14885,41 @@ export type DeleteV1IncentivesRecurringIdData = { */ Authorization: string; }; - path: { + path?: never; + query?: { /** - * Recurring Incentive ID + * Only show time off for a specific employment */ - id: string; - }; - query?: never; - url: '/v1/incentives/recurring/{id}'; -}; - -export type DeleteV1IncentivesRecurringIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; -}; - -export type DeleteV1IncentivesRecurringIdError = - DeleteV1IncentivesRecurringIdErrors[keyof DeleteV1IncentivesRecurringIdErrors]; - -export type DeleteV1IncentivesRecurringIdResponses = { - /** - * Success - */ - 200: DeleteRecurringIncentiveResponse; -}; - -export type DeleteV1IncentivesRecurringIdResponse = - DeleteV1IncentivesRecurringIdResponses[keyof DeleteV1IncentivesRecurringIdResponses]; - -export type GetV1IncentivesData = { - body?: never; - headers: { + employment_id?: string; /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Filter time off by its type */ - Authorization: string; - }; - path?: never; - query?: { + timeoff_type?: TimeoffType; /** - * Filter by Employment ID + * Filter time off by its status */ - employment_id?: string; + status?: TimeoffStatus; /** - * Filter by Incentive status + * Sort order */ - status?: string; + order?: 'asc' | 'desc'; /** - * Filter by Recurring Incentive id + * Field to sort by */ - recurring_incentive_id?: string; + sort_by?: 'timeoff_type' | 'status'; /** * Starts fetching records after the given page */ page?: number; /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * Number of items per page */ page_size?: number; }; - url: '/v1/incentives'; + url: '/api/eor/v1/timeoff'; }; -export type GetV1IncentivesErrors = { +export type GetV1TimeoffErrors = { /** * Bad Request */ @@ -15002,29 +14937,28 @@ export type GetV1IncentivesErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetV1IncentivesError = - GetV1IncentivesErrors[keyof GetV1IncentivesErrors]; +export type GetV1TimeoffError = GetV1TimeoffErrors[keyof GetV1TimeoffErrors]; -export type GetV1IncentivesResponses = { +export type GetV1TimeoffResponses = { /** * Success */ - 200: ListIncentivesResponse; + 200: ListTimeoffResponse; }; -export type GetV1IncentivesResponse = - GetV1IncentivesResponses[keyof GetV1IncentivesResponses]; +export type GetV1TimeoffResponse = + GetV1TimeoffResponses[keyof GetV1TimeoffResponses]; -export type PostV1IncentivesData = { +export type PostV1TimeoffData = { /** - * Incentive + * Timeoff */ - body?: CreateOneTimeIncentiveParams; + body: CreateApprovedTimeoffParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -15036,10 +14970,10 @@ export type PostV1IncentivesData = { }; path?: never; query?: never; - url: '/v1/incentives'; + url: '/api/eor/v1/timeoff'; }; -export type PostV1IncentivesErrors = { +export type PostV1TimeoffErrors = { /** * Bad Request */ @@ -15057,87 +14991,65 @@ export type PostV1IncentivesErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PostV1IncentivesError = - PostV1IncentivesErrors[keyof PostV1IncentivesErrors]; +export type PostV1TimeoffError = PostV1TimeoffErrors[keyof PostV1TimeoffErrors]; -export type PostV1IncentivesResponses = { +export type PostV1TimeoffResponses = { /** - * Success + * Created */ - 201: IncentiveResponse; + 201: TimeoffResponse; }; -export type PostV1IncentivesResponse = - PostV1IncentivesResponses[keyof PostV1IncentivesResponses]; +export type PostV1TimeoffResponse = + PostV1TimeoffResponses[keyof PostV1TimeoffResponses]; -export type PostV1ProbationCompletionLetterData = { - /** - * Work Authorization Request - */ - body: CreateProbationCompletionLetterParams; +export type GetV1CostCalculatorCountriesData = { + body?: never; path?: never; - query?: never; - url: '/v1/probation-completion-letter'; + query?: { + /** + * If the premium benefits should be included in the response + */ + include_premium_benefits?: boolean; + }; + url: '/api/eor/v1/cost-calculator/countries'; }; -export type PostV1ProbationCompletionLetterErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; +export type GetV1CostCalculatorCountriesResponses = { /** - * Unprocessable Entity + * Success */ - 422: UnprocessableEntityResponse; + 200: CostCalculatorListCountryResponse; }; -export type PostV1ProbationCompletionLetterError = - PostV1ProbationCompletionLetterErrors[keyof PostV1ProbationCompletionLetterErrors]; +export type GetV1CostCalculatorCountriesResponse = + GetV1CostCalculatorCountriesResponses[keyof GetV1CostCalculatorCountriesResponses]; -export type PostV1ProbationCompletionLetterResponses = { +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData = { /** - * Success + * Proof of Payment */ - 200: ProbationCompletionLetterResponse; -}; - -export type PostV1ProbationCompletionLetterResponse = - PostV1ProbationCompletionLetterResponses[keyof PostV1ProbationCompletionLetterResponses]; - -export type GetV1ContractorInvoiceSchedulesIdData = { - body?: never; + body: CreateRiskReserveProofOfPaymentParams; path: { /** - * Resource unique identifier + * Employment ID */ - id: UuidSlug; + employment_id: string; }; query?: never; - url: '/v1/contractor-invoice-schedules/{id}'; + url: '/api/eor/v1/employments/{employment_id}/risk-reserve-proof-of-payments'; }; -export type GetV1ContractorInvoiceSchedulesIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -15146,41 +15058,133 @@ export type GetV1ContractorInvoiceSchedulesIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetV1ContractorInvoiceSchedulesIdError = - GetV1ContractorInvoiceSchedulesIdErrors[keyof GetV1ContractorInvoiceSchedulesIdErrors]; +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsError = + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors[keyof PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors]; -export type GetV1ContractorInvoiceSchedulesIdResponses = { +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses = { /** * Success */ - 200: ContractorInvoiceScheduleResponse; + 200: RiskReserveProofOfPaymentResponse; }; -export type GetV1ContractorInvoiceSchedulesIdResponse = - GetV1ContractorInvoiceSchedulesIdResponses[keyof GetV1ContractorInvoiceSchedulesIdResponses]; +export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponse = + PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses[keyof PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses]; -export type PatchV1ContractorInvoiceSchedulesId2Data = { - /** - * Update parameters - */ - body: UpdateScheduleContractorInvoiceParams; +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData = + { + body?: never; + path: { + /** + * Employment Id + */ + employment_id: UuidSlug; + /** + * Background Check Id + */ + background_check_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/background-checks/{background_check_id}'; + }; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdError = + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors[keyof GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors]; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses = + { + /** + * Success + */ + 200: BackgroundChecksBackgroundCheckResponse; + }; + +export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponse = + GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses[keyof GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdResponses]; + +export type GetV1TimeoffBalancesEmploymentIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Resource unique identifier + * Employment ID for which to show the time off balance */ - id: UuidSlug; + employment_id: string; }; query?: never; - url: '/v1/contractor-invoice-schedules/{id}'; + url: '/api/eor/v1/timeoff-balances/{employment_id}'; }; -export type PatchV1ContractorInvoiceSchedulesId2Errors = { +export type GetV1TimeoffBalancesEmploymentIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * TimeoffBalanceNotFoundResponse + */ + 404: TimeoffBalanceNotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type GetV1TimeoffBalancesEmploymentIdError = + GetV1TimeoffBalancesEmploymentIdErrors[keyof GetV1TimeoffBalancesEmploymentIdErrors]; + +export type GetV1TimeoffBalancesEmploymentIdResponses = { + /** + * Success + */ + 200: TimeoffBalanceResponse; +}; + +export type GetV1TimeoffBalancesEmploymentIdResponse = + GetV1TimeoffBalancesEmploymentIdResponses[keyof GetV1TimeoffBalancesEmploymentIdResponses]; + +export type GetV1EmployeeExpensesData = { + body?: never; + path?: never; + query?: never; + url: '/api/eor/v1/employee/expenses'; +}; + +export type GetV1EmployeeExpensesErrors = { /** * Unauthorized */ @@ -15193,41 +15197,80 @@ export type PatchV1ContractorInvoiceSchedulesId2Errors = { * Not Found */ 404: NotFoundResponse; +}; + +export type GetV1EmployeeExpensesError = + GetV1EmployeeExpensesErrors[keyof GetV1EmployeeExpensesErrors]; + +export type GetV1EmployeeExpensesResponses = { /** - * Unprocessable Entity + * Success */ - 422: UnprocessableEntityResponse; + 200: SuccessResponse; }; -export type PatchV1ContractorInvoiceSchedulesId2Error = - PatchV1ContractorInvoiceSchedulesId2Errors[keyof PatchV1ContractorInvoiceSchedulesId2Errors]; +export type GetV1EmployeeExpensesResponse = + GetV1EmployeeExpensesResponses[keyof GetV1EmployeeExpensesResponses]; -export type PatchV1ContractorInvoiceSchedulesId2Responses = { +export type PostV1EmployeeExpensesData = { /** - * Success + * Expense params */ - 200: ContractorInvoiceScheduleResponse; + body?: ParamsToCreateEmployeeExpense; + path?: never; + query?: never; + url: '/api/eor/v1/employee/expenses'; }; -export type PatchV1ContractorInvoiceSchedulesId2Response = - PatchV1ContractorInvoiceSchedulesId2Responses[keyof PatchV1ContractorInvoiceSchedulesId2Responses]; +export type PostV1EmployeeExpensesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; -export type PatchV1ContractorInvoiceSchedulesIdData = { +export type PostV1EmployeeExpensesError = + PostV1EmployeeExpensesErrors[keyof PostV1EmployeeExpensesErrors]; + +export type PostV1EmployeeExpensesResponses = { /** - * Update parameters + * Created */ - body: UpdateScheduleContractorInvoiceParams; + 201: SuccessResponse; +}; + +export type PostV1EmployeeExpensesResponse = + PostV1EmployeeExpensesResponses[keyof PostV1EmployeeExpensesResponses]; + +export type GetV1ResignationsOffboardingRequestIdResignationLetterData = { + body?: never; path: { /** - * Resource unique identifier + * Offboarding request ID */ - id: UuidSlug; + offboarding_request_id: string; }; query?: never; - url: '/v1/contractor-invoice-schedules/{id}'; + url: '/api/eor/v1/resignations/{offboarding_request_id}/resignation-letter'; }; -export type PatchV1ContractorInvoiceSchedulesIdErrors = { +export type GetV1ResignationsOffboardingRequestIdResignationLetterErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15244,22 +15287,26 @@ export type PatchV1ContractorInvoiceSchedulesIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PatchV1ContractorInvoiceSchedulesIdError = - PatchV1ContractorInvoiceSchedulesIdErrors[keyof PatchV1ContractorInvoiceSchedulesIdErrors]; +export type GetV1ResignationsOffboardingRequestIdResignationLetterError = + GetV1ResignationsOffboardingRequestIdResignationLetterErrors[keyof GetV1ResignationsOffboardingRequestIdResignationLetterErrors]; -export type PatchV1ContractorInvoiceSchedulesIdResponses = { +export type GetV1ResignationsOffboardingRequestIdResignationLetterResponses = { /** * Success */ - 200: ContractorInvoiceScheduleResponse; + 200: GenericFile; }; -export type PatchV1ContractorInvoiceSchedulesIdResponse = - PatchV1ContractorInvoiceSchedulesIdResponses[keyof PatchV1ContractorInvoiceSchedulesIdResponses]; +export type GetV1ResignationsOffboardingRequestIdResignationLetterResponse = + GetV1ResignationsOffboardingRequestIdResignationLetterResponses[keyof GetV1ResignationsOffboardingRequestIdResignationLetterResponses]; -export type GetV1BillingDocumentsBillingDocumentIdData = { +export type DeleteV1CompanyManagersUserIdData = { body?: never; headers: { /** @@ -15272,20 +15319,15 @@ export type GetV1BillingDocumentsBillingDocumentIdData = { }; path: { /** - * The billing document's ID - */ - billing_document_id: string; - }; - query?: { - /** - * When true, includes billing document items whose type is not part of the standard set for the invoice type. + * User ID */ - include_unrecognized_types?: boolean; + user_id: string; }; - url: '/v1/billing-documents/{billing_document_id}'; + query?: never; + url: '/api/eor/v1/company-managers/{user_id}'; }; -export type GetV1BillingDocumentsBillingDocumentIdErrors = { +export type DeleteV1CompanyManagersUserIdErrors = { /** * Bad Request */ @@ -15303,110 +15345,133 @@ export type GetV1BillingDocumentsBillingDocumentIdErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetV1BillingDocumentsBillingDocumentIdError = - GetV1BillingDocumentsBillingDocumentIdErrors[keyof GetV1BillingDocumentsBillingDocumentIdErrors]; +export type DeleteV1CompanyManagersUserIdError = + DeleteV1CompanyManagersUserIdErrors[keyof DeleteV1CompanyManagersUserIdErrors]; -export type GetV1BillingDocumentsBillingDocumentIdResponses = { +export type DeleteV1CompanyManagersUserIdResponses = { /** * Success */ - 200: BillingDocumentResponse; + 200: SuccessResponse; }; -export type GetV1BillingDocumentsBillingDocumentIdResponse = - GetV1BillingDocumentsBillingDocumentIdResponses[keyof GetV1BillingDocumentsBillingDocumentIdResponses]; +export type DeleteV1CompanyManagersUserIdResponse = + DeleteV1CompanyManagersUserIdResponses[keyof DeleteV1CompanyManagersUserIdResponses]; -export type PostV1CostCalculatorEstimationPdfData = { - /** - * Estimate params - */ - body?: CostCalculatorEstimateParams; - path?: never; +export type GetV1CompanyManagersUserIdData = { + body?: never; + path: { + /** + * User ID + */ + user_id: string; + }; query?: never; - url: '/v1/cost-calculator/estimation-pdf'; + url: '/api/eor/v1/company-managers/{user_id}'; }; -export type PostV1CostCalculatorEstimationPdfErrors = { +export type GetV1CompanyManagersUserIdErrors = { /** - * Not Found + * Bad Request */ - 404: NotFoundResponse; + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostV1CostCalculatorEstimationPdfError = - PostV1CostCalculatorEstimationPdfErrors[keyof PostV1CostCalculatorEstimationPdfErrors]; +export type GetV1CompanyManagersUserIdError = + GetV1CompanyManagersUserIdErrors[keyof GetV1CompanyManagersUserIdErrors]; -export type PostV1CostCalculatorEstimationPdfResponses = { +export type GetV1CompanyManagersUserIdResponses = { /** * Success */ - 200: CostCalculatorEstimatePdfResponse; + 200: CompanyManagerResponse; }; -export type PostV1CostCalculatorEstimationPdfResponse = - PostV1CostCalculatorEstimationPdfResponses[keyof PostV1CostCalculatorEstimationPdfResponses]; +export type GetV1CompanyManagersUserIdResponse = + GetV1CompanyManagersUserIdResponses[keyof GetV1CompanyManagersUserIdResponses]; -export type GetV1WorkAuthorizationRequestsIdData = { +export type GetV1EmploymentsEmploymentIdOnboardingStepsData = { body?: never; path: { /** - * work authorization request ID + * Employment ID */ - id: string; + employment_id: UuidSlug; }; query?: never; - url: '/v1/work-authorization-requests/{id}'; + url: '/api/eor/v1/employments/{employment_id}/onboarding-steps'; }; -export type GetV1WorkAuthorizationRequestsIdErrors = { +export type GetV1EmploymentsEmploymentIdOnboardingStepsErrors = { /** - * Not Found + * Unauthorized */ - 404: NotFoundResponse; + 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; }; -export type GetV1WorkAuthorizationRequestsIdError = - GetV1WorkAuthorizationRequestsIdErrors[keyof GetV1WorkAuthorizationRequestsIdErrors]; +export type GetV1EmploymentsEmploymentIdOnboardingStepsError = + GetV1EmploymentsEmploymentIdOnboardingStepsErrors[keyof GetV1EmploymentsEmploymentIdOnboardingStepsErrors]; -export type GetV1WorkAuthorizationRequestsIdResponses = { +export type GetV1EmploymentsEmploymentIdOnboardingStepsResponses = { /** * Success */ - 200: WorkAuthorizationRequestResponse; + 200: EmploymentOnboardingStepsResponse; }; -export type GetV1WorkAuthorizationRequestsIdResponse = - GetV1WorkAuthorizationRequestsIdResponses[keyof GetV1WorkAuthorizationRequestsIdResponses]; +export type GetV1EmploymentsEmploymentIdOnboardingStepsResponse = + GetV1EmploymentsEmploymentIdOnboardingStepsResponses[keyof GetV1EmploymentsEmploymentIdOnboardingStepsResponses]; -export type PatchV1WorkAuthorizationRequestsId2Data = { +export type PostV1ContractAmendmentsAutomatableData = { /** - * Work Authorization Request + * Contract Amendment */ - body: UpdateWorkAuthorizationRequestParams; - path: { + body?: CreateContractAmendmentParams; + headers: { /** - * work authorization request ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; - query?: never; - url: '/v1/work-authorization-requests/{id}'; + path?: never; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/contract-amendments/automatable'; }; -export type PatchV1WorkAuthorizationRequestsId2Errors = { +export type PostV1ContractAmendmentsAutomatableErrors = { /** * Unauthorized */ @@ -15421,35 +15486,40 @@ export type PatchV1WorkAuthorizationRequestsId2Errors = { 422: UnprocessableEntityResponse; }; -export type PatchV1WorkAuthorizationRequestsId2Error = - PatchV1WorkAuthorizationRequestsId2Errors[keyof PatchV1WorkAuthorizationRequestsId2Errors]; +export type PostV1ContractAmendmentsAutomatableError = + PostV1ContractAmendmentsAutomatableErrors[keyof PostV1ContractAmendmentsAutomatableErrors]; -export type PatchV1WorkAuthorizationRequestsId2Responses = { +export type PostV1ContractAmendmentsAutomatableResponses = { /** * Success */ - 200: WorkAuthorizationRequestResponse; + 200: ContractAmendmentAutomatableResponse; }; -export type PatchV1WorkAuthorizationRequestsId2Response = - PatchV1WorkAuthorizationRequestsId2Responses[keyof PatchV1WorkAuthorizationRequestsId2Responses]; +export type PostV1ContractAmendmentsAutomatableResponse = + PostV1ContractAmendmentsAutomatableResponses[keyof PostV1ContractAmendmentsAutomatableResponses]; -export type PatchV1WorkAuthorizationRequestsIdData = { - /** - * Work Authorization Request - */ - body: UpdateWorkAuthorizationRequestParams; - path: { +export type GetV1PayrollRunsData = { + body?: never; + path?: never; + query?: { /** - * work authorization request ID + * Filters payroll runs where period_start or period_end match the given date */ - id: string; + payroll_period?: Date; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/work-authorization-requests/{id}'; + url: '/api/eor/v1/payroll-runs'; }; -export type PatchV1WorkAuthorizationRequestsIdErrors = { +export type GetV1PayrollRunsErrors = { /** * Unauthorized */ @@ -15464,39 +15534,31 @@ export type PatchV1WorkAuthorizationRequestsIdErrors = { 422: UnprocessableEntityResponse; }; -export type PatchV1WorkAuthorizationRequestsIdError = - PatchV1WorkAuthorizationRequestsIdErrors[keyof PatchV1WorkAuthorizationRequestsIdErrors]; +export type GetV1PayrollRunsError = + GetV1PayrollRunsErrors[keyof GetV1PayrollRunsErrors]; -export type PatchV1WorkAuthorizationRequestsIdResponses = { +export type GetV1PayrollRunsResponses = { /** * Success */ - 200: WorkAuthorizationRequestResponse; + 200: ListPayrollRunResponse; }; -export type PatchV1WorkAuthorizationRequestsIdResponse = - PatchV1WorkAuthorizationRequestsIdResponses[keyof PatchV1WorkAuthorizationRequestsIdResponses]; +export type GetV1PayrollRunsResponse = + GetV1PayrollRunsResponses[keyof GetV1PayrollRunsResponses]; -export type PutV2EmploymentsEmploymentIdFederalTaxesData = { - /** - * Employment federal taxes params - */ - body?: EmploymentFederalTaxesParams; - path: { - /** - * Employment ID - */ - employment_id: string; - }; +export type GetV1EmployeeIncentivesData = { + body?: never; + path?: never; query?: never; - url: '/v2/employments/{employment_id}/federal-taxes'; + url: '/api/eor/v1/employee/incentives'; }; -export type PutV2EmploymentsEmploymentIdFederalTaxesErrors = { +export type GetV1EmployeeIncentivesErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ @@ -15505,44 +15567,46 @@ export type PutV2EmploymentsEmploymentIdFederalTaxesErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdFederalTaxesError = - PutV2EmploymentsEmploymentIdFederalTaxesErrors[keyof PutV2EmploymentsEmploymentIdFederalTaxesErrors]; +export type GetV1EmployeeIncentivesError = + GetV1EmployeeIncentivesErrors[keyof GetV1EmployeeIncentivesErrors]; -export type PutV2EmploymentsEmploymentIdFederalTaxesResponses = { +export type GetV1EmployeeIncentivesResponses = { /** * Success */ 200: SuccessResponse; }; -export type PutV2EmploymentsEmploymentIdFederalTaxesResponse = - PutV2EmploymentsEmploymentIdFederalTaxesResponses[keyof PutV2EmploymentsEmploymentIdFederalTaxesResponses]; +export type GetV1EmployeeIncentivesResponse = + GetV1EmployeeIncentivesResponses[keyof GetV1EmployeeIncentivesResponses]; -export type PostV1ProbationExtensionsData = { +export type PatchV1SandboxEmploymentsEmploymentId2Data = { /** - * ProbationExtension + * Employment params */ - body: CreateProbationExtensionParams; - path?: never; + body?: EmploymentUpdateParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/probation-extensions'; + url: '/api/eor/v1/sandbox/employments/{employment_id}'; }; -export type PostV1ProbationExtensionsErrors = { +export type PatchV1SandboxEmploymentsEmploymentId2Errors = { /** * Bad Request */ @@ -15555,46 +15619,58 @@ export type PostV1ProbationExtensionsErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostV1ProbationExtensionsError = - PostV1ProbationExtensionsErrors[keyof PostV1ProbationExtensionsErrors]; +export type PatchV1SandboxEmploymentsEmploymentId2Error = + PatchV1SandboxEmploymentsEmploymentId2Errors[keyof PatchV1SandboxEmploymentsEmploymentId2Errors]; -export type PostV1ProbationExtensionsResponses = { +export type PatchV1SandboxEmploymentsEmploymentId2Responses = { /** * Success */ - 200: ProbationExtensionResponse; + 200: EmploymentResponse; }; -export type PostV1ProbationExtensionsResponse = - PostV1ProbationExtensionsResponses[keyof PostV1ProbationExtensionsResponses]; +export type PatchV1SandboxEmploymentsEmploymentId2Response = + PatchV1SandboxEmploymentsEmploymentId2Responses[keyof PatchV1SandboxEmploymentsEmploymentId2Responses]; -export type PutV2EmploymentsEmploymentIdBillingAddressDetailsData = { +export type PatchV1SandboxEmploymentsEmploymentIdData = { /** - * Employment billing address details params + * Employment params */ - body?: EmploymentBillingAddressDetailsParams; - path: { + body?: EmploymentUpdateParams; + headers: { /** - * Employment ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - employment_id: string; + Authorization: string; }; - query?: { + path: { /** - * Version of the billing_address_details form schema + * Employment ID */ - billing_address_details_json_schema_version?: number | 'latest'; + employment_id: string; }; - url: '/v2/employments/{employment_id}/billing_address_details'; + query?: never; + url: '/api/eor/v1/sandbox/employments/{employment_id}'; }; -export type PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors = { +export type PatchV1SandboxEmploymentsEmploymentIdErrors = { /** * Bad Request */ @@ -15603,10 +15679,6 @@ export type PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors = { * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -15620,29 +15692,84 @@ export type PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdBillingAddressDetailsError = - PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors[keyof PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors]; +export type PatchV1SandboxEmploymentsEmploymentIdError = + PatchV1SandboxEmploymentsEmploymentIdErrors[keyof PatchV1SandboxEmploymentsEmploymentIdErrors]; -export type PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses = { +export type PatchV1SandboxEmploymentsEmploymentIdResponses = { /** * Success */ 200: EmploymentResponse; }; -export type PutV2EmploymentsEmploymentIdBillingAddressDetailsResponse = - PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses[keyof PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses]; +export type PatchV1SandboxEmploymentsEmploymentIdResponse = + PatchV1SandboxEmploymentsEmploymentIdResponses[keyof PatchV1SandboxEmploymentsEmploymentIdResponses]; -export type PutV2EmploymentsEmploymentIdAddressDetailsData = { - /** - * Employment address details params +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Benefit Renewal Request Id + */ + benefit_renewal_request_id: UuidSlug; + }; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema'; +}; + +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors = { + /** + * Unauthorized */ - body?: EmploymentAddressDetailsParams; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaError = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors]; + +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses = + { + /** + * Success + */ + 200: BenefitRenewalRequestsBenefitRenewalRequestFormResponse; + }; + +export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponse = + GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaResponses]; + +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsData = { + /** + * Employment billing address details params + */ + body?: EmploymentBillingAddressDetailsParams; path: { /** * Employment ID @@ -15651,14 +15778,14 @@ export type PutV2EmploymentsEmploymentIdAddressDetailsData = { }; query?: { /** - * Version of the address_details form schema + * Version of the billing_address_details form schema */ - address_details_json_schema_version?: number | 'latest'; + billing_address_details_json_schema_version?: number | 'latest'; }; - url: '/v2/employments/{employment_id}/address_details'; + url: '/api/eor/v2/employments/{employment_id}/billing_address_details'; }; -export type PutV2EmploymentsEmploymentIdAddressDetailsErrors = { +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors = { /** * Bad Request */ @@ -15689,30 +15816,45 @@ export type PutV2EmploymentsEmploymentIdAddressDetailsErrors = { 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdAddressDetailsError = - PutV2EmploymentsEmploymentIdAddressDetailsErrors[keyof PutV2EmploymentsEmploymentIdAddressDetailsErrors]; +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsError = + PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors[keyof PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors]; -export type PutV2EmploymentsEmploymentIdAddressDetailsResponses = { +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses = { /** * Success */ 200: EmploymentResponse; }; -export type PutV2EmploymentsEmploymentIdAddressDetailsResponse = - PutV2EmploymentsEmploymentIdAddressDetailsResponses[keyof PutV2EmploymentsEmploymentIdAddressDetailsResponses]; +export type PutV2EmploymentsEmploymentIdBillingAddressDetailsResponse = + PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses[keyof PutV2EmploymentsEmploymentIdBillingAddressDetailsResponses]; -export type PostV1RiskReserveData = { - /** - * Risk Reserve - */ - body: CreateRiskReserveParams; - path?: never; +export type DeleteV1IncentivesIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Incentive ID + */ + id: string; + }; query?: never; - url: '/v1/risk-reserve'; + url: '/api/eor/v1/incentives/{id}'; }; -export type PostV1RiskReserveErrors = { +export type DeleteV1IncentivesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15721,41 +15863,59 @@ export type PostV1RiskReserveErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostV1RiskReserveError = - PostV1RiskReserveErrors[keyof PostV1RiskReserveErrors]; +export type DeleteV1IncentivesIdError = + DeleteV1IncentivesIdErrors[keyof DeleteV1IncentivesIdErrors]; -export type PostV1RiskReserveResponses = { +export type DeleteV1IncentivesIdResponses = { /** * Success */ 200: SuccessResponse; }; -export type PostV1RiskReserveResponse = - PostV1RiskReserveResponses[keyof PostV1RiskReserveResponses]; +export type DeleteV1IncentivesIdResponse = + DeleteV1IncentivesIdResponses[keyof DeleteV1IncentivesIdResponses]; -export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData = { - /** - * Proof of Payment - */ - body: CreateRiskReserveProofOfPaymentParams; +export type GetV1IncentivesIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Employment ID + * Incentive ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/employments/{employment_id}/risk-reserve-proof-of-payments'; + url: '/api/eor/v1/incentives/{id}'; }; -export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors = { +export type GetV1IncentivesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15768,74 +15928,54 @@ export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; -}; - -export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsError = - PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors[keyof PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors]; - -export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses = { /** - * Success + * Too many requests */ - 200: RiskReserveProofOfPaymentResponse; + 429: TooManyRequestsResponse; }; -export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponse = - PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses[keyof PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsResponses]; - -export type GetV1CompaniesCompanyIdComplianceProfileData = { - body?: never; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - }; - query?: never; - url: '/v1/companies/{company_id}/compliance-profile'; -}; +export type GetV1IncentivesIdError = + GetV1IncentivesIdErrors[keyof GetV1IncentivesIdErrors]; -export type GetV1CompaniesCompanyIdComplianceProfileErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; +export type GetV1IncentivesIdResponses = { /** - * Not Found + * Success */ - 404: NotFoundResponse; + 200: IncentiveResponse; }; -export type GetV1CompaniesCompanyIdComplianceProfileError = - GetV1CompaniesCompanyIdComplianceProfileErrors[keyof GetV1CompaniesCompanyIdComplianceProfileErrors]; +export type GetV1IncentivesIdResponse = + GetV1IncentivesIdResponses[keyof GetV1IncentivesIdResponses]; -export type GetV1CompaniesCompanyIdComplianceProfileResponses = { +export type PatchV1IncentivesId2Data = { /** - * Success + * Incentive */ - 200: CompanyComplianceProfileResponse; -}; - -export type GetV1CompaniesCompanyIdComplianceProfileResponse = - GetV1CompaniesCompanyIdComplianceProfileResponses[keyof GetV1CompaniesCompanyIdComplianceProfileResponses]; - -export type GetV1CompaniesCompanyIdProductPricesData = { - body?: never; + body?: UpdateIncentiveParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Company ID + * Incentive ID */ - company_id: UuidSlug; + id: string; }; query?: never; - url: '/v1/companies/{company_id}/product-prices'; + url: '/api/eor/v1/incentives/{id}'; }; -export type GetV1CompaniesCompanyIdProductPricesErrors = { +export type PatchV1IncentivesId2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -15844,27 +15984,38 @@ export type GetV1CompaniesCompanyIdProductPricesErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1CompaniesCompanyIdProductPricesError = - GetV1CompaniesCompanyIdProductPricesErrors[keyof GetV1CompaniesCompanyIdProductPricesErrors]; +export type PatchV1IncentivesId2Error = + PatchV1IncentivesId2Errors[keyof PatchV1IncentivesId2Errors]; -export type GetV1CompaniesCompanyIdProductPricesResponses = { +export type PatchV1IncentivesId2Responses = { /** * Success */ - 200: ListProductPricesResponse; + 200: IncentiveResponse; }; -export type GetV1CompaniesCompanyIdProductPricesResponse = - GetV1CompaniesCompanyIdProductPricesResponses[keyof GetV1CompaniesCompanyIdProductPricesResponses]; +export type PatchV1IncentivesId2Response = + PatchV1IncentivesId2Responses[keyof PatchV1IncentivesId2Responses]; -export type GetV1CompaniesCompanyIdData = { - body?: never; +export type PatchV1IncentivesIdData = { + /** + * Incentive + */ + body?: UpdateIncentiveParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -15876,15 +16027,352 @@ export type GetV1CompaniesCompanyIdData = { }; path: { /** - * Company ID + * Incentive ID */ - company_id: string; + id: string; }; query?: never; - url: '/v1/companies/{company_id}'; + url: '/api/eor/v1/incentives/{id}'; }; -export type GetV1CompaniesCompanyIdErrors = { +export type PatchV1IncentivesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; +}; + +export type PatchV1IncentivesIdError = + PatchV1IncentivesIdErrors[keyof PatchV1IncentivesIdErrors]; + +export type PatchV1IncentivesIdResponses = { + /** + * Success + */ + 200: IncentiveResponse; +}; + +export type PatchV1IncentivesIdResponse = + PatchV1IncentivesIdResponses[keyof PatchV1IncentivesIdResponses]; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData = + { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Legal entity ID + */ + legal_entity_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors]; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses = + { + /** + * ShowLegalEntityAdministrativeDetailsResponse + * + * Country specific json schema driven administrative details for legal entities + */ + 200: { + data: { + [key: string]: unknown; + }; + }; + }; + +export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse = + GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses]; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData = + { + /** + * Legal entity administrative details params + */ + body?: AdministrativeDetailsParams; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Legal entity ID + */ + legal_entity_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + }; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; + }; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError = + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors[keyof PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors]; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses = + { + /** + * ShowLegalEntityAdministrativeDetailsResponse + * + * Country specific json schema driven administrative details for legal entities + */ + 200: { + data: { + [key: string]: unknown; + }; + }; + }; + +export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse = + PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses[keyof PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses]; + +export type PutV2EmploymentsEmploymentIdBankAccountDetailsData = { + /** + * Employment bank account details params + */ + body?: EmploymentBankAccountDetailsParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v2/employments/{employment_id}/bank_account_details'; +}; + +export type PutV2EmploymentsEmploymentIdBankAccountDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type PutV2EmploymentsEmploymentIdBankAccountDetailsError = + PutV2EmploymentsEmploymentIdBankAccountDetailsErrors[keyof PutV2EmploymentsEmploymentIdBankAccountDetailsErrors]; + +export type PutV2EmploymentsEmploymentIdBankAccountDetailsResponses = { + /** + * Success + */ + 200: EmploymentResponse; +}; + +export type PutV2EmploymentsEmploymentIdBankAccountDetailsResponse = + PutV2EmploymentsEmploymentIdBankAccountDetailsResponses[keyof PutV2EmploymentsEmploymentIdBankAccountDetailsResponses]; + +export type GetV1ContractorInvoicesData = { + body?: never; + path?: never; + query?: { + /** + * Filters contractor invoices by status matching the value. + */ + status?: ContractorInvoiceStatus; + /** + * Filters contractor invoices by invoice schedule ID matching the value. + */ + contractor_invoice_schedule_id?: UuidSlug; + /** + * Filters contractor invoices by date greater than or equal to the value. + */ + date_from?: Date; + /** + * Filters contractor invoices by date less than or equal to the value. + */ + date_to?: Date; + /** + * Filters contractor invoices by due date greater than or equal to the value. + */ + due_date_from?: Date; + /** + * Filters contractor invoices by due date less than or equal to the value. + */ + due_date_to?: Date; + /** + * Filters contractor invoices by approved date greater than or equal to the value. + */ + approved_date_from?: Date; + /** + * Filters contractor invoices by approved date less than or equal to the value. + */ + approved_date_to?: Date; + /** + * Filters contractor invoices by paid out date greater than or equal to the value. + */ + paid_out_date_from?: Date; + /** + * Filters contractor invoices by paid out date less than or equal to the value. + */ + paid_out_date_to?: Date; + /** + * Field to sort by + */ + sort_by?: 'date' | 'due_date' | 'approved_at' | 'paid_out_at'; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/contractor-invoices'; +}; + +export type GetV1ContractorInvoicesErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1ContractorInvoicesError = + GetV1ContractorInvoicesErrors[keyof GetV1ContractorInvoicesErrors]; + +export type GetV1ContractorInvoicesResponses = { + /** + * Success + */ + 200: ListContractorInvoicesResponse; +}; + +export type GetV1ContractorInvoicesResponse = + GetV1ContractorInvoicesResponses[keyof GetV1ContractorInvoicesResponses]; + +export type GetV1ExpensesCategoriesData = { + body?: never; + path?: never; + query?: { + /** + * The employment ID for which to list categories. Required if neither expense_id nor country_code is provided. + */ + employment_id?: string; + /** + * The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context. + */ + expense_id?: string; + /** + * Include un-selectable intermediate categories in the response + */ + include_parents?: boolean; + /** + * Filter categories by country (ISO 3166-1 alpha-3 code, e.g. "GBR"). Only used when neither employment_id nor expense_id is provided. + */ + country_code?: string; + }; + url: '/api/eor/v1/expenses/categories'; +}; + +export type GetV1ExpensesCategoriesErrors = { /** * Bad Request */ @@ -15907,172 +16395,443 @@ export type GetV1CompaniesCompanyIdErrors = { 429: TooManyRequestsResponse; }; -export type GetV1CompaniesCompanyIdError = - GetV1CompaniesCompanyIdErrors[keyof GetV1CompaniesCompanyIdErrors]; +export type GetV1ExpensesCategoriesError = + GetV1ExpensesCategoriesErrors[keyof GetV1ExpensesCategoriesErrors]; -export type GetV1CompaniesCompanyIdResponses = { +export type GetV1ExpensesCategoriesResponses = { /** * Success */ - 200: CompanyResponse; + 200: ListExpenseCategoriesResponse; }; -export type GetV1CompaniesCompanyIdResponse = - GetV1CompaniesCompanyIdResponses[keyof GetV1CompaniesCompanyIdResponses]; +export type GetV1ExpensesCategoriesResponse = + GetV1ExpensesCategoriesResponses[keyof GetV1ExpensesCategoriesResponses]; -export type PatchV1CompaniesCompanyId2Data = { +export type GetV1EmploymentsEmploymentIdContractDocumentsData = { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Filter by contract document statuses + */ + statuses?: Array; + /** + * Exclude contract documents with specific statuses + */ + except_statuses?: Array; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employments/{employment_id}/contract-documents'; +}; + +export type GetV1EmploymentsEmploymentIdContractDocumentsErrors = { /** - * Update Company params + * Unauthorized */ - body?: UpdateCompanyParams; - headers: { + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1EmploymentsEmploymentIdContractDocumentsError = + GetV1EmploymentsEmploymentIdContractDocumentsErrors[keyof GetV1EmploymentsEmploymentIdContractDocumentsErrors]; + +export type GetV1EmploymentsEmploymentIdContractDocumentsResponses = { + /** + * Success + */ + 200: IndexContractDocumentsResponse; +}; + +export type GetV1EmploymentsEmploymentIdContractDocumentsResponse = + GetV1EmploymentsEmploymentIdContractDocumentsResponses[keyof GetV1EmploymentsEmploymentIdContractDocumentsResponses]; + +export type GetV1CountriesCountryCodeContractorContractDetailsData = { + body?: never; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Country code according to ISO 3-digit alphabetic codes */ - Authorization: string; + country_code: string; + }; + query?: { + /** + * Employment ID + */ + employment_id?: string; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/countries/{country_code}/contractor-contract-details'; +}; + +export type GetV1CountriesCountryCodeContractorContractDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type GetV1CountriesCountryCodeContractorContractDetailsError = + GetV1CountriesCountryCodeContractorContractDetailsErrors[keyof GetV1CountriesCountryCodeContractorContractDetailsErrors]; + +export type GetV1CountriesCountryCodeContractorContractDetailsResponses = { + /** + * Success + */ + 200: ContractorContractDetailsResponse; +}; + +export type GetV1CountriesCountryCodeContractorContractDetailsResponse = + GetV1CountriesCountryCodeContractorContractDetailsResponses[keyof GetV1CountriesCountryCodeContractorContractDetailsResponses]; + +export type GetV1ScimV2UsersIdData = { + body?: never; + path: { + /** + * User ID (slug) + */ + id: string; + }; + query?: never; + url: '/api/eor/v1/scim/v2/Users/{id}'; +}; + +export type GetV1ScimV2UsersIdErrors = { + /** + * Unauthorized + */ + 401: IntegrationsScimErrorResponse; + /** + * Forbidden + */ + 403: IntegrationsScimErrorResponse; + /** + * Not Found + */ + 404: IntegrationsScimErrorResponse; +}; + +export type GetV1ScimV2UsersIdError = + GetV1ScimV2UsersIdErrors[keyof GetV1ScimV2UsersIdErrors]; + +export type GetV1ScimV2UsersIdResponses = { + /** + * Success + */ + 200: IntegrationsScimUser; +}; + +export type GetV1ScimV2UsersIdResponse = + GetV1ScimV2UsersIdResponses[keyof GetV1ScimV2UsersIdResponses]; + +export type GetV1EmploymentsEmploymentIdFilesData = { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Filter by file type (optional) + */ + type?: string; + /** + * Filter by file sub_type (optional) + */ + sub_type?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employments/{employment_id}/files'; +}; + +export type GetV1EmploymentsEmploymentIdFilesErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type GetV1EmploymentsEmploymentIdFilesError = + GetV1EmploymentsEmploymentIdFilesErrors[keyof GetV1EmploymentsEmploymentIdFilesErrors]; + +export type GetV1EmploymentsEmploymentIdFilesResponses = { + /** + * Success + */ + 200: ListFilesResponse; +}; + +export type GetV1EmploymentsEmploymentIdFilesResponse = + GetV1EmploymentsEmploymentIdFilesResponses[keyof GetV1EmploymentsEmploymentIdFilesResponses]; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData = + { + /** + * Manage Contractor Plus subscription params + */ + body: ManageContractorPlusSubscriptionOperationsParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-plus-subscription'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; }; - path: { + +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionError = + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses = + { /** - * Company ID - * + * Success */ - company_id: string; + 200: SuccessResponse; }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponse = + PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses]; + +export type PostV1ContractorsEligibilityQuestionnaireData = { + /** + * Eligibility questionnaire submission + */ + body: SubmitEligibilityQuestionnaireRequest; + path?: never; query?: { /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; - /** - * Version of the bank_account_details form schema + * Version of the form schema */ - bank_account_details_json_schema_version?: number | 'latest'; + json_schema_version?: number | 'latest'; }; - url: '/v1/companies/{company_id}'; + url: '/api/eor/v1/contractors/eligibility-questionnaire'; }; -export type PatchV1CompaniesCompanyId2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1ContractorsEligibilityQuestionnaireErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Conflict */ - 422: UnprocessableEntityResponse; + 409: ConflictErrorResponse; /** - * Too many requests + * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PatchV1CompaniesCompanyId2Error = - PatchV1CompaniesCompanyId2Errors[keyof PatchV1CompaniesCompanyId2Errors]; +export type PostV1ContractorsEligibilityQuestionnaireError = + PostV1ContractorsEligibilityQuestionnaireErrors[keyof PostV1ContractorsEligibilityQuestionnaireErrors]; -export type PatchV1CompaniesCompanyId2Responses = { +export type PostV1ContractorsEligibilityQuestionnaireResponses = { /** - * Success + * Questionnaire submitted successfully */ - 200: CompanyResponse; + 201: EligibilityQuestionnaireResponse; }; -export type PatchV1CompaniesCompanyId2Response = - PatchV1CompaniesCompanyId2Responses[keyof PatchV1CompaniesCompanyId2Responses]; +export type PostV1ContractorsEligibilityQuestionnaireResponse = + PostV1ContractorsEligibilityQuestionnaireResponses[keyof PostV1ContractorsEligibilityQuestionnaireResponses]; -export type PatchV1CompaniesCompanyIdData = { +export type PutV1EmploymentsEmploymentIdBasicInformationData = { /** - * Update Company params + * Employment basic information params */ - body?: UpdateCompanyParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body?: EmploymentBasicInformationParams; path: { /** - * Company ID - * - */ - company_id: string; - }; - query?: { - /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; - /** - * Version of the bank_account_details form schema + * Employment ID */ - bank_account_details_json_schema_version?: number | 'latest'; + employment_id: string; }; - url: '/v1/companies/{company_id}'; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/basic_information'; }; -export type PatchV1CompaniesCompanyIdErrors = { +export type PutV1EmploymentsEmploymentIdBasicInformationErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PatchV1CompaniesCompanyIdError = - PatchV1CompaniesCompanyIdErrors[keyof PatchV1CompaniesCompanyIdErrors]; +export type PutV1EmploymentsEmploymentIdBasicInformationError = + PutV1EmploymentsEmploymentIdBasicInformationErrors[keyof PutV1EmploymentsEmploymentIdBasicInformationErrors]; -export type PatchV1CompaniesCompanyIdResponses = { +export type PutV1EmploymentsEmploymentIdBasicInformationResponses = { /** * Success */ - 200: CompanyResponse; + 200: EmploymentResponse; }; -export type PatchV1CompaniesCompanyIdResponse = - PatchV1CompaniesCompanyIdResponses[keyof PatchV1CompaniesCompanyIdResponses]; +export type PutV1EmploymentsEmploymentIdBasicInformationResponse = + PutV1EmploymentsEmploymentIdBasicInformationResponses[keyof PutV1EmploymentsEmploymentIdBasicInformationResponses]; -export type GetV1ResignationsOffboardingRequestIdResignationLetterData = { - body?: never; +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + /** + * Termination Request ID + */ + termination_request_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}'; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors = + { + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdError = + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors[keyof GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors]; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses = + { + /** + * Success + */ + 200: CorTerminationRequestResponse; + }; + +export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponse = + GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses[keyof GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses]; + +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesData = { + /** + * Create legal entity params + */ + body?: { + /** + * ISO 3166-1 alpha-3 country code + */ + country_code: string; + }; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Offboarding request ID + * Company ID */ - offboarding_request_id: string; + company_id: string; }; query?: never; - url: '/v1/resignations/{offboarding_request_id}/resignation-letter'; + url: '/api/eor/v1/sandbox/companies/{company_id}/legal-entities'; }; -export type GetV1ResignationsOffboardingRequestIdResignationLetterErrors = { +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors = { /** * Bad Request */ @@ -16081,10 +16840,6 @@ export type GetV1ResignationsOffboardingRequestIdResignationLetterErrors = { * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -16094,205 +16849,204 @@ export type GetV1ResignationsOffboardingRequestIdResignationLetterErrors = { */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetV1ResignationsOffboardingRequestIdResignationLetterError = - GetV1ResignationsOffboardingRequestIdResignationLetterErrors[keyof GetV1ResignationsOffboardingRequestIdResignationLetterErrors]; +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesError = + PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors[keyof PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors]; -export type GetV1ResignationsOffboardingRequestIdResignationLetterResponses = { +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses = { /** - * Success + * Legal entity created */ - 200: GenericFile; + 201: { + data?: { + /** + * Legal entity slug + */ + legal_entity_id?: string; + /** + * Legal entity name + */ + name?: string; + /** + * Legal entity status + */ + status?: string; + }; + }; }; -export type GetV1ResignationsOffboardingRequestIdResignationLetterResponse = - GetV1ResignationsOffboardingRequestIdResignationLetterResponses[keyof GetV1ResignationsOffboardingRequestIdResignationLetterResponses]; +export type PostV1SandboxCompaniesCompanyIdLegalEntitiesResponse = + PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses[keyof PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses]; -export type PutV1EmploymentsEmploymentIdFederalTaxesData = { - /** - * Employment federal taxes params - */ - body?: EmploymentFederalTaxesParams; - path: { +export type GetV1WdGphPayDetailDataData = { + body?: never; + headers?: { /** - * Employment ID + * The preferred language of the inquiring user in Workday */ - employment_id: string; + accept_language?: string; }; - query?: never; - url: '/v1/employments/{employment_id}/federal-taxes'; + path?: never; + query: { + /** + * The pay group ID for identifying the pay group at the vendor system + */ + payGroupExternalId: string; + /** + * The run type id provided in the paySummary API + */ + runTypeId: string; + /** + * The cycle type id, defaults to the main run if not provided + */ + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; + }; + url: '/api/eor/v1/wd/gph/payDetailData'; }; - -export type PutV1EmploymentsEmploymentIdFederalTaxesErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; + +export type GetV1WdGphPayDetailDataErrors = { /** - * Conflict + * Bad Request */ - 409: ConflictResponse; + 400: BadRequestResponse; /** - * Unprocessable Entity + * Unauthorized */ - 422: UnprocessableEntityResponse; + 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 429: TooManyRequestsResponse; + 404: NotFoundResponse; }; -export type PutV1EmploymentsEmploymentIdFederalTaxesError = - PutV1EmploymentsEmploymentIdFederalTaxesErrors[keyof PutV1EmploymentsEmploymentIdFederalTaxesErrors]; +export type GetV1WdGphPayDetailDataError = + GetV1WdGphPayDetailDataErrors[keyof GetV1WdGphPayDetailDataErrors]; -export type PutV1EmploymentsEmploymentIdFederalTaxesResponses = { +export type GetV1WdGphPayDetailDataResponses = { /** * Success */ - 200: SuccessResponse; + 200: PayDetailDataResponse; }; -export type PutV1EmploymentsEmploymentIdFederalTaxesResponse = - PutV1EmploymentsEmploymentIdFederalTaxesResponses[keyof PutV1EmploymentsEmploymentIdFederalTaxesResponses]; +export type GetV1WdGphPayDetailDataResponse = + GetV1WdGphPayDetailDataResponses[keyof GetV1WdGphPayDetailDataResponses]; -export type GetV1ContractAmendmentsData = { +export type GetV1CostCalculatorRegionsSlugFieldsData = { body?: never; - headers: { + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Slug */ - Authorization: string; + slug: string; }; - path?: never; query?: { /** - * Employment ID - */ - employment_id?: string; - /** - * Contract Amendment status - */ - status?: ContractAmendmentStatus; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * If the premium benefits should be included in the response */ - page_size?: number; + include_premium_benefits?: boolean; }; - url: '/v1/contract-amendments'; + url: '/api/eor/v1/cost-calculator/regions/{slug}/fields'; }; -export type GetV1ContractAmendmentsErrors = { +export type GetV1CostCalculatorRegionsSlugFieldsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity + * Internal Server Error */ - 422: UnprocessableEntityResponse; + 500: InternalServerErrorResponse; }; -export type GetV1ContractAmendmentsError = - GetV1ContractAmendmentsErrors[keyof GetV1ContractAmendmentsErrors]; +export type GetV1CostCalculatorRegionsSlugFieldsError = + GetV1CostCalculatorRegionsSlugFieldsErrors[keyof GetV1CostCalculatorRegionsSlugFieldsErrors]; -export type GetV1ContractAmendmentsResponses = { +export type GetV1CostCalculatorRegionsSlugFieldsResponses = { /** * Success */ - 200: ListContractAmendmentResponse; + 200: JsonSchemaResponse; }; -export type GetV1ContractAmendmentsResponse = - GetV1ContractAmendmentsResponses[keyof GetV1ContractAmendmentsResponses]; +export type GetV1CostCalculatorRegionsSlugFieldsResponse = + GetV1CostCalculatorRegionsSlugFieldsResponses[keyof GetV1CostCalculatorRegionsSlugFieldsResponses]; -export type PostV1ContractAmendmentsData = { - /** - * Contract Amendment - */ - body?: CreateContractAmendmentParams; - headers: { +export type PostV1CancelOnboardingEmploymentIdData = { + body?: never; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Employment ID */ - Authorization: string; + employment_id: string; }; - path?: never; query?: { /** - * Version of the form schema + * Whether the request should be performed async + * */ - json_schema_version?: number | 'latest'; + async?: boolean; }; - url: '/v1/contract-amendments'; + url: '/api/eor/v1/cancel-onboarding/{employment_id}'; }; -export type PostV1ContractAmendmentsErrors = { +export type PostV1CancelOnboardingEmploymentIdErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Unprocessable Entity */ - 404: NotFoundResponse; + 422: UnprocessableEntityResponse; /** * Unprocessable Entity */ - 422: UnprocessableEntityResponse; + 429: TooManyRequestsResponse; }; -export type PostV1ContractAmendmentsError = - PostV1ContractAmendmentsErrors[keyof PostV1ContractAmendmentsErrors]; +export type PostV1CancelOnboardingEmploymentIdError = + PostV1CancelOnboardingEmploymentIdErrors[keyof PostV1CancelOnboardingEmploymentIdErrors]; -export type PostV1ContractAmendmentsResponses = { +export type PostV1CancelOnboardingEmploymentIdResponses = { /** * Success */ - 200: ContractAmendmentResponse; + 200: SuccessResponse; }; -export type PostV1ContractAmendmentsResponse = - PostV1ContractAmendmentsResponses[keyof PostV1ContractAmendmentsResponses]; +export type PostV1CancelOnboardingEmploymentIdResponse = + PostV1CancelOnboardingEmploymentIdResponses[keyof PostV1CancelOnboardingEmploymentIdResponses]; -export type GetV1PayrollRunsPayrollRunIdData = { - body?: never; +export type PostV1EmployeeTimeoffIdCancelData = { + /** + * CancelTimeoff + */ + body: CancelTimeoffParams; path: { /** - * Payroll run ID + * Timeoff ID */ - payroll_run_id: string; + id: string; }; query?: never; - url: '/v1/payroll-runs/{payroll_run_id}'; + url: '/api/eor/v1/employee/timeoff/{id}/cancel'; }; -export type GetV1PayrollRunsPayrollRunIdErrors = { +export type PostV1EmployeeTimeoffIdCancelErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -16305,20 +17059,24 @@ export type GetV1PayrollRunsPayrollRunIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1PayrollRunsPayrollRunIdError = - GetV1PayrollRunsPayrollRunIdErrors[keyof GetV1PayrollRunsPayrollRunIdErrors]; +export type PostV1EmployeeTimeoffIdCancelError = + PostV1EmployeeTimeoffIdCancelErrors[keyof PostV1EmployeeTimeoffIdCancelErrors]; -export type GetV1PayrollRunsPayrollRunIdResponses = { +export type PostV1EmployeeTimeoffIdCancelResponses = { /** * Success */ - 200: PayrollRunResponse; + 200: TimeoffResponse; }; -export type GetV1PayrollRunsPayrollRunIdResponse = - GetV1PayrollRunsPayrollRunIdResponses[keyof GetV1PayrollRunsPayrollRunIdResponses]; +export type PostV1EmployeeTimeoffIdCancelResponse = + PostV1EmployeeTimeoffIdCancelResponses[keyof PostV1EmployeeTimeoffIdCancelResponses]; export type GetV1ExpensesExpenseIdReceiptData = { body?: never; @@ -16329,7 +17087,7 @@ export type GetV1ExpensesExpenseIdReceiptData = { expense_id: string; }; query?: never; - url: '/v1/expenses/{expense_id}/receipt'; + url: '/api/eor/v1/expenses/{expense_id}/receipt'; }; export type GetV1ExpensesExpenseIdReceiptErrors = { @@ -16372,23 +17130,23 @@ export type GetV1ExpensesExpenseIdReceiptResponses = { export type GetV1ExpensesExpenseIdReceiptResponse = GetV1ExpensesExpenseIdReceiptResponses[keyof GetV1ExpensesExpenseIdReceiptResponses]; -export type GetV1TravelLetterRequestsIdData = { +export type GetV1BenefitOffersCountrySummariesData = { body?: never; - path: { + headers: { /** - * travel letter request ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: UuidSlug; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/travel-letter-requests/{id}'; + url: '/api/eor/v1/benefit-offers/country-summaries'; }; -export type GetV1TravelLetterRequestsIdErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; +export type GetV1BenefitOffersCountrySummariesErrors = { /** * Not Found */ @@ -16399,35 +17157,32 @@ export type GetV1TravelLetterRequestsIdErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1TravelLetterRequestsIdError = - GetV1TravelLetterRequestsIdErrors[keyof GetV1TravelLetterRequestsIdErrors]; +export type GetV1BenefitOffersCountrySummariesError = + GetV1BenefitOffersCountrySummariesErrors[keyof GetV1BenefitOffersCountrySummariesErrors]; -export type GetV1TravelLetterRequestsIdResponses = { +export type GetV1BenefitOffersCountrySummariesResponses = { /** * Success */ - 200: TravelLetterResponse; + 200: CountrySummariesResponse; }; -export type GetV1TravelLetterRequestsIdResponse = - GetV1TravelLetterRequestsIdResponses[keyof GetV1TravelLetterRequestsIdResponses]; +export type GetV1BenefitOffersCountrySummariesResponse = + GetV1BenefitOffersCountrySummariesResponses[keyof GetV1BenefitOffersCountrySummariesResponses]; -export type PatchV1TravelLetterRequestsId2Data = { - /** - * Travel letter Request - */ - body: UpdateTravelLetterRequestParams; +export type GetV1LeavePoliciesDetailsEmploymentIdData = { + body?: never; path: { /** - * Travel letter Request ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/travel-letter-requests/{id}'; + url: '/api/eor/v1/leave-policies/details/{employment_id}'; }; -export type PatchV1TravelLetterRequestsId2Errors = { +export type GetV1LeavePoliciesDetailsEmploymentIdErrors = { /** * Unauthorized */ @@ -16442,39 +17197,62 @@ export type PatchV1TravelLetterRequestsId2Errors = { 422: UnprocessableEntityResponse; }; -export type PatchV1TravelLetterRequestsId2Error = - PatchV1TravelLetterRequestsId2Errors[keyof PatchV1TravelLetterRequestsId2Errors]; +export type GetV1LeavePoliciesDetailsEmploymentIdError = + GetV1LeavePoliciesDetailsEmploymentIdErrors[keyof GetV1LeavePoliciesDetailsEmploymentIdErrors]; -export type PatchV1TravelLetterRequestsId2Responses = { +export type GetV1LeavePoliciesDetailsEmploymentIdResponses = { /** * Success */ - 200: TravelLetterResponse; + 200: ListLeavePoliciesDetailsResponse; }; -export type PatchV1TravelLetterRequestsId2Response = - PatchV1TravelLetterRequestsId2Responses[keyof PatchV1TravelLetterRequestsId2Responses]; +export type GetV1LeavePoliciesDetailsEmploymentIdResponse = + GetV1LeavePoliciesDetailsEmploymentIdResponses[keyof GetV1LeavePoliciesDetailsEmploymentIdResponses]; -export type PatchV1TravelLetterRequestsIdData = { - /** - * Travel letter Request - */ - body: UpdateTravelLetterRequestParams; - path: { +export type GetV1WorkAuthorizationRequestsData = { + body?: never; + path?: never; + query?: { /** - * Travel letter Request ID + * Filter results on the given status */ - id: string; - }; - query?: never; - url: '/v1/travel-letter-requests/{id}'; -}; - -export type PatchV1TravelLetterRequestsIdErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; + status?: + | 'pending' + | 'cancelled' + | 'declined_by_manager' + | 'declined_by_remote' + | 'approved_by_manager' + | 'approved_by_remote'; + /** + * Filter results on the given employment slug + */ + employment_id?: string; + /** + * Filter results on the given employee name + */ + employee_name?: string; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'submitted_at'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/work-authorization-requests'; +}; + +export type GetV1WorkAuthorizationRequestsErrors = { /** * Not Found */ @@ -16485,215 +17263,251 @@ export type PatchV1TravelLetterRequestsIdErrors = { 422: UnprocessableEntityResponse; }; -export type PatchV1TravelLetterRequestsIdError = - PatchV1TravelLetterRequestsIdErrors[keyof PatchV1TravelLetterRequestsIdErrors]; +export type GetV1WorkAuthorizationRequestsError = + GetV1WorkAuthorizationRequestsErrors[keyof GetV1WorkAuthorizationRequestsErrors]; -export type PatchV1TravelLetterRequestsIdResponses = { +export type GetV1WorkAuthorizationRequestsResponses = { /** * Success */ - 200: TravelLetterResponse; + 200: ListWorkAuthorizationRequestsResponse; }; -export type PatchV1TravelLetterRequestsIdResponse = - PatchV1TravelLetterRequestsIdResponses[keyof PatchV1TravelLetterRequestsIdResponses]; +export type GetV1WorkAuthorizationRequestsResponse = + GetV1WorkAuthorizationRequestsResponses[keyof GetV1WorkAuthorizationRequestsResponses]; -export type GetV1TimeoffBalancesEmploymentIdData = { +export type GetV1EmploymentsEmploymentIdBenefitOffersData = { body?: never; - headers: { + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Unique identifier of the employment */ - Authorization: string; + employment_id: UuidSlug; }; - path: { + query?: { /** - * Employment ID for which to show the time off balance + * Starts fetching records after the given page */ - employment_id: string; + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/timeoff-balances/{employment_id}'; + url: '/api/eor/v1/employments/{employment_id}/benefit-offers'; }; -export type GetV1TimeoffBalancesEmploymentIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmploymentsEmploymentIdBenefitOffersErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * TimeoffBalanceNotFoundResponse + * Forbidden */ - 404: TimeoffBalanceNotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** - * Too many requests + * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1TimeoffBalancesEmploymentIdError = - GetV1TimeoffBalancesEmploymentIdErrors[keyof GetV1TimeoffBalancesEmploymentIdErrors]; +export type GetV1EmploymentsEmploymentIdBenefitOffersError = + GetV1EmploymentsEmploymentIdBenefitOffersErrors[keyof GetV1EmploymentsEmploymentIdBenefitOffersErrors]; -export type GetV1TimeoffBalancesEmploymentIdResponses = { +export type GetV1EmploymentsEmploymentIdBenefitOffersResponses = { /** * Success */ - 200: TimeoffBalanceResponse; + 200: EmploymentsBenefitOffersListBenefitOffers; }; -export type GetV1TimeoffBalancesEmploymentIdResponse = - GetV1TimeoffBalancesEmploymentIdResponses[keyof GetV1TimeoffBalancesEmploymentIdResponses]; +export type GetV1EmploymentsEmploymentIdBenefitOffersResponse = + GetV1EmploymentsEmploymentIdBenefitOffersResponses[keyof GetV1EmploymentsEmploymentIdBenefitOffersResponses]; -export type PutV1EmploymentsEmploymentIdBasicInformationData = { +export type PutV1EmploymentsEmploymentIdBenefitOffersData = { /** - * Employment basic information params + * Upsert employment benefit offers request */ - body?: EmploymentBasicInformationParams; + body: UnifiedEmploymentUpsertBenefitOffersRequest; path: { /** - * Employment ID + * Unique identifier of the employment */ - employment_id: string; + employment_id: UuidSlug; }; - query?: never; - url: '/v1/employments/{employment_id}/basic_information'; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/employments/{employment_id}/benefit-offers'; }; -export type PutV1EmploymentsEmploymentIdBasicInformationErrors = { +export type PutV1EmploymentsEmploymentIdBenefitOffersErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ 403: ForbiddenResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PutV1EmploymentsEmploymentIdBasicInformationError = - PutV1EmploymentsEmploymentIdBasicInformationErrors[keyof PutV1EmploymentsEmploymentIdBasicInformationErrors]; +export type PutV1EmploymentsEmploymentIdBenefitOffersError = + PutV1EmploymentsEmploymentIdBenefitOffersErrors[keyof PutV1EmploymentsEmploymentIdBenefitOffersErrors]; -export type PutV1EmploymentsEmploymentIdBasicInformationResponses = { +export type PutV1EmploymentsEmploymentIdBenefitOffersResponses = { /** * Success */ - 200: EmploymentResponse; + 200: SuccessResponse; }; -export type PutV1EmploymentsEmploymentIdBasicInformationResponse = - PutV1EmploymentsEmploymentIdBasicInformationResponses[keyof PutV1EmploymentsEmploymentIdBasicInformationResponses]; +export type PutV1EmploymentsEmploymentIdBenefitOffersResponse = + PutV1EmploymentsEmploymentIdBenefitOffersResponses[keyof PutV1EmploymentsEmploymentIdBenefitOffersResponses]; -export type GetV1ExpensesCategoriesData = { +export type GetV1EmploymentsData = { body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path?: never; query?: { /** - * The employment ID for which to list categories. Required if neither expense_id nor country_code is provided. + * Company ID */ - employment_id?: string; + company_id?: string; /** - * The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context. + * Filters the results by employments whose login email matches the value */ - expense_id?: string; + email?: string; /** - * Include un-selectable intermediate categories in the response + * Filters the results by employments whose status matches the value. + * Supports multiple values separated by commas. + * Also supports the value `incomplete` to get all employments that are not onboarded yet. + * */ - include_parents?: boolean; + status?: string; /** - * Filter categories by country (ISO 3166-1 alpha-3 code, e.g. "GBR"). Only used when neither employment_id nor expense_id is provided. + * Filters the results by employments whose employment product type matches the value */ - country_code?: string; + employment_type?: string; + /** + * Filters the results by employments whose employment model matches the value. + * Possible values: `global_payroll`, `peo`, `eor` + * + */ + employment_model?: 'global_payroll' | 'peo' | 'eor'; + /** + * Filters the results by the employment's short ID. Returns at most one result. + */ + short_id?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - url: '/v1/expenses/categories'; + url: '/api/eor/v1/employments'; }; -export type GetV1ExpensesCategoriesErrors = { +export type GetV1EmploymentsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetV1ExpensesCategoriesError = - GetV1ExpensesCategoriesErrors[keyof GetV1ExpensesCategoriesErrors]; +export type GetV1EmploymentsError = + GetV1EmploymentsErrors[keyof GetV1EmploymentsErrors]; -export type GetV1ExpensesCategoriesResponses = { +export type GetV1EmploymentsResponses = { /** * Success */ - 200: ListExpenseCategoriesResponse; + 200: ListEmploymentsResponse; }; -export type GetV1ExpensesCategoriesResponse = - GetV1ExpensesCategoriesResponses[keyof GetV1ExpensesCategoriesResponses]; +export type GetV1EmploymentsResponse = + GetV1EmploymentsResponses[keyof GetV1EmploymentsResponses]; -export type PostV1EmployeeTimeoffIdCancelData = { +export type PostV1EmploymentsData = { /** - * CancelTimeoff + * Employment params */ - body: CancelTimeoffParams; - path: { + body?: EmploymentCreateParams; + headers: { /** - * Timeoff ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - id: string; + Authorization: string; }; - query?: never; - url: '/v1/employee/timeoff/{id}/cancel'; + path?: never; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/employments'; }; -export type PostV1EmployeeTimeoffIdCancelErrors = { +export type PostV1EmploymentsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -16704,20 +17518,20 @@ export type PostV1EmployeeTimeoffIdCancelErrors = { 429: TooManyRequestsResponse; }; -export type PostV1EmployeeTimeoffIdCancelError = - PostV1EmployeeTimeoffIdCancelErrors[keyof PostV1EmployeeTimeoffIdCancelErrors]; +export type PostV1EmploymentsError = + PostV1EmploymentsErrors[keyof PostV1EmploymentsErrors]; -export type PostV1EmployeeTimeoffIdCancelResponses = { +export type PostV1EmploymentsResponses = { /** * Success */ - 200: TimeoffResponse; + 200: EmploymentCreationResponse; }; -export type PostV1EmployeeTimeoffIdCancelResponse = - PostV1EmployeeTimeoffIdCancelResponses[keyof PostV1EmployeeTimeoffIdCancelResponses]; +export type PostV1EmploymentsResponse = + PostV1EmploymentsResponses[keyof PostV1EmploymentsResponses]; -export type GetV1CountriesCountryCodeFormData = { +export type GetV1TimeoffIdData = { body?: never; headers: { /** @@ -16730,36 +17544,15 @@ export type GetV1CountriesCountryCodeFormData = { }; path: { /** - * Country code according to ISO 3-digit alphabetic codes - */ - country_code: string; - /** - * Name of the desired form - */ - form: string; - }; - query?: { - /** - * Required for `contract_amendment` form - */ - employment_id?: string; - /** - * FOR TESTING PURPOSES ONLY: Include scheduled benefit groups. - */ - only_for_testing_include_scheduled_benefit_groups?: boolean; - /** - * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. - */ - skip_benefits?: boolean; - /** - * Version of the form schema + * Timeoff ID */ - json_schema_version?: number | 'latest'; + id: string; }; - url: '/v1/countries/{country_code}/{form}'; + query?: never; + url: '/api/eor/v1/timeoff/{id}'; }; -export type GetV1CountriesCountryCodeFormErrors = { +export type GetV1TimeoffIdErrors = { /** * Bad Request */ @@ -16782,32 +17575,48 @@ export type GetV1CountriesCountryCodeFormErrors = { 429: TooManyRequestsResponse; }; -export type GetV1CountriesCountryCodeFormError = - GetV1CountriesCountryCodeFormErrors[keyof GetV1CountriesCountryCodeFormErrors]; +export type GetV1TimeoffIdError = + GetV1TimeoffIdErrors[keyof GetV1TimeoffIdErrors]; -export type GetV1CountriesCountryCodeFormResponses = { +export type GetV1TimeoffIdResponses = { /** * Success */ - 200: CountryFormResponse; + 200: TimeoffResponse; }; -export type GetV1CountriesCountryCodeFormResponse = - GetV1CountriesCountryCodeFormResponses[keyof GetV1CountriesCountryCodeFormResponses]; +export type GetV1TimeoffIdResponse = + GetV1TimeoffIdResponses[keyof GetV1TimeoffIdResponses]; -export type GetV1FilesIdData = { - body?: never; +export type PatchV1TimeoffId2Data = { + /** + * UpdateTimeoff + */ + body: UpdateApprovedTimeoffParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * File ID + * Timeoff ID */ id: string; }; query?: never; - url: '/v1/files/{id}'; + url: '/api/eor/v1/timeoff/{id}'; }; -export type GetV1FilesIdErrors = { +export type PatchV1TimeoffId2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -16820,22 +17629,30 @@ export type GetV1FilesIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1FilesIdError = GetV1FilesIdErrors[keyof GetV1FilesIdErrors]; +export type PatchV1TimeoffId2Error = + PatchV1TimeoffId2Errors[keyof PatchV1TimeoffId2Errors]; -export type GetV1FilesIdResponses = { +export type PatchV1TimeoffId2Responses = { /** * Success */ - 200: DownloadFileResponse; + 200: TimeoffResponse; }; -export type GetV1FilesIdResponse = - GetV1FilesIdResponses[keyof GetV1FilesIdResponses]; +export type PatchV1TimeoffId2Response = + PatchV1TimeoffId2Responses[keyof PatchV1TimeoffId2Responses]; -export type GetV1ContractAmendmentsIdData = { - body?: never; +export type PatchV1TimeoffIdData = { + /** + * UpdateTimeoff + */ + body: UpdateApprovedTimeoffParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -16847,15 +17664,19 @@ export type GetV1ContractAmendmentsIdData = { }; path: { /** - * Contract amendment request ID + * Timeoff ID */ id: string; }; query?: never; - url: '/v1/contract-amendments/{id}'; + url: '/api/eor/v1/timeoff/{id}'; }; -export type GetV1ContractAmendmentsIdErrors = { +export type PatchV1TimeoffIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -16868,42 +17689,41 @@ export type GetV1ContractAmendmentsIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1ContractAmendmentsIdError = - GetV1ContractAmendmentsIdErrors[keyof GetV1ContractAmendmentsIdErrors]; +export type PatchV1TimeoffIdError = + PatchV1TimeoffIdErrors[keyof PatchV1TimeoffIdErrors]; -export type GetV1ContractAmendmentsIdResponses = { +export type PatchV1TimeoffIdResponses = { /** * Success */ - 200: ContractAmendmentResponse; + 200: TimeoffResponse; }; -export type GetV1ContractAmendmentsIdResponse = - GetV1ContractAmendmentsIdResponses[keyof GetV1ContractAmendmentsIdResponses]; +export type PatchV1TimeoffIdResponse = + PatchV1TimeoffIdResponses[keyof PatchV1TimeoffIdResponses]; -export type PutV2EmploymentsEmploymentIdBankAccountDetailsData = { - /** - * Employment bank account details params - */ - body?: EmploymentBankAccountDetailsParams; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: { +export type GetV1IdentityCurrentData = { + body?: never; + headers: { /** - * Version of the bank_account_details form schema + * This endpoint works with any of the access tokens provided. You can use an access + * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. + * */ - bank_account_details_json_schema_version?: number | 'latest'; + Authorization: string; }; - url: '/v2/employments/{employment_id}/bank_account_details'; + path?: never; + query?: never; + url: '/api/eor/v1/identity/current'; }; -export type PutV2EmploymentsEmploymentIdBankAccountDetailsErrors = { +export type GetV1IdentityCurrentErrors = { /** * Bad Request */ @@ -16912,71 +17732,64 @@ export type PutV2EmploymentsEmploymentIdBankAccountDetailsErrors = { * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdBankAccountDetailsError = - PutV2EmploymentsEmploymentIdBankAccountDetailsErrors[keyof PutV2EmploymentsEmploymentIdBankAccountDetailsErrors]; +export type GetV1IdentityCurrentError = + GetV1IdentityCurrentErrors[keyof GetV1IdentityCurrentErrors]; -export type PutV2EmploymentsEmploymentIdBankAccountDetailsResponses = { +export type GetV1IdentityCurrentResponses = { /** * Success */ - 200: EmploymentResponse; + 201: IdentityCurrentResponse; }; -export type PutV2EmploymentsEmploymentIdBankAccountDetailsResponse = - PutV2EmploymentsEmploymentIdBankAccountDetailsResponses[keyof PutV2EmploymentsEmploymentIdBankAccountDetailsResponses]; +export type GetV1IdentityCurrentResponse = + GetV1IdentityCurrentResponses[keyof GetV1IdentityCurrentResponses]; -export type GetV1CompanyManagersData = { +export type GetV1WdGphPayVarianceData = { body?: never; - headers: { + headers?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * The preferred language of the inquiring user in Workday */ - Authorization: string; + accept_language?: string; }; path?: never; - query?: { + query: { /** - * A Company ID to filter the results (only applicable for Integration Partners). + * The pay group ID for identifying the pay group at the vendor system */ - company_id?: string; + payGroupExternalId: string; /** - * Starts fetching records after the given page + * The run type id provided in the paySummary API */ - page?: number; + runTypeId: string; /** - * Change the amount of records returned per page, defaults to 20, limited to 100 + * The cycle type id, defaults to the main run if not provided */ - page_size?: number; + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; }; - url: '/v1/company-managers'; + url: '/api/eor/v1/wd/gph/payVariance'; }; -export type GetV1CompanyManagersErrors = { +export type GetV1WdGphPayVarianceErrors = { /** * Bad Request */ @@ -16989,61 +17802,43 @@ export type GetV1CompanyManagersErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetV1CompanyManagersError = - GetV1CompanyManagersErrors[keyof GetV1CompanyManagersErrors]; +export type GetV1WdGphPayVarianceError = + GetV1WdGphPayVarianceErrors[keyof GetV1WdGphPayVarianceErrors]; -export type GetV1CompanyManagersResponses = { +export type GetV1WdGphPayVarianceResponses = { /** * Success */ - 200: CompanyManagersResponse; + 200: PayVarianceResponse; }; -export type GetV1CompanyManagersResponse = - GetV1CompanyManagersResponses[keyof GetV1CompanyManagersResponses]; +export type GetV1WdGphPayVarianceResponse = + GetV1WdGphPayVarianceResponses[keyof GetV1WdGphPayVarianceResponses]; -export type PostV1CompanyManagersData = { - /** - * Company Manager params - */ - body?: CompanyManagerParams; - headers: { +export type GetV1PayrollCalendarsCycleData = { + body?: never; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * The cycle for which to list the payroll calendars. Format: YYYY-MM */ - Authorization: string; + cycle: string; }; - path?: never; query?: { /** - * Complementary action(s) to perform when creating a company manager: - * - * - `no_invite` skips the email invitation step - * + * Starts fetching records after the given page */ - actions?: string; + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - url: '/v1/company-managers'; + url: '/api/eor/v1/payroll-calendars/{cycle}'; }; -export type PostV1CompanyManagersErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1PayrollCalendarsCycleErrors = { /** * Unauthorized */ @@ -17056,60 +17851,84 @@ export type PostV1CompanyManagersErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PostV1CompanyManagersError = - PostV1CompanyManagersErrors[keyof PostV1CompanyManagersErrors]; +export type GetV1PayrollCalendarsCycleError = + GetV1PayrollCalendarsCycleErrors[keyof GetV1PayrollCalendarsCycleErrors]; -export type PostV1CompanyManagersResponses = { +export type GetV1PayrollCalendarsCycleResponses = { /** * Success */ - 201: CompanyManagerData; + 200: PayrollCalendarsResponse; }; -export type PostV1CompanyManagersResponse = - PostV1CompanyManagersResponses[keyof PostV1CompanyManagersResponses]; +export type GetV1PayrollCalendarsCycleResponse = + GetV1PayrollCalendarsCycleResponses[keyof GetV1PayrollCalendarsCycleResponses]; -export type GetV1CostCalculatorCountriesData = { - body?: never; - path?: never; - query?: { +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/terminate-cor-employment'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors = + { /** - * If the premium benefits should be included in the response + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentError = + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors[keyof PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses = + { + /** + * Success */ - include_premium_benefits?: boolean; + 200: SuccessResponse; }; - url: '/v1/cost-calculator/countries'; -}; -export type GetV1CostCalculatorCountriesResponses = { +export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponse = + PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses[keyof PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses]; + +export type PostV1TimesheetsTimesheetIdSendBackData = { /** - * Success + * SendBackTimesheetParams */ - 200: CostCalculatorListCountryResponse; -}; - -export type GetV1CostCalculatorCountriesResponse = - GetV1CostCalculatorCountriesResponses[keyof GetV1CostCalculatorCountriesResponses]; - -export type PostV1IdentityVerificationEmploymentIdDeclineData = { - body?: never; + body?: SendBackTimesheetParams; path: { /** - * Employment ID + * Timesheet ID */ - employment_id: string; + timesheet_id: string; }; query?: never; - url: '/v1/identity-verification/{employment_id}/decline'; + url: '/api/eor/v1/timesheets/{timesheet_id}/send-back'; }; -export type PostV1IdentityVerificationEmploymentIdDeclineErrors = { +export type PostV1TimesheetsTimesheetIdSendBackErrors = { /** * Unauthorized */ @@ -17124,68 +17943,78 @@ export type PostV1IdentityVerificationEmploymentIdDeclineErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1IdentityVerificationEmploymentIdDeclineError = - PostV1IdentityVerificationEmploymentIdDeclineErrors[keyof PostV1IdentityVerificationEmploymentIdDeclineErrors]; +export type PostV1TimesheetsTimesheetIdSendBackError = + PostV1TimesheetsTimesheetIdSendBackErrors[keyof PostV1TimesheetsTimesheetIdSendBackErrors]; -export type PostV1IdentityVerificationEmploymentIdDeclineResponses = { +export type PostV1TimesheetsTimesheetIdSendBackResponses = { /** * Success */ - 200: SuccessResponse; + 200: SentBackTimesheetResponse; }; -export type PostV1IdentityVerificationEmploymentIdDeclineResponse = - PostV1IdentityVerificationEmploymentIdDeclineResponses[keyof PostV1IdentityVerificationEmploymentIdDeclineResponses]; +export type PostV1TimesheetsTimesheetIdSendBackResponse = + PostV1TimesheetsTimesheetIdSendBackResponses[keyof PostV1TimesheetsTimesheetIdSendBackResponses]; -export type GetV1CountriesCountryCodeEngagementAgreementDetailsData = { - body?: never; - path: { +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignData = + { /** - * Country code according to ISO 3-digit alphabetic codes + * SignContractDocument */ - country_code: string; + body: SignContractDocument; + path: { + /** + * Employment ID + */ + employment_id: string; + /** + * Pre-onboarding document ID + */ + id: string; + }; + query?: never; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign'; }; - query?: never; - url: '/v1/countries/{country_code}/engagement-agreement-details'; -}; -export type GetV1CountriesCountryCodeEngagementAgreementDetailsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; -}; +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; -export type GetV1CountriesCountryCodeEngagementAgreementDetailsError = - GetV1CountriesCountryCodeEngagementAgreementDetailsErrors[keyof GetV1CountriesCountryCodeEngagementAgreementDetailsErrors]; +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignError = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors]; -export type GetV1CountriesCountryCodeEngagementAgreementDetailsResponses = { - /** - * Success - */ - 200: EngagementAgreementDetailsResponse; -}; +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses = + { + /** + * Success + */ + 200: SuccessResponse; + }; -export type GetV1CountriesCountryCodeEngagementAgreementDetailsResponse = - GetV1CountriesCountryCodeEngagementAgreementDetailsResponses[keyof GetV1CountriesCountryCodeEngagementAgreementDetailsResponses]; +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponse = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignResponses]; -export type GetV1BillingDocumentsData = { +export type GetV1BenefitRenewalRequestsData = { body?: never; headers: { /** @@ -17198,10 +18027,6 @@ export type GetV1BillingDocumentsData = { }; path?: never; query?: { - /** - * The month for the billing documents (in ISO-8601 format) - */ - period?: string; /** * Starts fetching records after the given page */ @@ -17211,10 +18036,14 @@ export type GetV1BillingDocumentsData = { */ page_size?: number; }; - url: '/v1/billing-documents'; + url: '/api/eor/v1/benefit-renewal-requests'; }; -export type GetV1BillingDocumentsErrors = { +export type GetV1BenefitRenewalRequestsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -17227,22 +18056,90 @@ export type GetV1BillingDocumentsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1BillingDocumentsError = - GetV1BillingDocumentsErrors[keyof GetV1BillingDocumentsErrors]; +export type GetV1BenefitRenewalRequestsError = + GetV1BenefitRenewalRequestsErrors[keyof GetV1BenefitRenewalRequestsErrors]; -export type GetV1BillingDocumentsResponses = { +export type GetV1BenefitRenewalRequestsResponses = { /** * Success */ - 200: BillingDocumentsResponse; + 200: BenefitRenewalRequestsListBenefitRenewalRequestResponse; }; -export type GetV1BillingDocumentsResponse = - GetV1BillingDocumentsResponses[keyof GetV1BillingDocumentsResponses]; +export type GetV1BenefitRenewalRequestsResponse = + GetV1BenefitRenewalRequestsResponses[keyof GetV1BenefitRenewalRequestsResponses]; -export type DeleteV1WebhookCallbacksIdData = { +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData = + { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Company ID + */ + company_id: string; + /** + * Legal Entity ID to set as the new default + */ + legal_entity_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}'; + }; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; + }; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdError = + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors[keyof PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors]; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses = + { + /** + * Success + */ + 200: SuccessResponse; + }; + +export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponse = + PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses[keyof PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses]; + +export type GetV1EmploymentContractsData = { body?: never; headers: { /** @@ -17253,64 +18150,29 @@ export type DeleteV1WebhookCallbacksIdData = { */ Authorization: string; }; - path: { - /** - * Webhook Callback ID - */ - id: string; - }; - query?: never; - url: '/v1/webhook-callbacks/{id}'; -}; - -export type DeleteV1WebhookCallbacksIdErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; -}; - -export type DeleteV1WebhookCallbacksIdError = - DeleteV1WebhookCallbacksIdErrors[keyof DeleteV1WebhookCallbacksIdErrors]; - -export type DeleteV1WebhookCallbacksIdResponses = { - /** - * Success - */ - 200: SuccessResponse; -}; - -export type DeleteV1WebhookCallbacksIdResponse = - DeleteV1WebhookCallbacksIdResponses[keyof DeleteV1WebhookCallbacksIdResponses]; - -export type PatchV1WebhookCallbacksIdData = { - /** - * WebhookCallback - */ - body?: UpdateWebhookCallbackParams; - path: { + path?: never; + query: { /** - * Webhook Callback ID + * Employment ID */ - id: string; + employment_id: string; + /** + * Only Active + */ + only_active?: boolean; }; - query?: never; - url: '/v1/webhook-callbacks/{id}'; + url: '/api/eor/v1/employment-contracts'; }; -export type PatchV1WebhookCallbacksIdErrors = { +export type GetV1EmploymentContractsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -17321,157 +18183,151 @@ export type PatchV1WebhookCallbacksIdErrors = { 422: UnprocessableEntityResponse; }; -export type PatchV1WebhookCallbacksIdError = - PatchV1WebhookCallbacksIdErrors[keyof PatchV1WebhookCallbacksIdErrors]; +export type GetV1EmploymentContractsError = + GetV1EmploymentContractsErrors[keyof GetV1EmploymentContractsErrors]; -export type PatchV1WebhookCallbacksIdResponses = { +export type GetV1EmploymentContractsResponses = { /** * Success */ - 200: WebhookCallbackResponse; + 200: ListEmploymentContractResponse; }; -export type PatchV1WebhookCallbacksIdResponse = - PatchV1WebhookCallbacksIdResponses[keyof PatchV1WebhookCallbacksIdResponses]; +export type GetV1EmploymentContractsResponse = + GetV1EmploymentContractsResponses[keyof GetV1EmploymentContractsResponses]; -export type GetV1EmployeeTimesheetsData = { - body?: never; - path?: never; - query?: { +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData = + { + body?: never; + path: { + /** + * Contract amendment request ID + */ + contract_amendment_request_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel'; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors = + { /** - * Starts fetching records after the given page + * Bad Request */ - page?: number; + 400: BadRequestResponse; /** - * Number of items per page + * Unauthorized */ - page_size?: number; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; - url: '/v1/employee/timesheets'; -}; - -export type GetV1EmployeeTimesheetsErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; -}; -export type GetV1EmployeeTimesheetsError = - GetV1EmployeeTimesheetsErrors[keyof GetV1EmployeeTimesheetsErrors]; +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelError = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors]; -export type GetV1EmployeeTimesheetsResponses = { - /** - * Success - */ - 200: SuccessResponse; -}; +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses = + { + /** + * Success + */ + 200: SuccessResponse; + }; -export type GetV1EmployeeTimesheetsResponse = - GetV1EmployeeTimesheetsResponses[keyof GetV1EmployeeTimesheetsResponses]; +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponse = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses]; -export type PutV1EmploymentsEmploymentIdPersonalDetailsData = { - /** - * Employment personal details params - */ - body?: EmploymentPersonalDetailsParams; +export type GetV1PayslipsPayslipIdPdfData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Employment ID + * Payslip ID */ - employment_id: string; + payslip_id: string; }; query?: never; - url: '/v1/employments/{employment_id}/personal_details'; + url: '/api/eor/v1/payslips/{payslip_id}/pdf'; }; -export type PutV1EmploymentsEmploymentIdPersonalDetailsErrors = { +export type GetV1PayslipsPayslipIdPdfErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PutV1EmploymentsEmploymentIdPersonalDetailsError = - PutV1EmploymentsEmploymentIdPersonalDetailsErrors[keyof PutV1EmploymentsEmploymentIdPersonalDetailsErrors]; +export type GetV1PayslipsPayslipIdPdfError = + GetV1PayslipsPayslipIdPdfErrors[keyof GetV1PayslipsPayslipIdPdfErrors]; -export type PutV1EmploymentsEmploymentIdPersonalDetailsResponses = { +export type GetV1PayslipsPayslipIdPdfResponses = { /** * Success */ - 200: EmploymentResponse; + 200: PayslipDownloadResponse; }; -export type PutV1EmploymentsEmploymentIdPersonalDetailsResponse = - PutV1EmploymentsEmploymentIdPersonalDetailsResponses[keyof PutV1EmploymentsEmploymentIdPersonalDetailsResponses]; +export type GetV1PayslipsPayslipIdPdfResponse = + GetV1PayslipsPayslipIdPdfResponses[keyof GetV1PayslipsPayslipIdPdfResponses]; -export type GetV1TravelLetterRequestsData = { - body?: never; - path?: never; - query?: { - /** - * Filter results on the given status - */ - status?: - | 'pending' - | 'cancelled' - | 'declined_by_manager' - | 'declined_by_remote' - | 'approved_by_manager' - | 'approved_by_remote'; - /** - * Filter results on the given employment slug - */ - employment_id?: string; - /** - * Filter results on the given employee name - */ - employee_name?: string; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - /** - * Field to sort by - */ - sort_by?: 'submitted_at'; - /** - * Starts fetching records after the given page - */ - page?: number; +export type PostV1TimeoffTimeoffIdApproveData = { + /** + * ApproveTimeoff + */ + body: ApproveTimeoffParams; + path: { /** - * Number of items per page + * Time Off ID */ - page_size?: number; + timeoff_id: string; }; - url: '/v1/travel-letter-requests'; + query?: never; + url: '/api/eor/v1/timeoff/{timeoff_id}/approve'; }; -export type GetV1TravelLetterRequestsErrors = { +export type PostV1TimeoffTimeoffIdApproveErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -17480,28 +18336,32 @@ export type GetV1TravelLetterRequestsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1TravelLetterRequestsError = - GetV1TravelLetterRequestsErrors[keyof GetV1TravelLetterRequestsErrors]; +export type PostV1TimeoffTimeoffIdApproveError = + PostV1TimeoffTimeoffIdApproveErrors[keyof PostV1TimeoffTimeoffIdApproveErrors]; -export type GetV1TravelLetterRequestsResponses = { +export type PostV1TimeoffTimeoffIdApproveResponses = { /** * Success */ - 200: ListTravelLettersResponse; + 200: TimeoffResponse; }; -export type GetV1TravelLetterRequestsResponse = - GetV1TravelLetterRequestsResponses[keyof GetV1TravelLetterRequestsResponses]; +export type PostV1TimeoffTimeoffIdApproveResponse = + PostV1TimeoffTimeoffIdApproveResponses[keyof PostV1TimeoffTimeoffIdApproveResponses]; -export type GetV1BenefitRenewalRequestsData = { +export type GetV1CompaniesData = { body?: never; headers: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. * - * The refresh token needs to have been obtained through the Authorization Code flow. + * The refresh token needs to have been obtained through the Client Credentials flow. * */ Authorization: string; @@ -17509,22 +18369,14 @@ export type GetV1BenefitRenewalRequestsData = { path?: never; query?: { /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * External ID */ - page_size?: number; + external_id?: string; }; - url: '/v1/benefit-renewal-requests'; + url: '/api/eor/v1/companies'; }; -export type GetV1BenefitRenewalRequestsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CompaniesErrors = { /** * Unauthorized */ @@ -17537,85 +18389,118 @@ export type GetV1BenefitRenewalRequestsErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetV1BenefitRenewalRequestsError = - GetV1BenefitRenewalRequestsErrors[keyof GetV1BenefitRenewalRequestsErrors]; +export type GetV1CompaniesError = + GetV1CompaniesErrors[keyof GetV1CompaniesErrors]; -export type GetV1BenefitRenewalRequestsResponses = { +export type GetV1CompaniesResponses = { /** * Success */ - 200: BenefitRenewalRequestsListBenefitRenewalRequestResponse; + 200: CompaniesResponse; }; -export type GetV1BenefitRenewalRequestsResponse = - GetV1BenefitRenewalRequestsResponses[keyof GetV1BenefitRenewalRequestsResponses]; +export type GetV1CompaniesResponse = + GetV1CompaniesResponses[keyof GetV1CompaniesResponses]; -export type PostV1WebhookCallbacksData = { +export type PostV1CompaniesData = { /** - * WebhookCallback + * Create Company params */ - body?: CreateWebhookCallbackParams; + body?: CreateCompanyParams; headers: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. * - * The refresh token needs to have been obtained through the Authorization Code flow. + * The refresh token needs to have been obtained through the Client Credentials flow. * */ Authorization: string; }; path?: never; - query?: never; - url: '/v1/webhook-callbacks'; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + /** + * Complementary action(s) to perform when creating a company: + * + * - `get_oauth_access_tokens` returns the user's access and refresh tokens + * - `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only) + * + * If `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send) + * + */ + action?: string; + /** + * Whether the request should be performed async + * + */ + async?: boolean; + /** + * Scope of the access token + * + */ + scope?: string; + }; + url: '/api/eor/v1/companies'; }; -export type PostV1WebhookCallbacksErrors = { +export type PostV1CompaniesErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: CompanyCreationConflictErrorResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostV1WebhookCallbacksError = - PostV1WebhookCallbacksErrors[keyof PostV1WebhookCallbacksErrors]; +export type PostV1CompaniesError = + PostV1CompaniesErrors[keyof PostV1CompaniesErrors]; -export type PostV1WebhookCallbacksResponses = { +export type PostV1CompaniesResponses = { /** - * Success + * Created */ - 200: WebhookCallbackResponse; + 201: CompanyCreationResponse; }; -export type PostV1WebhookCallbacksResponse = - PostV1WebhookCallbacksResponses[keyof PostV1WebhookCallbacksResponses]; +export type PostV1CompaniesResponse = + PostV1CompaniesResponses[keyof PostV1CompaniesResponses]; -export type PostV1TimesheetsTimesheetIdApproveData = { +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesData = { body?: never; path: { /** - * Timesheet ID + * Employment ID */ - timesheet_id: string; + employment_id: string; }; query?: never; - url: '/v1/timesheets/{timesheet_id}/approve'; + url: '/api/eor/v1/employments/{employment_id}/company-structure-nodes'; }; -export type PostV1TimesheetsTimesheetIdApproveErrors = { +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors = { /** * Unauthorized */ @@ -17630,78 +18515,75 @@ export type PostV1TimesheetsTimesheetIdApproveErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1TimesheetsTimesheetIdApproveError = - PostV1TimesheetsTimesheetIdApproveErrors[keyof PostV1TimesheetsTimesheetIdApproveErrors]; +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesError = + GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors[keyof GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors]; -export type PostV1TimesheetsTimesheetIdApproveResponses = { +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses = { /** * Success */ - 200: MinimalTimesheetResponse; + 200: CompanyStructureNodesResponse; }; -export type PostV1TimesheetsTimesheetIdApproveResponse = - PostV1TimesheetsTimesheetIdApproveResponses[keyof PostV1TimesheetsTimesheetIdApproveResponses]; +export type GetV1EmploymentsEmploymentIdCompanyStructureNodesResponse = + GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses[keyof GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses]; -export type GetV1PayslipsIdData = { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; +export type PatchV2EmploymentsEmploymentId2Data = { + /** + * Employment params + */ + body?: EmploymentV2UpdateParams; path: { /** - * Payslip ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/payslips/{id}'; + url: '/api/eor/v2/employments/{employment_id}'; }; -export type GetV1PayslipsIdErrors = { +export type PatchV2EmploymentsEmploymentId2Errors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetV1PayslipsIdError = - GetV1PayslipsIdErrors[keyof GetV1PayslipsIdErrors]; +export type PatchV2EmploymentsEmploymentId2Error = + PatchV2EmploymentsEmploymentId2Errors[keyof PatchV2EmploymentsEmploymentId2Errors]; -export type GetV1PayslipsIdResponses = { +export type PatchV2EmploymentsEmploymentId2Responses = { /** * Success */ - 200: PayslipResponse; + 200: EmploymentResponse; }; -export type GetV1PayslipsIdResponse = - GetV1PayslipsIdResponses[keyof GetV1PayslipsIdResponses]; +export type PatchV2EmploymentsEmploymentId2Response = + PatchV2EmploymentsEmploymentId2Responses[keyof PatchV2EmploymentsEmploymentId2Responses]; -export type GetV1LeavePoliciesSummaryEmploymentIdData = { - body?: never; +export type PatchV2EmploymentsEmploymentIdData = { + /** + * Employment params + */ + body?: EmploymentV2UpdateParams; path: { /** * Employment ID @@ -17709,106 +18591,60 @@ export type GetV1LeavePoliciesSummaryEmploymentIdData = { employment_id: string; }; query?: never; - url: '/v1/leave-policies/summary/{employment_id}'; + url: '/api/eor/v2/employments/{employment_id}'; }; -export type GetV1LeavePoliciesSummaryEmploymentIdErrors = { +export type PatchV2EmploymentsEmploymentIdErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1LeavePoliciesSummaryEmploymentIdError = - GetV1LeavePoliciesSummaryEmploymentIdErrors[keyof GetV1LeavePoliciesSummaryEmploymentIdErrors]; +export type PatchV2EmploymentsEmploymentIdError = + PatchV2EmploymentsEmploymentIdErrors[keyof PatchV2EmploymentsEmploymentIdErrors]; -export type GetV1LeavePoliciesSummaryEmploymentIdResponses = { +export type PatchV2EmploymentsEmploymentIdResponses = { /** * Success */ - 200: ListLeavePoliciesSummaryResponse; + 200: EmploymentResponse; }; -export type GetV1LeavePoliciesSummaryEmploymentIdResponse = - GetV1LeavePoliciesSummaryEmploymentIdResponses[keyof GetV1LeavePoliciesSummaryEmploymentIdResponses]; +export type PatchV2EmploymentsEmploymentIdResponse = + PatchV2EmploymentsEmploymentIdResponses[keyof PatchV2EmploymentsEmploymentIdResponses]; -export type GetV1EmployeeExpenseCategoriesData = { - body?: never; +export type PostV1ProbationCompletionLetterData = { + /** + * Work Authorization Request + */ + body: CreateProbationCompletionLetterParams; path?: never; - query?: { - /** - * Include parent (non-selectable) categories in addition to selectable leaves - */ - include_parents?: boolean; - /** - * Expense ID (slug) whose category should be included in the result, even if it is not selectable by default - */ - expense_id?: string; - }; - url: '/v1/employee/expense-categories'; + query?: never; + url: '/api/eor/v1/probation-completion-letter'; }; -export type GetV1EmployeeExpenseCategoriesErrors = { +export type PostV1ProbationCompletionLetterErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; -}; - -export type GetV1EmployeeExpenseCategoriesError = - GetV1EmployeeExpenseCategoriesErrors[keyof GetV1EmployeeExpenseCategoriesErrors]; - -export type GetV1EmployeeExpenseCategoriesResponses = { - /** - * Success - */ - 200: ListExpenseCategoriesResponse; -}; - -export type GetV1EmployeeExpenseCategoriesResponse = - GetV1EmployeeExpenseCategoriesResponses[keyof GetV1EmployeeExpenseCategoriesResponses]; - -export type GetV1CompanyDepartmentsData = { - body?: never; - path?: never; - query: { - /** - * Company ID - */ - company_id: string; - /** - * Paginate option. Default: true. When true, paginates response; otherwise, does not. - */ - paginate?: boolean; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/company-departments'; -}; - -export type GetV1CompanyDepartmentsErrors = { /** * Not Found */ @@ -17819,30 +18655,30 @@ export type GetV1CompanyDepartmentsErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1CompanyDepartmentsError = - GetV1CompanyDepartmentsErrors[keyof GetV1CompanyDepartmentsErrors]; +export type PostV1ProbationCompletionLetterError = + PostV1ProbationCompletionLetterErrors[keyof PostV1ProbationCompletionLetterErrors]; -export type GetV1CompanyDepartmentsResponses = { +export type PostV1ProbationCompletionLetterResponses = { /** * Success */ - 200: ListCompanyDepartmentsPaginatedResponse; + 200: ProbationCompletionLetterResponse; }; -export type GetV1CompanyDepartmentsResponse = - GetV1CompanyDepartmentsResponses[keyof GetV1CompanyDepartmentsResponses]; +export type PostV1ProbationCompletionLetterResponse = + PostV1ProbationCompletionLetterResponses[keyof PostV1ProbationCompletionLetterResponses]; -export type PostV1CompanyDepartmentsData = { +export type PostV1CostCalculatorEstimationPdfData = { /** - * Create Company Department request params + * Estimate params */ - body: CreateCompanyDepartmentParams; + body?: CostCalculatorEstimateParams; path?: never; query?: never; - url: '/v1/company-departments'; + url: '/api/eor/v1/cost-calculator/estimation-pdf'; }; -export type PostV1CompanyDepartmentsErrors = { +export type PostV1CostCalculatorEstimationPdfErrors = { /** * Not Found */ @@ -17853,147 +18689,120 @@ export type PostV1CompanyDepartmentsErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1CompanyDepartmentsError = - PostV1CompanyDepartmentsErrors[keyof PostV1CompanyDepartmentsErrors]; +export type PostV1CostCalculatorEstimationPdfError = + PostV1CostCalculatorEstimationPdfErrors[keyof PostV1CostCalculatorEstimationPdfErrors]; -export type PostV1CompanyDepartmentsResponses = { +export type PostV1CostCalculatorEstimationPdfResponses = { /** - * Created + * Success */ - 201: CompanyDepartmentCreatedResponse; + 200: CostCalculatorEstimatePdfResponse; }; -export type PostV1CompanyDepartmentsResponse = - PostV1CompanyDepartmentsResponses[keyof PostV1CompanyDepartmentsResponses]; +export type PostV1CostCalculatorEstimationPdfResponse = + PostV1CostCalculatorEstimationPdfResponses[keyof PostV1CostCalculatorEstimationPdfResponses]; -export type PostV1TimeoffTimeoffIdCancelRequestDeclineData = { +export type PostAuthOauth2Token2Data = { /** - * Timeoff + * OAuth2Token */ - body: DeclineTimeoffParams; - path: { - /** - * Time Off ID - */ - timeoff_id: string; - }; + body?: OAuth2TokenParams; + path?: never; query?: never; - url: '/v1/timeoff/{timeoff_id}/cancel-request/decline'; + url: '/api/eor/auth/oauth2/token'; }; -export type PostV1TimeoffTimeoffIdCancelRequestDeclineErrors = { +export type PostAuthOauth2Token2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PostV1TimeoffTimeoffIdCancelRequestDeclineError = - PostV1TimeoffTimeoffIdCancelRequestDeclineErrors[keyof PostV1TimeoffTimeoffIdCancelRequestDeclineErrors]; +export type PostAuthOauth2Token2Error = + PostAuthOauth2Token2Errors[keyof PostAuthOauth2Token2Errors]; -export type PostV1TimeoffTimeoffIdCancelRequestDeclineResponses = { +export type PostAuthOauth2Token2Responses = { /** * Success */ - 200: SuccessResponse; + 200: OAuth2Tokens; }; -export type PostV1TimeoffTimeoffIdCancelRequestDeclineResponse = - PostV1TimeoffTimeoffIdCancelRequestDeclineResponses[keyof PostV1TimeoffTimeoffIdCancelRequestDeclineResponses]; +export type PostAuthOauth2Token2Response = + PostAuthOauth2Token2Responses[keyof PostAuthOauth2Token2Responses]; -export type PutV2EmploymentsEmploymentIdAdministrativeDetailsData = { - /** - * Employment administrative details params - */ - body?: EmploymentAdministrativeDetailsParams; +export type GetV1EmployeeDocumentsIdData = { + body?: never; path: { /** - * Employment ID + * Document ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v2/employments/{employment_id}/administrative_details'; + url: '/api/eor/v1/employee/documents/{id}'; }; -export type PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmployeeDocumentsIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdAdministrativeDetailsError = - PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors[keyof PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors]; +export type GetV1EmployeeDocumentsIdError = + GetV1EmployeeDocumentsIdErrors[keyof GetV1EmployeeDocumentsIdErrors]; -export type PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses = { +export type GetV1EmployeeDocumentsIdResponses = { /** * Success */ - 200: EmploymentResponse; + 200: DownloadDocumentResponse; }; -export type PutV2EmploymentsEmploymentIdAdministrativeDetailsResponse = - PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses[keyof PutV2EmploymentsEmploymentIdAdministrativeDetailsResponses]; +export type GetV1EmployeeDocumentsIdResponse = + GetV1EmployeeDocumentsIdResponses[keyof GetV1EmployeeDocumentsIdResponses]; -export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaData = { - body?: never; - path: { - /** - * Unique identifier of the employment - */ - employment_id: UuidSlug; - }; - query?: { - /** - * Version of the form schema - */ - json_schema_version?: number | 'latest'; - }; - url: '/v1/employments/{employment_id}/benefit-offers/schema'; +export type PostV1WebhookEventsReplayData = { + /** + * WebhookEvent + */ + body: ReplayWebhookEventsParams; + path?: never; + query?: never; + url: '/api/eor/v1/webhook-events/replay'; }; -export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors = { +export type PostV1WebhookEventsReplayErrors = { /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -18004,78 +18813,74 @@ export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaError = - GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors[keyof GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors]; +export type PostV1WebhookEventsReplayError = + PostV1WebhookEventsReplayErrors[keyof PostV1WebhookEventsReplayErrors]; -export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses = { +export type PostV1WebhookEventsReplayResponses = { /** * Success */ - 200: UnifiedEmploymentsBenefitOffersJsonSchemaResponse; + 200: SuccessResponse; }; -export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponse = - GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses[keyof GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses]; +export type PostV1WebhookEventsReplayResponse = + PostV1WebhookEventsReplayResponses[keyof PostV1WebhookEventsReplayResponses]; -export type PostV1ContractorsEligibilityQuestionnaireData = { +export type PostV1SandboxWebhookCallbacksTriggerData = { /** - * Eligibility questionnaire submission + * Webhook Trigger Params */ - body: SubmitEligibilityQuestionnaireRequest; + body?: WebhookTriggerParams; path?: never; - query?: { - /** - * Version of the form schema - */ - json_schema_version?: number | 'latest'; - }; - url: '/v1/contractors/eligibility-questionnaire'; + query?: never; + url: '/api/eor/v1/sandbox/webhook-callbacks/trigger'; }; -export type PostV1ContractorsEligibilityQuestionnaireErrors = { +export type PostV1SandboxWebhookCallbacksTriggerErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict + * Not Found */ - 409: ConflictErrorResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type PostV1ContractorsEligibilityQuestionnaireError = - PostV1ContractorsEligibilityQuestionnaireErrors[keyof PostV1ContractorsEligibilityQuestionnaireErrors]; +export type PostV1SandboxWebhookCallbacksTriggerError = + PostV1SandboxWebhookCallbacksTriggerErrors[keyof PostV1SandboxWebhookCallbacksTriggerErrors]; -export type PostV1ContractorsEligibilityQuestionnaireResponses = { +export type PostV1SandboxWebhookCallbacksTriggerResponses = { /** - * Questionnaire submitted successfully + * Success */ - 201: EligibilityQuestionnaireResponse; + 200: SuccessResponse; }; -export type PostV1ContractorsEligibilityQuestionnaireResponse = - PostV1ContractorsEligibilityQuestionnaireResponses[keyof PostV1ContractorsEligibilityQuestionnaireResponses]; +export type PostV1SandboxWebhookCallbacksTriggerResponse = + PostV1SandboxWebhookCallbacksTriggerResponses[keyof PostV1SandboxWebhookCallbacksTriggerResponses]; -export type GetV1EmployeePersonalInformationData = { +export type GetV1BulkEmploymentJobsJobIdData = { body?: never; - path?: never; + path: { + /** + * Bulk employment job id + */ + job_id: string; + }; query?: never; - url: '/v1/employee/personal-information'; + url: '/api/eor/v1/bulk-employment-jobs/{job_id}'; }; -export type GetV1EmployeePersonalInformationErrors = { +export type GetV1BulkEmploymentJobsJobIdErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** * Forbidden */ @@ -18084,37 +18889,34 @@ export type GetV1EmployeePersonalInformationErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmployeePersonalInformationError = - GetV1EmployeePersonalInformationErrors[keyof GetV1EmployeePersonalInformationErrors]; +export type GetV1BulkEmploymentJobsJobIdError = + GetV1BulkEmploymentJobsJobIdErrors[keyof GetV1BulkEmploymentJobsJobIdErrors]; -export type GetV1EmployeePersonalInformationResponses = { +export type GetV1BulkEmploymentJobsJobIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: BulkEmploymentImportJobResponse; }; -export type GetV1EmployeePersonalInformationResponse = - GetV1EmployeePersonalInformationResponses[keyof GetV1EmployeePersonalInformationResponses]; +export type GetV1BulkEmploymentJobsJobIdResponse = + GetV1BulkEmploymentJobsJobIdResponses[keyof GetV1BulkEmploymentJobsJobIdResponses]; -export type GetV1TimesheetsData = { +export type GetV1BulkEmploymentJobsJobIdRowsData = { body?: never; - path?: never; - query?: { - /** - * Filter timesheets by their status - */ - status?: TimesheetStatus; - /** - * Sort order - */ - order?: 'asc' | 'desc'; + path: { /** - * Field to sort by + * Bulk employment job id */ - sort_by?: 'submitted_at'; + job_id: string; + }; + query?: { /** * Starts fetching records after the given page */ @@ -18124,47 +18926,82 @@ export type GetV1TimesheetsData = { */ page_size?: number; }; - url: '/v1/timesheets'; + url: '/api/eor/v1/bulk-employment-jobs/{job_id}/rows'; }; -export type GetV1TimesheetsErrors = { +export type GetV1BulkEmploymentJobsJobIdRowsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; + +export type GetV1BulkEmploymentJobsJobIdRowsError = + GetV1BulkEmploymentJobsJobIdRowsErrors[keyof GetV1BulkEmploymentJobsJobIdRowsErrors]; + +export type GetV1BulkEmploymentJobsJobIdRowsResponses = { + /** + * Success + */ + 200: ImportJobRowsResponse; +}; + +export type GetV1BulkEmploymentJobsJobIdRowsResponse = + GetV1BulkEmploymentJobsJobIdRowsResponses[keyof GetV1BulkEmploymentJobsJobIdRowsResponses]; + +export type PostV1MagicLinkData = { + /** + * Magic links generator body + */ + body: MagicLinkParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path?: never; + query?: never; + url: '/api/eor/v1/magic-link'; +}; + +export type PostV1MagicLinkErrors = { /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type GetV1TimesheetsError = - GetV1TimesheetsErrors[keyof GetV1TimesheetsErrors]; +export type PostV1MagicLinkError = + PostV1MagicLinkErrors[keyof PostV1MagicLinkErrors]; -export type GetV1TimesheetsResponses = { +export type PostV1MagicLinkResponses = { /** * Success */ - 200: ListTimesheetsResponse; + 200: MagicLinkResponse; }; -export type GetV1TimesheetsResponse = - GetV1TimesheetsResponses[keyof GetV1TimesheetsResponses]; +export type PostV1MagicLinkResponse = + PostV1MagicLinkResponses[keyof PostV1MagicLinkResponses]; -export type PostV1SandboxCompaniesCompanyIdLegalEntitiesData = { - /** - * Create legal entity params - */ - body?: { - /** - * ISO 3166-1 alpha-3 country code - */ - country_code: string; - }; +export type GetV1CompaniesCompanyIdData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -18181,10 +19018,10 @@ export type PostV1SandboxCompaniesCompanyIdLegalEntitiesData = { company_id: string; }; query?: never; - url: '/v1/sandbox/companies/{company_id}/legal-entities'; + url: '/api/eor/v1/companies/{company_id}'; }; -export type PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors = { +export type GetV1CompaniesCompanyIdErrors = { /** * Bad Request */ @@ -18207,36 +19044,24 @@ export type PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors = { 429: TooManyRequestsResponse; }; -export type PostV1SandboxCompaniesCompanyIdLegalEntitiesError = - PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors[keyof PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors]; +export type GetV1CompaniesCompanyIdError = + GetV1CompaniesCompanyIdErrors[keyof GetV1CompaniesCompanyIdErrors]; -export type PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses = { +export type GetV1CompaniesCompanyIdResponses = { /** - * Legal entity created + * Success */ - 201: { - data?: { - /** - * Legal entity slug - */ - legal_entity_id?: string; - /** - * Legal entity name - */ - name?: string; - /** - * Legal entity status - */ - status?: string; - }; - }; + 200: CompanyResponse; }; -export type PostV1SandboxCompaniesCompanyIdLegalEntitiesResponse = - PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses[keyof PostV1SandboxCompaniesCompanyIdLegalEntitiesResponses]; +export type GetV1CompaniesCompanyIdResponse = + GetV1CompaniesCompanyIdResponses[keyof GetV1CompaniesCompanyIdResponses]; -export type GetV1EmploymentsEmploymentIdData = { - body?: never; +export type PatchV1CompaniesCompanyId2Data = { + /** + * Update Company params + */ + body?: UpdateCompanyParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -18248,60 +19073,65 @@ export type GetV1EmploymentsEmploymentIdData = { }; path: { /** - * Employment ID + * Company ID + * */ - employment_id: string; + company_id: string; }; query?: { /** - * Wether files should be excluded + * Version of the address_details form schema */ - exclude_files?: boolean; + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; }; - url: '/v1/employments/{employment_id}'; + url: '/api/eor/v1/companies/{company_id}'; }; -export type GetV1EmploymentsEmploymentIdErrors = { +export type PatchV1CompaniesCompanyId2Errors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type GetV1EmploymentsEmploymentIdError = - GetV1EmploymentsEmploymentIdErrors[keyof GetV1EmploymentsEmploymentIdErrors]; +export type PatchV1CompaniesCompanyId2Error = + PatchV1CompaniesCompanyId2Errors[keyof PatchV1CompaniesCompanyId2Errors]; -export type GetV1EmploymentsEmploymentIdResponses = { +export type PatchV1CompaniesCompanyId2Responses = { /** * Success */ - 200: EmploymentShowResponse; + 200: CompanyResponse; }; -export type GetV1EmploymentsEmploymentIdResponse = - GetV1EmploymentsEmploymentIdResponses[keyof GetV1EmploymentsEmploymentIdResponses]; +export type PatchV1CompaniesCompanyId2Response = + PatchV1CompaniesCompanyId2Responses[keyof PatchV1CompaniesCompanyId2Responses]; -export type PatchV1EmploymentsEmploymentId2Data = { +export type PatchV1CompaniesCompanyIdData = { /** - * Employment params + * Update Company params */ - body?: EmploymentFullParams; + body?: UpdateCompanyParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -18313,274 +19143,160 @@ export type PatchV1EmploymentsEmploymentId2Data = { }; path: { /** - * Employment ID + * Company ID + * */ - employment_id: string; + company_id: string; }; query?: { /** * Version of the address_details form schema */ address_details_json_schema_version?: number | 'latest'; - /** - * Version of the administrative_details form schema - */ - administrative_details_json_schema_version?: number | 'latest'; /** * Version of the bank_account_details form schema */ bank_account_details_json_schema_version?: number | 'latest'; - /** - * Version of the employment_basic_information form schema - */ - employment_basic_information_json_schema_version?: number | 'latest'; - /** - * Version of the billing_address_details form schema - */ - billing_address_details_json_schema_version?: number | 'latest'; - /** - * Version of the contract_details form schema - */ - contract_details_json_schema_version?: number | 'latest'; - /** - * Version of the emergency_contact_details form schema - */ - emergency_contact_details_json_schema_version?: number | 'latest'; - /** - * Version of the personal_details form schema - */ - personal_details_json_schema_version?: number | 'latest'; - /** - * Version of the pricing_plan_details form schema - */ - pricing_plan_details_json_schema_version?: number | 'latest'; - /** - * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. - */ - skip_benefits?: boolean; - /** - * Complementary action(s) to perform when creating an employment. - */ - actions?: string; }; - url: '/v1/employments/{employment_id}'; + url: '/api/eor/v1/companies/{company_id}'; }; -export type PatchV1EmploymentsEmploymentId2Errors = { +export type PatchV1CompaniesCompanyIdErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Unprocessable Entity + * Too many requests */ 429: TooManyRequestsResponse; }; -export type PatchV1EmploymentsEmploymentId2Error = - PatchV1EmploymentsEmploymentId2Errors[keyof PatchV1EmploymentsEmploymentId2Errors]; +export type PatchV1CompaniesCompanyIdError = + PatchV1CompaniesCompanyIdErrors[keyof PatchV1CompaniesCompanyIdErrors]; -export type PatchV1EmploymentsEmploymentId2Responses = { +export type PatchV1CompaniesCompanyIdResponses = { /** * Success */ - 200: EmploymentResponse; + 200: CompanyResponse; }; -export type PatchV1EmploymentsEmploymentId2Response = - PatchV1EmploymentsEmploymentId2Responses[keyof PatchV1EmploymentsEmploymentId2Responses]; +export type PatchV1CompaniesCompanyIdResponse = + PatchV1CompaniesCompanyIdResponses[keyof PatchV1CompaniesCompanyIdResponses]; -export type PatchV1EmploymentsEmploymentIdData = { - /** - * Employment params - */ - body?: EmploymentFullParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: { - /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; - /** - * Version of the administrative_details form schema - */ - administrative_details_json_schema_version?: number | 'latest'; - /** - * Version of the bank_account_details form schema - */ - bank_account_details_json_schema_version?: number | 'latest'; - /** - * Version of the employment_basic_information form schema - */ - employment_basic_information_json_schema_version?: number | 'latest'; - /** - * Version of the billing_address_details form schema - */ - billing_address_details_json_schema_version?: number | 'latest'; - /** - * Version of the contract_details form schema - */ - contract_details_json_schema_version?: number | 'latest'; - /** - * Version of the emergency_contact_details form schema - */ - emergency_contact_details_json_schema_version?: number | 'latest'; - /** - * Version of the personal_details form schema - */ - personal_details_json_schema_version?: number | 'latest'; +export type GetV1CompaniesSchemaData = { + body?: never; + path?: never; + query: { /** - * Version of the pricing_plan_details form schema + * Country code according to ISO 3-digit alphabetic codes. */ - pricing_plan_details_json_schema_version?: number | 'latest'; + country_code: string; /** - * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + * Name of the desired form */ - skip_benefits?: boolean; + form: 'address_details'; /** - * Complementary action(s) to perform when creating an employment. + * Version of the form schema */ - actions?: string; + json_schema_version?: number | 'latest'; }; - url: '/v1/employments/{employment_id}'; + url: '/api/eor/v1/companies/schema'; }; -export type PatchV1EmploymentsEmploymentIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; +export type GetV1CompaniesSchemaErrors = { /** - * Conflict + * Unauthorized */ - 409: ConflictResponse; + 401: UnauthorizedResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PatchV1EmploymentsEmploymentIdError = - PatchV1EmploymentsEmploymentIdErrors[keyof PatchV1EmploymentsEmploymentIdErrors]; +export type GetV1CompaniesSchemaError = + GetV1CompaniesSchemaErrors[keyof GetV1CompaniesSchemaErrors]; -export type PatchV1EmploymentsEmploymentIdResponses = { +export type GetV1CompaniesSchemaResponses = { /** * Success */ - 200: EmploymentResponse; + 200: CompanyFormResponse; }; -export type PatchV1EmploymentsEmploymentIdResponse = - PatchV1EmploymentsEmploymentIdResponses[keyof PatchV1EmploymentsEmploymentIdResponses]; +export type GetV1CompaniesSchemaResponse = + GetV1CompaniesSchemaResponses[keyof GetV1CompaniesSchemaResponses]; -export type GetV1ScimV2UsersData = { +export type GetV1PricingPlanPartnerTemplatesData = { body?: never; path?: never; - query?: { - /** - * 1-based index of the first result - */ - startIndex?: number; - /** - * Maximum number of results per page - */ - count?: number; - /** - * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) - */ - filter?: string; - }; - url: '/v1/scim/v2/Users'; + query?: never; + url: '/api/eor/v1/pricing-plan-partner-templates'; }; -export type GetV1ScimV2UsersErrors = { - /** - * Bad Request - */ - 400: IntegrationsScimErrorResponse; +export type GetV1PricingPlanPartnerTemplatesErrors = { /** * Unauthorized */ - 401: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: IntegrationsScimErrorResponse; + 404: NotFoundResponse; /** - * Not Found + * Unprocessable Entity */ - 404: IntegrationsScimErrorResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1ScimV2UsersError = - GetV1ScimV2UsersErrors[keyof GetV1ScimV2UsersErrors]; +export type GetV1PricingPlanPartnerTemplatesError = + GetV1PricingPlanPartnerTemplatesErrors[keyof GetV1PricingPlanPartnerTemplatesErrors]; -export type GetV1ScimV2UsersResponses = { +export type GetV1PricingPlanPartnerTemplatesResponses = { /** * Success */ - 200: IntegrationsScimUserListResponse; + 200: ListPricingPlanPartnerTemplatesResponse; }; -export type GetV1ScimV2UsersResponse = - GetV1ScimV2UsersResponses[keyof GetV1ScimV2UsersResponses]; +export type GetV1PricingPlanPartnerTemplatesResponse = + GetV1PricingPlanPartnerTemplatesResponses[keyof GetV1PricingPlanPartnerTemplatesResponses]; -export type GetV1PayrollCalendarsCycleData = { +export type GetV1CountriesCountryCodeEngagementAgreementDetailsData = { body?: never; path: { /** - * The cycle for which to list the payroll calendars. Format: YYYY-MM - */ - cycle: string; - }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Country code according to ISO 3-digit alphabetic codes */ - page_size?: number; + country_code: string; }; - url: '/v1/payroll-calendars/{cycle}'; + query?: never; + url: '/api/eor/v1/countries/{country_code}/engagement-agreement-details'; }; -export type GetV1PayrollCalendarsCycleErrors = { +export type GetV1CountriesCountryCodeEngagementAgreementDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -18593,133 +19309,24 @@ export type GetV1PayrollCalendarsCycleErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1PayrollCalendarsCycleError = - GetV1PayrollCalendarsCycleErrors[keyof GetV1PayrollCalendarsCycleErrors]; +export type GetV1CountriesCountryCodeEngagementAgreementDetailsError = + GetV1CountriesCountryCodeEngagementAgreementDetailsErrors[keyof GetV1CountriesCountryCodeEngagementAgreementDetailsErrors]; -export type GetV1PayrollCalendarsCycleResponses = { +export type GetV1CountriesCountryCodeEngagementAgreementDetailsResponses = { /** * Success */ - 200: PayrollCalendarsResponse; + 200: EngagementAgreementDetailsResponse; }; -export type GetV1PayrollCalendarsCycleResponse = - GetV1PayrollCalendarsCycleResponses[keyof GetV1PayrollCalendarsCycleResponses]; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData = - { - body?: never; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - /** - * Legal entity ID - */ - legal_entity_id: UuidSlug; - }; - query?: never; - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; - }; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = - { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - }; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError = - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors]; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses = - { - /** - * ShowLegalEntityAdministrativeDetailsResponse - * - * Country specific json schema driven administrative details for legal entities - */ - 200: { - data: { - [key: string]: unknown; - }; - }; - }; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse = - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses]; - -export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsData = - { - /** - * Legal entity administrative details params - */ - body?: AdministrativeDetailsParams; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - /** - * Legal entity ID - */ - legal_entity_id: UuidSlug; - }; - query?: never; - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; - }; - -export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = - { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; - }; - -export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsError = - PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors[keyof PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors]; - -export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses = - { - /** - * ShowLegalEntityAdministrativeDetailsResponse - * - * Country specific json schema driven administrative details for legal entities - */ - 200: { - data: { - [key: string]: unknown; - }; - }; - }; - -export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponse = - PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses[keyof PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsResponses]; +export type GetV1CountriesCountryCodeEngagementAgreementDetailsResponse = + GetV1CountriesCountryCodeEngagementAgreementDetailsResponses[keyof GetV1CountriesCountryCodeEngagementAgreementDetailsResponses]; export type PutV2EmploymentsEmploymentIdContractDetailsData = { /** @@ -18742,7 +19349,7 @@ export type PutV2EmploymentsEmploymentIdContractDetailsData = { */ skip_benefits?: boolean; }; - url: '/v2/employments/{employment_id}/contract_details'; + url: '/api/eor/v2/employments/{employment_id}/contract_details'; }; export type PutV2EmploymentsEmploymentIdContractDetailsErrors = { @@ -18783,70 +19390,25 @@ export type PutV2EmploymentsEmploymentIdContractDetailsResponses = { /** * Success */ - 200: EmploymentResponse; -}; - -export type PutV2EmploymentsEmploymentIdContractDetailsResponse = - PutV2EmploymentsEmploymentIdContractDetailsResponses[keyof PutV2EmploymentsEmploymentIdContractDetailsResponses]; - -export type GetV1CostCalculatorRegionsSlugFieldsData = { - body?: never; - path: { - /** - * Slug - */ - slug: string; - }; - query?: { - /** - * If the premium benefits should be included in the response - */ - include_premium_benefits?: boolean; - }; - url: '/v1/cost-calculator/regions/{slug}/fields'; -}; - -export type GetV1CostCalculatorRegionsSlugFieldsErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Internal Server Error - */ - 500: InternalServerErrorResponse; -}; - -export type GetV1CostCalculatorRegionsSlugFieldsError = - GetV1CostCalculatorRegionsSlugFieldsErrors[keyof GetV1CostCalculatorRegionsSlugFieldsErrors]; - -export type GetV1CostCalculatorRegionsSlugFieldsResponses = { - /** - * Success - */ - 200: JsonSchemaResponse; + 200: EmploymentResponse; }; -export type GetV1CostCalculatorRegionsSlugFieldsResponse = - GetV1CostCalculatorRegionsSlugFieldsResponses[keyof GetV1CostCalculatorRegionsSlugFieldsResponses]; +export type PutV2EmploymentsEmploymentIdContractDetailsResponse = + PutV2EmploymentsEmploymentIdContractDetailsResponses[keyof PutV2EmploymentsEmploymentIdContractDetailsResponses]; -export type GetV1OffboardingsIdData = { +export type GetV1CompaniesCompanyIdProductPricesData = { body?: never; path: { /** - * Offboarding request ID + * Company ID */ - id: string; + company_id: UuidSlug; }; query?: never; - url: '/v1/offboardings/{id}'; + url: '/api/eor/v1/companies/{company_id}/product-prices'; }; -export type GetV1OffboardingsIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CompaniesCompanyIdProductPricesErrors = { /** * Unauthorized */ @@ -18859,47 +19421,39 @@ export type GetV1OffboardingsIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetV1OffboardingsIdError = - GetV1OffboardingsIdErrors[keyof GetV1OffboardingsIdErrors]; +export type GetV1CompaniesCompanyIdProductPricesError = + GetV1CompaniesCompanyIdProductPricesErrors[keyof GetV1CompaniesCompanyIdProductPricesErrors]; -export type GetV1OffboardingsIdResponses = { +export type GetV1CompaniesCompanyIdProductPricesResponses = { /** * Success */ - 200: OffboardingResponse; + 200: ListProductPricesResponse; }; -export type GetV1OffboardingsIdResponse = - GetV1OffboardingsIdResponses[keyof GetV1OffboardingsIdResponses]; +export type GetV1CompaniesCompanyIdProductPricesResponse = + GetV1CompaniesCompanyIdProductPricesResponses[keyof GetV1CompaniesCompanyIdProductPricesResponses]; -export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsData = { +export type PostV1CompaniesCompanyIdCreateTokenData = { body?: never; path: { /** - * Payroll run ID + * The ID of the company */ - payroll_run_id: string; + company_id: string; }; query?: { /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * The scope of the token */ - page_size?: number; + scope?: string; }; - url: '/v1/payroll-runs/{payroll_run_id}/employee-details'; + url: '/api/eor/v1/companies/{company_id}/create-token'; }; -export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors = { +export type PostV1CompaniesCompanyIdCreateTokenErrors = { /** * Unauthorized */ @@ -18914,49 +19468,36 @@ export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsError = - GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors[keyof GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors]; +export type PostV1CompaniesCompanyIdCreateTokenError = + PostV1CompaniesCompanyIdCreateTokenErrors[keyof PostV1CompaniesCompanyIdCreateTokenErrors]; -export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses = { +export type PostV1CompaniesCompanyIdCreateTokenResponses = { /** * Success */ - 200: EmployeeDetailsResponse; + 200: CompanyTokenResponse; }; -export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponse = - GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses[keyof GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses]; +export type PostV1CompaniesCompanyIdCreateTokenResponse = + PostV1CompaniesCompanyIdCreateTokenResponses[keyof PostV1CompaniesCompanyIdCreateTokenResponses]; -export type GetV1BulkEmploymentJobsJobIdRowsData = { +export type GetV1IdentityVerificationEmploymentIdData = { body?: never; path: { /** - * Bulk employment job id - */ - job_id: string; - }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/bulk-employment-jobs/{job_id}/rows'; + query?: never; + url: '/api/eor/v1/identity-verification/{employment_id}'; }; -export type GetV1BulkEmploymentJobsJobIdRowsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1IdentityVerificationEmploymentIdErrors = { /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -18964,42 +19505,39 @@ export type GetV1BulkEmploymentJobsJobIdRowsErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1BulkEmploymentJobsJobIdRowsError = - GetV1BulkEmploymentJobsJobIdRowsErrors[keyof GetV1BulkEmploymentJobsJobIdRowsErrors]; +export type GetV1IdentityVerificationEmploymentIdError = + GetV1IdentityVerificationEmploymentIdErrors[keyof GetV1IdentityVerificationEmploymentIdErrors]; -export type GetV1BulkEmploymentJobsJobIdRowsResponses = { +export type GetV1IdentityVerificationEmploymentIdResponses = { /** * Success */ - 200: ImportJobRowsResponse; + 200: IdentityVerificationResponse; }; -export type GetV1BulkEmploymentJobsJobIdRowsResponse = - GetV1BulkEmploymentJobsJobIdRowsResponses[keyof GetV1BulkEmploymentJobsJobIdRowsResponses]; +export type GetV1IdentityVerificationEmploymentIdResponse = + GetV1IdentityVerificationEmploymentIdResponses[keyof GetV1IdentityVerificationEmploymentIdResponses]; -export type PostV1SandboxEmploymentsData = { - /** - * Employment params - */ - body?: EmploymentCreateParams; - headers: { +export type GetV1ExpensesExpenseIdReceiptsReceiptIdData = { + body?: never; + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * The expense ID */ - Authorization: string; + expense_id: string; + /** + * The receipt ID + */ + receipt_id: string; }; - path?: never; query?: never; - url: '/v1/sandbox/employments'; + url: '/api/eor/v1/expenses/{expense_id}/receipts/{receipt_id}'; }; -export type PostV1SandboxEmploymentsErrors = { +export type GetV1ExpensesExpenseIdReceiptsReceiptIdErrors = { /** * Bad Request */ @@ -19008,6 +19546,10 @@ export type PostV1SandboxEmploymentsErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -19017,83 +19559,98 @@ export type PostV1SandboxEmploymentsErrors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PostV1SandboxEmploymentsError = - PostV1SandboxEmploymentsErrors[keyof PostV1SandboxEmploymentsErrors]; +export type GetV1ExpensesExpenseIdReceiptsReceiptIdError = + GetV1ExpensesExpenseIdReceiptsReceiptIdErrors[keyof GetV1ExpensesExpenseIdReceiptsReceiptIdErrors]; -export type PostV1SandboxEmploymentsResponses = { +export type GetV1ExpensesExpenseIdReceiptsReceiptIdResponses = { /** * Success */ - 201: EmploymentCreationResponse; + 200: GenericFile; }; -export type PostV1SandboxEmploymentsResponse = - PostV1SandboxEmploymentsResponses[keyof PostV1SandboxEmploymentsResponses]; +export type GetV1ExpensesExpenseIdReceiptsReceiptIdResponse = + GetV1ExpensesExpenseIdReceiptsReceiptIdResponses[keyof GetV1ExpensesExpenseIdReceiptsReceiptIdResponses]; -export type PostV1EmploymentsEmploymentIdContractEligibilityData = { - /** - * Contract Eligibility Create Parameters - */ - body: CreateContractEligibilityParams; - path: { +export type GetV1ScimV2GroupsData = { + body?: never; + path?: never; + query?: { /** - * Employment ID + * 1-based index of the first result */ - employment_id: string; + startIndex?: number; + /** + * Maximum number of results per page + */ + count?: number; + /** + * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + */ + filter?: string; }; - query?: never; - url: '/v1/employments/{employment_id}/contract-eligibility'; + url: '/api/eor/v1/scim/v2/Groups'; }; -export type PostV1EmploymentsEmploymentIdContractEligibilityErrors = { +export type GetV1ScimV2GroupsErrors = { /** * Bad Request */ - 400: BadRequestResponse; + 400: IntegrationsScimErrorResponse; /** - * Unprocessable Entity + * Unauthorized */ - 422: UnprocessableEntityResponse; + 401: IntegrationsScimErrorResponse; /** - * Unprocessable Entity + * Forbidden */ - 429: TooManyRequestsResponse; + 403: IntegrationsScimErrorResponse; + /** + * Not Found + */ + 404: IntegrationsScimErrorResponse; }; -export type PostV1EmploymentsEmploymentIdContractEligibilityError = - PostV1EmploymentsEmploymentIdContractEligibilityErrors[keyof PostV1EmploymentsEmploymentIdContractEligibilityErrors]; +export type GetV1ScimV2GroupsError = + GetV1ScimV2GroupsErrors[keyof GetV1ScimV2GroupsErrors]; -export type PostV1EmploymentsEmploymentIdContractEligibilityResponses = { +export type GetV1ScimV2GroupsResponses = { /** * Success */ - 200: SuccessResponse; + 200: IntegrationsScimGroupListResponse; }; -export type PostV1EmploymentsEmploymentIdContractEligibilityResponse = - PostV1EmploymentsEmploymentIdContractEligibilityResponses[keyof PostV1EmploymentsEmploymentIdContractEligibilityResponses]; +export type GetV1ScimV2GroupsResponse = + GetV1ScimV2GroupsResponses[keyof GetV1ScimV2GroupsResponses]; -export type GetV1CountriesData = { +export type GetV1ExpensesIdData = { body?: never; headers: { /** - * This endpoint works with any of the access tokens provided. You can use an access - * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. * */ Authorization: string; }; - path?: never; + path: { + /** + * Expense ID + */ + id: string; + }; query?: never; - url: '/v1/countries'; + url: '/api/eor/v1/expenses/{id}'; }; -export type GetV1CountriesErrors = { +export type GetV1ExpensesIdErrors = { /** * Bad Request */ @@ -19116,81 +19673,39 @@ export type GetV1CountriesErrors = { 429: TooManyRequestsResponse; }; -export type GetV1CountriesError = - GetV1CountriesErrors[keyof GetV1CountriesErrors]; - -export type GetV1CountriesResponses = { - /** - * Success - */ - 200: CountriesResponse; -}; - -export type GetV1CountriesResponse = - GetV1CountriesResponses[keyof GetV1CountriesResponses]; - -export type GetV1EmployeePayslipFilesData = { - body?: never; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - }; - url: '/v1/employee/payslip-files'; -}; - -export type GetV1EmployeePayslipFilesErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; -}; - -export type GetV1EmployeePayslipFilesError = - GetV1EmployeePayslipFilesErrors[keyof GetV1EmployeePayslipFilesErrors]; +export type GetV1ExpensesIdError = + GetV1ExpensesIdErrors[keyof GetV1ExpensesIdErrors]; -export type GetV1EmployeePayslipFilesResponses = { +export type GetV1ExpensesIdResponses = { /** * Success */ - 200: ListPayslipFilesResponse; + 200: ExpenseResponse; }; -export type GetV1EmployeePayslipFilesResponse = - GetV1EmployeePayslipFilesResponses[keyof GetV1EmployeePayslipFilesResponses]; +export type GetV1ExpensesIdResponse = + GetV1ExpensesIdResponses[keyof GetV1ExpensesIdResponses]; -export type PostV1CompaniesCompanyIdCreateTokenData = { - body?: never; +export type PatchV1ExpensesId2Data = { + /** + * Expenses + */ + body?: UpdateExpenseParams; path: { /** - * The ID of the company - */ - company_id: string; - }; - query?: { - /** - * The scope of the token + * Expense ID */ - scope?: string; + id: string; }; - url: '/v1/companies/{company_id}/create-token'; + query?: never; + url: '/api/eor/v1/expenses/{id}'; }; -export type PostV1CompaniesCompanyIdCreateTokenErrors = { +export type PatchV1ExpensesId2Errors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -19199,47 +19714,53 @@ export type PostV1CompaniesCompanyIdCreateTokenErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PostV1CompaniesCompanyIdCreateTokenError = - PostV1CompaniesCompanyIdCreateTokenErrors[keyof PostV1CompaniesCompanyIdCreateTokenErrors]; +export type PatchV1ExpensesId2Error = + PatchV1ExpensesId2Errors[keyof PatchV1ExpensesId2Errors]; -export type PostV1CompaniesCompanyIdCreateTokenResponses = { +export type PatchV1ExpensesId2Responses = { /** * Success */ - 200: CompanyTokenResponse; + 200: ExpenseResponse; }; -export type PostV1CompaniesCompanyIdCreateTokenResponse = - PostV1CompaniesCompanyIdCreateTokenResponses[keyof PostV1CompaniesCompanyIdCreateTokenResponses]; +export type PatchV1ExpensesId2Response = + PatchV1ExpensesId2Responses[keyof PatchV1ExpensesId2Responses]; -export type GetV1CompaniesCompanyIdLegalEntitiesData = { - body?: never; +export type PatchV1ExpensesIdData = { + /** + * Expenses + */ + body?: UpdateExpenseParams; path: { /** - * Company ID - */ - company_id: UuidSlug; - }; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page + * Expense ID */ - page_size?: number; + id: string; }; - url: '/v1/companies/{company_id}/legal-entities'; + query?: never; + url: '/api/eor/v1/expenses/{id}'; }; -export type GetV1CompaniesCompanyIdLegalEntitiesErrors = { +export type PatchV1ExpensesIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -19248,37 +19769,54 @@ export type GetV1CompaniesCompanyIdLegalEntitiesErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1CompaniesCompanyIdLegalEntitiesError = - GetV1CompaniesCompanyIdLegalEntitiesErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesErrors]; +export type PatchV1ExpensesIdError = + PatchV1ExpensesIdErrors[keyof PatchV1ExpensesIdErrors]; -export type GetV1CompaniesCompanyIdLegalEntitiesResponses = { +export type PatchV1ExpensesIdResponses = { /** * Success */ - 200: ListCompanyLegalEntitiesResponse; + 200: ExpenseResponse; }; -export type GetV1CompaniesCompanyIdLegalEntitiesResponse = - GetV1CompaniesCompanyIdLegalEntitiesResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesResponses]; +export type PatchV1ExpensesIdResponse = + PatchV1ExpensesIdResponses[keyof PatchV1ExpensesIdResponses]; -export type PutV2EmploymentsEmploymentIdPersonalDetailsData = { +export type PutV2EmploymentsEmploymentIdEmergencyContactData = { /** - * Employment personal details params + * Employment emergency contact params */ - body?: EmploymentPersonalDetailsParams; + body?: EmploymentEmergencyContactParams; path: { /** * Employment ID */ employment_id: string; }; - query?: never; - url: '/v2/employments/{employment_id}/personal_details'; + query?: { + /** + * Version of the emergency_contact_details form schema + */ + emergency_contact_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v2/employments/{employment_id}/emergency_contact'; }; -export type PutV2EmploymentsEmploymentIdPersonalDetailsErrors = { +export type PutV2EmploymentsEmploymentIdEmergencyContactErrors = { /** * Bad Request */ @@ -19309,24 +19847,24 @@ export type PutV2EmploymentsEmploymentIdPersonalDetailsErrors = { 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdPersonalDetailsError = - PutV2EmploymentsEmploymentIdPersonalDetailsErrors[keyof PutV2EmploymentsEmploymentIdPersonalDetailsErrors]; +export type PutV2EmploymentsEmploymentIdEmergencyContactError = + PutV2EmploymentsEmploymentIdEmergencyContactErrors[keyof PutV2EmploymentsEmploymentIdEmergencyContactErrors]; -export type PutV2EmploymentsEmploymentIdPersonalDetailsResponses = { +export type PutV2EmploymentsEmploymentIdEmergencyContactResponses = { /** * Success */ 200: EmploymentResponse; }; -export type PutV2EmploymentsEmploymentIdPersonalDetailsResponse = - PutV2EmploymentsEmploymentIdPersonalDetailsResponses[keyof PutV2EmploymentsEmploymentIdPersonalDetailsResponses]; +export type PutV2EmploymentsEmploymentIdEmergencyContactResponse = + PutV2EmploymentsEmploymentIdEmergencyContactResponses[keyof PutV2EmploymentsEmploymentIdEmergencyContactResponses]; -export type PostV1ReadyData = { +export type PostV1SandboxBenefitRenewalRequestsData = { /** - * Employment slug + * Benefit Renewal Request */ - body?: CompleteOnboarding; + body: BenefitRenewalRequestsCreateBenefitRenewalRequest; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -19338,22 +19876,18 @@ export type PostV1ReadyData = { }; path?: never; query?: never; - url: '/v1/ready'; + url: '/api/eor/v1/sandbox/benefit-renewal-requests'; }; -export type PostV1ReadyErrors = { +export type PostV1SandboxBenefitRenewalRequestsErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Conflict + * Unauthorized */ - 409: ConflictResponse; + 401: UnauthorizedResponse; /** * Unprocessable Entity */ @@ -19364,20 +19898,24 @@ export type PostV1ReadyErrors = { 429: TooManyRequestsResponse; }; -export type PostV1ReadyError = PostV1ReadyErrors[keyof PostV1ReadyErrors]; +export type PostV1SandboxBenefitRenewalRequestsError = + PostV1SandboxBenefitRenewalRequestsErrors[keyof PostV1SandboxBenefitRenewalRequestsErrors]; -export type PostV1ReadyResponses = { +export type PostV1SandboxBenefitRenewalRequestsResponses = { /** * Success */ - 200: EmploymentResponse; + 200: BenefitRenewalRequestsCreateBenefitRenewalRequestResponse; }; -export type PostV1ReadyResponse = - PostV1ReadyResponses[keyof PostV1ReadyResponses]; +export type PostV1SandboxBenefitRenewalRequestsResponse = + PostV1SandboxBenefitRenewalRequestsResponses[keyof PostV1SandboxBenefitRenewalRequestsResponses]; -export type GetV1LeavePoliciesDetailsEmploymentIdData = { - body?: never; +export type PutV2EmploymentsEmploymentIdBasicInformationData = { + /** + * Employment basic information params + */ + body?: EmploymentBasicInformationParams; path: { /** * Employment ID @@ -19385,63 +19923,58 @@ export type GetV1LeavePoliciesDetailsEmploymentIdData = { employment_id: string; }; query?: never; - url: '/v1/leave-policies/details/{employment_id}'; + url: '/api/eor/v2/employments/{employment_id}/basic_information'; }; -export type GetV1LeavePoliciesDetailsEmploymentIdErrors = { +export type PutV2EmploymentsEmploymentIdBasicInformationErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1LeavePoliciesDetailsEmploymentIdError = - GetV1LeavePoliciesDetailsEmploymentIdErrors[keyof GetV1LeavePoliciesDetailsEmploymentIdErrors]; +export type PutV2EmploymentsEmploymentIdBasicInformationError = + PutV2EmploymentsEmploymentIdBasicInformationErrors[keyof PutV2EmploymentsEmploymentIdBasicInformationErrors]; -export type GetV1LeavePoliciesDetailsEmploymentIdResponses = { +export type PutV2EmploymentsEmploymentIdBasicInformationResponses = { /** * Success */ - 200: ListLeavePoliciesDetailsResponse; + 200: EmploymentResponse; }; -export type GetV1LeavePoliciesDetailsEmploymentIdResponse = - GetV1LeavePoliciesDetailsEmploymentIdResponses[keyof GetV1LeavePoliciesDetailsEmploymentIdResponses]; +export type PutV2EmploymentsEmploymentIdBasicInformationResponse = + PutV2EmploymentsEmploymentIdBasicInformationResponses[keyof PutV2EmploymentsEmploymentIdBasicInformationResponses]; -export type GetV1TimeoffTypesData = { +export type GetV1LeavePoliciesSummaryEmploymentIdData = { body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: { + path: { /** - * Optional. Employment type to list time off types for: `contractor` or `full_time`. Omit for backward-compatible behavior (full-time types). + * Employment ID */ - type?: TimeoffTypesEmploymentType; + employment_id: string; }; - url: '/v1/timeoff/types'; + query?: never; + url: '/api/eor/v1/leave-policies/summary/{employment_id}'; }; -export type GetV1TimeoffTypesErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1LeavePoliciesSummaryEmploymentIdErrors = { /** * Unauthorized */ @@ -19454,36 +19987,45 @@ export type GetV1TimeoffTypesErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetV1TimeoffTypesError = - GetV1TimeoffTypesErrors[keyof GetV1TimeoffTypesErrors]; +export type GetV1LeavePoliciesSummaryEmploymentIdError = + GetV1LeavePoliciesSummaryEmploymentIdErrors[keyof GetV1LeavePoliciesSummaryEmploymentIdErrors]; -export type GetV1TimeoffTypesResponses = { +export type GetV1LeavePoliciesSummaryEmploymentIdResponses = { /** * Success */ - 200: ListTimeoffTypesResponse; + 200: ListLeavePoliciesSummaryResponse; }; -export type GetV1TimeoffTypesResponse = - GetV1TimeoffTypesResponses[keyof GetV1TimeoffTypesResponses]; +export type GetV1LeavePoliciesSummaryEmploymentIdResponse = + GetV1LeavePoliciesSummaryEmploymentIdResponses[keyof GetV1LeavePoliciesSummaryEmploymentIdResponses]; -export type PostV1CostCalculatorEstimationCsvData = { +export type PostV1TimeoffTimeoffIdCancelData = { /** - * Estimate params + * CancelTimeoff */ - body?: CostCalculatorEstimateParams; - path?: never; + body: CancelTimeoffParams; + path: { + /** + * Time Off ID + */ + timeoff_id: string; + }; query?: never; - url: '/v1/cost-calculator/estimation-csv'; + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel'; }; -export type PostV1CostCalculatorEstimationCsvErrors = { +export type PostV1TimeoffTimeoffIdCancelErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ @@ -19492,89 +20034,76 @@ export type PostV1CostCalculatorEstimationCsvErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type PostV1CostCalculatorEstimationCsvError = - PostV1CostCalculatorEstimationCsvErrors[keyof PostV1CostCalculatorEstimationCsvErrors]; +export type PostV1TimeoffTimeoffIdCancelError = + PostV1TimeoffTimeoffIdCancelErrors[keyof PostV1TimeoffTimeoffIdCancelErrors]; -export type PostV1CostCalculatorEstimationCsvResponses = { +export type PostV1TimeoffTimeoffIdCancelResponses = { /** * Success */ - 200: CostCalculatorEstimateCsvResponse; + 200: TimeoffResponse; }; -export type PostV1CostCalculatorEstimationCsvResponse = - PostV1CostCalculatorEstimationCsvResponses[keyof PostV1CostCalculatorEstimationCsvResponses]; +export type PostV1TimeoffTimeoffIdCancelResponse = + PostV1TimeoffTimeoffIdCancelResponses[keyof PostV1TimeoffTimeoffIdCancelResponses]; -export type GetV1ScimV2GroupsData = { +export type GetV1HelpCenterArticlesIdData = { body?: never; - path?: never; - query?: { - /** - * 1-based index of the first result - */ - startIndex?: number; - /** - * Maximum number of results per page - */ - count?: number; + path: { /** - * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + * Help Center Article Zendesk ID */ - filter?: string; + id: number; }; - url: '/v1/scim/v2/Groups'; + query?: never; + url: '/api/eor/v1/help-center-articles/{id}'; }; -export type GetV1ScimV2GroupsErrors = { - /** - * Bad Request - */ - 400: IntegrationsScimErrorResponse; - /** - * Unauthorized - */ - 401: IntegrationsScimErrorResponse; - /** - * Forbidden - */ - 403: IntegrationsScimErrorResponse; +export type GetV1HelpCenterArticlesIdErrors = { /** * Not Found */ - 404: IntegrationsScimErrorResponse; + 404: NotFoundResponse; }; -export type GetV1ScimV2GroupsError = - GetV1ScimV2GroupsErrors[keyof GetV1ScimV2GroupsErrors]; +export type GetV1HelpCenterArticlesIdError = + GetV1HelpCenterArticlesIdErrors[keyof GetV1HelpCenterArticlesIdErrors]; -export type GetV1ScimV2GroupsResponses = { +export type GetV1HelpCenterArticlesIdResponses = { /** * Success */ - 200: IntegrationsScimGroupListResponse; + 200: HelpCenterArticleResponse; }; -export type GetV1ScimV2GroupsResponse = - GetV1ScimV2GroupsResponses[keyof GetV1ScimV2GroupsResponses]; +export type GetV1HelpCenterArticlesIdResponse = + GetV1HelpCenterArticlesIdResponses[keyof GetV1HelpCenterArticlesIdResponses]; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData = { +export type PostV1DocumentsData = { /** - * CreateContractDocumentParams + * File */ - body: CreateContractDocument; - path: { + body: FileParams; + headers: { /** - * Employment ID + * This endpoint works with any of the access tokens provided. You can use an access + * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. + * */ - employment_id: string; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/contractors/employments/{employment_id}/contract-documents'; + url: '/api/eor/v1/documents'; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors = { +export type PostV1DocumentsErrors = { /** * Unauthorized */ @@ -19589,31 +20118,32 @@ export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsError = - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors]; +export type PostV1DocumentsError = + PostV1DocumentsErrors[keyof PostV1DocumentsErrors]; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses = - { +export type PostV1DocumentsResponses = { + /** + * Success + */ + 200: UploadFileResponse; +}; + +export type PostV1DocumentsResponse = + PostV1DocumentsResponses[keyof PostV1DocumentsResponses]; + +export type PostV1IdentityVerificationEmploymentIdVerifyData = { + body?: never; + path: { /** - * Success + * Employment ID */ - 200: CreateContractDocumentResponse; + employment_id: string; }; - -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponse = - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsResponses]; - -export type PostV1SandboxWebhookCallbacksTriggerData = { - /** - * Webhook Trigger Params - */ - body?: WebhookTriggerParams; - path?: never; query?: never; - url: '/v1/sandbox/webhook-callbacks/trigger'; + url: '/api/eor/v1/identity-verification/{employment_id}/verify'; }; -export type PostV1SandboxWebhookCallbacksTriggerErrors = { +export type PostV1IdentityVerificationEmploymentIdVerifyErrors = { /** * Unauthorized */ @@ -19628,45 +20158,36 @@ export type PostV1SandboxWebhookCallbacksTriggerErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1SandboxWebhookCallbacksTriggerError = - PostV1SandboxWebhookCallbacksTriggerErrors[keyof PostV1SandboxWebhookCallbacksTriggerErrors]; +export type PostV1IdentityVerificationEmploymentIdVerifyError = + PostV1IdentityVerificationEmploymentIdVerifyErrors[keyof PostV1IdentityVerificationEmploymentIdVerifyErrors]; -export type PostV1SandboxWebhookCallbacksTriggerResponses = { +export type PostV1IdentityVerificationEmploymentIdVerifyResponses = { /** * Success */ 200: SuccessResponse; }; -export type PostV1SandboxWebhookCallbacksTriggerResponse = - PostV1SandboxWebhookCallbacksTriggerResponses[keyof PostV1SandboxWebhookCallbacksTriggerResponses]; +export type PostV1IdentityVerificationEmploymentIdVerifyResponse = + PostV1IdentityVerificationEmploymentIdVerifyResponses[keyof PostV1IdentityVerificationEmploymentIdVerifyResponses]; -export type GetV1PayslipsPayslipIdPdfData = { +export type GetV1CustomFieldsData = { body?: never; - headers: { + path?: never; + query?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Starts fetching records after the given page */ - Authorization: string; - }; - path: { + page?: number; /** - * Payslip ID + * Number of items per page */ - payslip_id: string; + page_size?: number; }; - query?: never; - url: '/v1/payslips/{payslip_id}/pdf'; + url: '/api/eor/v1/custom-fields'; }; -export type GetV1PayslipsPayslipIdPdfErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CustomFieldsErrors = { /** * Unauthorized */ @@ -19679,36 +20200,32 @@ export type GetV1PayslipsPayslipIdPdfErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetV1PayslipsPayslipIdPdfError = - GetV1PayslipsPayslipIdPdfErrors[keyof GetV1PayslipsPayslipIdPdfErrors]; +export type GetV1CustomFieldsError = + GetV1CustomFieldsErrors[keyof GetV1CustomFieldsErrors]; -export type GetV1PayslipsPayslipIdPdfResponses = { +export type GetV1CustomFieldsResponses = { /** * Success */ - 200: PayslipDownloadResponse; + 200: ListEmploymentCustomFieldsResponse; }; -export type GetV1PayslipsPayslipIdPdfResponse = - GetV1PayslipsPayslipIdPdfResponses[keyof GetV1PayslipsPayslipIdPdfResponses]; +export type GetV1CustomFieldsResponse = + GetV1CustomFieldsResponses[keyof GetV1CustomFieldsResponses]; -export type PostV1CurrencyConverterEffectiveData = { +export type PostV1CustomFieldsData = { /** - * Convert currency parameters + * Custom Field Definition Create Parameters */ - body: ConvertCurrencyParams; + body: CreateCustomFieldDefinitionParams; path?: never; query?: never; - url: '/v1/currency-converter/effective'; + url: '/api/eor/v1/custom-fields'; }; -export type PostV1CurrencyConverterEffectiveErrors = { +export type PostV1CustomFieldsErrors = { /** * Unauthorized */ @@ -19723,81 +20240,75 @@ export type PostV1CurrencyConverterEffectiveErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1CurrencyConverterEffectiveError = - PostV1CurrencyConverterEffectiveErrors[keyof PostV1CurrencyConverterEffectiveErrors]; +export type PostV1CustomFieldsError = + PostV1CustomFieldsErrors[keyof PostV1CustomFieldsErrors]; -export type PostV1CurrencyConverterEffectiveResponses = { +export type PostV1CustomFieldsResponses = { /** * Success */ - 200: ConvertCurrencyResponse; + 200: CreateEmploymentCustomFieldResponse; }; -export type PostV1CurrencyConverterEffectiveResponse = - PostV1CurrencyConverterEffectiveResponses[keyof PostV1CurrencyConverterEffectiveResponses]; +export type PostV1CustomFieldsResponse = + PostV1CustomFieldsResponses[keyof PostV1CustomFieldsResponses]; -export type GetV1TimeoffIdData = { - body?: never; - headers: { +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve'; + }; + +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Bad Request */ - Authorization: string; - }; - path: { + 400: BadRequestResponse; /** - * Timeoff ID + * Unauthorized */ - id: string; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; - query?: never; - url: '/v1/timeoff/{id}'; -}; - -export type GetV1TimeoffIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; -}; -export type GetV1TimeoffIdError = - GetV1TimeoffIdErrors[keyof GetV1TimeoffIdErrors]; +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveError = + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors[keyof PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors]; -export type GetV1TimeoffIdResponses = { - /** - * Success - */ - 200: TimeoffResponse; -}; +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses = + { + /** + * Success + */ + 200: RiskReserveProofOfPaymentResponse; + }; -export type GetV1TimeoffIdResponse = - GetV1TimeoffIdResponses[keyof GetV1TimeoffIdResponses]; +export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponse = + PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses[keyof PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveResponses]; -export type PatchV1TimeoffId2Data = { +export type PostV1WebhookCallbacksData = { /** - * UpdateTimeoff + * WebhookCallback */ - body: UpdateApprovedTimeoffParams; + body?: CreateWebhookCallbackParams; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -19807,21 +20318,12 @@ export type PatchV1TimeoffId2Data = { */ Authorization: string; }; - path: { - /** - * Timeoff ID - */ - id: string; - }; + path?: never; query?: never; - url: '/v1/timeoff/{id}'; + url: '/api/eor/v1/webhook-callbacks'; }; -export type PatchV1TimeoffId2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1WebhookCallbacksErrors = { /** * Unauthorized */ @@ -19834,50 +20336,29 @@ export type PatchV1TimeoffId2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PatchV1TimeoffId2Error = - PatchV1TimeoffId2Errors[keyof PatchV1TimeoffId2Errors]; +export type PostV1WebhookCallbacksError = + PostV1WebhookCallbacksErrors[keyof PostV1WebhookCallbacksErrors]; -export type PatchV1TimeoffId2Responses = { +export type PostV1WebhookCallbacksResponses = { /** * Success */ - 200: TimeoffResponse; + 200: WebhookCallbackResponse; }; -export type PatchV1TimeoffId2Response = - PatchV1TimeoffId2Responses[keyof PatchV1TimeoffId2Responses]; +export type PostV1WebhookCallbacksResponse = + PostV1WebhookCallbacksResponses[keyof PostV1WebhookCallbacksResponses]; -export type PatchV1TimeoffIdData = { - /** - * UpdateTimeoff - */ - body: UpdateApprovedTimeoffParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { - /** - * Timeoff ID - */ - id: string; - }; +export type GetV1SsoConfigurationDetailsData = { + body?: never; + path?: never; query?: never; - url: '/v1/timeoff/{id}'; + url: '/api/eor/v1/sso-configuration/details'; }; -export type PatchV1TimeoffIdErrors = { +export type GetV1SsoConfigurationDetailsErrors = { /** * Bad Request */ @@ -19890,53 +20371,108 @@ export type PatchV1TimeoffIdErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; /** * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PatchV1TimeoffIdError = - PatchV1TimeoffIdErrors[keyof PatchV1TimeoffIdErrors]; +export type GetV1SsoConfigurationDetailsError = + GetV1SsoConfigurationDetailsErrors[keyof GetV1SsoConfigurationDetailsErrors]; -export type PatchV1TimeoffIdResponses = { +export type GetV1SsoConfigurationDetailsResponses = { /** * Success */ - 200: TimeoffResponse; + 200: SsoConfigurationDetailsResponse; }; -export type PatchV1TimeoffIdResponse = - PatchV1TimeoffIdResponses[keyof PatchV1TimeoffIdResponses]; +export type GetV1SsoConfigurationDetailsResponse = + GetV1SsoConfigurationDetailsResponses[keyof GetV1SsoConfigurationDetailsResponses]; -export type PostV1TimeoffTimeoffIdDeclineData = { - /** - * DeclineTimeoff - */ - body: DeclineTimeoffParams; - path: { +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData = + { /** - * Time Off ID + * SignContractDocument */ - timeoff_id: string; + body: SignContractDocument; + path: { + /** + * Employment ID + */ + employment_id: string; + /** + * Document ID + */ + contract_document_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign'; }; - query?: never; - url: '/v1/timeoff/{timeoff_id}/decline'; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignError = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses = + { + /** + * Success + */ + 200: SuccessResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponse = + PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses]; + +export type GetV1PayItemsData = { + body?: never; + path?: never; + query?: { + /** + * Filter by employment slug + */ + employment_slug?: UuidSlug; + /** + * Filter pay items with effective_date >= given date (YYYY-MM-DD) + */ + effective_from?: Date; + /** + * Filter pay items with effective_date <= given date (YYYY-MM-DD) + */ + effective_to?: Date; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/pay-items'; }; -export type PostV1TimeoffTimeoffIdDeclineErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1PayItemsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -19945,93 +20481,85 @@ export type PostV1TimeoffTimeoffIdDeclineErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostV1TimeoffTimeoffIdDeclineError = - PostV1TimeoffTimeoffIdDeclineErrors[keyof PostV1TimeoffTimeoffIdDeclineErrors]; +export type GetV1PayItemsError = GetV1PayItemsErrors[keyof GetV1PayItemsErrors]; -export type PostV1TimeoffTimeoffIdDeclineResponses = { +export type GetV1PayItemsResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ListPayItemsResponse; }; -export type PostV1TimeoffTimeoffIdDeclineResponse = - PostV1TimeoffTimeoffIdDeclineResponses[keyof PostV1TimeoffTimeoffIdDeclineResponses]; +export type GetV1PayItemsResponse = + GetV1PayItemsResponses[keyof GetV1PayItemsResponses]; -export type PostV1ContractAmendmentsAutomatableData = { - /** - * Contract Amendment - */ - body?: CreateContractAmendmentParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; +export type GetV1ScimV2UsersData = { + body?: never; path?: never; query?: { /** - * Version of the form schema + * 1-based index of the first result */ - json_schema_version?: number | 'latest'; + startIndex?: number; + /** + * Maximum number of results per page + */ + count?: number; + /** + * Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge) + */ + filter?: string; }; - url: '/v1/contract-amendments/automatable'; + url: '/api/eor/v1/scim/v2/Users'; }; -export type PostV1ContractAmendmentsAutomatableErrors = { +export type GetV1ScimV2UsersErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: IntegrationsScimErrorResponse; /** - * Not Found + * Unauthorized */ - 404: NotFoundResponse; + 401: IntegrationsScimErrorResponse; /** - * Unprocessable Entity + * Forbidden */ - 422: UnprocessableEntityResponse; -}; - -export type PostV1ContractAmendmentsAutomatableError = - PostV1ContractAmendmentsAutomatableErrors[keyof PostV1ContractAmendmentsAutomatableErrors]; - -export type PostV1ContractAmendmentsAutomatableResponses = { + 403: IntegrationsScimErrorResponse; /** - * Success + * Not Found */ - 200: ContractAmendmentAutomatableResponse; + 404: IntegrationsScimErrorResponse; }; -export type PostV1ContractAmendmentsAutomatableResponse = - PostV1ContractAmendmentsAutomatableResponses[keyof PostV1ContractAmendmentsAutomatableResponses]; +export type GetV1ScimV2UsersError = + GetV1ScimV2UsersErrors[keyof GetV1ScimV2UsersErrors]; -export type PostV1TimeoffTimeoffIdApproveData = { +export type GetV1ScimV2UsersResponses = { /** - * ApproveTimeoff + * Success */ - body: ApproveTimeoffParams; + 200: IntegrationsScimUserListResponse; +}; + +export type GetV1ScimV2UsersResponse = + GetV1ScimV2UsersResponses[keyof GetV1ScimV2UsersResponses]; + +export type GetV1ResignationsOffboardingRequestIdData = { + body?: never; path: { /** - * Time Off ID + * Offboarding request ID */ - timeoff_id: string; + offboarding_request_id: string; }; query?: never; - url: '/v1/timeoff/{timeoff_id}/approve'; + url: '/api/eor/v1/resignations/{offboarding_request_id}'; }; -export type PostV1TimeoffTimeoffIdApproveErrors = { +export type GetV1ResignationsOffboardingRequestIdErrors = { /** * Bad Request */ @@ -20054,49 +20582,41 @@ export type PostV1TimeoffTimeoffIdApproveErrors = { 429: TooManyRequestsResponse; }; -export type PostV1TimeoffTimeoffIdApproveError = - PostV1TimeoffTimeoffIdApproveErrors[keyof PostV1TimeoffTimeoffIdApproveErrors]; +export type GetV1ResignationsOffboardingRequestIdError = + GetV1ResignationsOffboardingRequestIdErrors[keyof GetV1ResignationsOffboardingRequestIdErrors]; -export type PostV1TimeoffTimeoffIdApproveResponses = { +export type GetV1ResignationsOffboardingRequestIdResponses = { /** * Success */ - 200: TimeoffResponse; + 200: ResignationResponse; }; -export type PostV1TimeoffTimeoffIdApproveResponse = - PostV1TimeoffTimeoffIdApproveResponses[keyof PostV1TimeoffTimeoffIdApproveResponses]; +export type GetV1ResignationsOffboardingRequestIdResponse = + GetV1ResignationsOffboardingRequestIdResponses[keyof GetV1ResignationsOffboardingRequestIdResponses]; -export type GetV1EmploymentsEmploymentIdFilesData = { +export type GetV1BillingDocumentsBillingDocumentIdBreakdownData = { body?: never; path: { /** - * Employment ID + * The billing document's ID */ - employment_id: string; + billing_document_id: string; }; query?: { /** - * Filter by file type (optional) + * Filters the results by the type of the billing breakdown item. */ type?: string; - /** - * Filter by file sub_type (optional) - */ - sub_type?: string; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; }; - url: '/v1/employments/{employment_id}/files'; + url: '/api/eor/v1/billing-documents/{billing_document_id}/breakdown'; }; -export type GetV1EmploymentsEmploymentIdFilesErrors = { +export type GetV1BillingDocumentsBillingDocumentIdBreakdownErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -20109,76 +20629,97 @@ export type GetV1EmploymentsEmploymentIdFilesErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmploymentsEmploymentIdFilesError = - GetV1EmploymentsEmploymentIdFilesErrors[keyof GetV1EmploymentsEmploymentIdFilesErrors]; +export type GetV1BillingDocumentsBillingDocumentIdBreakdownError = + GetV1BillingDocumentsBillingDocumentIdBreakdownErrors[keyof GetV1BillingDocumentsBillingDocumentIdBreakdownErrors]; -export type GetV1EmploymentsEmploymentIdFilesResponses = { +export type GetV1BillingDocumentsBillingDocumentIdBreakdownResponses = { /** * Success */ - 200: ListFilesResponse; + 200: BillingDocumentBreakdownResponse; }; -export type GetV1EmploymentsEmploymentIdFilesResponse = - GetV1EmploymentsEmploymentIdFilesResponses[keyof GetV1EmploymentsEmploymentIdFilesResponses]; +export type GetV1BillingDocumentsBillingDocumentIdBreakdownResponse = + GetV1BillingDocumentsBillingDocumentIdBreakdownResponses[keyof GetV1BillingDocumentsBillingDocumentIdBreakdownResponses]; -export type GetV1CustomFieldsData = { - body?: never; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; +export type PostV1TimeoffTimeoffIdCancelRequestDeclineData = { + /** + * Timeoff + */ + body: DeclineTimeoffParams; + path: { /** - * Number of items per page + * Time Off ID */ - page_size?: number; + timeoff_id: string; }; - url: '/v1/custom-fields'; + query?: never; + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/decline'; }; -export type GetV1CustomFieldsErrors = { +export type PostV1TimeoffTimeoffIdCancelRequestDeclineErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1CustomFieldsError = - GetV1CustomFieldsErrors[keyof GetV1CustomFieldsErrors]; +export type PostV1TimeoffTimeoffIdCancelRequestDeclineError = + PostV1TimeoffTimeoffIdCancelRequestDeclineErrors[keyof PostV1TimeoffTimeoffIdCancelRequestDeclineErrors]; -export type GetV1CustomFieldsResponses = { +export type PostV1TimeoffTimeoffIdCancelRequestDeclineResponses = { /** * Success */ - 200: ListEmploymentCustomFieldsResponse; + 200: SuccessResponse; }; -export type GetV1CustomFieldsResponse = - GetV1CustomFieldsResponses[keyof GetV1CustomFieldsResponses]; +export type PostV1TimeoffTimeoffIdCancelRequestDeclineResponse = + PostV1TimeoffTimeoffIdCancelRequestDeclineResponses[keyof PostV1TimeoffTimeoffIdCancelRequestDeclineResponses]; -export type PostV1CustomFieldsData = { - /** - * Custom Field Definition Create Parameters - */ - body: CreateCustomFieldDefinitionParams; +export type GetV1PayrollCalendarsData = { + body?: never; path?: never; - query?: never; - url: '/v1/custom-fields'; + query?: { + /** + * Filter payroll calendars by country code + */ + country_code?: string; + /** + * Filter payroll calendars by year + */ + year?: string; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/payroll-calendars'; }; -export type PostV1CustomFieldsErrors = { +export type GetV1PayrollCalendarsErrors = { /** * Unauthorized */ @@ -20193,71 +20734,50 @@ export type PostV1CustomFieldsErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1CustomFieldsError = - PostV1CustomFieldsErrors[keyof PostV1CustomFieldsErrors]; +export type GetV1PayrollCalendarsError = + GetV1PayrollCalendarsErrors[keyof GetV1PayrollCalendarsErrors]; -export type PostV1CustomFieldsResponses = { +export type GetV1PayrollCalendarsResponses = { /** * Success */ - 200: CreateEmploymentCustomFieldResponse; + 200: PayrollCalendarsEorResponse; }; -export type PostV1CustomFieldsResponse = - PostV1CustomFieldsResponses[keyof PostV1CustomFieldsResponses]; +export type GetV1PayrollCalendarsResponse = + GetV1PayrollCalendarsResponses[keyof GetV1PayrollCalendarsResponses]; -export type GetV1CompanyCurrenciesData = { +export type GetV1WdGphPayDetailData = { body?: never; - path?: never; - query?: never; - url: '/v1/company-currencies'; -}; - -export type GetV1CompanyCurrenciesErrors = { - /** - * Not Found - */ - 404: NotFoundResponse; -}; - -export type GetV1CompanyCurrenciesError = - GetV1CompanyCurrenciesErrors[keyof GetV1CompanyCurrenciesErrors]; - -export type GetV1CompanyCurrenciesResponses = { - /** - * Success - */ - 200: CompanyCurrenciesResponse; -}; - -export type GetV1CompanyCurrenciesResponse = - GetV1CompanyCurrenciesResponses[keyof GetV1CompanyCurrenciesResponses]; - -export type PatchV1SandboxEmploymentsEmploymentId2Data = { - /** - * Employment params - */ - body?: EmploymentUpdateParams; - headers: { + headers?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * The preferred language of the inquiring user in Workday */ - Authorization: string; + accept_language?: string; }; - path: { + path?: never; + query: { /** - * Employment ID + * The pay group ID for identifying the pay group at the vendor system */ - employment_id: string; + payGroupExternalId: string; + /** + * The run type id provided in the paySummary API + */ + runTypeId: string; + /** + * The cycle type id, defaults to the main run if not provided + */ + cycleTypeId?: string; + /** + * The period end date in question, defaults to current period if not provided + */ + periodEndDate?: Date; }; - query?: never; - url: '/v1/sandbox/employments/{employment_id}'; + url: '/api/eor/v1/wd/gph/payDetail'; }; -export type PatchV1SandboxEmploymentsEmploymentId2Errors = { +export type GetV1WdGphPayDetailErrors = { /** * Bad Request */ @@ -20270,38 +20790,23 @@ export type PatchV1SandboxEmploymentsEmploymentId2Errors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchV1SandboxEmploymentsEmploymentId2Error = - PatchV1SandboxEmploymentsEmploymentId2Errors[keyof PatchV1SandboxEmploymentsEmploymentId2Errors]; +export type GetV1WdGphPayDetailError = + GetV1WdGphPayDetailErrors[keyof GetV1WdGphPayDetailErrors]; -export type PatchV1SandboxEmploymentsEmploymentId2Responses = { +export type GetV1WdGphPayDetailResponses = { /** * Success */ - 200: EmploymentResponse; + 200: PayDetailResponse; }; -export type PatchV1SandboxEmploymentsEmploymentId2Response = - PatchV1SandboxEmploymentsEmploymentId2Responses[keyof PatchV1SandboxEmploymentsEmploymentId2Responses]; +export type GetV1WdGphPayDetailResponse = + GetV1WdGphPayDetailResponses[keyof GetV1WdGphPayDetailResponses]; -export type PatchV1SandboxEmploymentsEmploymentIdData = { - /** - * Employment params - */ - body?: EmploymentUpdateParams; +export type GetV1ContractAmendmentsSchemaData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -20311,21 +20816,29 @@ export type PatchV1SandboxEmploymentsEmploymentIdData = { */ Authorization: string; }; - path: { + path?: never; + query: { /** - * Employment ID + * The ID of the employment concerned by the contract amendment request. */ employment_id: string; + /** + * Country code according to ISO 3-digit alphabetic codes. + */ + country_code: string; + /** + * Name of the desired form + */ + form?: 'contract_amendment'; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - query?: never; - url: '/v1/sandbox/employments/{employment_id}'; + url: '/api/eor/v1/contract-amendments/schema'; }; -export type PatchV1SandboxEmploymentsEmploymentIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1ContractAmendmentsSchemaErrors = { /** * Unauthorized */ @@ -20334,63 +20847,71 @@ export type PatchV1SandboxEmploymentsEmploymentIdErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type PatchV1SandboxEmploymentsEmploymentIdError = - PatchV1SandboxEmploymentsEmploymentIdErrors[keyof PatchV1SandboxEmploymentsEmploymentIdErrors]; +export type GetV1ContractAmendmentsSchemaError = + GetV1ContractAmendmentsSchemaErrors[keyof GetV1ContractAmendmentsSchemaErrors]; -export type PatchV1SandboxEmploymentsEmploymentIdResponses = { +export type GetV1ContractAmendmentsSchemaResponses = { /** * Success */ - 200: EmploymentResponse; + 200: ContractAmendmentFormResponse; }; -export type PatchV1SandboxEmploymentsEmploymentIdResponse = - PatchV1SandboxEmploymentsEmploymentIdResponses[keyof PatchV1SandboxEmploymentsEmploymentIdResponses]; +export type GetV1ContractAmendmentsSchemaResponse = + GetV1ContractAmendmentsSchemaResponses[keyof GetV1ContractAmendmentsSchemaResponses]; -export type GetV1EmploymentContractsEmploymentIdPendingChangesData = { +export type GetV1TestSchemaData = { body?: never; - headers: { + path?: never; + query?: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Version of the form schema */ - Authorization: string; + json_schema_version?: number | 'latest'; }; + url: '/api/eor/v1/test-schema'; +}; + +export type GetV1TestSchemaResponses = { + /** + * Success + */ + 200: CompanyFormResponse; +}; + +export type GetV1TestSchemaResponse = + GetV1TestSchemaResponses[keyof GetV1TestSchemaResponses]; + +export type PatchV1EmployeeTimeoffId2Data = { + /** + * UpdateTimeoff + */ + body: UpdateEmployeeTimeoffParams; path: { /** - * Employment ID + * Timeoff ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v1/employment-contracts/{employment_id}/pending-changes'; + url: '/api/eor/v1/employee/timeoff/{id}'; }; -export type GetV1EmploymentContractsEmploymentIdPendingChangesErrors = { +export type PatchV1EmployeeTimeoffId2Errors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -20399,34 +20920,41 @@ export type GetV1EmploymentContractsEmploymentIdPendingChangesErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmploymentContractsEmploymentIdPendingChangesError = - GetV1EmploymentContractsEmploymentIdPendingChangesErrors[keyof GetV1EmploymentContractsEmploymentIdPendingChangesErrors]; +export type PatchV1EmployeeTimeoffId2Error = + PatchV1EmployeeTimeoffId2Errors[keyof PatchV1EmployeeTimeoffId2Errors]; -export type GetV1EmploymentContractsEmploymentIdPendingChangesResponses = { +export type PatchV1EmployeeTimeoffId2Responses = { /** * Success */ - 200: EmploymentContractPendingChangesResponse; + 200: TimeoffResponse; }; -export type GetV1EmploymentContractsEmploymentIdPendingChangesResponse = - GetV1EmploymentContractsEmploymentIdPendingChangesResponses[keyof GetV1EmploymentContractsEmploymentIdPendingChangesResponses]; +export type PatchV1EmployeeTimeoffId2Response = + PatchV1EmployeeTimeoffId2Responses[keyof PatchV1EmployeeTimeoffId2Responses]; -export type GetV1ResignationsOffboardingRequestIdData = { - body?: never; +export type PatchV1EmployeeTimeoffIdData = { + /** + * UpdateTimeoff + */ + body: UpdateEmployeeTimeoffParams; path: { /** - * Offboarding request ID + * Timeoff ID */ - offboarding_request_id: string; + id: string; }; query?: never; - url: '/v1/resignations/{offboarding_request_id}'; + url: '/api/eor/v1/employee/timeoff/{id}'; }; -export type GetV1ResignationsOffboardingRequestIdErrors = { +export type PatchV1EmployeeTimeoffIdErrors = { /** * Bad Request */ @@ -20449,95 +20977,101 @@ export type GetV1ResignationsOffboardingRequestIdErrors = { 429: TooManyRequestsResponse; }; -export type GetV1ResignationsOffboardingRequestIdError = - GetV1ResignationsOffboardingRequestIdErrors[keyof GetV1ResignationsOffboardingRequestIdErrors]; +export type PatchV1EmployeeTimeoffIdError = + PatchV1EmployeeTimeoffIdErrors[keyof PatchV1EmployeeTimeoffIdErrors]; -export type GetV1ResignationsOffboardingRequestIdResponses = { +export type PatchV1EmployeeTimeoffIdResponses = { /** * Success */ - 200: ResignationResponse; + 200: TimeoffResponse; }; -export type GetV1ResignationsOffboardingRequestIdResponse = - GetV1ResignationsOffboardingRequestIdResponses[keyof GetV1ResignationsOffboardingRequestIdResponses]; +export type PatchV1EmployeeTimeoffIdResponse = + PatchV1EmployeeTimeoffIdResponses[keyof PatchV1EmployeeTimeoffIdResponses]; -export type PostV1DocumentsData = { - /** - * File - */ - body: FileParams; - headers: { +export type GetV1ScimV2GroupsIdData = { + body?: never; + path: { /** - * This endpoint works with any of the access tokens provided. You can use an access - * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. - * + * Group ID (slug) */ - Authorization: string; + id: string; }; - path?: never; query?: never; - url: '/v1/documents'; + url: '/api/eor/v1/scim/v2/Groups/{id}'; }; -export type PostV1DocumentsErrors = { +export type GetV1ScimV2GroupsIdErrors = { /** * Unauthorized */ - 401: UnauthorizedResponse; + 401: IntegrationsScimErrorResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: IntegrationsScimErrorResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: IntegrationsScimErrorResponse; }; -export type PostV1DocumentsError = - PostV1DocumentsErrors[keyof PostV1DocumentsErrors]; +export type GetV1ScimV2GroupsIdError = + GetV1ScimV2GroupsIdErrors[keyof GetV1ScimV2GroupsIdErrors]; -export type PostV1DocumentsResponses = { +export type GetV1ScimV2GroupsIdResponses = { /** * Success */ - 200: UploadFileResponse; + 200: IntegrationsScimGroup; }; -export type PostV1DocumentsResponse = - PostV1DocumentsResponses[keyof PostV1DocumentsResponses]; +export type GetV1ScimV2GroupsIdResponse = + GetV1ScimV2GroupsIdResponses[keyof GetV1ScimV2GroupsIdResponses]; -export type PostV1EmploymentsEmploymentIdInviteData = { +export type GetV1CountriesCountryCodeLegalEntityFormsFormData = { body?: never; - headers: { + path: { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Country code according to ISO 3-digit alphabetic codes */ - Authorization: string; + country_code: string; + /** + * Name of the desired form + */ + form: string; }; - path: { + query?: { /** - * Employment ID + * Product type. Default value is global_payroll. */ - employment_id: string; + product_type?: 'peo' | 'global_payroll' | 'e2e_payroll'; + /** + * Legal entity id for admistrative_details of e2e payroll products in GBR + */ + legal_entity_id?: UuidSlug; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - query?: never; - url: '/v1/employments/{employment_id}/invite'; + url: '/api/eor/v1/countries/{country_code}/legal_entity_forms/{form}'; }; -export type PostV1EmploymentsEmploymentIdInviteErrors = { +export type GetV1CountriesCountryCodeLegalEntityFormsFormErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Conflict + * Unauthorized */ - 409: ConflictResponse; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; /** * Unprocessable Entity */ @@ -20548,20 +21082,20 @@ export type PostV1EmploymentsEmploymentIdInviteErrors = { 429: TooManyRequestsResponse; }; -export type PostV1EmploymentsEmploymentIdInviteError = - PostV1EmploymentsEmploymentIdInviteErrors[keyof PostV1EmploymentsEmploymentIdInviteErrors]; +export type GetV1CountriesCountryCodeLegalEntityFormsFormError = + GetV1CountriesCountryCodeLegalEntityFormsFormErrors[keyof GetV1CountriesCountryCodeLegalEntityFormsFormErrors]; -export type PostV1EmploymentsEmploymentIdInviteResponses = { +export type GetV1CountriesCountryCodeLegalEntityFormsFormResponses = { /** * Success */ - 200: SuccessResponse; + 200: CountryFormResponse; }; -export type PostV1EmploymentsEmploymentIdInviteResponse = - PostV1EmploymentsEmploymentIdInviteResponses[keyof PostV1EmploymentsEmploymentIdInviteResponses]; +export type GetV1CountriesCountryCodeLegalEntityFormsFormResponse = + GetV1CountriesCountryCodeLegalEntityFormsFormResponses[keyof GetV1CountriesCountryCodeLegalEntityFormsFormResponses]; -export type GetV1ExpensesIdData = { +export type GetV1EmploymentContractsEmploymentIdPendingChangesData = { body?: never; headers: { /** @@ -20574,23 +21108,23 @@ export type GetV1ExpensesIdData = { }; path: { /** - * Expense ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/expenses/{id}'; + url: '/api/eor/v1/employment-contracts/{employment_id}/pending-changes'; }; -export type GetV1ExpensesIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmploymentContractsEmploymentIdPendingChangesErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ @@ -20599,136 +21133,93 @@ export type GetV1ExpensesIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type GetV1ExpensesIdError = - GetV1ExpensesIdErrors[keyof GetV1ExpensesIdErrors]; +export type GetV1EmploymentContractsEmploymentIdPendingChangesError = + GetV1EmploymentContractsEmploymentIdPendingChangesErrors[keyof GetV1EmploymentContractsEmploymentIdPendingChangesErrors]; -export type GetV1ExpensesIdResponses = { +export type GetV1EmploymentContractsEmploymentIdPendingChangesResponses = { /** * Success */ - 200: ExpenseResponse; + 200: EmploymentContractPendingChangesResponse; }; -export type GetV1ExpensesIdResponse = - GetV1ExpensesIdResponses[keyof GetV1ExpensesIdResponses]; +export type GetV1EmploymentContractsEmploymentIdPendingChangesResponse = + GetV1EmploymentContractsEmploymentIdPendingChangesResponses[keyof GetV1EmploymentContractsEmploymentIdPendingChangesResponses]; -export type PatchV1ExpensesId2Data = { +export type PostV1SdkTelemetryErrorsData = { /** - * Expenses + * SDK Error Report */ - body?: UpdateExpenseParams; - path: { - /** - * Expense ID - */ - id: string; - }; + body: SdkErrorPayload; + path?: never; query?: never; - url: '/v1/expenses/{id}'; + url: '/api/eor/v1/sdk/telemetry-errors'; }; -export type PatchV1ExpensesId2Errors = { +export type PostV1SdkTelemetryErrorsErrors = { /** * Bad Request */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; + 400: ErrorResponse; /** - * Too many requests + * Too Many Requests */ - 429: TooManyRequestsResponse; + 429: RateLimitResponse; }; -export type PatchV1ExpensesId2Error = - PatchV1ExpensesId2Errors[keyof PatchV1ExpensesId2Errors]; +export type PostV1SdkTelemetryErrorsError = + PostV1SdkTelemetryErrorsErrors[keyof PostV1SdkTelemetryErrorsErrors]; -export type PatchV1ExpensesId2Responses = { +export type PostV1SdkTelemetryErrorsResponses = { /** - * Success + * No Content */ - 200: ExpenseResponse; + 204: unknown; }; -export type PatchV1ExpensesId2Response = - PatchV1ExpensesId2Responses[keyof PatchV1ExpensesId2Responses]; - -export type PatchV1ExpensesIdData = { - /** - * Expenses - */ - body?: UpdateExpenseParams; +export type GetV1CompaniesCompanyIdComplianceProfileData = { + body?: never; path: { /** - * Expense ID + * Company ID */ - id: string; + company_id: UuidSlug; }; query?: never; - url: '/v1/expenses/{id}'; + url: '/api/eor/v1/companies/{company_id}/compliance-profile'; }; -export type PatchV1ExpensesIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CompaniesCompanyIdComplianceProfileErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; - /** - * Unprocessable Entity + * Forbidden */ - 422: UnprocessableEntityResponse; + 403: ForbiddenResponse; /** - * Too many requests + * Not Found */ - 429: TooManyRequestsResponse; + 404: NotFoundResponse; }; -export type PatchV1ExpensesIdError = - PatchV1ExpensesIdErrors[keyof PatchV1ExpensesIdErrors]; +export type GetV1CompaniesCompanyIdComplianceProfileError = + GetV1CompaniesCompanyIdComplianceProfileErrors[keyof GetV1CompaniesCompanyIdComplianceProfileErrors]; -export type PatchV1ExpensesIdResponses = { +export type GetV1CompaniesCompanyIdComplianceProfileResponses = { /** * Success */ - 200: ExpenseResponse; + 200: CompanyComplianceProfileResponse; }; -export type PatchV1ExpensesIdResponse = - PatchV1ExpensesIdResponses[keyof PatchV1ExpensesIdResponses]; +export type GetV1CompaniesCompanyIdComplianceProfileResponse = + GetV1CompaniesCompanyIdComplianceProfileResponses[keyof GetV1CompaniesCompanyIdComplianceProfileResponses]; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { +export type GetV1PayslipsIdData = { body?: never; headers: { /** @@ -20741,15 +21232,19 @@ export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { }; path: { /** - * Benefit Renewal Request Id + * Payslip ID */ - benefit_renewal_request_id: UuidSlug; + id: string; }; query?: never; - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; + url: '/api/eor/v1/payslips/{id}'; }; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { +export type GetV1PayslipsIdErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -20762,51 +21257,38 @@ export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdError = - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors]; +export type GetV1PayslipsIdError = + GetV1PayslipsIdErrors[keyof GetV1PayslipsIdErrors]; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses = { +export type GetV1PayslipsIdResponses = { /** * Success */ - 200: BenefitRenewalRequestsBenefitRenewalRequestResponse; + 200: PayslipResponse; }; -export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse = - GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses[keyof GetV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses]; +export type GetV1PayslipsIdResponse = + GetV1PayslipsIdResponses[keyof GetV1PayslipsIdResponses]; -export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { - /** - * Benefit Renewal Request Response - */ - body?: BenefitRenewalRequestsUpdateBenefitRenewalRequest; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; +export type PostV1TimeoffTimeoffIdCancelRequestApproveData = { + body?: never; path: { /** - * Benefit Renewal Request Id - */ - benefit_renewal_request_id: UuidSlug; - }; - query?: { - /** - * Version of the form schema + * Time Off ID */ - json_schema_version?: number | 'latest'; + timeoff_id: string; }; - url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; + query?: never; + url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/approve'; }; -export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { +export type PostV1TimeoffTimeoffIdCancelRequestApproveErrors = { /** * Unauthorized */ @@ -20821,32 +21303,64 @@ export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { 429: TooManyRequestsResponse; }; -export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdError = - PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors[keyof PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors]; +export type PostV1TimeoffTimeoffIdCancelRequestApproveError = + PostV1TimeoffTimeoffIdCancelRequestApproveErrors[keyof PostV1TimeoffTimeoffIdCancelRequestApproveErrors]; -export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses = { +export type PostV1TimeoffTimeoffIdCancelRequestApproveResponses = { /** * Success */ 200: SuccessResponse; }; -export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponse = - PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses[keyof PostV1BenefitRenewalRequestsBenefitRenewalRequestIdResponses]; +export type PostV1TimeoffTimeoffIdCancelRequestApproveResponse = + PostV1TimeoffTimeoffIdCancelRequestApproveResponses[keyof PostV1TimeoffTimeoffIdCancelRequestApproveResponses]; -export type GetV1EmploymentsEmploymentIdOnboardingStepsData = { +export type GetV1WebhookEventsData = { body?: never; - path: { + path?: never; + query?: { /** - * Employment ID + * Filter by webhook event type */ - employment_id: UuidSlug; + event_type?: string; + /** + * Filter by delivery status (true = 200, false = 4xx/5xx) + */ + successfully_delivered?: boolean; + /** + * Filter by company ID + */ + company_id?: string; + /** + * Filter by date before (ISO 8601 format) + */ + before?: string; + /** + * Filter by date after (ISO 8601 format) + */ + after?: string; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + /** + * Field to sort by + */ + sort_by?: 'first_triggered_at'; + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; }; - query?: never; - url: '/v1/employments/{employment_id}/onboarding-steps'; + url: '/api/eor/v1/webhook-events'; }; -export type GetV1EmploymentsEmploymentIdOnboardingStepsErrors = { +export type GetV1WebhookEventsErrors = { /** * Unauthorized */ @@ -20855,34 +21369,51 @@ export type GetV1EmploymentsEmploymentIdOnboardingStepsErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type GetV1EmploymentsEmploymentIdOnboardingStepsError = - GetV1EmploymentsEmploymentIdOnboardingStepsErrors[keyof GetV1EmploymentsEmploymentIdOnboardingStepsErrors]; +export type GetV1WebhookEventsError = + GetV1WebhookEventsErrors[keyof GetV1WebhookEventsErrors]; -export type GetV1EmploymentsEmploymentIdOnboardingStepsResponses = { +export type GetV1WebhookEventsResponses = { /** * Success */ - 200: EmploymentOnboardingStepsResponse; + 200: ListWebhookEventsResponse; }; -export type GetV1EmploymentsEmploymentIdOnboardingStepsResponse = - GetV1EmploymentsEmploymentIdOnboardingStepsResponses[keyof GetV1EmploymentsEmploymentIdOnboardingStepsResponses]; +export type GetV1WebhookEventsResponse = + GetV1WebhookEventsResponses[keyof GetV1WebhookEventsResponses]; -export type GetV1EmploymentsEmploymentIdCompanyStructureNodesData = { +export type GetV1TimeoffTypesData = { body?: never; - path: { + headers: { /** - * Employment ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - employment_id: string; + Authorization: string; }; - query?: never; - url: '/v1/employments/{employment_id}/company-structure-nodes'; + path?: never; + query?: { + /** + * Optional. Employment type to list time off types for: `contractor` or `full_time`. Omit for backward-compatible behavior (full-time types). + */ + type?: TimeoffTypesEmploymentType; + }; + url: '/api/eor/v1/timeoff/types'; }; -export type GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors = { +export type GetV1TimeoffTypesErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -20895,28 +21426,32 @@ export type GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmploymentsEmploymentIdCompanyStructureNodesError = - GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors[keyof GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors]; +export type GetV1TimeoffTypesError = + GetV1TimeoffTypesErrors[keyof GetV1TimeoffTypesErrors]; -export type GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses = { +export type GetV1TimeoffTypesResponses = { /** * Success */ - 200: CompanyStructureNodesResponse; + 200: ListTimeoffTypesResponse; }; -export type GetV1EmploymentsEmploymentIdCompanyStructureNodesResponse = - GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses[keyof GetV1EmploymentsEmploymentIdCompanyStructureNodesResponses]; +export type GetV1TimeoffTypesResponse = + GetV1TimeoffTypesResponses[keyof GetV1TimeoffTypesResponses]; -export type GetV1EmploymentsEmploymentIdCustomFieldsData = { +export type GetV1CompaniesCompanyIdLegalEntitiesData = { body?: never; path: { /** - * Employment ID + * Company ID */ - employment_id: string; + company_id: UuidSlug; }; query?: { /** @@ -20928,10 +21463,10 @@ export type GetV1EmploymentsEmploymentIdCustomFieldsData = { */ page_size?: number; }; - url: '/v1/employments/{employment_id}/custom-fields'; + url: '/api/eor/v1/companies/{company_id}/legal-entities'; }; -export type GetV1EmploymentsEmploymentIdCustomFieldsErrors = { +export type GetV1CompaniesCompanyIdLegalEntitiesErrors = { /** * Unauthorized */ @@ -20940,53 +21475,41 @@ export type GetV1EmploymentsEmploymentIdCustomFieldsErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type GetV1EmploymentsEmploymentIdCustomFieldsError = - GetV1EmploymentsEmploymentIdCustomFieldsErrors[keyof GetV1EmploymentsEmploymentIdCustomFieldsErrors]; +export type GetV1CompaniesCompanyIdLegalEntitiesError = + GetV1CompaniesCompanyIdLegalEntitiesErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesErrors]; -export type GetV1EmploymentsEmploymentIdCustomFieldsResponses = { +export type GetV1CompaniesCompanyIdLegalEntitiesResponses = { /** * Success */ - 200: ListEmploymentCustomFieldValuePaginatedResponse; + 200: ListCompanyLegalEntitiesResponse; }; -export type GetV1EmploymentsEmploymentIdCustomFieldsResponse = - GetV1EmploymentsEmploymentIdCustomFieldsResponses[keyof GetV1EmploymentsEmploymentIdCustomFieldsResponses]; +export type GetV1CompaniesCompanyIdLegalEntitiesResponse = + GetV1CompaniesCompanyIdLegalEntitiesResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesResponses]; -export type PutV1ResignationsOffboardingRequestIdValidateData = { +export type PostV1EmploymentsEmploymentIdContractEligibilityData = { /** - * ValidateResignation + * Contract Eligibility Create Parameters */ - body: ValidateResignationRequestParams; + body: CreateContractEligibilityParams; path: { /** - * Offboarding request ID + * Employment ID */ - offboarding_request_id: string; + employment_id: string; }; query?: never; - url: '/v1/resignations/{offboarding_request_id}/validate'; + url: '/api/eor/v1/employments/{employment_id}/contract-eligibility'; }; -export type PutV1ResignationsOffboardingRequestIdValidateErrors = { +export type PostV1EmploymentsEmploymentIdContractEligibilityErrors = { /** * Bad Request */ 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; /** * Unprocessable Entity */ @@ -20997,179 +21520,111 @@ export type PutV1ResignationsOffboardingRequestIdValidateErrors = { 429: TooManyRequestsResponse; }; -export type PutV1ResignationsOffboardingRequestIdValidateError = - PutV1ResignationsOffboardingRequestIdValidateErrors[keyof PutV1ResignationsOffboardingRequestIdValidateErrors]; +export type PostV1EmploymentsEmploymentIdContractEligibilityError = + PostV1EmploymentsEmploymentIdContractEligibilityErrors[keyof PostV1EmploymentsEmploymentIdContractEligibilityErrors]; -export type PutV1ResignationsOffboardingRequestIdValidateResponses = { +export type PostV1EmploymentsEmploymentIdContractEligibilityResponses = { /** * Success */ 200: SuccessResponse; }; -export type PutV1ResignationsOffboardingRequestIdValidateResponse = - PutV1ResignationsOffboardingRequestIdValidateResponses[keyof PutV1ResignationsOffboardingRequestIdValidateResponses]; +export type PostV1EmploymentsEmploymentIdContractEligibilityResponse = + PostV1EmploymentsEmploymentIdContractEligibilityResponses[keyof PostV1EmploymentsEmploymentIdContractEligibilityResponses]; -export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData = - { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { - /** - * Company ID - */ - company_id: string; - /** - * Legal Entity ID to set as the new default - */ - legal_entity_id: string; - }; - query?: never; - url: '/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}'; +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData = { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; }; - -export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors = - { + query?: { /** - * Bad Request + * Restrict to currencies which payout is guaranteed (default: true) */ - 400: BadRequestResponse; + restrict_to_guaranteed_pay_out_currencies?: boolean; + }; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-currencies'; +}; + +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors = + { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; /** - * Too many requests + * Internal Server Error */ - 429: TooManyRequestsResponse; + 500: InternalServerErrorResponse; }; -export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdError = - PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors[keyof PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors]; +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesError = + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors]; -export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses = +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses = { /** * Success */ - 200: SuccessResponse; + 200: ContractorCurrencyResponse; }; -export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponse = - PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses[keyof PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdResponses]; +export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponse = + GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesResponses]; -export type GetV1CompaniesCompanyIdWebhookCallbacksData = { +export type GetV1PayslipsData = { body?: never; - path: { + path?: never; + query?: { /** - * Company ID + * Employment ID */ - company_id: string; - }; - query?: never; - url: '/v1/companies/{company_id}/webhook-callbacks'; -}; - -export type GetV1CompaniesCompanyIdWebhookCallbacksErrors = { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; -}; - -export type GetV1CompaniesCompanyIdWebhookCallbacksError = - GetV1CompaniesCompanyIdWebhookCallbacksErrors[keyof GetV1CompaniesCompanyIdWebhookCallbacksErrors]; - -export type GetV1CompaniesCompanyIdWebhookCallbacksResponses = { - /** - * Success - */ - 200: ListWebhookCallbacksResponse; -}; - -export type GetV1CompaniesCompanyIdWebhookCallbacksResponse = - GetV1CompaniesCompanyIdWebhookCallbacksResponses[keyof GetV1CompaniesCompanyIdWebhookCallbacksResponses]; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityData = - { - body?: never; - path: { - /** - * Company ID - */ - company_id: UuidSlug; - /** - * Legal entity ID - */ - legal_entity_id: UuidSlug; - }; - query?: never; - url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility'; - }; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors = - { + employment_id?: string; /** - * Unauthorized + * Filters by payslips `issued_at` field, after or on the same day than the given date */ - 401: UnauthorizedResponse; + start_date?: string; /** - * Not Found + * Filters by payslips `issued_at` field, before or or the same day than the given date */ - 404: NotFoundResponse; - }; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityError = - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors]; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses = - { + end_date?: string; /** - * Success + * Filters by payslips `expected_payout_date` field, after or on the same day than the given date */ - 200: ContractorEligibilityResponse; - }; - -export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponse = - GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses[keyof GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityResponses]; - -export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { - body?: never; - path: { + expected_payout_start_date?: string; /** - * Custom field ID + * Filters by payslips `expected_payout_date` field, before or or the same day than the given date */ - custom_field_id: string; + expected_payout_end_date?: string; /** - * Employment ID + * Starts fetching records after the given page */ - employment_id: string; + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; }; - query?: never; - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/api/eor/v1/payslips'; }; -export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { +export type GetV1PayslipsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -21182,49 +21637,52 @@ export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdError = - GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors[keyof GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors]; +export type GetV1PayslipsError = GetV1PayslipsErrors[keyof GetV1PayslipsErrors]; -export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses = { +export type GetV1PayslipsResponses = { /** * Success */ - 200: EmploymentCustomFieldValueResponse; + 200: ListPayslipsResponse; }; -export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse = - GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses[keyof GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses]; +export type GetV1PayslipsResponse = + GetV1PayslipsResponses[keyof GetV1PayslipsResponses]; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data = { +export type PostV1SandboxEmploymentsData = { /** - * Custom Field Value Update Parameters + * Employment params */ - body: UpdateEmploymentCustomFieldValueParams; - path: { - /** - * Custom field ID - */ - custom_field_id: string; + body?: EmploymentCreateParams; + headers: { /** - * Employment ID + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * */ - employment_id: string; + Authorization: string; }; + path?: never; query?: never; - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/api/eor/v1/sandbox/employments'; }; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors = { +export type PostV1SandboxEmploymentsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ @@ -21233,49 +21691,42 @@ export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; }; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Error = - PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors]; +export type PostV1SandboxEmploymentsError = + PostV1SandboxEmploymentsErrors[keyof PostV1SandboxEmploymentsErrors]; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses = { +export type PostV1SandboxEmploymentsResponses = { /** * Success */ - 200: EmploymentCustomFieldValueResponse; + 201: EmploymentCreationResponse; }; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Response = - PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses]; +export type PostV1SandboxEmploymentsResponse = + PostV1SandboxEmploymentsResponses[keyof PostV1SandboxEmploymentsResponses]; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { - /** - * Custom Field Value Update Parameters - */ - body: UpdateEmploymentCustomFieldValueParams; +export type GetV1PayrollRunsPayrollRunIdData = { + body?: never; path: { /** - * Custom field ID - */ - custom_field_id: string; - /** - * Employment ID + * Payroll run ID */ - employment_id: string; + payroll_run_id: string; }; query?: never; - url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/api/eor/v1/payroll-runs/{payroll_run_id}'; }; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { +export type GetV1PayrollRunsPayrollRunIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; /** * Not Found */ @@ -21286,63 +21737,20 @@ export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { 422: UnprocessableEntityResponse; }; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdError = - PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors]; +export type GetV1PayrollRunsPayrollRunIdError = + GetV1PayrollRunsPayrollRunIdErrors[keyof GetV1PayrollRunsPayrollRunIdErrors]; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses = { +export type GetV1PayrollRunsPayrollRunIdResponses = { /** * Success */ - 200: EmploymentCustomFieldValueResponse; + 200: PayrollRunResponse; }; -export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse = - PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses]; - -export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdData = - { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - /** - * Termination Request ID - */ - termination_request_id: string; - }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}'; - }; - -export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors = - { - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - }; - -export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdError = - GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors[keyof GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors]; - -export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses = - { - /** - * Success - */ - 200: CorTerminationRequestResponse; - }; - -export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponse = - GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses[keyof GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdResponses]; +export type GetV1PayrollRunsPayrollRunIdResponse = + GetV1PayrollRunsPayrollRunIdResponses[keyof GetV1PayrollRunsPayrollRunIdResponses]; -export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData = +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsData = { body?: never; path: { @@ -21352,15 +21760,15 @@ export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData = employment_id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/terminate-cor-employment'; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements'; }; -export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors = +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ @@ -21369,88 +21777,35 @@ export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentError = - PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors[keyof PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors]; - -export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses = - { - /** - * Success - */ - 200: SuccessResponse; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponse = - PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses[keyof PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentResponses]; - -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignData = - { - /** - * SignContractDocument - */ - body: SignContractDocument; - path: { - /** - * Employment ID - */ - employment_id: string; - /** - * Document ID - */ - contract_document_id: string; - }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign'; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors = - { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignError = - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors]; +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsError = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors]; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses = +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses = { /** * Success */ - 200: SuccessResponse; + 200: IndexPreOnboardingDocumentRequirementsResponse; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponse = - PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignResponses]; +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponse = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsResponses]; -export type GetV1IdentityCurrentData = { +export type GetV1OffboardingsIdData = { body?: never; - headers: { + path: { /** - * This endpoint works with any of the access tokens provided. You can use an access - * token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow. - * + * Offboarding request ID */ - Authorization: string; + id: string; }; - path?: never; query?: never; - url: '/v1/identity/current'; + url: '/api/eor/v1/offboardings/{id}'; }; -export type GetV1IdentityCurrentErrors = { +export type GetV1OffboardingsIdErrors = { /** * Bad Request */ @@ -21473,20 +21828,20 @@ export type GetV1IdentityCurrentErrors = { 429: TooManyRequestsResponse; }; -export type GetV1IdentityCurrentError = - GetV1IdentityCurrentErrors[keyof GetV1IdentityCurrentErrors]; +export type GetV1OffboardingsIdError = + GetV1OffboardingsIdErrors[keyof GetV1OffboardingsIdErrors]; -export type GetV1IdentityCurrentResponses = { +export type GetV1OffboardingsIdResponses = { /** * Success */ - 201: IdentityCurrentResponse; + 200: OffboardingResponse; }; -export type GetV1IdentityCurrentResponse = - GetV1IdentityCurrentResponses[keyof GetV1IdentityCurrentResponses]; +export type GetV1OffboardingsIdResponse = + GetV1OffboardingsIdResponses[keyof GetV1OffboardingsIdResponses]; -export type DeleteV1IncentivesIdData = { +export type GetV1ExpensesData = { body?: never; headers: { /** @@ -21497,17 +21852,21 @@ export type DeleteV1IncentivesIdData = { */ Authorization: string; }; - path: { + path?: never; + query?: { /** - * Incentive ID + * Starts fetching records after the given page */ - id: string; + page?: number; + /** + * Change the amount of records returned per page, defaults to 20, limited to 100 + */ + page_size?: number; }; - query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/expenses'; }; -export type DeleteV1IncentivesIdErrors = { +export type GetV1ExpensesErrors = { /** * Bad Request */ @@ -21520,10 +21879,6 @@ export type DeleteV1IncentivesIdErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ @@ -21534,21 +21889,23 @@ export type DeleteV1IncentivesIdErrors = { 429: TooManyRequestsResponse; }; -export type DeleteV1IncentivesIdError = - DeleteV1IncentivesIdErrors[keyof DeleteV1IncentivesIdErrors]; +export type GetV1ExpensesError = GetV1ExpensesErrors[keyof GetV1ExpensesErrors]; -export type DeleteV1IncentivesIdResponses = { +export type GetV1ExpensesResponses = { /** * Success */ - 200: SuccessResponse; + 201: ListExpenseResponse; }; -export type DeleteV1IncentivesIdResponse = - DeleteV1IncentivesIdResponses[keyof DeleteV1IncentivesIdResponses]; +export type GetV1ExpensesResponse = + GetV1ExpensesResponses[keyof GetV1ExpensesResponses]; -export type GetV1IncentivesIdData = { - body?: never; +export type PostV1ExpensesData = { + /** + * Expenses + */ + body?: ParamsToCreateExpense; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -21558,17 +21915,12 @@ export type GetV1IncentivesIdData = { */ Authorization: string; }; - path: { - /** - * Incentive ID - */ - id: string; - }; + path?: never; query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/expenses'; }; -export type GetV1IncentivesIdErrors = { +export type PostV1ExpensesErrors = { /** * Bad Request */ @@ -21591,24 +21943,65 @@ export type GetV1IncentivesIdErrors = { 429: TooManyRequestsResponse; }; -export type GetV1IncentivesIdError = - GetV1IncentivesIdErrors[keyof GetV1IncentivesIdErrors]; +export type PostV1ExpensesError = + PostV1ExpensesErrors[keyof PostV1ExpensesErrors]; -export type GetV1IncentivesIdResponses = { +export type PostV1ExpensesResponses = { + /** + * Success + */ + 201: ExpenseResponse; +}; + +export type PostV1ExpensesResponse = + PostV1ExpensesResponses[keyof PostV1ExpensesResponses]; + +export type GetV1EmployeePayslipFilesData = { + body?: never; + path?: never; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employee/payslip-files'; +}; + +export type GetV1EmployeePayslipFilesErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1EmployeePayslipFilesError = + GetV1EmployeePayslipFilesErrors[keyof GetV1EmployeePayslipFilesErrors]; + +export type GetV1EmployeePayslipFilesResponses = { /** * Success */ - 200: IncentiveResponse; + 200: ListPayslipFilesResponse; }; -export type GetV1IncentivesIdResponse = - GetV1IncentivesIdResponses[keyof GetV1IncentivesIdResponses]; +export type GetV1EmployeePayslipFilesResponse = + GetV1EmployeePayslipFilesResponses[keyof GetV1EmployeePayslipFilesResponses]; -export type PatchV1IncentivesId2Data = { - /** - * Incentive - */ - body?: UpdateIncentiveParams; +export type PostV1EmploymentsEmploymentIdInviteData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -21620,27 +22013,19 @@ export type PatchV1IncentivesId2Data = { }; path: { /** - * Incentive ID + * Employment ID */ - id: string; + employment_id: string; }; query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/employments/{employment_id}/invite'; }; -export type PatchV1IncentivesId2Errors = { +export type PostV1EmploymentsEmploymentIdInviteErrors = { /** * Bad Request */ 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; /** * Conflict */ @@ -21650,49 +22035,35 @@ export type PatchV1IncentivesId2Errors = { */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type PatchV1IncentivesId2Error = - PatchV1IncentivesId2Errors[keyof PatchV1IncentivesId2Errors]; +export type PostV1EmploymentsEmploymentIdInviteError = + PostV1EmploymentsEmploymentIdInviteErrors[keyof PostV1EmploymentsEmploymentIdInviteErrors]; -export type PatchV1IncentivesId2Responses = { +export type PostV1EmploymentsEmploymentIdInviteResponses = { /** * Success */ - 200: IncentiveResponse; + 200: SuccessResponse; }; -export type PatchV1IncentivesId2Response = - PatchV1IncentivesId2Responses[keyof PatchV1IncentivesId2Responses]; +export type PostV1EmploymentsEmploymentIdInviteResponse = + PostV1EmploymentsEmploymentIdInviteResponses[keyof PostV1EmploymentsEmploymentIdInviteResponses]; -export type PatchV1IncentivesIdData = { +export type PostV1ProbationExtensionsData = { /** - * Incentive + * ProbationExtension */ - body?: UpdateIncentiveParams; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path: { - /** - * Incentive ID - */ - id: string; - }; + body: CreateProbationExtensionParams; + path?: never; query?: never; - url: '/v1/incentives/{id}'; + url: '/api/eor/v1/probation-extensions'; }; -export type PatchV1IncentivesIdErrors = { +export type PostV1ProbationExtensionsErrors = { /** * Bad Request */ @@ -21705,50 +22076,136 @@ export type PatchV1IncentivesIdErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PatchV1IncentivesIdError = - PatchV1IncentivesIdErrors[keyof PatchV1IncentivesIdErrors]; +export type PostV1ProbationExtensionsError = + PostV1ProbationExtensionsErrors[keyof PostV1ProbationExtensionsErrors]; -export type PatchV1IncentivesIdResponses = { +export type PostV1ProbationExtensionsResponses = { /** * Success */ - 200: IncentiveResponse; + 200: ProbationExtensionResponse; }; -export type PatchV1IncentivesIdResponse = - PatchV1IncentivesIdResponses[keyof PatchV1IncentivesIdResponses]; +export type PostV1ProbationExtensionsResponse = + PostV1ProbationExtensionsResponses[keyof PostV1ProbationExtensionsResponses]; -export type GetV1ContractorsSchemasEligibilityQuestionnaireData = { - body?: never; - path?: never; - query: { +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData = + { + body?: never; + path: { + /** + * Contract amendment request ID + */ + contract_amendment_request_id: string; + }; + query?: never; + url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve'; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors = + { /** - * Type of eligibility questionnaire + * Bad Request */ - type: 'contractor_of_record'; + 400: BadRequestResponse; /** - * Version of the form schema + * Unauthorized */ - json_schema_version?: number | 'latest'; + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Too many requests + */ + 429: TooManyRequestsResponse; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveError = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors]; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses = + { + /** + * Success + */ + 200: ContractAmendmentResponse; + }; + +export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponse = + PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveResponses]; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusData = + { + body?: never; + path: { + /** + * Company ID + */ + company_id: UuidSlug; + /** + * Employment ID + */ + employment_id: UuidSlug; + }; + query?: never; + url: '/api/eor/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status'; + }; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + }; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusError = + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors[keyof GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors]; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses = + { + /** + * Success + */ + 200: OnboardingReservesStatusResponse; + }; + +export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponse = + GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses[keyof GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusResponses]; + +export type GetV1ContractorInvoicesIdData = { + body?: never; + path: { + /** + * Resource unique identifier + */ + id: UuidSlug; }; - url: '/v1/contractors/schemas/eligibility-questionnaire'; + query?: never; + url: '/api/eor/v1/contractor-invoices/{id}'; }; -export type GetV1ContractorsSchemasEligibilityQuestionnaireErrors = { +export type GetV1ContractorInvoicesIdErrors = { /** * Unauthorized */ @@ -21757,108 +22214,167 @@ export type GetV1ContractorsSchemasEligibilityQuestionnaireErrors = { * Forbidden */ 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type GetV1ContractorsSchemasEligibilityQuestionnaireError = - GetV1ContractorsSchemasEligibilityQuestionnaireErrors[keyof GetV1ContractorsSchemasEligibilityQuestionnaireErrors]; +export type GetV1ContractorInvoicesIdError = + GetV1ContractorInvoicesIdErrors[keyof GetV1ContractorInvoicesIdErrors]; -export type GetV1ContractorsSchemasEligibilityQuestionnaireResponses = { +export type GetV1ContractorInvoicesIdResponses = { /** * Success */ - 200: EligibilityQuestionnaireJsonSchemaResponse; + 200: ContractorInvoiceResponse; }; -export type GetV1ContractorsSchemasEligibilityQuestionnaireResponse = - GetV1ContractorsSchemasEligibilityQuestionnaireResponses[keyof GetV1ContractorsSchemasEligibilityQuestionnaireResponses]; +export type GetV1ContractorInvoicesIdResponse = + GetV1ContractorInvoicesIdResponses[keyof GetV1ContractorInvoicesIdResponses]; -export type GetV1WorkAuthorizationRequestsData = { +export type GetV1WdGphPayProcessingFeatureData = { body?: never; path?: never; - query?: { - /** - * Filter results on the given status - */ - status?: - | 'pending' - | 'cancelled' - | 'declined_by_manager' - | 'declined_by_remote' - | 'approved_by_manager' - | 'approved_by_remote'; - /** - * Filter results on the given employment slug - */ - employment_id?: string; + query?: never; + url: '/api/eor/v1/wd/gph/payProcessingFeature'; +}; + +export type GetV1WdGphPayProcessingFeatureErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1WdGphPayProcessingFeatureError = + GetV1WdGphPayProcessingFeatureErrors[keyof GetV1WdGphPayProcessingFeatureErrors]; + +export type GetV1WdGphPayProcessingFeatureResponses = { + /** + * Success + */ + 200: PayProcessingFeatureResponse; +}; + +export type GetV1WdGphPayProcessingFeatureResponse = + GetV1WdGphPayProcessingFeatureResponses[keyof GetV1WdGphPayProcessingFeatureResponses]; + +export type GetV1WdGphPayProgressData = { + body?: never; + headers?: { /** - * Filter results on the given employee name + * The preferred language of the inquiring user in Workday */ - employee_name?: string; + accept_language?: string; + }; + path?: never; + query: { /** - * Sort order + * The pay group ID for identifying the pay group at the vendor system */ - order?: 'asc' | 'desc'; + payGroupExternalId: string; /** - * Field to sort by + * The run type id provided in the paySummary API */ - sort_by?: 'submitted_at'; + runTypeId: string; /** - * Starts fetching records after the given page + * The cycle type id, defaults to the main run if not provided */ - page?: number; + cycleTypeId?: string; /** - * Number of items per page + * The period end date in question, defaults to current period if not provided */ - page_size?: number; + periodEndDate?: Date; }; - url: '/v1/work-authorization-requests'; + url: '/api/eor/v1/wd/gph/payProgress'; }; -export type GetV1WorkAuthorizationRequestsErrors = { +export type GetV1WdGphPayProgressErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Not Found */ 404: NotFoundResponse; +}; + +export type GetV1WdGphPayProgressError = + GetV1WdGphPayProgressErrors[keyof GetV1WdGphPayProgressErrors]; + +export type GetV1WdGphPayProgressResponses = { /** - * Unprocessable Entity + * Success */ - 422: UnprocessableEntityResponse; + 200: PayProgressResponse; }; -export type GetV1WorkAuthorizationRequestsError = - GetV1WorkAuthorizationRequestsErrors[keyof GetV1WorkAuthorizationRequestsErrors]; +export type GetV1WdGphPayProgressResponse = + GetV1WdGphPayProgressResponses[keyof GetV1WdGphPayProgressResponses]; -export type GetV1WorkAuthorizationRequestsResponses = { +export type GetV1CompanyCurrenciesData = { + body?: never; + path?: never; + query?: never; + url: '/api/eor/v1/company-currencies'; +}; + +export type GetV1CompanyCurrenciesErrors = { + /** + * Not Found + */ + 404: NotFoundResponse; +}; + +export type GetV1CompanyCurrenciesError = + GetV1CompanyCurrenciesErrors[keyof GetV1CompanyCurrenciesErrors]; + +export type GetV1CompanyCurrenciesResponses = { /** * Success */ - 200: ListWorkAuthorizationRequestsResponse; + 200: CompanyCurrenciesResponse; }; -export type GetV1WorkAuthorizationRequestsResponse = - GetV1WorkAuthorizationRequestsResponses[keyof GetV1WorkAuthorizationRequestsResponses]; +export type GetV1CompanyCurrenciesResponse = + GetV1CompanyCurrenciesResponses[keyof GetV1CompanyCurrenciesResponses]; -export type GetV1BulkEmploymentJobsJobIdData = { +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaData = { body?: never; path: { /** - * Bulk employment job id + * Unique identifier of the employment */ - job_id: string; + employment_id: UuidSlug; }; - query?: never; - url: '/v1/bulk-employment-jobs/{job_id}'; + query?: { + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v1/employments/{employment_id}/benefit-offers/schema'; }; -export type GetV1BulkEmploymentJobsJobIdErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors = { /** * Forbidden */ @@ -21870,38 +22386,71 @@ export type GetV1BulkEmploymentJobsJobIdErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1BulkEmploymentJobsJobIdError = - GetV1BulkEmploymentJobsJobIdErrors[keyof GetV1BulkEmploymentJobsJobIdErrors]; +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaError = + GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors[keyof GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors]; -export type GetV1BulkEmploymentJobsJobIdResponses = { +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses = { /** * Success */ - 200: BulkEmploymentImportJobResponse; + 200: UnifiedEmploymentsBenefitOffersJsonSchemaResponse; }; -export type GetV1BulkEmploymentJobsJobIdResponse = - GetV1BulkEmploymentJobsJobIdResponses[keyof GetV1BulkEmploymentJobsJobIdResponses]; +export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponse = + GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses[keyof GetV1EmploymentsEmploymentIdBenefitOffersSchemaResponses]; -export type GetV1PayItemsData = { +export type GetV1ContractorInvoiceSchedulesData = { body?: never; path?: never; query?: { /** - * Filter by employment slug + * Filters contractor invoice schedules by start date greater than or equal to the value. */ - employment_slug?: UuidSlug; + start_date_from?: Date; /** - * Filter pay items with effective_date >= given date (YYYY-MM-DD) + * Filters contractor invoice schedules by start date less than or equal to the value. */ - effective_from?: Date; + start_date_to?: Date; /** - * Filter pay items with effective_date <= given date (YYYY-MM-DD) + * Filters contractor invoice schedules by next invoice date greater than or equal to the value. */ - effective_to?: Date; + next_invoice_date_from?: Date; + /** + * Filters contractor invoice schedules by next invoice date less than or equal to the value. + */ + next_invoice_date_to?: Date; + /** + * Filters contractor invoice schedules by status matching the value. + */ + status?: ContractorInvoiceScheduleStatus; + /** + * Filters contractor invoice schedules by employment id matching the value. + */ + employment_id?: UuidSlug; + /** + * Filters contractor invoice schedules by periodicity matching the value. + */ + periodicity?: ContractorInvoiceSchedulePeriodicity; + /** + * Filters contractor invoice schedules by currency matching the value. + */ + currency?: string; + /** + * Field to sort by + */ + sort_by?: + | 'number' + | 'total_amount' + | 'next_invoice_at' + | 'start_date' + | 'nr_occurrences'; + /** + * Sort order + */ + order?: 'asc' | 'desc'; /** * Starts fetching records after the given page */ @@ -21911,10 +22460,10 @@ export type GetV1PayItemsData = { */ page_size?: number; }; - url: '/v1/pay-items'; + url: '/api/eor/v1/contractor-invoice-schedules'; }; -export type GetV1PayItemsErrors = { +export type GetV1ContractorInvoiceSchedulesErrors = { /** * Unauthorized */ @@ -21927,176 +22476,97 @@ export type GetV1PayItemsErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; }; -export type GetV1PayItemsError = GetV1PayItemsErrors[keyof GetV1PayItemsErrors]; +export type GetV1ContractorInvoiceSchedulesError = + GetV1ContractorInvoiceSchedulesErrors[keyof GetV1ContractorInvoiceSchedulesErrors]; -export type GetV1PayItemsResponses = { +export type GetV1ContractorInvoiceSchedulesResponses = { /** * Success */ - 200: ListPayItemsResponse; -}; - -export type GetV1PayItemsResponse = - GetV1PayItemsResponses[keyof GetV1PayItemsResponses]; - -export type GetV1BenefitOffersCountrySummariesData = { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query?: never; - url: '/v1/benefit-offers/country-summaries'; -}; - -export type GetV1BenefitOffersCountrySummariesErrors = { - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; + 200: ListContractorInvoiceSchedulesResponse; }; -export type GetV1BenefitOffersCountrySummariesError = - GetV1BenefitOffersCountrySummariesErrors[keyof GetV1BenefitOffersCountrySummariesErrors]; +export type GetV1ContractorInvoiceSchedulesResponse = + GetV1ContractorInvoiceSchedulesResponses[keyof GetV1ContractorInvoiceSchedulesResponses]; -export type GetV1BenefitOffersCountrySummariesResponses = { +export type PostV1ContractorInvoiceSchedulesData = { /** - * Success + * Bulk creation payload */ - 200: CountrySummariesResponse; -}; - -export type GetV1BenefitOffersCountrySummariesResponse = - GetV1BenefitOffersCountrySummariesResponses[keyof GetV1BenefitOffersCountrySummariesResponses]; - -export type GetV1BenefitOffersData = { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; + body: BulkContractorInvoiceScheduleCreateParams; path?: never; query?: never; - url: '/v1/benefit-offers'; + url: '/api/eor/v1/contractor-invoice-schedules'; }; -export type GetV1BenefitOffersErrors = { +export type PostV1ContractorInvoiceSchedulesErrors = { + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; -}; - -export type GetV1BenefitOffersError = - GetV1BenefitOffersErrors[keyof GetV1BenefitOffersErrors]; - -export type GetV1BenefitOffersResponses = { /** - * Success + * BulkContractorInvoiceScheduleCreateResponse + * + * Response containing the lists of succeeded and failed schedules. */ - 200: BenefitOfferByEmploymentResponse; -}; - -export type GetV1BenefitOffersResponse = - GetV1BenefitOffersResponses[keyof GetV1BenefitOffersResponses]; - -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData = - { - body?: never; - path: { - /** - * Contract amendment request ID - */ - contract_amendment_request_id: string; - }; - query?: never; - url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel'; - }; - -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors = - { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; + 422: { + data: { + failures: Array; + successes: Array; + }; }; +}; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelError = - PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors]; +export type PostV1ContractorInvoiceSchedulesError = + PostV1ContractorInvoiceSchedulesErrors[keyof PostV1ContractorInvoiceSchedulesErrors]; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses = - { - /** - * Success - */ - 200: SuccessResponse; +export type PostV1ContractorInvoiceSchedulesResponses = { + /** + * BulkContractorInvoiceScheduleCreateResponse + * + * Response containing the lists of succeeded and failed schedules. + */ + 201: { + data: { + failures: Array; + successes: Array; + }; + }; + /** + * BulkContractorInvoiceScheduleCreateResponse + * + * Response containing the lists of succeeded and failed schedules. + */ + 207: { + data: { + failures: Array; + successes: Array; + }; }; +}; -export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponse = - PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses[keyof PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelResponses]; +export type PostV1ContractorInvoiceSchedulesResponse = + PostV1ContractorInvoiceSchedulesResponses[keyof PostV1ContractorInvoiceSchedulesResponses]; -export type GetV1EmployeeTimeoffData = { +export type GetV1WorkAuthorizationRequestsIdData = { body?: never; - path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; + path: { /** - * Number of items per page + * work authorization request ID */ - page_size?: number; + id: string; }; - url: '/v1/employee/timeoff'; + query?: never; + url: '/api/eor/v1/work-authorization-requests/{id}'; }; -export type GetV1EmployeeTimeoffErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; +export type GetV1WorkAuthorizationRequestsIdErrors = { /** * Not Found */ @@ -22104,37 +22574,38 @@ export type GetV1EmployeeTimeoffErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1EmployeeTimeoffError = - GetV1EmployeeTimeoffErrors[keyof GetV1EmployeeTimeoffErrors]; +export type GetV1WorkAuthorizationRequestsIdError = + GetV1WorkAuthorizationRequestsIdErrors[keyof GetV1WorkAuthorizationRequestsIdErrors]; -export type GetV1EmployeeTimeoffResponses = { +export type GetV1WorkAuthorizationRequestsIdResponses = { /** * Success */ - 200: ListTimeoffResponse; + 200: WorkAuthorizationRequestResponse; }; -export type GetV1EmployeeTimeoffResponse = - GetV1EmployeeTimeoffResponses[keyof GetV1EmployeeTimeoffResponses]; +export type GetV1WorkAuthorizationRequestsIdResponse = + GetV1WorkAuthorizationRequestsIdResponses[keyof GetV1WorkAuthorizationRequestsIdResponses]; -export type PostV1EmployeeTimeoffData = { +export type PatchV1WorkAuthorizationRequestsId2Data = { /** - * Timeoff + * Work Authorization Request */ - body: CreateEmployeeTimeoffParams; - path?: never; + body: UpdateWorkAuthorizationRequestParams; + path: { + /** + * work authorization request ID + */ + id: string; + }; query?: never; - url: '/v1/employee/timeoff'; + url: '/api/eor/v1/work-authorization-requests/{id}'; }; -export type PostV1EmployeeTimeoffErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PatchV1WorkAuthorizationRequestsId2Errors = { /** * Unauthorized */ @@ -22147,104 +22618,92 @@ export type PostV1EmployeeTimeoffErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostV1EmployeeTimeoffError = - PostV1EmployeeTimeoffErrors[keyof PostV1EmployeeTimeoffErrors]; +export type PatchV1WorkAuthorizationRequestsId2Error = + PatchV1WorkAuthorizationRequestsId2Errors[keyof PatchV1WorkAuthorizationRequestsId2Errors]; -export type PostV1EmployeeTimeoffResponses = { +export type PatchV1WorkAuthorizationRequestsId2Responses = { /** - * Created + * Success */ - 201: TimeoffResponse; + 200: WorkAuthorizationRequestResponse; }; -export type PostV1EmployeeTimeoffResponse = - PostV1EmployeeTimeoffResponses[keyof PostV1EmployeeTimeoffResponses]; +export type PatchV1WorkAuthorizationRequestsId2Response = + PatchV1WorkAuthorizationRequestsId2Responses[keyof PatchV1WorkAuthorizationRequestsId2Responses]; -export type PatchV2EmploymentsEmploymentId2Data = { +export type PatchV1WorkAuthorizationRequestsIdData = { /** - * Employment params + * Work Authorization Request */ - body?: EmploymentV2UpdateParams; + body: UpdateWorkAuthorizationRequestParams; path: { /** - * Employment ID + * work authorization request ID */ - employment_id: string; + id: string; }; query?: never; - url: '/v2/employments/{employment_id}'; + url: '/api/eor/v1/work-authorization-requests/{id}'; }; -export type PatchV2EmploymentsEmploymentId2Errors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PatchV1WorkAuthorizationRequestsIdErrors = { /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PatchV2EmploymentsEmploymentId2Error = - PatchV2EmploymentsEmploymentId2Errors[keyof PatchV2EmploymentsEmploymentId2Errors]; +export type PatchV1WorkAuthorizationRequestsIdError = + PatchV1WorkAuthorizationRequestsIdErrors[keyof PatchV1WorkAuthorizationRequestsIdErrors]; -export type PatchV2EmploymentsEmploymentId2Responses = { +export type PatchV1WorkAuthorizationRequestsIdResponses = { /** * Success */ - 200: EmploymentResponse; + 200: WorkAuthorizationRequestResponse; }; -export type PatchV2EmploymentsEmploymentId2Response = - PatchV2EmploymentsEmploymentId2Responses[keyof PatchV2EmploymentsEmploymentId2Responses]; +export type PatchV1WorkAuthorizationRequestsIdResponse = + PatchV1WorkAuthorizationRequestsIdResponses[keyof PatchV1WorkAuthorizationRequestsIdResponses]; -export type PatchV2EmploymentsEmploymentIdData = { +export type PostV1TimeoffTimeoffIdDeclineData = { /** - * Employment params + * DeclineTimeoff */ - body?: EmploymentV2UpdateParams; + body: DeclineTimeoffParams; path: { /** - * Employment ID + * Time Off ID */ - employment_id: string; + timeoff_id: string; }; query?: never; - url: '/v2/employments/{employment_id}'; + url: '/api/eor/v1/timeoff/{timeoff_id}/decline'; }; -export type PatchV2EmploymentsEmploymentIdErrors = { +export type PostV1TimeoffTimeoffIdDeclineErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** - * Conflict + * Not Found */ - 409: ConflictResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ @@ -22255,96 +22714,74 @@ export type PatchV2EmploymentsEmploymentIdErrors = { 429: TooManyRequestsResponse; }; -export type PatchV2EmploymentsEmploymentIdError = - PatchV2EmploymentsEmploymentIdErrors[keyof PatchV2EmploymentsEmploymentIdErrors]; +export type PostV1TimeoffTimeoffIdDeclineError = + PostV1TimeoffTimeoffIdDeclineErrors[keyof PostV1TimeoffTimeoffIdDeclineErrors]; -export type PatchV2EmploymentsEmploymentIdResponses = { +export type PostV1TimeoffTimeoffIdDeclineResponses = { /** * Success */ - 200: EmploymentResponse; + 200: TimeoffResponse; }; -export type PatchV2EmploymentsEmploymentIdResponse = - PatchV2EmploymentsEmploymentIdResponses[keyof PatchV2EmploymentsEmploymentIdResponses]; +export type PostV1TimeoffTimeoffIdDeclineResponse = + PostV1TimeoffTimeoffIdDeclineResponses[keyof PostV1TimeoffTimeoffIdDeclineResponses]; -export type GetV1ProbationExtensionsIdData = { +export type GetV1ContractorsSchemasEligibilityQuestionnaireData = { body?: never; - path: { + path?: never; + query: { /** - * Probation Extension Request ID + * Type of eligibility questionnaire */ - id: string; + type: 'contractor_of_record'; + /** + * Version of the form schema + */ + json_schema_version?: number | 'latest'; }; - query?: never; - url: '/v1/probation-extensions/{id}'; + url: '/api/eor/v1/contractors/schemas/eligibility-questionnaire'; }; -export type GetV1ProbationExtensionsIdErrors = { +export type GetV1ContractorsSchemasEligibilityQuestionnaireErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; - -export type GetV1ProbationExtensionsIdError = - GetV1ProbationExtensionsIdErrors[keyof GetV1ProbationExtensionsIdErrors]; - -export type GetV1ProbationExtensionsIdResponses = { - /** - * Success - */ - 200: ProbationExtensionResponse; -}; - -export type GetV1ProbationExtensionsIdResponse = - GetV1ProbationExtensionsIdResponses[keyof GetV1ProbationExtensionsIdResponses]; - -export type GetV1PayslipsData = { - body?: never; - path?: never; - query?: { - /** - * Employment ID - */ - employment_id?: string; - /** - * Filters by payslips `issued_at` field, after or on the same day than the given date - */ - start_date?: string; - /** - * Filters by payslips `issued_at` field, before or or the same day than the given date - */ - end_date?: string; - /** - * Filters by payslips `expected_payout_date` field, after or on the same day than the given date - */ - expected_payout_start_date?: string; - /** - * Filters by payslips `expected_payout_date` field, before or or the same day than the given date - */ - expected_payout_end_date?: string; - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Change the amount of records returned per page, defaults to 20, limited to 100 - */ - page_size?: number; - }; - url: '/v1/payslips'; + +export type GetV1ContractorsSchemasEligibilityQuestionnaireError = + GetV1ContractorsSchemasEligibilityQuestionnaireErrors[keyof GetV1ContractorsSchemasEligibilityQuestionnaireErrors]; + +export type GetV1ContractorsSchemasEligibilityQuestionnaireResponses = { + /** + * Success + */ + 200: EligibilityQuestionnaireJsonSchemaResponse; }; -export type GetV1PayslipsErrors = { +export type GetV1ContractorsSchemasEligibilityQuestionnaireResponse = + GetV1ContractorsSchemasEligibilityQuestionnaireResponses[keyof GetV1ContractorsSchemasEligibilityQuestionnaireResponses]; + +export type PostAuthOauth2TokenData = { + /** + * OAuth2Token + */ + body?: OAuth2TokenParams; + path?: never; + query?: never; + url: '/api/eor/oauth2/token'; +}; + +export type PostAuthOauth2TokenErrors = { /** * Bad Request */ @@ -22367,35 +22804,126 @@ export type GetV1PayslipsErrors = { 429: TooManyRequestsResponse; }; -export type GetV1PayslipsError = GetV1PayslipsErrors[keyof GetV1PayslipsErrors]; +export type PostAuthOauth2TokenError = + PostAuthOauth2TokenErrors[keyof PostAuthOauth2TokenErrors]; -export type GetV1PayslipsResponses = { +export type PostAuthOauth2TokenResponses = { /** * Success */ - 200: ListPayslipsResponse; + 200: OAuth2Tokens; }; -export type GetV1PayslipsResponse = - GetV1PayslipsResponses[keyof GetV1PayslipsResponses]; +export type PostAuthOauth2TokenResponse = + PostAuthOauth2TokenResponses[keyof PostAuthOauth2TokenResponses]; -export type GetV1ExpensesExpenseIdReceiptsReceiptIdData = { - body?: never; - path: { +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + }; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = + { /** - * The expense ID + * Unauthorized */ - expense_id: string; + 401: UnauthorizedResponse; /** - * The receipt ID + * Forbidden */ - receipt_id: string; + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError = + DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors[keyof DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors]; + +export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses = + { + /** + * No Content + */ + 204: unknown; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = + { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError = + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses = + { + /** + * Created + */ + 201: SuccessResponse; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponse = + PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses]; + +export type PutV2EmploymentsEmploymentIdPersonalDetailsData = { + /** + * Employment personal details params + */ + body?: EmploymentPersonalDetailsParams; + path: { + /** + * Employment ID + */ + employment_id: string; }; query?: never; - url: '/v1/expenses/{expense_id}/receipts/{receipt_id}'; + url: '/api/eor/v2/employments/{employment_id}/personal_details'; }; -export type GetV1ExpensesExpenseIdReceiptsReceiptIdErrors = { +export type PutV2EmploymentsEmploymentIdPersonalDetailsErrors = { /** * Bad Request */ @@ -22412,6 +22940,10 @@ export type GetV1ExpensesExpenseIdReceiptsReceiptIdErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -22422,34 +22954,91 @@ export type GetV1ExpensesExpenseIdReceiptsReceiptIdErrors = { 429: TooManyRequestsResponse; }; -export type GetV1ExpensesExpenseIdReceiptsReceiptIdError = - GetV1ExpensesExpenseIdReceiptsReceiptIdErrors[keyof GetV1ExpensesExpenseIdReceiptsReceiptIdErrors]; +export type PutV2EmploymentsEmploymentIdPersonalDetailsError = + PutV2EmploymentsEmploymentIdPersonalDetailsErrors[keyof PutV2EmploymentsEmploymentIdPersonalDetailsErrors]; -export type GetV1ExpensesExpenseIdReceiptsReceiptIdResponses = { +export type PutV2EmploymentsEmploymentIdPersonalDetailsResponses = { /** * Success */ - 200: GenericFile; + 200: EmploymentResponse; }; -export type GetV1ExpensesExpenseIdReceiptsReceiptIdResponse = - GetV1ExpensesExpenseIdReceiptsReceiptIdResponses[keyof GetV1ExpensesExpenseIdReceiptsReceiptIdResponses]; +export type PutV2EmploymentsEmploymentIdPersonalDetailsResponse = + PutV2EmploymentsEmploymentIdPersonalDetailsResponses[keyof PutV2EmploymentsEmploymentIdPersonalDetailsResponses]; -export type PostAuthOauth2TokenData = { - /** - * OAuth2Token - */ - body?: OAuth2TokenParams; - path?: never; +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData = + { + /** + * FindOrCreatePreOnboardingDocumentParams + */ + body: FindOrCreatePreOnboardingDocumentParams; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents'; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors = + { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsError = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors]; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses = + { + /** + * Success + */ + 200: CreatePreOnboardingDocumentResponse; + }; + +export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponse = + PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses[keyof PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsResponses]; + +export type GetV1ContractAmendmentsIdData = { + body?: never; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; + path: { + /** + * Contract amendment request ID + */ + id: string; + }; query?: never; - url: '/auth/oauth2/token'; + url: '/api/eor/v1/contract-amendments/{id}'; }; -export type PostAuthOauth2TokenErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1ContractAmendmentsIdErrors = { /** * Unauthorized */ @@ -22462,30 +23051,23 @@ export type PostAuthOauth2TokenErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Too many requests - */ - 429: TooManyRequestsResponse; }; -export type PostAuthOauth2TokenError = - PostAuthOauth2TokenErrors[keyof PostAuthOauth2TokenErrors]; +export type GetV1ContractAmendmentsIdError = + GetV1ContractAmendmentsIdErrors[keyof GetV1ContractAmendmentsIdErrors]; -export type PostAuthOauth2TokenResponses = { +export type GetV1ContractAmendmentsIdResponses = { /** * Success */ - 200: OAuth2Tokens; + 200: ContractAmendmentResponse; }; -export type PostAuthOauth2TokenResponse = - PostAuthOauth2TokenResponses[keyof PostAuthOauth2TokenResponses]; +export type GetV1ContractAmendmentsIdResponse = + GetV1ContractAmendmentsIdResponses[keyof GetV1ContractAmendmentsIdResponses]; -export type PutV2EmploymentsEmploymentIdPricingPlanDetailsData = { - /** - * Employment pricing plan details params - */ - body?: EmploymentPricingPlanDetailsParams; +export type PostV1IdentityVerificationEmploymentIdDeclineData = { + body?: never; path: { /** * Employment ID @@ -22493,161 +23075,163 @@ export type PutV2EmploymentsEmploymentIdPricingPlanDetailsData = { employment_id: string; }; query?: never; - url: '/v2/employments/{employment_id}/pricing_plan_details'; + url: '/api/eor/v1/identity-verification/{employment_id}/decline'; }; -export type PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1IdentityVerificationEmploymentIdDeclineErrors = { /** * Unauthorized */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdPricingPlanDetailsError = - PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors[keyof PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors]; +export type PostV1IdentityVerificationEmploymentIdDeclineError = + PostV1IdentityVerificationEmploymentIdDeclineErrors[keyof PostV1IdentityVerificationEmploymentIdDeclineErrors]; -export type PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses = { +export type PostV1IdentityVerificationEmploymentIdDeclineResponses = { /** * Success */ - 200: EmploymentResponse; + 200: SuccessResponse; }; -export type PutV2EmploymentsEmploymentIdPricingPlanDetailsResponse = - PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses[keyof PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses]; +export type PostV1IdentityVerificationEmploymentIdDeclineResponse = + PostV1IdentityVerificationEmploymentIdDeclineResponses[keyof PostV1IdentityVerificationEmploymentIdDeclineResponses]; -export type GetV1CountriesCountryCodeLegalEntityFormsFormData = { +export type GetV1EmployeeExpenseCategoriesData = { body?: never; - path: { - /** - * Country code according to ISO 3-digit alphabetic codes - */ - country_code: string; - /** - * Name of the desired form - */ - form: string; - }; + path?: never; query?: { /** - * Product type. Default value is global_payroll. - */ - product_type?: 'peo' | 'global_payroll' | 'e2e_payroll'; - /** - * Legal entity id for admistrative_details of e2e payroll products in GBR + * Include parent (non-selectable) categories in addition to selectable leaves */ - legal_entity_id?: UuidSlug; + include_parents?: boolean; /** - * Version of the form schema + * Expense ID (slug) whose category should be included in the result, even if it is not selectable by default */ - json_schema_version?: number | 'latest'; + expense_id?: string; }; - url: '/v1/countries/{country_code}/legal_entity_forms/{form}'; + url: '/api/eor/v1/employee/expense-categories'; }; -export type GetV1CountriesCountryCodeLegalEntityFormsFormErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1EmployeeExpenseCategoriesErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; +}; + +export type GetV1EmployeeExpenseCategoriesError = + GetV1EmployeeExpenseCategoriesErrors[keyof GetV1EmployeeExpenseCategoriesErrors]; + +export type GetV1EmployeeExpenseCategoriesResponses = { /** - * Unprocessable Entity + * Success */ - 422: UnprocessableEntityResponse; + 200: ListExpenseCategoriesResponse; +}; + +export type GetV1EmployeeExpenseCategoriesResponse = + GetV1EmployeeExpenseCategoriesResponses[keyof GetV1EmployeeExpenseCategoriesResponses]; + +export type PostV1CostCalculatorEstimationCsvData = { + /** + * Estimate params + */ + body?: CostCalculatorEstimateParams; + path?: never; + query?: never; + url: '/api/eor/v1/cost-calculator/estimation-csv'; +}; + +export type PostV1CostCalculatorEstimationCsvErrors = { + /** + * Not Found + */ + 404: NotFoundResponse; /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 422: UnprocessableEntityResponse; }; -export type GetV1CountriesCountryCodeLegalEntityFormsFormError = - GetV1CountriesCountryCodeLegalEntityFormsFormErrors[keyof GetV1CountriesCountryCodeLegalEntityFormsFormErrors]; +export type PostV1CostCalculatorEstimationCsvError = + PostV1CostCalculatorEstimationCsvErrors[keyof PostV1CostCalculatorEstimationCsvErrors]; -export type GetV1CountriesCountryCodeLegalEntityFormsFormResponses = { +export type PostV1CostCalculatorEstimationCsvResponses = { /** * Success */ - 200: CountryFormResponse; + 200: CostCalculatorEstimateCsvResponse; }; -export type GetV1CountriesCountryCodeLegalEntityFormsFormResponse = - GetV1CountriesCountryCodeLegalEntityFormsFormResponses[keyof GetV1CountriesCountryCodeLegalEntityFormsFormResponses]; +export type PostV1CostCalculatorEstimationCsvResponse = + PostV1CostCalculatorEstimationCsvResponses[keyof PostV1CostCalculatorEstimationCsvResponses]; -export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionData = +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData = { - /** - * Manage Contractor Plus subscription params - */ - body: ManageContractorPlusSubscriptionOperationsParams; + body?: never; path: { /** * Employment ID */ employment_id: string; + /** + * Pre-onboarding document ID + */ + id: string; }; query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-plus-subscription'; + url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}'; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors = +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionError = - PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors]; +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdError = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors]; -export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses = +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: ShowPreOnboardingDocumentResponse; }; -export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponse = - PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionResponses]; +export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponse = + GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses[keyof GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdResponses]; -export type GetV1TimeoffData = { +export type GetV1BillingDocumentsData = { body?: never; headers: { /** @@ -22661,25 +23245,9 @@ export type GetV1TimeoffData = { path?: never; query?: { /** - * Only show time off for a specific employment - */ - employment_id?: string; - /** - * Filter time off by its type - */ - timeoff_type?: TimeoffType; - /** - * Filter time off by its status - */ - status?: TimeoffStatus; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - /** - * Field to sort by + * The month for the billing documents (in ISO-8601 format) */ - sort_by?: 'timeoff_type' | 'status'; + period?: string; /** * Starts fetching records after the given page */ @@ -22689,14 +23257,10 @@ export type GetV1TimeoffData = { */ page_size?: number; }; - url: '/v1/timeoff'; + url: '/api/eor/v1/billing-documents'; }; -export type GetV1TimeoffErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1BillingDocumentsErrors = { /** * Unauthorized */ @@ -22709,29 +23273,23 @@ export type GetV1TimeoffErrors = { * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type GetV1TimeoffError = GetV1TimeoffErrors[keyof GetV1TimeoffErrors]; +export type GetV1BillingDocumentsError = + GetV1BillingDocumentsErrors[keyof GetV1BillingDocumentsErrors]; -export type GetV1TimeoffResponses = { +export type GetV1BillingDocumentsResponses = { /** * Success */ - 200: ListTimeoffResponse; + 200: BillingDocumentsResponse; }; -export type GetV1TimeoffResponse = - GetV1TimeoffResponses[keyof GetV1TimeoffResponses]; +export type GetV1BillingDocumentsResponse = + GetV1BillingDocumentsResponses[keyof GetV1BillingDocumentsResponses]; -export type PostV1TimeoffData = { - /** - * Timeoff - */ - body: CreateApprovedTimeoffParams; +export type GetV1BillingDocumentsBillingDocumentIdData = { + body?: never; headers: { /** * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. @@ -22741,12 +23299,22 @@ export type PostV1TimeoffData = { */ Authorization: string; }; - path?: never; - query?: never; - url: '/v1/timeoff'; + path: { + /** + * The billing document's ID + */ + billing_document_id: string; + }; + query?: { + /** + * When true, includes billing document items whose type is not part of the standard set for the invoice type. + */ + include_unrecognized_types?: boolean; + }; + url: '/api/eor/v1/billing-documents/{billing_document_id}'; }; -export type PostV1TimeoffErrors = { +export type GetV1BillingDocumentsBillingDocumentIdErrors = { /** * Bad Request */ @@ -22766,29 +23334,95 @@ export type PostV1TimeoffErrors = { /** * Unprocessable Entity */ - 429: TooManyRequestsResponse; + 429: TooManyRequestsResponse; +}; + +export type GetV1BillingDocumentsBillingDocumentIdError = + GetV1BillingDocumentsBillingDocumentIdErrors[keyof GetV1BillingDocumentsBillingDocumentIdErrors]; + +export type GetV1BillingDocumentsBillingDocumentIdResponses = { + /** + * Success + */ + 200: BillingDocumentResponse; +}; + +export type GetV1BillingDocumentsBillingDocumentIdResponse = + GetV1BillingDocumentsBillingDocumentIdResponses[keyof GetV1BillingDocumentsBillingDocumentIdResponses]; + +export type GetV1EmployeeDocumentsData = { + body?: never; + path?: never; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + /** + * Filter documents by their description or file name, accepts full and partial case insensitive matches + */ + name?: string; + /** + * Filters the results that were uploaded on or after a given date + */ + inserted_after?: Date; + /** + * Filters the results that were uploaded before a given date + */ + inserted_before?: Date; + /** + * Field to sort by + */ + sort_by?: + | 'description' + | 'document_source' + | 'inserted_at' + | 'name' + | 'type' + | 'uploaded_by_role' + | 'related_to' + | 'sub_type' + | 'uploaded_by'; + /** + * Sort order + */ + order?: 'asc' | 'desc'; + }; + url: '/api/eor/v1/employee/documents'; +}; + +export type GetV1EmployeeDocumentsErrors = { + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; }; -export type PostV1TimeoffError = PostV1TimeoffErrors[keyof PostV1TimeoffErrors]; +export type GetV1EmployeeDocumentsError = + GetV1EmployeeDocumentsErrors[keyof GetV1EmployeeDocumentsErrors]; -export type PostV1TimeoffResponses = { +export type GetV1EmployeeDocumentsResponses = { /** - * Created + * Success */ - 201: TimeoffResponse; + 200: ListDocumentsResponse; }; -export type PostV1TimeoffResponse = - PostV1TimeoffResponses[keyof PostV1TimeoffResponses]; +export type GetV1EmployeeDocumentsResponse = + GetV1EmployeeDocumentsResponses[keyof GetV1EmployeeDocumentsResponses]; -export type GetV1PayrollRunsData = { +export type GetV1EmployeeTimeoffData = { body?: never; path?: never; query?: { - /** - * Filters payroll runs where period_start or period_end match the given date - */ - payroll_period?: Date; /** * Starts fetching records after the given page */ @@ -22798,10 +23432,14 @@ export type GetV1PayrollRunsData = { */ page_size?: number; }; - url: '/v1/payroll-runs'; + url: '/api/eor/v1/employee/timeoff'; }; -export type GetV1PayrollRunsErrors = { +export type GetV1EmployeeTimeoffErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ @@ -22813,130 +23451,132 @@ export type GetV1PayrollRunsErrors = { /** * Unprocessable Entity */ - 422: UnprocessableEntityResponse; + 429: TooManyRequestsResponse; }; -export type GetV1PayrollRunsError = - GetV1PayrollRunsErrors[keyof GetV1PayrollRunsErrors]; +export type GetV1EmployeeTimeoffError = + GetV1EmployeeTimeoffErrors[keyof GetV1EmployeeTimeoffErrors]; -export type GetV1PayrollRunsResponses = { +export type GetV1EmployeeTimeoffResponses = { /** * Success */ - 200: ListPayrollRunResponse; + 200: ListTimeoffResponse; }; -export type GetV1PayrollRunsResponse = - GetV1PayrollRunsResponses[keyof GetV1PayrollRunsResponses]; +export type GetV1EmployeeTimeoffResponse = + GetV1EmployeeTimeoffResponses[keyof GetV1EmployeeTimeoffResponses]; -export type GetV1ScimV2GroupsIdData = { - body?: never; - path: { - /** - * Group ID (slug) - */ - id: string; - }; +export type PostV1EmployeeTimeoffData = { + /** + * Timeoff + */ + body: CreateEmployeeTimeoffParams; + path?: never; query?: never; - url: '/v1/scim/v2/Groups/{id}'; + url: '/api/eor/v1/employee/timeoff'; }; -export type GetV1ScimV2GroupsIdErrors = { +export type PostV1EmployeeTimeoffErrors = { /** - * Unauthorized + * Bad Request */ - 401: IntegrationsScimErrorResponse; + 400: BadRequestResponse; /** - * Forbidden + * Unauthorized */ - 403: IntegrationsScimErrorResponse; + 401: UnauthorizedResponse; /** * Not Found */ - 404: IntegrationsScimErrorResponse; + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1ScimV2GroupsIdError = - GetV1ScimV2GroupsIdErrors[keyof GetV1ScimV2GroupsIdErrors]; +export type PostV1EmployeeTimeoffError = + PostV1EmployeeTimeoffErrors[keyof PostV1EmployeeTimeoffErrors]; -export type GetV1ScimV2GroupsIdResponses = { +export type PostV1EmployeeTimeoffResponses = { /** - * Success + * Created */ - 200: IntegrationsScimGroup; + 201: TimeoffResponse; }; -export type GetV1ScimV2GroupsIdResponse = - GetV1ScimV2GroupsIdResponses[keyof GetV1ScimV2GroupsIdResponses]; +export type PostV1EmployeeTimeoffResponse = + PostV1EmployeeTimeoffResponses[keyof PostV1EmployeeTimeoffResponses]; -export type GetV1EmploymentContractsData = { - body?: never; - headers: { - /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * - */ - Authorization: string; - }; - path?: never; - query: { +export type PutV1EmploymentsEmploymentIdPersonalDetailsData = { + /** + * Employment personal details params + */ + body?: EmploymentPersonalDetailsParams; + path: { /** * Employment ID */ employment_id: string; - /** - * Only Active - */ - only_active?: boolean; }; - url: '/v1/employment-contracts'; + query?: never; + url: '/api/eor/v1/employments/{employment_id}/personal_details'; }; -export type GetV1EmploymentContractsErrors = { +export type PutV1EmploymentsEmploymentIdPersonalDetailsErrors = { /** - * Unauthorized + * Bad Request */ - 401: UnauthorizedResponse; + 400: BadRequestResponse; /** * Forbidden */ 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; }; -export type GetV1EmploymentContractsError = - GetV1EmploymentContractsErrors[keyof GetV1EmploymentContractsErrors]; +export type PutV1EmploymentsEmploymentIdPersonalDetailsError = + PutV1EmploymentsEmploymentIdPersonalDetailsErrors[keyof PutV1EmploymentsEmploymentIdPersonalDetailsErrors]; -export type GetV1EmploymentContractsResponses = { +export type PutV1EmploymentsEmploymentIdPersonalDetailsResponses = { /** * Success */ - 200: ListEmploymentContractResponse; + 200: EmploymentResponse; }; -export type GetV1EmploymentContractsResponse = - GetV1EmploymentContractsResponses[keyof GetV1EmploymentContractsResponses]; +export type PutV1EmploymentsEmploymentIdPersonalDetailsResponse = + PutV1EmploymentsEmploymentIdPersonalDetailsResponses[keyof PutV1EmploymentsEmploymentIdPersonalDetailsResponses]; -export type PostV1CurrencyConverterEffective2Data = { - /** - * Convert currency parameters - */ - body: ConvertCurrencyParams; - path?: never; +export type GetV1ProbationExtensionsIdData = { + body?: never; + path: { + /** + * Probation Extension Request ID + */ + id: string; + }; query?: never; - url: '/v1/currency-converter'; + url: '/api/eor/v1/probation-extensions/{id}'; }; -export type PostV1CurrencyConverterEffective2Errors = { +export type GetV1ProbationExtensionsIdErrors = { /** * Unauthorized */ @@ -22951,41 +23591,32 @@ export type PostV1CurrencyConverterEffective2Errors = { 422: UnprocessableEntityResponse; }; -export type PostV1CurrencyConverterEffective2Error = - PostV1CurrencyConverterEffective2Errors[keyof PostV1CurrencyConverterEffective2Errors]; +export type GetV1ProbationExtensionsIdError = + GetV1ProbationExtensionsIdErrors[keyof GetV1ProbationExtensionsIdErrors]; -export type PostV1CurrencyConverterEffective2Responses = { +export type GetV1ProbationExtensionsIdResponses = { /** * Success */ - 200: ConvertCurrencyResponse; + 200: ProbationExtensionResponse; }; -export type PostV1CurrencyConverterEffective2Response = - PostV1CurrencyConverterEffective2Responses[keyof PostV1CurrencyConverterEffective2Responses]; +export type GetV1ProbationExtensionsIdResponse = + GetV1ProbationExtensionsIdResponses[keyof GetV1ProbationExtensionsIdResponses]; -export type GetV1CompaniesData = { +export type GetV1FilesIdData = { body?: never; - headers: { - /** - * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Client Credentials flow. - * - */ - Authorization: string; - }; - path?: never; - query?: { + path: { /** - * External ID + * File ID */ - external_id?: string; + id: string; }; - url: '/v1/companies'; + query?: never; + url: '/api/eor/v1/files/{id}'; }; -export type GetV1CompaniesErrors = { +export type GetV1FilesIdErrors = { /** * Unauthorized */ @@ -23000,161 +23631,122 @@ export type GetV1CompaniesErrors = { 422: UnprocessableEntityResponse; }; -export type GetV1CompaniesError = - GetV1CompaniesErrors[keyof GetV1CompaniesErrors]; +export type GetV1FilesIdError = GetV1FilesIdErrors[keyof GetV1FilesIdErrors]; -export type GetV1CompaniesResponses = { +export type GetV1FilesIdResponses = { /** * Success */ - 200: CompaniesResponse; + 200: DownloadFileResponse; }; -export type GetV1CompaniesResponse = - GetV1CompaniesResponses[keyof GetV1CompaniesResponses]; +export type GetV1FilesIdResponse = + GetV1FilesIdResponses[keyof GetV1FilesIdResponses]; -export type PostV1CompaniesData = { - /** - * Create Company params - */ - body?: CreateCompanyParams; - headers: { - /** - * Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Client Credentials flow. - * - */ - Authorization: string; - }; +export type GetV1CompanyDepartmentsData = { + body?: never; path?: never; - query?: { - /** - * Version of the address_details form schema - */ - address_details_json_schema_version?: number | 'latest'; + query: { /** - * Version of the bank_account_details form schema + * Company ID */ - bank_account_details_json_schema_version?: number | 'latest'; + company_id: string; /** - * Complementary action(s) to perform when creating a company: - * - * - `get_oauth_access_tokens` returns the user's access and refresh tokens - * - `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only) - * - * If `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send) - * + * Paginate option. Default: true. When true, paginates response; otherwise, does not. */ - action?: string; + paginate?: boolean; /** - * Whether the request should be performed async - * + * Starts fetching records after the given page */ - async?: boolean; + page?: number; /** - * Scope of the access token - * + * Number of items per page */ - scope?: string; + page_size?: number; }; - url: '/v1/companies'; + url: '/api/eor/v1/company-departments'; }; -export type PostV1CompaniesErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; +export type GetV1CompanyDepartmentsErrors = { /** - * Conflict + * Not Found */ - 409: CompanyCreationConflictErrorResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostV1CompaniesError = - PostV1CompaniesErrors[keyof PostV1CompaniesErrors]; +export type GetV1CompanyDepartmentsError = + GetV1CompanyDepartmentsErrors[keyof GetV1CompanyDepartmentsErrors]; -export type PostV1CompaniesResponses = { +export type GetV1CompanyDepartmentsResponses = { /** - * Created + * Success */ - 201: CompanyCreationResponse; + 200: ListCompanyDepartmentsPaginatedResponse; }; -export type PostV1CompaniesResponse = - PostV1CompaniesResponses[keyof PostV1CompaniesResponses]; +export type GetV1CompanyDepartmentsResponse = + GetV1CompanyDepartmentsResponses[keyof GetV1CompanyDepartmentsResponses]; -export type PostV1BulkEmploymentJobsData = { +export type PostV1CompanyDepartmentsData = { /** - * Bulk employment params + * Create Company Department request params */ - body?: BulkEmploymentCreateParams; + body: CreateCompanyDepartmentParams; path?: never; query?: never; - url: '/v1/bulk-employment-jobs'; + url: '/api/eor/v1/company-departments'; }; -export type PostV1BulkEmploymentJobsErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type PostV1CompanyDepartmentsErrors = { /** - * Forbidden + * Not Found */ - 403: ForbiddenResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostV1BulkEmploymentJobsError = - PostV1BulkEmploymentJobsErrors[keyof PostV1BulkEmploymentJobsErrors]; +export type PostV1CompanyDepartmentsError = + PostV1CompanyDepartmentsErrors[keyof PostV1CompanyDepartmentsErrors]; -export type PostV1BulkEmploymentJobsResponses = { +export type PostV1CompanyDepartmentsResponses = { /** - * Accepted + * Created */ - 202: BulkEmploymentImportJobResponse; + 201: CompanyDepartmentCreatedResponse; }; -export type PostV1BulkEmploymentJobsResponse = - PostV1BulkEmploymentJobsResponses[keyof PostV1BulkEmploymentJobsResponses]; +export type PostV1CompanyDepartmentsResponse = + PostV1CompanyDepartmentsResponses[keyof PostV1CompanyDepartmentsResponses]; -export type PostV1TimesheetsTimesheetIdSendBackData = { - /** - * SendBackTimesheetParams - */ - body?: SendBackTimesheetParams; +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsData = { + body?: never; path: { /** - * Timesheet ID + * Payroll run ID */ - timesheet_id: string; + payroll_run_id: string; }; - query?: never; - url: '/v1/timesheets/{timesheet_id}/send-back'; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/payroll-runs/{payroll_run_id}/employee-details'; }; -export type PostV1TimesheetsTimesheetIdSendBackErrors = { +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors = { /** * Unauthorized */ @@ -23169,20 +23761,20 @@ export type PostV1TimesheetsTimesheetIdSendBackErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1TimesheetsTimesheetIdSendBackError = - PostV1TimesheetsTimesheetIdSendBackErrors[keyof PostV1TimesheetsTimesheetIdSendBackErrors]; +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsError = + GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors[keyof GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors]; -export type PostV1TimesheetsTimesheetIdSendBackResponses = { +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses = { /** * Success */ - 200: SentBackTimesheetResponse; + 200: EmployeeDetailsResponse; }; -export type PostV1TimesheetsTimesheetIdSendBackResponse = - PostV1TimesheetsTimesheetIdSendBackResponses[keyof PostV1TimesheetsTimesheetIdSendBackResponses]; +export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponse = + GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses[keyof GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses]; -export type DeleteV1CompanyManagersUserIdData = { +export type GetV1EmploymentsEmploymentIdData = { body?: never; headers: { /** @@ -23195,135 +23787,238 @@ export type DeleteV1CompanyManagersUserIdData = { }; path: { /** - * User ID + * Employment ID */ - user_id: string; + employment_id: string; }; - query?: never; - url: '/v1/company-managers/{user_id}'; + query?: { + /** + * Wether files should be excluded + */ + exclude_files?: boolean; + }; + url: '/api/eor/v1/employments/{employment_id}'; }; -export type DeleteV1CompanyManagersUserIdErrors = { +export type GetV1EmploymentsEmploymentIdErrors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type DeleteV1CompanyManagersUserIdError = - DeleteV1CompanyManagersUserIdErrors[keyof DeleteV1CompanyManagersUserIdErrors]; +export type GetV1EmploymentsEmploymentIdError = + GetV1EmploymentsEmploymentIdErrors[keyof GetV1EmploymentsEmploymentIdErrors]; -export type DeleteV1CompanyManagersUserIdResponses = { +export type GetV1EmploymentsEmploymentIdResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentShowResponse; }; -export type DeleteV1CompanyManagersUserIdResponse = - DeleteV1CompanyManagersUserIdResponses[keyof DeleteV1CompanyManagersUserIdResponses]; +export type GetV1EmploymentsEmploymentIdResponse = + GetV1EmploymentsEmploymentIdResponses[keyof GetV1EmploymentsEmploymentIdResponses]; -export type GetV1CompanyManagersUserIdData = { - body?: never; +export type PatchV1EmploymentsEmploymentId2Data = { + /** + * Employment params + */ + body?: EmploymentFullParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * User ID + * Employment ID */ - user_id: string; + employment_id: string; }; - query?: never; - url: '/v1/company-managers/{user_id}'; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the administrative_details form schema + */ + administrative_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + /** + * Version of the employment_basic_information form schema + */ + employment_basic_information_json_schema_version?: number | 'latest'; + /** + * Version of the billing_address_details form schema + */ + billing_address_details_json_schema_version?: number | 'latest'; + /** + * Version of the contract_details form schema + */ + contract_details_json_schema_version?: number | 'latest'; + /** + * Version of the emergency_contact_details form schema + */ + emergency_contact_details_json_schema_version?: number | 'latest'; + /** + * Version of the personal_details form schema + */ + personal_details_json_schema_version?: number | 'latest'; + /** + * Version of the pricing_plan_details form schema + */ + pricing_plan_details_json_schema_version?: number | 'latest'; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; + /** + * Complementary action(s) to perform when creating an employment. + */ + actions?: string; + }; + url: '/api/eor/v1/employments/{employment_id}'; }; -export type GetV1CompanyManagersUserIdErrors = { +export type PatchV1EmploymentsEmploymentId2Errors = { /** * Bad Request */ 400: BadRequestResponse; /** - * Unauthorized + * Forbidden */ - 401: UnauthorizedResponse; + 403: ForbiddenResponse; /** - * Not Found + * Conflict */ - 404: NotFoundResponse; + 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; /** - * Too many requests + * Unprocessable Entity */ 429: TooManyRequestsResponse; }; -export type GetV1CompanyManagersUserIdError = - GetV1CompanyManagersUserIdErrors[keyof GetV1CompanyManagersUserIdErrors]; +export type PatchV1EmploymentsEmploymentId2Error = + PatchV1EmploymentsEmploymentId2Errors[keyof PatchV1EmploymentsEmploymentId2Errors]; -export type GetV1CompanyManagersUserIdResponses = { +export type PatchV1EmploymentsEmploymentId2Responses = { /** * Success */ - 200: CompanyManagerResponse; + 200: EmploymentResponse; }; -export type GetV1CompanyManagersUserIdResponse = - GetV1CompanyManagersUserIdResponses[keyof GetV1CompanyManagersUserIdResponses]; +export type PatchV1EmploymentsEmploymentId2Response = + PatchV1EmploymentsEmploymentId2Responses[keyof PatchV1EmploymentsEmploymentId2Responses]; -export type PutV2EmploymentsEmploymentIdEmergencyContactData = { +export type PatchV1EmploymentsEmploymentIdData = { /** - * Employment emergency contact params + * Employment params */ - body?: EmploymentEmergencyContactParams; + body?: EmploymentFullParams; + headers: { + /** + * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. + * + * The refresh token needs to have been obtained through the Authorization Code flow. + * + */ + Authorization: string; + }; path: { /** - * Employment ID + * Employment ID + */ + employment_id: string; + }; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + /** + * Version of the administrative_details form schema + */ + administrative_details_json_schema_version?: number | 'latest'; + /** + * Version of the bank_account_details form schema + */ + bank_account_details_json_schema_version?: number | 'latest'; + /** + * Version of the employment_basic_information form schema + */ + employment_basic_information_json_schema_version?: number | 'latest'; + /** + * Version of the billing_address_details form schema */ - employment_id: string; - }; - query?: { + billing_address_details_json_schema_version?: number | 'latest'; + /** + * Version of the contract_details form schema + */ + contract_details_json_schema_version?: number | 'latest'; /** * Version of the emergency_contact_details form schema */ emergency_contact_details_json_schema_version?: number | 'latest'; + /** + * Version of the personal_details form schema + */ + personal_details_json_schema_version?: number | 'latest'; + /** + * Version of the pricing_plan_details form schema + */ + pricing_plan_details_json_schema_version?: number | 'latest'; + /** + * Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API. + */ + skip_benefits?: boolean; + /** + * Complementary action(s) to perform when creating an employment. + */ + actions?: string; }; - url: '/v2/employments/{employment_id}/emergency_contact'; + url: '/api/eor/v1/employments/{employment_id}'; }; -export type PutV2EmploymentsEmploymentIdEmergencyContactErrors = { +export type PatchV1EmploymentsEmploymentIdErrors = { /** * Bad Request */ 400: BadRequestResponse; - /** - * Unauthorized - */ - 401: UnauthorizedResponse; /** * Forbidden */ 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; /** * Conflict */ @@ -23338,27 +24033,36 @@ export type PutV2EmploymentsEmploymentIdEmergencyContactErrors = { 429: TooManyRequestsResponse; }; -export type PutV2EmploymentsEmploymentIdEmergencyContactError = - PutV2EmploymentsEmploymentIdEmergencyContactErrors[keyof PutV2EmploymentsEmploymentIdEmergencyContactErrors]; +export type PatchV1EmploymentsEmploymentIdError = + PatchV1EmploymentsEmploymentIdErrors[keyof PatchV1EmploymentsEmploymentIdErrors]; -export type PutV2EmploymentsEmploymentIdEmergencyContactResponses = { +export type PatchV1EmploymentsEmploymentIdResponses = { /** * Success */ 200: EmploymentResponse; }; -export type PutV2EmploymentsEmploymentIdEmergencyContactResponse = - PutV2EmploymentsEmploymentIdEmergencyContactResponses[keyof PutV2EmploymentsEmploymentIdEmergencyContactResponses]; +export type PatchV1EmploymentsEmploymentIdResponse = + PatchV1EmploymentsEmploymentIdResponses[keyof PatchV1EmploymentsEmploymentIdResponses]; -export type GetV1EmployeeExpensesData = { +export type GetV1EmployeeTimesheetsData = { body?: never; path?: never; - query?: never; - url: '/v1/employee/expenses'; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employee/timesheets'; }; -export type GetV1EmployeeExpensesErrors = { +export type GetV1EmployeeTimesheetsErrors = { /** * Unauthorized */ @@ -23373,214 +24077,83 @@ export type GetV1EmployeeExpensesErrors = { 404: NotFoundResponse; }; -export type GetV1EmployeeExpensesError = - GetV1EmployeeExpensesErrors[keyof GetV1EmployeeExpensesErrors]; +export type GetV1EmployeeTimesheetsError = + GetV1EmployeeTimesheetsErrors[keyof GetV1EmployeeTimesheetsErrors]; -export type GetV1EmployeeExpensesResponses = { +export type GetV1EmployeeTimesheetsResponses = { /** * Success */ 200: SuccessResponse; }; -export type GetV1EmployeeExpensesResponse = - GetV1EmployeeExpensesResponses[keyof GetV1EmployeeExpensesResponses]; +export type GetV1EmployeeTimesheetsResponse = + GetV1EmployeeTimesheetsResponses[keyof GetV1EmployeeTimesheetsResponses]; -export type PostV1EmployeeExpensesData = { - /** - * Expense params - */ - body?: ParamsToCreateEmployeeExpense; - path?: never; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { + body?: never; + path: { + /** + * Custom field ID + */ + custom_field_id: string; + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/employee/expenses'; + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; -export type PostV1EmployeeExpensesErrors = { - /** - * Bad Request - */ - 400: BadRequestResponse; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Forbidden + * Not Found */ - 403: ForbiddenResponse; + 404: NotFoundResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; }; -export type PostV1EmployeeExpensesError = - PostV1EmployeeExpensesErrors[keyof PostV1EmployeeExpensesErrors]; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdError = + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors[keyof GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors]; -export type PostV1EmployeeExpensesResponses = { +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses = { /** - * Created + * Success */ - 201: SuccessResponse; + 200: EmploymentCustomFieldValueResponse; }; -export type PostV1EmployeeExpensesResponse = - PostV1EmployeeExpensesResponses[keyof PostV1EmployeeExpensesResponses]; - -export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData = - { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; - }; - -export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = - { - /** - * Unauthorized - */ - 401: UnauthorizedResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - }; - -export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError = - DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors[keyof DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors]; - -export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses = - { - /** - * No Content - */ - 204: unknown; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionData = - { - body?: never; - path: { - /** - * Employment ID - */ - employment_id: string; - }; - query?: never; - url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = - { - /** - * Bad Request - */ - 400: BadRequestResponse; - /** - * Forbidden - */ - 403: ForbiddenResponse; - /** - * Not Found - */ - 404: NotFoundResponse; - /** - * Unprocessable Entity - */ - 422: UnprocessableEntityResponse; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionError = - PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors[keyof PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors]; - -export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses = - { - /** - * Created - */ - 201: SuccessResponse; - }; - -export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponse = - PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses[keyof PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionResponses]; +export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse = + GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses[keyof GetV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses]; -export type GetV1ContractorInvoiceSchedulesData = { - body?: never; - path?: never; - query?: { - /** - * Filters contractor invoice schedules by start date greater than or equal to the value. - */ - start_date_from?: Date; - /** - * Filters contractor invoice schedules by start date less than or equal to the value. - */ - start_date_to?: Date; - /** - * Filters contractor invoice schedules by next invoice date greater than or equal to the value. - */ - next_invoice_date_from?: Date; - /** - * Filters contractor invoice schedules by next invoice date less than or equal to the value. - */ - next_invoice_date_to?: Date; - /** - * Filters contractor invoice schedules by status matching the value. - */ - status?: ContractorInvoiceScheduleStatus; - /** - * Filters contractor invoice schedules by employment id matching the value. - */ - employment_id?: UuidSlug; - /** - * Filters contractor invoice schedules by periodicity matching the value. - */ - periodicity?: ContractorInvoiceSchedulePeriodicity; - /** - * Filters contractor invoice schedules by currency matching the value. - */ - currency?: string; - /** - * Field to sort by - */ - sort_by?: - | 'number' - | 'total_amount' - | 'next_invoice_at' - | 'start_date' - | 'nr_occurrences'; - /** - * Sort order - */ - order?: 'asc' | 'desc'; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data = { + /** + * Custom Field Value Update Parameters + */ + body: UpdateEmploymentCustomFieldValueParams; + path: { /** - * Starts fetching records after the given page + * Custom field ID */ - page?: number; + custom_field_id: string; /** - * Number of items per page + * Employment ID */ - page_size?: number; + employment_id: string; }; - url: '/v1/contractor-invoice-schedules'; + query?: never; + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; -export type GetV1ContractorInvoiceSchedulesErrors = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors = { /** * Unauthorized */ @@ -23593,32 +24166,49 @@ export type GetV1ContractorInvoiceSchedulesErrors = { * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type GetV1ContractorInvoiceSchedulesError = - GetV1ContractorInvoiceSchedulesErrors[keyof GetV1ContractorInvoiceSchedulesErrors]; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Error = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors]; -export type GetV1ContractorInvoiceSchedulesResponses = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses = { /** * Success */ - 200: ListContractorInvoiceSchedulesResponse; + 200: EmploymentCustomFieldValueResponse; }; -export type GetV1ContractorInvoiceSchedulesResponse = - GetV1ContractorInvoiceSchedulesResponses[keyof GetV1ContractorInvoiceSchedulesResponses]; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Response = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Responses]; -export type PostV1ContractorInvoiceSchedulesData = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { /** - * Bulk creation payload + * Custom Field Value Update Parameters */ - body: BulkContractorInvoiceScheduleCreateParams; - path?: never; + body: UpdateEmploymentCustomFieldValueParams; + path: { + /** + * Custom field ID + */ + custom_field_id: string; + /** + * Employment ID + */ + employment_id: string; + }; query?: never; - url: '/v1/contractor-invoice-schedules'; + url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; -export type PostV1ContractorInvoiceSchedulesErrors = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ @@ -23628,66 +24218,96 @@ export type PostV1ContractorInvoiceSchedulesErrors = { */ 404: NotFoundResponse; /** - * BulkContractorInvoiceScheduleCreateResponse - * - * Response containing the lists of succeeded and failed schedules. + * Unprocessable Entity */ - 422: { - data: { - failures: Array; - successes: Array; - }; - }; + 422: UnprocessableEntityResponse; }; -export type PostV1ContractorInvoiceSchedulesError = - PostV1ContractorInvoiceSchedulesErrors[keyof PostV1ContractorInvoiceSchedulesErrors]; +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdError = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors]; -export type PostV1ContractorInvoiceSchedulesResponses = { +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses = { /** - * BulkContractorInvoiceScheduleCreateResponse - * - * Response containing the lists of succeeded and failed schedules. + * Success */ - 201: { - data: { - failures: Array; - successes: Array; - }; - }; + 200: EmploymentCustomFieldValueResponse; +}; + +export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponse = + PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses[keyof PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdResponses]; + +export type PutV1ResignationsOffboardingRequestIdValidateData = { /** - * BulkContractorInvoiceScheduleCreateResponse - * - * Response containing the lists of succeeded and failed schedules. + * ValidateResignation */ - 207: { - data: { - failures: Array; - successes: Array; - }; + body: ValidateResignationRequestParams; + path: { + /** + * Offboarding request ID + */ + offboarding_request_id: string; }; + query?: never; + url: '/api/eor/v1/resignations/{offboarding_request_id}/validate'; }; -export type PostV1ContractorInvoiceSchedulesResponse = - PostV1ContractorInvoiceSchedulesResponses[keyof PostV1ContractorInvoiceSchedulesResponses]; +export type PutV1ResignationsOffboardingRequestIdValidateErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; + /** + * Unprocessable Entity + */ + 429: TooManyRequestsResponse; +}; -export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { +export type PutV1ResignationsOffboardingRequestIdValidateError = + PutV1ResignationsOffboardingRequestIdValidateErrors[keyof PutV1ResignationsOffboardingRequestIdValidateErrors]; + +export type PutV1ResignationsOffboardingRequestIdValidateResponses = { + /** + * Success + */ + 200: SuccessResponse; +}; + +export type PutV1ResignationsOffboardingRequestIdValidateResponse = + PutV1ResignationsOffboardingRequestIdValidateResponses[keyof PutV1ResignationsOffboardingRequestIdValidateResponses]; + +export type GetV1ContractorInvoiceSchedulesIdData = { body?: never; path: { /** - * Employment ID + * Resource unique identifier */ - employment_id: string; + id: UuidSlug; }; query?: never; - url: '/v1/employments/{employment_id}/engagement-agreement-details'; + url: '/api/eor/v1/contractor-invoice-schedules/{id}'; }; -export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { +export type GetV1ContractorInvoiceSchedulesIdErrors = { /** * Bad Request */ 400: BadRequestResponse; + /** + * Unauthorized + */ + 401: UnauthorizedResponse; /** * Forbidden */ @@ -23706,39 +24326,39 @@ export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { 429: TooManyRequestsResponse; }; -export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsError = - GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; +export type GetV1ContractorInvoiceSchedulesIdError = + GetV1ContractorInvoiceSchedulesIdErrors[keyof GetV1ContractorInvoiceSchedulesIdErrors]; -export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { +export type GetV1ContractorInvoiceSchedulesIdResponses = { /** * Success */ - 200: EmploymentEngagementAgreementDetailsResponse; + 200: ContractorInvoiceScheduleResponse; }; -export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse = - GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof GetV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; +export type GetV1ContractorInvoiceSchedulesIdResponse = + GetV1ContractorInvoiceSchedulesIdResponses[keyof GetV1ContractorInvoiceSchedulesIdResponses]; -export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { +export type PatchV1ContractorInvoiceSchedulesId2Data = { /** - * Employment engagement agreement details params + * Update parameters */ - body?: EmploymentEngagementAgreementDetailsParams; + body: UpdateScheduleContractorInvoiceParams; path: { /** - * Employment ID + * Resource unique identifier */ - employment_id: string; + id: UuidSlug; }; query?: never; - url: '/v1/employments/{employment_id}/engagement-agreement-details'; + url: '/api/eor/v1/contractor-invoice-schedules/{id}'; }; -export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { +export type PatchV1ContractorInvoiceSchedulesId2Errors = { /** - * Bad Request + * Unauthorized */ - 400: BadRequestResponse; + 401: UnauthorizedResponse; /** * Forbidden */ @@ -23747,51 +24367,88 @@ export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { * Not Found */ 404: NotFoundResponse; - /** - * Conflict - */ - 409: ConflictResponse; /** * Unprocessable Entity */ 422: UnprocessableEntityResponse; - /** - * Unprocessable Entity - */ - 429: TooManyRequestsResponse; }; -export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsError = - PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors[keyof PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors]; +export type PatchV1ContractorInvoiceSchedulesId2Error = + PatchV1ContractorInvoiceSchedulesId2Errors[keyof PatchV1ContractorInvoiceSchedulesId2Errors]; -export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses = { +export type PatchV1ContractorInvoiceSchedulesId2Responses = { /** * Success */ - 200: SuccessResponse; + 200: ContractorInvoiceScheduleResponse; }; -export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponse = - PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses[keyof PostV1EmploymentsEmploymentIdEngagementAgreementDetailsResponses]; +export type PatchV1ContractorInvoiceSchedulesId2Response = + PatchV1ContractorInvoiceSchedulesId2Responses[keyof PatchV1ContractorInvoiceSchedulesId2Responses]; -export type GetV1BillingDocumentsBillingDocumentIdBreakdownData = { - body?: never; +export type PatchV1ContractorInvoiceSchedulesIdData = { + /** + * Update parameters + */ + body: UpdateScheduleContractorInvoiceParams; path: { /** - * The billing document's ID + * Resource unique identifier */ - billing_document_id: string; + id: UuidSlug; }; - query?: { + query?: never; + url: '/api/eor/v1/contractor-invoice-schedules/{id}'; +}; + +export type PatchV1ContractorInvoiceSchedulesIdErrors = { + /** + * Unauthorized + */ + 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; +}; + +export type PatchV1ContractorInvoiceSchedulesIdError = + PatchV1ContractorInvoiceSchedulesIdErrors[keyof PatchV1ContractorInvoiceSchedulesIdErrors]; + +export type PatchV1ContractorInvoiceSchedulesIdResponses = { + /** + * Success + */ + 200: ContractorInvoiceScheduleResponse; +}; + +export type PatchV1ContractorInvoiceSchedulesIdResponse = + PatchV1ContractorInvoiceSchedulesIdResponses[keyof PatchV1ContractorInvoiceSchedulesIdResponses]; + +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsData = { + /** + * Employment pricing plan details params + */ + body?: EmploymentPricingPlanDetailsParams; + path: { /** - * Filters the results by the type of the billing breakdown item. + * Employment ID */ - type?: string; + employment_id: string; }; - url: '/v1/billing-documents/{billing_document_id}/breakdown'; + query?: never; + url: '/api/eor/v2/employments/{employment_id}/pricing_plan_details'; }; -export type GetV1BillingDocumentsBillingDocumentIdBreakdownErrors = { +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors = { /** * Bad Request */ @@ -23800,10 +24457,18 @@ export type GetV1BillingDocumentsBillingDocumentIdBreakdownErrors = { * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -23814,105 +24479,98 @@ export type GetV1BillingDocumentsBillingDocumentIdBreakdownErrors = { 429: TooManyRequestsResponse; }; -export type GetV1BillingDocumentsBillingDocumentIdBreakdownError = - GetV1BillingDocumentsBillingDocumentIdBreakdownErrors[keyof GetV1BillingDocumentsBillingDocumentIdBreakdownErrors]; +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsError = + PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors[keyof PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors]; -export type GetV1BillingDocumentsBillingDocumentIdBreakdownResponses = { +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses = { /** * Success */ - 200: BillingDocumentBreakdownResponse; + 200: EmploymentResponse; }; -export type GetV1BillingDocumentsBillingDocumentIdBreakdownResponse = - GetV1BillingDocumentsBillingDocumentIdBreakdownResponses[keyof GetV1BillingDocumentsBillingDocumentIdBreakdownResponses]; +export type PutV2EmploymentsEmploymentIdPricingPlanDetailsResponse = + PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses[keyof PutV2EmploymentsEmploymentIdPricingPlanDetailsResponses]; -export type GetV1EmployeeDocumentsData = { - body?: never; +export type PostV1RiskReserveData = { + /** + * Risk Reserve + */ + body: CreateRiskReserveParams; path?: never; - query?: { - /** - * Starts fetching records after the given page - */ - page?: number; - /** - * Number of items per page - */ - page_size?: number; - /** - * Filter documents by their description or file name, accepts full and partial case insensitive matches - */ - name?: string; - /** - * Filters the results that were uploaded on or after a given date - */ - inserted_after?: Date; - /** - * Filters the results that were uploaded before a given date - */ - inserted_before?: Date; - /** - * Field to sort by - */ - sort_by?: - | 'description' - | 'document_source' - | 'inserted_at' - | 'name' - | 'type' - | 'uploaded_by_role' - | 'related_to' - | 'sub_type' - | 'uploaded_by'; - /** - * Sort order - */ - order?: 'asc' | 'desc'; - }; - url: '/v1/employee/documents'; + query?: never; + url: '/api/eor/v1/risk-reserve'; }; -export type GetV1EmployeeDocumentsErrors = { +export type PostV1RiskReserveErrors = { /** - * Forbidden + * Unauthorized */ - 403: ForbiddenResponse; + 401: UnauthorizedResponse; /** * Not Found */ 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; -export type GetV1EmployeeDocumentsError = - GetV1EmployeeDocumentsErrors[keyof GetV1EmployeeDocumentsErrors]; +export type PostV1RiskReserveError = + PostV1RiskReserveErrors[keyof PostV1RiskReserveErrors]; -export type GetV1EmployeeDocumentsResponses = { +export type PostV1RiskReserveResponses = { /** * Success */ - 200: ListDocumentsResponse; + 200: SuccessResponse; }; -export type GetV1EmployeeDocumentsResponse = - GetV1EmployeeDocumentsResponses[keyof GetV1EmployeeDocumentsResponses]; +export type PostV1RiskReserveResponse = + PostV1RiskReserveResponses[keyof PostV1RiskReserveResponses]; -export type PostV1TimeoffTimeoffIdCancelRequestApproveData = { - body?: never; +export type PutV2EmploymentsEmploymentIdAddressDetailsData = { + /** + * Employment address details params + */ + body?: EmploymentAddressDetailsParams; path: { /** - * Time Off ID + * Employment ID */ - timeoff_id: string; + employment_id: string; }; - query?: never; - url: '/v1/timeoff/{timeoff_id}/cancel-request/approve'; + query?: { + /** + * Version of the address_details form schema + */ + address_details_json_schema_version?: number | 'latest'; + }; + url: '/api/eor/v2/employments/{employment_id}/address_details'; }; -export type PostV1TimeoffTimeoffIdCancelRequestApproveErrors = { +export type PutV2EmploymentsEmploymentIdAddressDetailsErrors = { + /** + * Bad Request + */ + 400: BadRequestResponse; /** * Unauthorized */ 401: UnauthorizedResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Conflict + */ + 409: ConflictResponse; /** * Unprocessable Entity */ @@ -23923,32 +24581,36 @@ export type PostV1TimeoffTimeoffIdCancelRequestApproveErrors = { 429: TooManyRequestsResponse; }; -export type PostV1TimeoffTimeoffIdCancelRequestApproveError = - PostV1TimeoffTimeoffIdCancelRequestApproveErrors[keyof PostV1TimeoffTimeoffIdCancelRequestApproveErrors]; +export type PutV2EmploymentsEmploymentIdAddressDetailsError = + PutV2EmploymentsEmploymentIdAddressDetailsErrors[keyof PutV2EmploymentsEmploymentIdAddressDetailsErrors]; -export type PostV1TimeoffTimeoffIdCancelRequestApproveResponses = { +export type PutV2EmploymentsEmploymentIdAddressDetailsResponses = { /** * Success */ - 200: SuccessResponse; + 200: EmploymentResponse; }; -export type PostV1TimeoffTimeoffIdCancelRequestApproveResponse = - PostV1TimeoffTimeoffIdCancelRequestApproveResponses[keyof PostV1TimeoffTimeoffIdCancelRequestApproveResponses]; +export type PutV2EmploymentsEmploymentIdAddressDetailsResponse = + PutV2EmploymentsEmploymentIdAddressDetailsResponses[keyof PutV2EmploymentsEmploymentIdAddressDetailsResponses]; -export type PostV1IdentityVerificationEmploymentIdVerifyData = { +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData = { body?: never; path: { /** * Employment ID */ employment_id: string; + /** + * Document ID + */ + id: string; }; query?: never; - url: '/v1/identity-verification/{employment_id}/verify'; + url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{id}'; }; -export type PostV1IdentityVerificationEmploymentIdVerifyErrors = { +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors = { /** * Unauthorized */ @@ -23963,64 +24625,107 @@ export type PostV1IdentityVerificationEmploymentIdVerifyErrors = { 422: UnprocessableEntityResponse; }; -export type PostV1IdentityVerificationEmploymentIdVerifyError = - PostV1IdentityVerificationEmploymentIdVerifyErrors[keyof PostV1IdentityVerificationEmploymentIdVerifyErrors]; +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdError = + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors[keyof GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors]; -export type PostV1IdentityVerificationEmploymentIdVerifyResponses = { - /** - * Success - */ - 200: SuccessResponse; -}; +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses = + { + /** + * Success + */ + 200: ContractDocumentResponse; + }; -export type PostV1IdentityVerificationEmploymentIdVerifyResponse = - PostV1IdentityVerificationEmploymentIdVerifyResponses[keyof PostV1IdentityVerificationEmploymentIdVerifyResponses]; +export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponse = + GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses[keyof GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdResponses]; -export type GetV1BillingDocumentsBillingDocumentIdPdfData = { - body?: never; - headers: { +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData = + { + body?: never; + path: { + /** + * Employment ID + */ + employment_id: string; + }; + query?: never; + url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests'; + }; + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors = + { /** - * Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow. - * - * The refresh token needs to have been obtained through the Authorization Code flow. - * + * Bad Request */ - Authorization: string; + 400: BadRequestResponse; + /** + * Forbidden + */ + 403: ForbiddenResponse; + /** + * Not Found + */ + 404: NotFoundResponse; + /** + * Unprocessable Entity + */ + 422: UnprocessableEntityResponse; }; - path: { + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsError = + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors[keyof PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors]; + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses = + { /** - * The billing document's ID + * Created */ - billing_document_id: string; + 201: CorTerminationRequestCreatedResponse; }; - query?: never; - url: '/v1/billing-documents/{billing_document_id}/pdf'; + +export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponse = + PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses[keyof PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsResponses]; + +export type GetV1EmployeePayslipsData = { + body?: never; + path?: never; + query?: { + /** + * Starts fetching records after the given page + */ + page?: number; + /** + * Number of items per page + */ + page_size?: number; + }; + url: '/api/eor/v1/employee/payslips'; }; -export type GetV1BillingDocumentsBillingDocumentIdPdfErrors = { +export type GetV1EmployeePayslipsErrors = { /** * Unauthorized */ 401: UnauthorizedResponse; /** - * Not Found + * Forbidden */ - 404: NotFoundResponse; + 403: ForbiddenResponse; /** - * Unprocessable Entity + * Not Found */ - 422: UnprocessableEntityResponse; + 404: NotFoundResponse; }; -export type GetV1BillingDocumentsBillingDocumentIdPdfError = - GetV1BillingDocumentsBillingDocumentIdPdfErrors[keyof GetV1BillingDocumentsBillingDocumentIdPdfErrors]; +export type GetV1EmployeePayslipsError = + GetV1EmployeePayslipsErrors[keyof GetV1EmployeePayslipsErrors]; -export type GetV1BillingDocumentsBillingDocumentIdPdfResponses = { +export type GetV1EmployeePayslipsResponses = { /** * Success */ - 200: GenericFile; + 200: ListEmployeePayslipsResponse; }; -export type GetV1BillingDocumentsBillingDocumentIdPdfResponse = - GetV1BillingDocumentsBillingDocumentIdPdfResponses[keyof GetV1BillingDocumentsBillingDocumentIdPdfResponses]; +export type GetV1EmployeePayslipsResponse = + GetV1EmployeePayslipsResponses[keyof GetV1EmployeePayslipsResponses]; From 07fbf3a008c11d16eaf5e0bcec77dfa923985374 Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Fri, 15 May 2026 08:39:16 +0200 Subject: [PATCH 5/8] integrate --- openapi-ts.config.ts | 2 +- src/flows/Onboarding/api.ts | 19 +++++++++++-------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/openapi-ts.config.ts b/openapi-ts.config.ts index 77871dc17..2ec3f1e51 100644 --- a/openapi-ts.config.ts +++ b/openapi-ts.config.ts @@ -2,7 +2,7 @@ import { defineConfig, defaultPlugins } from '@hey-api/openapi-ts'; export default defineConfig({ // local gateway http://localhost:4000/api/eor/openapi - input: 'http://localhost:4000/api/eor/openapi', + input: 'https://gateway.remote.com/v1/docs/openapi.json', output: 'src/client', plugins: defaultPlugins, }); diff --git a/src/flows/Onboarding/api.ts b/src/flows/Onboarding/api.ts index 4ef70dda6..234345073 100644 --- a/src/flows/Onboarding/api.ts +++ b/src/flows/Onboarding/api.ts @@ -14,6 +14,7 @@ import { getV1EmploymentsEmploymentIdBenefitOffers, getV1EmploymentsEmploymentIdBenefitOffersSchema, getV1EmploymentsEmploymentIdEngagementAgreementDetails, + getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirements, patchV1EmploymentsEmploymentId2, postV1CurrencyConverterEffective, postV1CurrencyConverterRaw, @@ -569,17 +570,19 @@ export const useGetPreOnboardingRequirements = ( employmentId: string, options?: { queryOptions?: { enabled?: boolean } }, ) => { + const { client } = useClient(); + return useQuery({ queryKey: ['pre-onboarding-requirements', employmentId], - queryFn: async () => { - const { mockPreOnboardingRequirements } = - await import('@/src/common/api/fixtures/pre-onboarding'); - // Simulated delay - await new Promise((resolve) => setTimeout(resolve, 500)); - return mockPreOnboardingRequirements; - }, + queryFn: () => + getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirements({ + client: client as Client, + path: { + employment_id: employmentId, + }, + }), enabled: options?.queryOptions?.enabled ?? true, - select: (data) => data.data, + select: (response) => response.data?.data, }); }; From e1245c204a528a521cc90f958b7eb8c182dbc530 Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Fri, 15 May 2026 08:52:56 +0200 Subject: [PATCH 6/8] fix api/eor --- src/client/sdk.gen.ts | 498 ++++++++++++++++++++-------------------- src/client/types.gen.ts | 498 ++++++++++++++++++++-------------------- 2 files changed, 498 insertions(+), 498 deletions(-) diff --git a/src/client/sdk.gen.ts b/src/client/sdk.gen.ts index 5dce0bf6e..16ca37995 100644 --- a/src/client/sdk.gen.ts +++ b/src/client/sdk.gen.ts @@ -822,7 +822,7 @@ export const putV2EmploymentsEmploymentIdAdministrativeDetails = < PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/administrative_details', + url: '/v2/employments/{employment_id}/administrative_details', ...options, headers: { 'Content-Type': 'application/json', @@ -855,7 +855,7 @@ export const getV1EmploymentsEmploymentIdEngagementAgreementDetails = < GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details', + url: '/v1/employments/{employment_id}/engagement-agreement-details', ...options, }); @@ -894,7 +894,7 @@ export const postV1EmploymentsEmploymentIdEngagementAgreementDetails = < PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details', + url: '/v1/employments/{employment_id}/engagement-agreement-details', ...options, headers: { 'Content-Type': 'application/json', @@ -924,7 +924,7 @@ export const postV1CurrencyConverterEffective2 = < PostV1CurrencyConverterEffective2Errors, ThrowOnError >({ - url: '/api/eor/v1/currency-converter', + url: '/v1/currency-converter', ...options, headers: { 'Content-Type': 'application/json', @@ -958,7 +958,7 @@ export const getV1ContractorsEmploymentsEmploymentIdContractorSubscriptions = < GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-subscriptions', + url: '/v1/contractors/employments/{employment_id}/contractor-subscriptions', ...options, }); @@ -985,7 +985,7 @@ export const postV1CurrencyConverterRaw = < PostV1CurrencyConverterRawErrors, ThrowOnError >({ - url: '/api/eor/v1/currency-converter/raw', + url: '/v1/currency-converter/raw', ...options, headers: { 'Content-Type': 'application/json', @@ -1012,7 +1012,7 @@ export const getV1Incentives = ( GetV1IncentivesResponses, GetV1IncentivesErrors, ThrowOnError - >({ url: '/api/eor/v1/incentives', ...options }); + >({ url: '/v1/incentives', ...options }); /** * Create Incentive @@ -1037,7 +1037,7 @@ export const postV1Incentives = ( PostV1IncentivesErrors, ThrowOnError >({ - url: '/api/eor/v1/incentives', + url: '/v1/incentives', ...options, headers: { 'Content-Type': 'application/json', @@ -1065,7 +1065,7 @@ export const getV1BenefitOffers = ( GetV1BenefitOffersResponses, GetV1BenefitOffersErrors, ThrowOnError - >({ url: '/api/eor/v1/benefit-offers', ...options }); + >({ url: '/v1/benefit-offers', ...options }); /** * Complete onboarding @@ -1083,7 +1083,7 @@ export const postV1Ready = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/ready', + url: '/v1/ready', ...options, headers: { 'Content-Type': 'application/json', @@ -1104,7 +1104,7 @@ export const postV1CostCalculatorEstimation = < PostV1CostCalculatorEstimationErrors, ThrowOnError >({ - url: '/api/eor/v1/cost-calculator/estimation', + url: '/v1/cost-calculator/estimation', ...options, headers: { 'Content-Type': 'application/json', @@ -1132,7 +1132,7 @@ export const getV1IncentivesRecurring = ( GetV1IncentivesRecurringResponses, GetV1IncentivesRecurringErrors, ThrowOnError - >({ url: '/api/eor/v1/incentives/recurring', ...options }); + >({ url: '/v1/incentives/recurring', ...options }); /** * Create Recurring Incentive @@ -1157,7 +1157,7 @@ export const postV1IncentivesRecurring = ( PostV1IncentivesRecurringErrors, ThrowOnError >({ - url: '/api/eor/v1/incentives/recurring', + url: '/v1/incentives/recurring', ...options, headers: { 'Content-Type': 'application/json', @@ -1184,7 +1184,7 @@ export const getV1Timesheets = ( GetV1TimesheetsResponses, GetV1TimesheetsErrors, ThrowOnError - >({ url: '/api/eor/v1/timesheets', ...options }); + >({ url: '/v1/timesheets', ...options }); /** * Create timesheet @@ -1206,7 +1206,7 @@ export const postV1Timesheets = ( PostV1TimesheetsErrors, ThrowOnError >({ - url: '/api/eor/v1/timesheets', + url: '/v1/timesheets', ...options, headers: { 'Content-Type': 'application/json', @@ -1235,7 +1235,7 @@ export const postV1TimesheetsTimesheetIdApprove = < PostV1TimesheetsTimesheetIdApproveResponses, PostV1TimesheetsTimesheetIdApproveErrors, ThrowOnError - >({ url: '/api/eor/v1/timesheets/{timesheet_id}/approve', ...options }); + >({ url: '/v1/timesheets/{timesheet_id}/approve', ...options }); /** * Get latest data sync events @@ -1254,7 +1254,7 @@ export const getV1DataSync = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/data-sync', + url: '/v1/data-sync', ...options, }); @@ -1279,7 +1279,7 @@ export const postV1DataSync = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/data-sync', + url: '/v1/data-sync', ...options, headers: { 'Content-Type': 'application/json', @@ -1308,7 +1308,7 @@ export const getV1ProbationCompletionLetterId = < GetV1ProbationCompletionLetterIdResponses, GetV1ProbationCompletionLetterIdErrors, ThrowOnError - >({ url: '/api/eor/v1/probation-completion-letter/{id}', ...options }); + >({ url: '/v1/probation-completion-letter/{id}', ...options }); /** * Show the current SSO Configuration @@ -1329,7 +1329,7 @@ export const getV1SsoConfiguration = ( GetV1SsoConfigurationResponses, GetV1SsoConfigurationErrors, ThrowOnError - >({ url: '/api/eor/v1/sso-configuration', ...options }); + >({ url: '/v1/sso-configuration', ...options }); /** * Create the SSO Configuration @@ -1351,7 +1351,7 @@ export const postV1SsoConfiguration = ( PostV1SsoConfigurationErrors, ThrowOnError >({ - url: '/api/eor/v1/sso-configuration', + url: '/v1/sso-configuration', ...options, headers: { 'Content-Type': 'application/json', @@ -1378,7 +1378,7 @@ export const getV1Offboardings = ( GetV1OffboardingsResponses, GetV1OffboardingsErrors, ThrowOnError - >({ url: '/api/eor/v1/offboardings', ...options }); + >({ url: '/v1/offboardings', ...options }); /** * Create Offboarding @@ -1401,7 +1401,7 @@ export const postV1Offboardings = ( PostV1OffboardingsErrors, ThrowOnError >({ - url: '/api/eor/v1/offboardings', + url: '/v1/offboardings', ...options, headers: { 'Content-Type': 'application/json', @@ -1435,7 +1435,7 @@ export const postV1ContractorsEmploymentsEmploymentIdContractDocuments = < PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents', + url: '/v1/contractors/employments/{employment_id}/contract-documents', ...options, headers: { 'Content-Type': 'application/json', @@ -1488,7 +1488,7 @@ export const putV1EmploymentsEmploymentIdFederalTaxes = < PutV1EmploymentsEmploymentIdFederalTaxesErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/federal-taxes', + url: '/v1/employments/{employment_id}/federal-taxes', ...options, headers: { 'Content-Type': 'application/json', @@ -1519,7 +1519,7 @@ export const getV1CompaniesCompanyIdPricingPlans = < GetV1CompaniesCompanyIdPricingPlansResponses, GetV1CompaniesCompanyIdPricingPlansErrors, ThrowOnError - >({ url: '/api/eor/v1/companies/{company_id}/pricing-plans', ...options }); + >({ url: '/v1/companies/{company_id}/pricing-plans', ...options }); /** * Create a pricing plan for a company @@ -1549,7 +1549,7 @@ export const postV1CompaniesCompanyIdPricingPlans = < PostV1CompaniesCompanyIdPricingPlansErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/pricing-plans', + url: '/v1/companies/{company_id}/pricing-plans', ...options, headers: { 'Content-Type': 'application/json', @@ -1602,7 +1602,7 @@ export const putV2EmploymentsEmploymentIdFederalTaxes = < PutV2EmploymentsEmploymentIdFederalTaxesErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/federal-taxes', + url: '/v2/employments/{employment_id}/federal-taxes', ...options, headers: { 'Content-Type': 'application/json', @@ -1629,7 +1629,7 @@ export const getV1TravelLetterRequests = ( GetV1TravelLetterRequestsResponses, GetV1TravelLetterRequestsErrors, ThrowOnError - >({ url: '/api/eor/v1/travel-letter-requests', ...options }); + >({ url: '/v1/travel-letter-requests', ...options }); /** * Get engagement agreement details @@ -1656,7 +1656,7 @@ export const getV2EmploymentsEmploymentIdEngagementAgreementDetails = < GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details', + url: '/v2/employments/{employment_id}/engagement-agreement-details', ...options, }); @@ -1695,7 +1695,7 @@ export const postV2EmploymentsEmploymentIdEngagementAgreementDetails = < PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details', + url: '/v2/employments/{employment_id}/engagement-agreement-details', ...options, headers: { 'Content-Type': 'application/json', @@ -1717,7 +1717,7 @@ export const getV1WdGphPaySummary = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/wd/gph/paySummary', + url: '/v1/wd/gph/paySummary', ...options, }); @@ -1743,7 +1743,7 @@ export const getV1EmploymentsEmploymentIdJob = < GetV1EmploymentsEmploymentIdJobResponses, GetV1EmploymentsEmploymentIdJobErrors, ThrowOnError - >({ url: '/api/eor/v1/employments/{employment_id}/job', ...options }); + >({ url: '/v1/employments/{employment_id}/job', ...options }); /** * Create bulk employment job @@ -1765,7 +1765,7 @@ export const postV1BulkEmploymentJobs = ( PostV1BulkEmploymentJobsErrors, ThrowOnError >({ - url: '/api/eor/v1/bulk-employment-jobs', + url: '/v1/bulk-employment-jobs', ...options, headers: { 'Content-Type': 'application/json', @@ -1792,7 +1792,7 @@ export const getV1ContractAmendments = ( GetV1ContractAmendmentsResponses, GetV1ContractAmendmentsErrors, ThrowOnError - >({ url: '/api/eor/v1/contract-amendments', ...options }); + >({ url: '/v1/contract-amendments', ...options }); /** * Create Contract Amendment @@ -1832,7 +1832,7 @@ export const postV1ContractAmendments = ( PostV1ContractAmendmentsErrors, ThrowOnError >({ - url: '/api/eor/v1/contract-amendments', + url: '/v1/contract-amendments', ...options, headers: { 'Content-Type': 'application/json', @@ -1869,7 +1869,7 @@ export const deleteV1IncentivesRecurringId = < DeleteV1IncentivesRecurringIdResponses, DeleteV1IncentivesRecurringIdErrors, ThrowOnError - >({ url: '/api/eor/v1/incentives/recurring/{id}', ...options }); + >({ url: '/v1/incentives/recurring/{id}', ...options }); /** * Show Benefit Renewal Request @@ -1896,7 +1896,7 @@ export const getV1BenefitRenewalRequestsBenefitRenewalRequestId = < GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, ThrowOnError >({ - url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}', + url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}', ...options, }); @@ -1925,7 +1925,7 @@ export const postV1BenefitRenewalRequestsBenefitRenewalRequestId = < PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors, ThrowOnError >({ - url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}', + url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -1955,7 +1955,7 @@ export const getV1CountriesCountryCodeHolidaysYear = < GetV1CountriesCountryCodeHolidaysYearErrors, ThrowOnError >({ - url: '/api/eor/v1/countries/{country_code}/holidays/{year}', + url: '/v1/countries/{country_code}/holidays/{year}', ...options, }); @@ -1981,7 +1981,7 @@ export const getV1EmploymentsEmploymentIdCustomFields = < GetV1EmploymentsEmploymentIdCustomFieldsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/custom-fields', + url: '/v1/employments/{employment_id}/custom-fields', ...options, }); @@ -2004,7 +2004,7 @@ export const getV1TimesheetsId = ( GetV1TimesheetsIdResponses, GetV1TimesheetsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/timesheets/{id}', ...options }); + >({ url: '/v1/timesheets/{id}', ...options }); /** * List Company Managers @@ -2027,7 +2027,7 @@ export const getV1CompanyManagers = ( GetV1CompanyManagersResponses, GetV1CompanyManagersErrors, ThrowOnError - >({ url: '/api/eor/v1/company-managers', ...options }); + >({ url: '/v1/company-managers', ...options }); /** * Create and invite a Company Manager @@ -2049,7 +2049,7 @@ export const postV1CompanyManagers = ( PostV1CompanyManagersErrors, ThrowOnError >({ - url: '/api/eor/v1/company-managers', + url: '/v1/company-managers', ...options, headers: { 'Content-Type': 'application/json', @@ -2080,7 +2080,7 @@ export const postV1PayItemsBulk = ( PostV1PayItemsBulkErrors, ThrowOnError >({ - url: '/api/eor/v1/pay-items/bulk', + url: '/v1/pay-items/bulk', ...options, headers: { 'Content-Type': 'application/json', @@ -2109,7 +2109,7 @@ export const getV1TravelLetterRequestsId = < GetV1TravelLetterRequestsIdResponses, GetV1TravelLetterRequestsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/travel-letter-requests/{id}', ...options }); + >({ url: '/v1/travel-letter-requests/{id}', ...options }); /** * Updates a travel letter request @@ -2133,7 +2133,7 @@ export const patchV1TravelLetterRequestsId2 = < PatchV1TravelLetterRequestsId2Errors, ThrowOnError >({ - url: '/api/eor/v1/travel-letter-requests/{id}', + url: '/v1/travel-letter-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2163,7 +2163,7 @@ export const patchV1TravelLetterRequestsId = < PatchV1TravelLetterRequestsIdErrors, ThrowOnError >({ - url: '/api/eor/v1/travel-letter-requests/{id}', + url: '/v1/travel-letter-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2192,7 +2192,7 @@ export const postV1SandboxCompaniesCompanyIdBypassEligibilityChecks = < PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/companies/{company_id}/bypass-eligibility-checks', + url: '/v1/sandbox/companies/{company_id}/bypass-eligibility-checks', ...options, }); @@ -2217,7 +2217,7 @@ export const getV1EmployeeLeavePolicies = < GetV1EmployeeLeavePoliciesResponses, GetV1EmployeeLeavePoliciesErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/leave-policies', ...options }); + >({ url: '/v1/employee/leave-policies', ...options }); /** * List Webhook Callbacks @@ -2241,7 +2241,7 @@ export const getV1CompaniesCompanyIdWebhookCallbacks = < GetV1CompaniesCompanyIdWebhookCallbacksErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/webhook-callbacks', + url: '/v1/companies/{company_id}/webhook-callbacks', ...options, }); @@ -2267,7 +2267,7 @@ export const getV1BillingDocumentsBillingDocumentIdPdf = < GetV1BillingDocumentsBillingDocumentIdPdfErrors, ThrowOnError >({ - url: '/api/eor/v1/billing-documents/{billing_document_id}/pdf', + url: '/v1/billing-documents/{billing_document_id}/pdf', ...options, }); @@ -2292,7 +2292,7 @@ export const deleteV1WebhookCallbacksId = < DeleteV1WebhookCallbacksIdResponses, DeleteV1WebhookCallbacksIdErrors, ThrowOnError - >({ url: '/api/eor/v1/webhook-callbacks/{id}', ...options }); + >({ url: '/v1/webhook-callbacks/{id}', ...options }); /** * Update a Webhook Callback @@ -2314,7 +2314,7 @@ export const patchV1WebhookCallbacksId = ( PatchV1WebhookCallbacksIdErrors, ThrowOnError >({ - url: '/api/eor/v1/webhook-callbacks/{id}', + url: '/v1/webhook-callbacks/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2344,7 +2344,7 @@ export const getV1Countries = ( GetV1CountriesResponses, GetV1CountriesErrors, ThrowOnError - >({ url: '/api/eor/v1/countries', ...options }); + >({ url: '/v1/countries', ...options }); /** * Show contractor eligibility and COR-supported countries for legal entity @@ -2374,7 +2374,7 @@ export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibil GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility', + url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility', ...options, }); @@ -2400,7 +2400,7 @@ export const postV1CurrencyConverterEffective = < PostV1CurrencyConverterEffectiveErrors, ThrowOnError >({ - url: '/api/eor/v1/currency-converter/effective', + url: '/v1/currency-converter/effective', ...options, headers: { 'Content-Type': 'application/json', @@ -2429,7 +2429,7 @@ export const getV1EmployeePersonalInformation = < GetV1EmployeePersonalInformationResponses, GetV1EmployeePersonalInformationErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/personal-information', ...options }); + >({ url: '/v1/employee/personal-information', ...options }); /** * Show form schema @@ -2483,7 +2483,7 @@ export const getV1CountriesCountryCodeForm = < GetV1CountriesCountryCodeFormResponses, GetV1CountriesCountryCodeFormErrors, ThrowOnError - >({ url: '/api/eor/v1/countries/{country_code}/{form}', ...options }); + >({ url: '/v1/countries/{country_code}/{form}', ...options }); /** * List Time Off @@ -2504,7 +2504,7 @@ export const getV1Timeoff = ( GetV1TimeoffResponses, GetV1TimeoffErrors, ThrowOnError - >({ url: '/api/eor/v1/timeoff', ...options }); + >({ url: '/v1/timeoff', ...options }); /** * Create Time Off @@ -2526,7 +2526,7 @@ export const postV1Timeoff = ( PostV1TimeoffErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff', + url: '/v1/timeoff', ...options, headers: { 'Content-Type': 'application/json', @@ -2548,7 +2548,7 @@ export const getV1CostCalculatorCountries = < GetV1CostCalculatorCountriesResponses, unknown, ThrowOnError - >({ url: '/api/eor/v1/cost-calculator/countries', ...options }); + >({ url: '/v1/cost-calculator/countries', ...options }); /** * Submit risk reserve proof of payment @@ -2579,7 +2579,7 @@ export const postV1EmploymentsEmploymentIdRiskReserveProofOfPayments = < ThrowOnError >({ ...formDataBodySerializer, - url: '/api/eor/v1/employments/{employment_id}/risk-reserve-proof-of-payments', + url: '/v1/employments/{employment_id}/risk-reserve-proof-of-payments', ...options, headers: { 'Content-Type': null, @@ -2612,7 +2612,7 @@ export const getV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckId = < GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/background-checks/{background_check_id}', + url: '/v1/employments/{employment_id}/background-checks/{background_check_id}', ...options, }); @@ -2642,7 +2642,7 @@ export const getV1TimeoffBalancesEmploymentId = < GetV1TimeoffBalancesEmploymentIdResponses, GetV1TimeoffBalancesEmploymentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/timeoff-balances/{employment_id}', ...options }); + >({ url: '/v1/timeoff-balances/{employment_id}', ...options }); /** * List expenses for the authenticated employee @@ -2663,7 +2663,7 @@ export const getV1EmployeeExpenses = ( GetV1EmployeeExpensesResponses, GetV1EmployeeExpensesErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/expenses', ...options }); + >({ url: '/v1/employee/expenses', ...options }); /** * Create an expense for the authenticated employee @@ -2685,7 +2685,7 @@ export const postV1EmployeeExpenses = ( PostV1EmployeeExpensesErrors, ThrowOnError >({ - url: '/api/eor/v1/employee/expenses', + url: '/v1/employee/expenses', ...options, headers: { 'Content-Type': 'application/json', @@ -2718,7 +2718,7 @@ export const getV1ResignationsOffboardingRequestIdResignationLetter = < GetV1ResignationsOffboardingRequestIdResignationLetterErrors, ThrowOnError >({ - url: '/api/eor/v1/resignations/{offboarding_request_id}/resignation-letter', + url: '/v1/resignations/{offboarding_request_id}/resignation-letter', ...options, }); @@ -2743,7 +2743,7 @@ export const deleteV1CompanyManagersUserId = < DeleteV1CompanyManagersUserIdResponses, DeleteV1CompanyManagersUserIdErrors, ThrowOnError - >({ url: '/api/eor/v1/company-managers/{user_id}', ...options }); + >({ url: '/v1/company-managers/{user_id}', ...options }); /** * Show company manager user @@ -2766,7 +2766,7 @@ export const getV1CompanyManagersUserId = < GetV1CompanyManagersUserIdResponses, GetV1CompanyManagersUserIdErrors, ThrowOnError - >({ url: '/api/eor/v1/company-managers/{user_id}', ...options }); + >({ url: '/v1/company-managers/{user_id}', ...options }); /** * Show onboarding steps for an employment @@ -2793,7 +2793,7 @@ export const getV1EmploymentsEmploymentIdOnboardingSteps = < GetV1EmploymentsEmploymentIdOnboardingStepsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/onboarding-steps', + url: '/v1/employments/{employment_id}/onboarding-steps', ...options, }); @@ -2839,7 +2839,7 @@ export const postV1ContractAmendmentsAutomatable = < PostV1ContractAmendmentsAutomatableErrors, ThrowOnError >({ - url: '/api/eor/v1/contract-amendments/automatable', + url: '/v1/contract-amendments/automatable', ...options, headers: { 'Content-Type': 'application/json', @@ -2866,7 +2866,7 @@ export const getV1PayrollRuns = ( GetV1PayrollRunsResponses, GetV1PayrollRunsErrors, ThrowOnError - >({ url: '/api/eor/v1/payroll-runs', ...options }); + >({ url: '/v1/payroll-runs', ...options }); /** * List incentives for the authenticated employee @@ -2887,7 +2887,7 @@ export const getV1EmployeeIncentives = ( GetV1EmployeeIncentivesResponses, GetV1EmployeeIncentivesErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/incentives', ...options }); + >({ url: '/v1/employee/incentives', ...options }); /** * Update employment @@ -2911,7 +2911,7 @@ export const patchV1SandboxEmploymentsEmploymentId2 = < PatchV1SandboxEmploymentsEmploymentId2Errors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/employments/{employment_id}', + url: '/v1/sandbox/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2941,7 +2941,7 @@ export const patchV1SandboxEmploymentsEmploymentId = < PatchV1SandboxEmploymentsEmploymentIdErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/employments/{employment_id}', + url: '/v1/sandbox/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -2977,7 +2977,7 @@ export const getV1BenefitRenewalRequestsBenefitRenewalRequestIdSchema = < GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors, ThrowOnError >({ - url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema', + url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema', ...options, }); @@ -3024,7 +3024,7 @@ export const putV2EmploymentsEmploymentIdBillingAddressDetails = < PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/billing_address_details', + url: '/v2/employments/{employment_id}/billing_address_details', ...options, headers: { 'Content-Type': 'application/json', @@ -3056,7 +3056,7 @@ export const deleteV1IncentivesId = ( DeleteV1IncentivesIdResponses, DeleteV1IncentivesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/incentives/{id}', ...options }); + >({ url: '/v1/incentives/{id}', ...options }); /** * Show Incentive @@ -3077,7 +3077,7 @@ export const getV1IncentivesId = ( GetV1IncentivesIdResponses, GetV1IncentivesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/incentives/{id}', ...options }); + >({ url: '/v1/incentives/{id}', ...options }); /** * Update Incentive @@ -3104,7 +3104,7 @@ export const patchV1IncentivesId2 = ( PatchV1IncentivesId2Errors, ThrowOnError >({ - url: '/api/eor/v1/incentives/{id}', + url: '/v1/incentives/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -3137,7 +3137,7 @@ export const patchV1IncentivesId = ( PatchV1IncentivesIdErrors, ThrowOnError >({ - url: '/api/eor/v1/incentives/{id}', + url: '/v1/incentives/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -3170,7 +3170,7 @@ export const getV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDeta GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', ...options, }); @@ -3199,7 +3199,7 @@ export const putV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDeta PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', + url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details', ...options, headers: { 'Content-Type': 'application/json', @@ -3250,7 +3250,7 @@ export const putV2EmploymentsEmploymentIdBankAccountDetails = < PutV2EmploymentsEmploymentIdBankAccountDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/bank_account_details', + url: '/v2/employments/{employment_id}/bank_account_details', ...options, headers: { 'Content-Type': 'application/json', @@ -3277,7 +3277,7 @@ export const getV1ContractorInvoices = ( GetV1ContractorInvoicesResponses, GetV1ContractorInvoicesErrors, ThrowOnError - >({ url: '/api/eor/v1/contractor-invoices', ...options }); + >({ url: '/v1/contractor-invoices', ...options }); /** * List expense categories @@ -3291,7 +3291,7 @@ export const getV1ExpensesCategories = ( GetV1ExpensesCategoriesResponses, GetV1ExpensesCategoriesErrors, ThrowOnError - >({ url: '/api/eor/v1/expenses/categories', ...options }); + >({ url: '/v1/expenses/categories', ...options }); /** * List contract documents for an employment @@ -3318,7 +3318,7 @@ export const getV1EmploymentsEmploymentIdContractDocuments = < GetV1EmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/contract-documents', + url: '/v1/employments/{employment_id}/contract-documents', ...options, }); @@ -3347,7 +3347,7 @@ export const getV1CountriesCountryCodeContractorContractDetails = < GetV1CountriesCountryCodeContractorContractDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/countries/{country_code}/contractor-contract-details', + url: '/v1/countries/{country_code}/contractor-contract-details', ...options, }); @@ -3365,7 +3365,7 @@ export const getV1ScimV2UsersId = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/scim/v2/Users/{id}', + url: '/v1/scim/v2/Users/{id}', ...options, }); @@ -3393,7 +3393,7 @@ export const getV1EmploymentsEmploymentIdFiles = < GetV1EmploymentsEmploymentIdFilesResponses, GetV1EmploymentsEmploymentIdFilesErrors, ThrowOnError - >({ url: '/api/eor/v1/employments/{employment_id}/files', ...options }); + >({ url: '/v1/employments/{employment_id}/files', ...options }); /** * Manage contractor plus subscription @@ -3422,7 +3422,7 @@ export const postV1ContractorsEmploymentsEmploymentIdContractorPlusSubscription PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-plus-subscription', + url: '/v1/contractors/employments/{employment_id}/contractor-plus-subscription', ...options, headers: { 'Content-Type': 'application/json', @@ -3461,7 +3461,7 @@ export const postV1ContractorsEligibilityQuestionnaire = < PostV1ContractorsEligibilityQuestionnaireErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/eligibility-questionnaire', + url: '/v1/contractors/eligibility-questionnaire', ...options, headers: { 'Content-Type': 'application/json', @@ -3514,7 +3514,7 @@ export const putV1EmploymentsEmploymentIdBasicInformation = < PutV1EmploymentsEmploymentIdBasicInformationErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/basic_information', + url: '/v1/employments/{employment_id}/basic_information', ...options, headers: { 'Content-Type': 'application/json', @@ -3547,7 +3547,7 @@ export const getV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTermin GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}', + url: '/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}', ...options, }); @@ -3574,7 +3574,7 @@ export const postV1SandboxCompaniesCompanyIdLegalEntities = < PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/companies/{company_id}/legal-entities', + url: '/v1/sandbox/companies/{company_id}/legal-entities', ...options, headers: { 'Content-Type': 'application/json', @@ -3596,7 +3596,7 @@ export const getV1WdGphPayDetailData = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/wd/gph/payDetailData', + url: '/v1/wd/gph/payDetailData', ...options, }); @@ -3616,7 +3616,7 @@ export const getV1CostCalculatorRegionsSlugFields = < GetV1CostCalculatorRegionsSlugFieldsResponses, GetV1CostCalculatorRegionsSlugFieldsErrors, ThrowOnError - >({ url: '/api/eor/v1/cost-calculator/regions/{slug}/fields', ...options }); + >({ url: '/v1/cost-calculator/regions/{slug}/fields', ...options }); /** * Cancel onboarding @@ -3645,7 +3645,7 @@ export const postV1CancelOnboardingEmploymentId = < PostV1CancelOnboardingEmploymentIdResponses, PostV1CancelOnboardingEmploymentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/cancel-onboarding/{employment_id}', ...options }); + >({ url: '/v1/cancel-onboarding/{employment_id}', ...options }); /** * Cancel Time Off as Employee @@ -3669,7 +3669,7 @@ export const postV1EmployeeTimeoffIdCancel = < PostV1EmployeeTimeoffIdCancelErrors, ThrowOnError >({ - url: '/api/eor/v1/employee/timeoff/{id}/cancel', + url: '/v1/employee/timeoff/{id}/cancel', ...options, headers: { 'Content-Type': 'application/json', @@ -3703,7 +3703,7 @@ export const getV1ExpensesExpenseIdReceipt = < GetV1ExpensesExpenseIdReceiptResponses, GetV1ExpensesExpenseIdReceiptErrors, ThrowOnError - >({ url: '/api/eor/v1/expenses/{expense_id}/receipt', ...options }); + >({ url: '/v1/expenses/{expense_id}/receipt', ...options }); /** * List Benefit Offers @@ -3727,7 +3727,7 @@ export const getV1BenefitOffersCountrySummaries = < GetV1BenefitOffersCountrySummariesResponses, GetV1BenefitOffersCountrySummariesErrors, ThrowOnError - >({ url: '/api/eor/v1/benefit-offers/country-summaries', ...options }); + >({ url: '/v1/benefit-offers/country-summaries', ...options }); /** * List Leave Policies Details @@ -3750,7 +3750,7 @@ export const getV1LeavePoliciesDetailsEmploymentId = < GetV1LeavePoliciesDetailsEmploymentIdResponses, GetV1LeavePoliciesDetailsEmploymentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/leave-policies/details/{employment_id}', ...options }); + >({ url: '/v1/leave-policies/details/{employment_id}', ...options }); /** * List work authorization requests @@ -3773,7 +3773,7 @@ export const getV1WorkAuthorizationRequests = < GetV1WorkAuthorizationRequestsResponses, GetV1WorkAuthorizationRequestsErrors, ThrowOnError - >({ url: '/api/eor/v1/work-authorization-requests', ...options }); + >({ url: '/v1/work-authorization-requests', ...options }); /** * Get employment benefit offers @@ -3795,7 +3795,7 @@ export const getV1EmploymentsEmploymentIdBenefitOffers = < GetV1EmploymentsEmploymentIdBenefitOffersErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/benefit-offers', + url: '/v1/employments/{employment_id}/benefit-offers', ...options, }); @@ -3813,7 +3813,7 @@ export const putV1EmploymentsEmploymentIdBenefitOffers = < ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/employments/{employment_id}/benefit-offers', + url: '/v1/employments/{employment_id}/benefit-offers', ...options, headers: { 'Content-Type': 'application/json', @@ -3853,7 +3853,7 @@ export const getV1Employments = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/employments', + url: '/v1/employments', ...options, }); @@ -3904,7 +3904,7 @@ export const postV1Employments = ( PostV1EmploymentsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments', + url: '/v1/employments', ...options, headers: { 'Content-Type': 'application/json', @@ -3931,7 +3931,7 @@ export const getV1TimeoffId = ( GetV1TimeoffIdResponses, GetV1TimeoffIdErrors, ThrowOnError - >({ url: '/api/eor/v1/timeoff/{id}', ...options }); + >({ url: '/v1/timeoff/{id}', ...options }); /** * Update Time Off @@ -3956,7 +3956,7 @@ export const patchV1TimeoffId2 = ( PatchV1TimeoffId2Errors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{id}', + url: '/v1/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -3987,7 +3987,7 @@ export const patchV1TimeoffId = ( PatchV1TimeoffIdErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{id}', + url: '/v1/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4008,7 +4008,7 @@ export const getV1IdentityCurrent = ( GetV1IdentityCurrentResponses, GetV1IdentityCurrentErrors, ThrowOnError - >({ url: '/api/eor/v1/identity/current', ...options }); + >({ url: '/v1/identity/current', ...options }); /** * Payroll Variance Analysis API resource @@ -4024,7 +4024,7 @@ export const getV1WdGphPayVariance = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/wd/gph/payVariance', + url: '/v1/wd/gph/payVariance', ...options, }); @@ -4049,7 +4049,7 @@ export const getV1PayrollCalendarsCycle = < GetV1PayrollCalendarsCycleResponses, GetV1PayrollCalendarsCycleErrors, ThrowOnError - >({ url: '/api/eor/v1/payroll-calendars/{cycle}', ...options }); + >({ url: '/v1/payroll-calendars/{cycle}', ...options }); /** * Terminate contractor of record employment @@ -4083,7 +4083,7 @@ export const postV1ContractorsEmploymentsEmploymentIdTerminateCorEmployment = < PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/terminate-cor-employment', + url: '/v1/contractors/employments/{employment_id}/terminate-cor-employment', ...options, }); @@ -4109,7 +4109,7 @@ export const postV1TimesheetsTimesheetIdSendBack = < PostV1TimesheetsTimesheetIdSendBackErrors, ThrowOnError >({ - url: '/api/eor/v1/timesheets/{timesheet_id}/send-back', + url: '/v1/timesheets/{timesheet_id}/send-back', ...options, headers: { 'Content-Type': 'application/json', @@ -4143,7 +4143,7 @@ export const postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSign PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors, ThrowOnError >({ - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign', + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign', ...options, headers: { 'Content-Type': 'application/json', @@ -4172,7 +4172,7 @@ export const getV1BenefitRenewalRequests = < GetV1BenefitRenewalRequestsResponses, GetV1BenefitRenewalRequestsErrors, ThrowOnError - >({ url: '/api/eor/v1/benefit-renewal-requests', ...options }); + >({ url: '/v1/benefit-renewal-requests', ...options }); /** * Reassign default legal entity @@ -4196,7 +4196,7 @@ export const putV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityId = < PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}', + url: '/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}', ...options, }); @@ -4219,7 +4219,7 @@ export const getV1EmploymentContracts = ( GetV1EmploymentContractsResponses, GetV1EmploymentContractsErrors, ThrowOnError - >({ url: '/api/eor/v1/employment-contracts', ...options }); + >({ url: '/v1/employment-contracts', ...options }); /** * Cancel Contract Amendment @@ -4242,7 +4242,7 @@ export const putV1SandboxContractAmendmentsContractAmendmentRequestIdCancel = < PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel', + url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel', ...options, }); @@ -4267,7 +4267,7 @@ export const getV1PayslipsPayslipIdPdf = ( GetV1PayslipsPayslipIdPdfResponses, GetV1PayslipsPayslipIdPdfErrors, ThrowOnError - >({ url: '/api/eor/v1/payslips/{payslip_id}/pdf', ...options }); + >({ url: '/v1/payslips/{payslip_id}/pdf', ...options }); /** * Approve Time Off @@ -4291,7 +4291,7 @@ export const postV1TimeoffTimeoffIdApprove = < PostV1TimeoffTimeoffIdApproveErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{timeoff_id}/approve', + url: '/v1/timeoff/{timeoff_id}/approve', ...options, headers: { 'Content-Type': 'application/json', @@ -4318,7 +4318,7 @@ export const getV1Companies = ( GetV1CompaniesResponses, GetV1CompaniesErrors, ThrowOnError - >({ url: '/api/eor/v1/companies', ...options }); + >({ url: '/v1/companies', ...options }); /** * Create a company @@ -4372,7 +4372,7 @@ export const postV1Companies = ( PostV1CompaniesErrors, ThrowOnError >({ - url: '/api/eor/v1/companies', + url: '/v1/companies', ...options, headers: { 'Content-Type': 'application/json', @@ -4406,7 +4406,7 @@ export const getV1EmploymentsEmploymentIdCompanyStructureNodes = < GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/company-structure-nodes', + url: '/v1/employments/{employment_id}/company-structure-nodes', ...options, }); @@ -4424,7 +4424,7 @@ export const patchV2EmploymentsEmploymentId2 = < ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v2/employments/{employment_id}', + url: '/v2/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4446,7 +4446,7 @@ export const patchV2EmploymentsEmploymentId = < ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v2/employments/{employment_id}', + url: '/v2/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4476,7 +4476,7 @@ export const postV1ProbationCompletionLetter = < PostV1ProbationCompletionLetterErrors, ThrowOnError >({ - url: '/api/eor/v1/probation-completion-letter', + url: '/v1/probation-completion-letter', ...options, headers: { 'Content-Type': 'application/json', @@ -4499,7 +4499,7 @@ export const postV1CostCalculatorEstimationPdf = < PostV1CostCalculatorEstimationPdfErrors, ThrowOnError >({ - url: '/api/eor/v1/cost-calculator/estimation-pdf', + url: '/v1/cost-calculator/estimation-pdf', ...options, headers: { 'Content-Type': 'application/json', @@ -4545,7 +4545,7 @@ export const getV1EmployeeDocumentsId = ( GetV1EmployeeDocumentsIdResponses, GetV1EmployeeDocumentsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/documents/{id}', ...options }); + >({ url: '/v1/employee/documents/{id}', ...options }); /** * Replay Webhook Events @@ -4567,7 +4567,7 @@ export const postV1WebhookEventsReplay = ( PostV1WebhookEventsReplayErrors, ThrowOnError >({ - url: '/api/eor/v1/webhook-events/replay', + url: '/v1/webhook-events/replay', ...options, headers: { 'Content-Type': 'application/json', @@ -4593,7 +4593,7 @@ export const postV1SandboxWebhookCallbacksTrigger = < PostV1SandboxWebhookCallbacksTriggerErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/webhook-callbacks/trigger', + url: '/v1/sandbox/webhook-callbacks/trigger', ...options, headers: { 'Content-Type': 'application/json', @@ -4620,7 +4620,7 @@ export const getV1BulkEmploymentJobsJobId = < GetV1BulkEmploymentJobsJobIdResponses, GetV1BulkEmploymentJobsJobIdErrors, ThrowOnError - >({ url: '/api/eor/v1/bulk-employment-jobs/{job_id}', ...options }); + >({ url: '/v1/bulk-employment-jobs/{job_id}', ...options }); /** * List bulk employment rows @@ -4643,7 +4643,7 @@ export const getV1BulkEmploymentJobsJobIdRows = < GetV1BulkEmploymentJobsJobIdRowsResponses, GetV1BulkEmploymentJobsJobIdRowsErrors, ThrowOnError - >({ url: '/api/eor/v1/bulk-employment-jobs/{job_id}/rows', ...options }); + >({ url: '/v1/bulk-employment-jobs/{job_id}/rows', ...options }); /** * Magic links generator @@ -4668,7 +4668,7 @@ export const postV1MagicLink = ( PostV1MagicLinkErrors, ThrowOnError >({ - url: '/api/eor/v1/magic-link', + url: '/v1/magic-link', ...options, headers: { 'Content-Type': 'application/json', @@ -4699,7 +4699,7 @@ export const getV1CompaniesCompanyId = ( GetV1CompaniesCompanyIdResponses, GetV1CompaniesCompanyIdErrors, ThrowOnError - >({ url: '/api/eor/v1/companies/{company_id}', ...options }); + >({ url: '/v1/companies/{company_id}', ...options }); /** * Update a company @@ -4740,7 +4740,7 @@ export const patchV1CompaniesCompanyId2 = < PatchV1CompaniesCompanyId2Errors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}', + url: '/v1/companies/{company_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4785,7 +4785,7 @@ export const patchV1CompaniesCompanyId = ( PatchV1CompaniesCompanyIdErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}', + url: '/v1/companies/{company_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -4814,7 +4814,7 @@ export const getV1CompaniesSchema = ( GetV1CompaniesSchemaResponses, GetV1CompaniesSchemaErrors, ThrowOnError - >({ url: '/api/eor/v1/companies/schema', ...options }); + >({ url: '/v1/companies/schema', ...options }); /** * List pricing plan partner templates @@ -4838,7 +4838,7 @@ export const getV1PricingPlanPartnerTemplates = < GetV1PricingPlanPartnerTemplatesResponses, GetV1PricingPlanPartnerTemplatesErrors, ThrowOnError - >({ url: '/api/eor/v1/pricing-plan-partner-templates', ...options }); + >({ url: '/v1/pricing-plan-partner-templates', ...options }); /** * Show engagement agreement details @@ -4866,7 +4866,7 @@ export const getV1CountriesCountryCodeEngagementAgreementDetails = < GetV1CountriesCountryCodeEngagementAgreementDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/countries/{country_code}/engagement-agreement-details', + url: '/v1/countries/{country_code}/engagement-agreement-details', ...options, }); @@ -4913,7 +4913,7 @@ export const putV2EmploymentsEmploymentIdContractDetails = < PutV2EmploymentsEmploymentIdContractDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/contract_details', + url: '/v2/employments/{employment_id}/contract_details', ...options, headers: { 'Content-Type': 'application/json', @@ -4945,7 +4945,7 @@ export const getV1CompaniesCompanyIdProductPrices = < GetV1CompaniesCompanyIdProductPricesResponses, GetV1CompaniesCompanyIdProductPricesErrors, ThrowOnError - >({ url: '/api/eor/v1/companies/{company_id}/product-prices', ...options }); + >({ url: '/v1/companies/{company_id}/product-prices', ...options }); /** * Create a new token for a company @@ -4961,7 +4961,7 @@ export const postV1CompaniesCompanyIdCreateToken = < PostV1CompaniesCompanyIdCreateTokenResponses, PostV1CompaniesCompanyIdCreateTokenErrors, ThrowOnError - >({ url: '/api/eor/v1/companies/{company_id}/create-token', ...options }); + >({ url: '/v1/companies/{company_id}/create-token', ...options }); /** * Get Employment Profile @@ -4985,7 +4985,7 @@ export const getV1IdentityVerificationEmploymentId = < GetV1IdentityVerificationEmploymentIdResponses, GetV1IdentityVerificationEmploymentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/identity-verification/{employment_id}', ...options }); + >({ url: '/v1/identity-verification/{employment_id}', ...options }); /** * Download a receipt by id @@ -5009,7 +5009,7 @@ export const getV1ExpensesExpenseIdReceiptsReceiptId = < GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, ThrowOnError >({ - url: '/api/eor/v1/expenses/{expense_id}/receipts/{receipt_id}', + url: '/v1/expenses/{expense_id}/receipts/{receipt_id}', ...options, }); @@ -5027,7 +5027,7 @@ export const getV1ScimV2Groups = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/scim/v2/Groups', + url: '/v1/scim/v2/Groups', ...options, }); @@ -5050,7 +5050,7 @@ export const getV1ExpensesId = ( GetV1ExpensesIdResponses, GetV1ExpensesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/expenses/{id}', ...options }); + >({ url: '/v1/expenses/{id}', ...options }); /** * Update an expense @@ -5072,7 +5072,7 @@ export const patchV1ExpensesId2 = ( PatchV1ExpensesId2Errors, ThrowOnError >({ - url: '/api/eor/v1/expenses/{id}', + url: '/v1/expenses/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5100,7 +5100,7 @@ export const patchV1ExpensesId = ( PatchV1ExpensesIdErrors, ThrowOnError >({ - url: '/api/eor/v1/expenses/{id}', + url: '/v1/expenses/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5138,7 +5138,7 @@ export const putV2EmploymentsEmploymentIdEmergencyContact = < PutV2EmploymentsEmploymentIdEmergencyContactErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/emergency_contact', + url: '/v2/employments/{employment_id}/emergency_contact', ...options, headers: { 'Content-Type': 'application/json', @@ -5163,7 +5163,7 @@ export const postV1SandboxBenefitRenewalRequests = < PostV1SandboxBenefitRenewalRequestsErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/benefit-renewal-requests', + url: '/v1/sandbox/benefit-renewal-requests', ...options, headers: { 'Content-Type': 'application/json', @@ -5216,7 +5216,7 @@ export const putV2EmploymentsEmploymentIdBasicInformation = < PutV2EmploymentsEmploymentIdBasicInformationErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/basic_information', + url: '/v2/employments/{employment_id}/basic_information', ...options, headers: { 'Content-Type': 'application/json', @@ -5245,7 +5245,7 @@ export const getV1LeavePoliciesSummaryEmploymentId = < GetV1LeavePoliciesSummaryEmploymentIdResponses, GetV1LeavePoliciesSummaryEmploymentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/leave-policies/summary/{employment_id}', ...options }); + >({ url: '/v1/leave-policies/summary/{employment_id}', ...options }); /** * Cancel Time Off @@ -5269,7 +5269,7 @@ export const postV1TimeoffTimeoffIdCancel = < PostV1TimeoffTimeoffIdCancelErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{timeoff_id}/cancel', + url: '/v1/timeoff/{timeoff_id}/cancel', ...options, headers: { 'Content-Type': 'application/json', @@ -5296,7 +5296,7 @@ export const getV1HelpCenterArticlesId = ( GetV1HelpCenterArticlesIdResponses, GetV1HelpCenterArticlesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/help-center-articles/{id}', ...options }); + >({ url: '/v1/help-center-articles/{id}', ...options }); /** * Upload file @@ -5322,7 +5322,7 @@ export const postV1Documents = ( ThrowOnError >({ ...formDataBodySerializer, - url: '/api/eor/v1/documents', + url: '/v1/documents', ...options, headers: { 'Content-Type': null, @@ -5356,7 +5356,7 @@ export const postV1IdentityVerificationEmploymentIdVerify = < PostV1IdentityVerificationEmploymentIdVerifyErrors, ThrowOnError >({ - url: '/api/eor/v1/identity-verification/{employment_id}/verify', + url: '/v1/identity-verification/{employment_id}/verify', ...options, }); @@ -5379,7 +5379,7 @@ export const getV1CustomFields = ( GetV1CustomFieldsResponses, GetV1CustomFieldsErrors, ThrowOnError - >({ url: '/api/eor/v1/custom-fields', ...options }); + >({ url: '/v1/custom-fields', ...options }); /** * Create Custom Field Definition @@ -5401,7 +5401,7 @@ export const postV1CustomFields = ( PostV1CustomFieldsErrors, ThrowOnError >({ - url: '/api/eor/v1/custom-fields', + url: '/v1/custom-fields', ...options, headers: { 'Content-Type': 'application/json', @@ -5431,7 +5431,7 @@ export const postV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsAppro PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve', + url: '/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve', ...options, }); @@ -5455,7 +5455,7 @@ export const postV1WebhookCallbacks = ( PostV1WebhookCallbacksErrors, ThrowOnError >({ - url: '/api/eor/v1/webhook-callbacks', + url: '/v1/webhook-callbacks', ...options, headers: { 'Content-Type': 'application/json', @@ -5484,7 +5484,7 @@ export const getV1SsoConfigurationDetails = < GetV1SsoConfigurationDetailsResponses, GetV1SsoConfigurationDetailsErrors, ThrowOnError - >({ url: '/api/eor/v1/sso-configuration/details', ...options }); + >({ url: '/v1/sso-configuration/details', ...options }); /** * Sign a document for a contractor @@ -5508,7 +5508,7 @@ export const postV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDo PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign', + url: '/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign', ...options, headers: { 'Content-Type': 'application/json', @@ -5535,7 +5535,7 @@ export const getV1PayItems = ( GetV1PayItemsResponses, GetV1PayItemsErrors, ThrowOnError - >({ url: '/api/eor/v1/pay-items', ...options }); + >({ url: '/v1/pay-items', ...options }); /** * List users via SCIM v2.0 @@ -5551,7 +5551,7 @@ export const getV1ScimV2Users = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/scim/v2/Users', + url: '/v1/scim/v2/Users', ...options, }); @@ -5576,7 +5576,7 @@ export const getV1ResignationsOffboardingRequestId = < GetV1ResignationsOffboardingRequestIdResponses, GetV1ResignationsOffboardingRequestIdErrors, ThrowOnError - >({ url: '/api/eor/v1/resignations/{offboarding_request_id}', ...options }); + >({ url: '/v1/resignations/{offboarding_request_id}', ...options }); /** * Get Billing Document Breakdown @@ -5603,7 +5603,7 @@ export const getV1BillingDocumentsBillingDocumentIdBreakdown = < GetV1BillingDocumentsBillingDocumentIdBreakdownErrors, ThrowOnError >({ - url: '/api/eor/v1/billing-documents/{billing_document_id}/breakdown', + url: '/v1/billing-documents/{billing_document_id}/breakdown', ...options, }); @@ -5633,7 +5633,7 @@ export const postV1TimeoffTimeoffIdCancelRequestDecline = < PostV1TimeoffTimeoffIdCancelRequestDeclineErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/decline', + url: '/v1/timeoff/{timeoff_id}/cancel-request/decline', ...options, headers: { 'Content-Type': 'application/json', @@ -5660,7 +5660,7 @@ export const getV1PayrollCalendars = ( GetV1PayrollCalendarsResponses, GetV1PayrollCalendarsErrors, ThrowOnError - >({ url: '/api/eor/v1/payroll-calendars', ...options }); + >({ url: '/v1/payroll-calendars', ...options }); /** * Payroll processing details API resource @@ -5676,7 +5676,7 @@ export const getV1WdGphPayDetail = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/wd/gph/payDetail', + url: '/v1/wd/gph/payDetail', ...options, }); @@ -5704,7 +5704,7 @@ export const getV1ContractAmendmentsSchema = < GetV1ContractAmendmentsSchemaResponses, GetV1ContractAmendmentsSchemaErrors, ThrowOnError - >({ url: '/api/eor/v1/contract-amendments/schema', ...options }); + >({ url: '/v1/contract-amendments/schema', ...options }); /** * Get a mock JSON Schema @@ -5718,7 +5718,7 @@ export const getV1TestSchema = ( GetV1TestSchemaResponses, unknown, ThrowOnError - >({ url: '/api/eor/v1/test-schema', ...options }); + >({ url: '/v1/test-schema', ...options }); /** * Update Time Off as Employee @@ -5740,7 +5740,7 @@ export const patchV1EmployeeTimeoffId2 = ( PatchV1EmployeeTimeoffId2Errors, ThrowOnError >({ - url: '/api/eor/v1/employee/timeoff/{id}', + url: '/v1/employee/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5768,7 +5768,7 @@ export const patchV1EmployeeTimeoffId = ( PatchV1EmployeeTimeoffIdErrors, ThrowOnError >({ - url: '/api/eor/v1/employee/timeoff/{id}', + url: '/v1/employee/timeoff/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -5790,7 +5790,7 @@ export const getV1ScimV2GroupsId = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/scim/v2/Groups/{id}', + url: '/v1/scim/v2/Groups/{id}', ...options, }); @@ -5827,7 +5827,7 @@ export const getV1CountriesCountryCodeLegalEntityFormsForm = < GetV1CountriesCountryCodeLegalEntityFormsFormErrors, ThrowOnError >({ - url: '/api/eor/v1/countries/{country_code}/legal_entity_forms/{form}', + url: '/v1/countries/{country_code}/legal_entity_forms/{form}', ...options, }); @@ -5856,7 +5856,7 @@ export const getV1EmploymentContractsEmploymentIdPendingChanges = < GetV1EmploymentContractsEmploymentIdPendingChangesErrors, ThrowOnError >({ - url: '/api/eor/v1/employment-contracts/{employment_id}/pending-changes', + url: '/v1/employment-contracts/{employment_id}/pending-changes', ...options, }); @@ -5875,7 +5875,7 @@ export const postV1SdkTelemetryErrors = ( PostV1SdkTelemetryErrorsErrors, ThrowOnError >({ - url: '/api/eor/v1/sdk/telemetry-errors', + url: '/v1/sdk/telemetry-errors', ...options, headers: { 'Content-Type': 'application/json', @@ -5906,7 +5906,7 @@ export const getV1CompaniesCompanyIdComplianceProfile = < GetV1CompaniesCompanyIdComplianceProfileErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/compliance-profile', + url: '/v1/companies/{company_id}/compliance-profile', ...options, }); @@ -5932,7 +5932,7 @@ export const getV1PayslipsId = ( GetV1PayslipsIdResponses, GetV1PayslipsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/payslips/{id}', ...options }); + >({ url: '/v1/payslips/{id}', ...options }); /** * Approve a time off cancellation request @@ -5961,7 +5961,7 @@ export const postV1TimeoffTimeoffIdCancelRequestApprove = < PostV1TimeoffTimeoffIdCancelRequestApproveErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/approve', + url: '/v1/timeoff/{timeoff_id}/cancel-request/approve', ...options, }); @@ -5984,7 +5984,7 @@ export const getV1WebhookEvents = ( GetV1WebhookEventsResponses, GetV1WebhookEventsErrors, ThrowOnError - >({ url: '/api/eor/v1/webhook-events', ...options }); + >({ url: '/v1/webhook-events', ...options }); /** * List Time Off Types @@ -6010,7 +6010,7 @@ export const getV1TimeoffTypes = ( GetV1TimeoffTypesResponses, GetV1TimeoffTypesErrors, ThrowOnError - >({ url: '/api/eor/v1/timeoff/types', ...options }); + >({ url: '/v1/timeoff/types', ...options }); /** * List Company Legal Entities @@ -6034,7 +6034,7 @@ export const getV1CompaniesCompanyIdLegalEntities = < GetV1CompaniesCompanyIdLegalEntitiesResponses, GetV1CompaniesCompanyIdLegalEntitiesErrors, ThrowOnError - >({ url: '/api/eor/v1/companies/{company_id}/legal-entities', ...options }); + >({ url: '/v1/companies/{company_id}/legal-entities', ...options }); /** * Create contract eligibility @@ -6064,7 +6064,7 @@ export const postV1EmploymentsEmploymentIdContractEligibility = < PostV1EmploymentsEmploymentIdContractEligibilityErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/contract-eligibility', + url: '/v1/employments/{employment_id}/contract-eligibility', ...options, headers: { 'Content-Type': 'application/json', @@ -6102,7 +6102,7 @@ export const getV1ContractorsEmploymentsEmploymentIdContractorCurrencies = < GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-currencies', + url: '/v1/contractors/employments/{employment_id}/contractor-currencies', ...options, }); @@ -6127,7 +6127,7 @@ export const getV1Payslips = ( GetV1PayslipsResponses, GetV1PayslipsErrors, ThrowOnError - >({ url: '/api/eor/v1/payslips', ...options }); + >({ url: '/v1/payslips', ...options }); /** * Create employment @@ -6154,7 +6154,7 @@ export const postV1SandboxEmployments = ( PostV1SandboxEmploymentsErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/employments', + url: '/v1/sandbox/employments', ...options, headers: { 'Content-Type': 'application/json', @@ -6185,7 +6185,7 @@ export const getV1PayrollRunsPayrollRunId = < GetV1PayrollRunsPayrollRunIdResponses, GetV1PayrollRunsPayrollRunIdErrors, ThrowOnError - >({ url: '/api/eor/v1/payroll-runs/{payroll_run_id}', ...options }); + >({ url: '/v1/payroll-runs/{payroll_run_id}', ...options }); /** * List pre-onboarding document requirements for an employment @@ -6213,7 +6213,7 @@ export const getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequire GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors, ThrowOnError >({ - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements', + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements', ...options, }); @@ -6236,7 +6236,7 @@ export const getV1OffboardingsId = ( GetV1OffboardingsIdResponses, GetV1OffboardingsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/offboardings/{id}', ...options }); + >({ url: '/v1/offboardings/{id}', ...options }); /** * List expenses @@ -6257,7 +6257,7 @@ export const getV1Expenses = ( GetV1ExpensesResponses, GetV1ExpensesErrors, ThrowOnError - >({ url: '/api/eor/v1/expenses', ...options }); + >({ url: '/v1/expenses', ...options }); /** * Create expense @@ -6279,7 +6279,7 @@ export const postV1Expenses = ( PostV1ExpensesErrors, ThrowOnError >({ - url: '/api/eor/v1/expenses', + url: '/v1/expenses', ...options, headers: { 'Content-Type': 'application/json', @@ -6306,7 +6306,7 @@ export const getV1EmployeePayslipFiles = ( GetV1EmployeePayslipFilesResponses, GetV1EmployeePayslipFilesErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/payslip-files', ...options }); + >({ url: '/v1/employee/payslip-files', ...options }); /** * Invite employment @@ -6344,7 +6344,7 @@ export const postV1EmploymentsEmploymentIdInvite = < PostV1EmploymentsEmploymentIdInviteResponses, PostV1EmploymentsEmploymentIdInviteErrors, ThrowOnError - >({ url: '/api/eor/v1/employments/{employment_id}/invite', ...options }); + >({ url: '/v1/employments/{employment_id}/invite', ...options }); /** * Create Probation Extension @@ -6366,7 +6366,7 @@ export const postV1ProbationExtensions = ( PostV1ProbationExtensionsErrors, ThrowOnError >({ - url: '/api/eor/v1/probation-extensions', + url: '/v1/probation-extensions', ...options, headers: { 'Content-Type': 'application/json', @@ -6397,7 +6397,7 @@ export const putV1SandboxContractAmendmentsContractAmendmentRequestIdApprove = < PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors, ThrowOnError >({ - url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve', + url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve', ...options, }); @@ -6428,7 +6428,7 @@ export const getV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesSta GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors, ThrowOnError >({ - url: '/api/eor/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status', + url: '/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status', ...options, }); @@ -6451,7 +6451,7 @@ export const getV1ContractorInvoicesId = ( GetV1ContractorInvoicesIdResponses, GetV1ContractorInvoicesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/contractor-invoices/{id}', ...options }); + >({ url: '/v1/contractor-invoices/{id}', ...options }); /** * Payroll Feature API resource @@ -6469,7 +6469,7 @@ export const getV1WdGphPayProcessingFeature = < ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/wd/gph/payProcessingFeature', + url: '/v1/wd/gph/payProcessingFeature', ...options, }); @@ -6487,7 +6487,7 @@ export const getV1WdGphPayProgress = ( ThrowOnError >({ security: [{ scheme: 'bearer', type: 'http' }], - url: '/api/eor/v1/wd/gph/payProgress', + url: '/v1/wd/gph/payProgress', ...options, }); @@ -6510,7 +6510,7 @@ export const getV1CompanyCurrencies = ( GetV1CompanyCurrenciesResponses, GetV1CompanyCurrenciesErrors, ThrowOnError - >({ url: '/api/eor/v1/company-currencies', ...options }); + >({ url: '/v1/company-currencies', ...options }); /** * Get a employment benefit offers JSON schema @@ -6535,7 +6535,7 @@ export const getV1EmploymentsEmploymentIdBenefitOffersSchema = < GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/benefit-offers/schema', + url: '/v1/employments/{employment_id}/benefit-offers/schema', ...options, }); @@ -6560,7 +6560,7 @@ export const getV1ContractorInvoiceSchedules = < GetV1ContractorInvoiceSchedulesResponses, GetV1ContractorInvoiceSchedulesErrors, ThrowOnError - >({ url: '/api/eor/v1/contractor-invoice-schedules', ...options }); + >({ url: '/v1/contractor-invoice-schedules', ...options }); /** * Create Contractor Invoice Schedules @@ -6586,7 +6586,7 @@ export const postV1ContractorInvoiceSchedules = < PostV1ContractorInvoiceSchedulesErrors, ThrowOnError >({ - url: '/api/eor/v1/contractor-invoice-schedules', + url: '/v1/contractor-invoice-schedules', ...options, headers: { 'Content-Type': 'application/json', @@ -6615,7 +6615,7 @@ export const getV1WorkAuthorizationRequestsId = < GetV1WorkAuthorizationRequestsIdResponses, GetV1WorkAuthorizationRequestsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/work-authorization-requests/{id}', ...options }); + >({ url: '/v1/work-authorization-requests/{id}', ...options }); /** * Update work authorization request @@ -6639,7 +6639,7 @@ export const patchV1WorkAuthorizationRequestsId2 = < PatchV1WorkAuthorizationRequestsId2Errors, ThrowOnError >({ - url: '/api/eor/v1/work-authorization-requests/{id}', + url: '/v1/work-authorization-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -6669,7 +6669,7 @@ export const patchV1WorkAuthorizationRequestsId = < PatchV1WorkAuthorizationRequestsIdErrors, ThrowOnError >({ - url: '/api/eor/v1/work-authorization-requests/{id}', + url: '/v1/work-authorization-requests/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -6699,7 +6699,7 @@ export const postV1TimeoffTimeoffIdDecline = < PostV1TimeoffTimeoffIdDeclineErrors, ThrowOnError >({ - url: '/api/eor/v1/timeoff/{timeoff_id}/decline', + url: '/v1/timeoff/{timeoff_id}/decline', ...options, headers: { 'Content-Type': 'application/json', @@ -6736,7 +6736,7 @@ export const getV1ContractorsSchemasEligibilityQuestionnaire = < GetV1ContractorsSchemasEligibilityQuestionnaireErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/schemas/eligibility-questionnaire', + url: '/v1/contractors/schemas/eligibility-questionnaire', ...options, }); @@ -6786,7 +6786,7 @@ export const deleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscription DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription', ...options, }); @@ -6819,7 +6819,7 @@ export const postV1ContractorsEmploymentsEmploymentIdContractorCorSubscription = PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription', + url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription', ...options, }); @@ -6866,7 +6866,7 @@ export const putV2EmploymentsEmploymentIdPersonalDetails = < PutV2EmploymentsEmploymentIdPersonalDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/personal_details', + url: '/v2/employments/{employment_id}/personal_details', ...options, headers: { 'Content-Type': 'application/json', @@ -6902,7 +6902,7 @@ export const postV1OnboardingEmploymentsEmploymentIdPreOnboardingDocuments = < PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors, ThrowOnError >({ - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents', + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents', ...options, headers: { 'Content-Type': 'application/json', @@ -6929,7 +6929,7 @@ export const getV1ContractAmendmentsId = ( GetV1ContractAmendmentsIdResponses, GetV1ContractAmendmentsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/contract-amendments/{id}', ...options }); + >({ url: '/v1/contract-amendments/{id}', ...options }); /** * Decline Identity Verification @@ -6957,7 +6957,7 @@ export const postV1IdentityVerificationEmploymentIdDecline = < PostV1IdentityVerificationEmploymentIdDeclineErrors, ThrowOnError >({ - url: '/api/eor/v1/identity-verification/{employment_id}/decline', + url: '/v1/identity-verification/{employment_id}/decline', ...options, }); @@ -6982,7 +6982,7 @@ export const getV1EmployeeExpenseCategories = < GetV1EmployeeExpenseCategoriesResponses, GetV1EmployeeExpenseCategoriesErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/expense-categories', ...options }); + >({ url: '/v1/employee/expense-categories', ...options }); /** * Creates a CSV cost estimation of employments @@ -6999,7 +6999,7 @@ export const postV1CostCalculatorEstimationCsv = < PostV1CostCalculatorEstimationCsvErrors, ThrowOnError >({ - url: '/api/eor/v1/cost-calculator/estimation-csv', + url: '/v1/cost-calculator/estimation-csv', ...options, headers: { 'Content-Type': 'application/json', @@ -7035,7 +7035,7 @@ export const getV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsId = < GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors, ThrowOnError >({ - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}', + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}', ...options, }); @@ -7058,7 +7058,7 @@ export const getV1BillingDocuments = ( GetV1BillingDocumentsResponses, GetV1BillingDocumentsErrors, ThrowOnError - >({ url: '/api/eor/v1/billing-documents', ...options }); + >({ url: '/v1/billing-documents', ...options }); /** * Show Billing Document @@ -7084,7 +7084,7 @@ export const getV1BillingDocumentsBillingDocumentId = < GetV1BillingDocumentsBillingDocumentIdResponses, GetV1BillingDocumentsBillingDocumentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/billing-documents/{billing_document_id}', ...options }); + >({ url: '/v1/billing-documents/{billing_document_id}', ...options }); /** * Indexes all the documents for the employee @@ -7103,7 +7103,7 @@ export const getV1EmployeeDocuments = ( GetV1EmployeeDocumentsResponses, GetV1EmployeeDocumentsErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/documents', ...options }); + >({ url: '/v1/employee/documents', ...options }); /** * List employee time offs @@ -7124,7 +7124,7 @@ export const getV1EmployeeTimeoff = ( GetV1EmployeeTimeoffResponses, GetV1EmployeeTimeoffErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/timeoff', ...options }); + >({ url: '/v1/employee/timeoff', ...options }); /** * Create a Pending Time Off @@ -7146,7 +7146,7 @@ export const postV1EmployeeTimeoff = ( PostV1EmployeeTimeoffErrors, ThrowOnError >({ - url: '/api/eor/v1/employee/timeoff', + url: '/v1/employee/timeoff', ...options, headers: { 'Content-Type': 'application/json', @@ -7197,7 +7197,7 @@ export const putV1EmploymentsEmploymentIdPersonalDetails = < PutV1EmploymentsEmploymentIdPersonalDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}/personal_details', + url: '/v1/employments/{employment_id}/personal_details', ...options, headers: { 'Content-Type': 'application/json', @@ -7227,7 +7227,7 @@ export const getV1ProbationExtensionsId = < GetV1ProbationExtensionsIdResponses, GetV1ProbationExtensionsIdErrors, ThrowOnError - >({ url: '/api/eor/v1/probation-extensions/{id}', ...options }); + >({ url: '/v1/probation-extensions/{id}', ...options }); /** * Download file @@ -7249,7 +7249,7 @@ export const getV1FilesId = ( GetV1FilesIdResponses, GetV1FilesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/files/{id}', ...options }); + >({ url: '/v1/files/{id}', ...options }); /** * List Company Departments @@ -7271,7 +7271,7 @@ export const getV1CompanyDepartments = ( GetV1CompanyDepartmentsResponses, GetV1CompanyDepartmentsErrors, ThrowOnError - >({ url: '/api/eor/v1/company-departments', ...options }); + >({ url: '/v1/company-departments', ...options }); /** * Create New Department @@ -7293,7 +7293,7 @@ export const postV1CompanyDepartments = ( PostV1CompanyDepartmentsErrors, ThrowOnError >({ - url: '/api/eor/v1/company-departments', + url: '/v1/company-departments', ...options, headers: { 'Content-Type': 'application/json', @@ -7326,7 +7326,7 @@ export const getV1PayrollRunsPayrollRunIdEmployeeDetails = < GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, ThrowOnError >({ - url: '/api/eor/v1/payroll-runs/{payroll_run_id}/employee-details', + url: '/v1/payroll-runs/{payroll_run_id}/employee-details', ...options, }); @@ -7369,7 +7369,7 @@ export const getV1EmploymentsEmploymentId = < GetV1EmploymentsEmploymentIdResponses, GetV1EmploymentsEmploymentIdErrors, ThrowOnError - >({ url: '/api/eor/v1/employments/{employment_id}', ...options }); + >({ url: '/v1/employments/{employment_id}', ...options }); /** * Update employment @@ -7436,7 +7436,7 @@ export const patchV1EmploymentsEmploymentId2 = < PatchV1EmploymentsEmploymentId2Errors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}', + url: '/v1/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7509,7 +7509,7 @@ export const patchV1EmploymentsEmploymentId = < PatchV1EmploymentsEmploymentIdErrors, ThrowOnError >({ - url: '/api/eor/v1/employments/{employment_id}', + url: '/v1/employments/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7536,7 +7536,7 @@ export const getV1EmployeeTimesheets = ( GetV1EmployeeTimesheetsResponses, GetV1EmployeeTimesheetsErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/timesheets', ...options }); + >({ url: '/v1/employee/timesheets', ...options }); /** * Show a custom field value @@ -7563,7 +7563,7 @@ export const getV1CustomFieldsCustomFieldIdValuesEmploymentId = < GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, ThrowOnError >({ - url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, }); @@ -7592,7 +7592,7 @@ export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId2 = < PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors, ThrowOnError >({ - url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7625,7 +7625,7 @@ export const patchV1CustomFieldsCustomFieldIdValuesEmploymentId = < PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors, ThrowOnError >({ - url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}', + url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7658,7 +7658,7 @@ export const putV1ResignationsOffboardingRequestIdValidate = < PutV1ResignationsOffboardingRequestIdValidateErrors, ThrowOnError >({ - url: '/api/eor/v1/resignations/{offboarding_request_id}/validate', + url: '/v1/resignations/{offboarding_request_id}/validate', ...options, headers: { 'Content-Type': 'application/json', @@ -7687,7 +7687,7 @@ export const getV1ContractorInvoiceSchedulesId = < GetV1ContractorInvoiceSchedulesIdResponses, GetV1ContractorInvoiceSchedulesIdErrors, ThrowOnError - >({ url: '/api/eor/v1/contractor-invoice-schedules/{id}', ...options }); + >({ url: '/v1/contractor-invoice-schedules/{id}', ...options }); /** * Updates Contractor Invoice Schedule @@ -7711,7 +7711,7 @@ export const patchV1ContractorInvoiceSchedulesId2 = < PatchV1ContractorInvoiceSchedulesId2Errors, ThrowOnError >({ - url: '/api/eor/v1/contractor-invoice-schedules/{id}', + url: '/v1/contractor-invoice-schedules/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7741,7 +7741,7 @@ export const patchV1ContractorInvoiceSchedulesId = < PatchV1ContractorInvoiceSchedulesIdErrors, ThrowOnError >({ - url: '/api/eor/v1/contractor-invoice-schedules/{id}', + url: '/v1/contractor-invoice-schedules/{id}', ...options, headers: { 'Content-Type': 'application/json', @@ -7776,7 +7776,7 @@ export const putV2EmploymentsEmploymentIdPricingPlanDetails = < PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/pricing_plan_details', + url: '/v2/employments/{employment_id}/pricing_plan_details', ...options, headers: { 'Content-Type': 'application/json', @@ -7804,7 +7804,7 @@ export const postV1RiskReserve = ( PostV1RiskReserveErrors, ThrowOnError >({ - url: '/api/eor/v1/risk-reserve', + url: '/v1/risk-reserve', ...options, headers: { 'Content-Type': 'application/json', @@ -7855,7 +7855,7 @@ export const putV2EmploymentsEmploymentIdAddressDetails = < PutV2EmploymentsEmploymentIdAddressDetailsErrors, ThrowOnError >({ - url: '/api/eor/v2/employments/{employment_id}/address_details', + url: '/v2/employments/{employment_id}/address_details', ...options, headers: { 'Content-Type': 'application/json', @@ -7886,7 +7886,7 @@ export const getV1ContractorsEmploymentsEmploymentIdContractDocumentsId = < GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{id}', + url: '/v1/contractors/employments/{employment_id}/contract-documents/{id}', ...options, }); @@ -7918,7 +7918,7 @@ export const postV1ContractorsEmploymentsEmploymentIdCorTerminationRequests = < PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors, ThrowOnError >({ - url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests', + url: '/v1/contractors/employments/{employment_id}/cor-termination-requests', ...options, }); @@ -7941,4 +7941,4 @@ export const getV1EmployeePayslips = ( GetV1EmployeePayslipsResponses, GetV1EmployeePayslipsErrors, ThrowOnError - >({ url: '/api/eor/v1/employee/payslips', ...options }); + >({ url: '/v1/employee/payslips', ...options }); diff --git a/src/client/types.gen.ts b/src/client/types.gen.ts index 0cd4d31f3..79bda2780 100644 --- a/src/client/types.gen.ts +++ b/src/client/types.gen.ts @@ -11982,7 +11982,7 @@ export type PutV2EmploymentsEmploymentIdAdministrativeDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/administrative_details'; + url: '/v2/employments/{employment_id}/administrative_details'; }; export type PutV2EmploymentsEmploymentIdAdministrativeDetailsErrors = { @@ -12038,7 +12038,7 @@ export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details'; + url: '/v1/employments/{employment_id}/engagement-agreement-details'; }; export type GetV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { @@ -12089,7 +12089,7 @@ export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/engagement-agreement-details'; + url: '/v1/employments/{employment_id}/engagement-agreement-details'; }; export type PostV1EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { @@ -12139,7 +12139,7 @@ export type PostV1CurrencyConverterEffective2Data = { body: ConvertCurrencyParams; path?: never; query?: never; - url: '/api/eor/v1/currency-converter'; + url: '/v1/currency-converter'; }; export type PostV1CurrencyConverterEffective2Errors = { @@ -12180,7 +12180,7 @@ export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsData = employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-subscriptions'; + url: '/v1/contractors/employments/{employment_id}/contractor-subscriptions'; }; export type GetV1ContractorsEmploymentsEmploymentIdContractorSubscriptionsErrors = @@ -12220,7 +12220,7 @@ export type PostV1CurrencyConverterRawData = { body: ConvertCurrencyParams; path?: never; query?: never; - url: '/api/eor/v1/currency-converter/raw'; + url: '/v1/currency-converter/raw'; }; export type PostV1CurrencyConverterRawErrors = { @@ -12285,7 +12285,7 @@ export type GetV1IncentivesData = { */ page_size?: number; }; - url: '/api/eor/v1/incentives'; + url: '/v1/incentives'; }; export type GetV1IncentivesErrors = { @@ -12340,7 +12340,7 @@ export type PostV1IncentivesData = { }; path?: never; query?: never; - url: '/api/eor/v1/incentives'; + url: '/v1/incentives'; }; export type PostV1IncentivesErrors = { @@ -12392,7 +12392,7 @@ export type GetV1BenefitOffersData = { }; path?: never; query?: never; - url: '/api/eor/v1/benefit-offers'; + url: '/v1/benefit-offers'; }; export type GetV1BenefitOffersErrors = { @@ -12431,7 +12431,7 @@ export type PostV1ReadyData = { }; path?: never; query?: never; - url: '/api/eor/v1/ready'; + url: '/v1/ready'; }; export type PostV1ReadyErrors = { @@ -12476,7 +12476,7 @@ export type PostV1CostCalculatorEstimationData = { body: CostCalculatorEstimateParams; path?: never; query?: never; - url: '/api/eor/v1/cost-calculator/estimation'; + url: '/v1/cost-calculator/estimation'; }; export type PostV1CostCalculatorEstimationErrors = { @@ -12537,7 +12537,7 @@ export type GetV1IncentivesRecurringData = { */ page_size?: number; }; - url: '/api/eor/v1/incentives/recurring'; + url: '/v1/incentives/recurring'; }; export type GetV1IncentivesRecurringErrors = { @@ -12592,7 +12592,7 @@ export type PostV1IncentivesRecurringData = { }; path?: never; query?: never; - url: '/api/eor/v1/incentives/recurring'; + url: '/v1/incentives/recurring'; }; export type PostV1IncentivesRecurringErrors = { @@ -12656,7 +12656,7 @@ export type GetV1TimesheetsData = { */ page_size?: number; }; - url: '/api/eor/v1/timesheets'; + url: '/v1/timesheets'; }; export type GetV1TimesheetsErrors = { @@ -12694,7 +12694,7 @@ export type PostV1TimesheetsData = { body?: CreateTimesheetParams; path?: never; query?: never; - url: '/api/eor/v1/timesheets'; + url: '/v1/timesheets'; }; export type PostV1TimesheetsErrors = { @@ -12738,7 +12738,7 @@ export type PostV1TimesheetsTimesheetIdApproveData = { timesheet_id: string; }; query?: never; - url: '/api/eor/v1/timesheets/{timesheet_id}/approve'; + url: '/v1/timesheets/{timesheet_id}/approve'; }; export type PostV1TimesheetsTimesheetIdApproveErrors = { @@ -12773,7 +12773,7 @@ export type GetV1DataSyncData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/data-sync'; + url: '/v1/data-sync'; }; export type GetV1DataSyncErrors = { @@ -12822,7 +12822,7 @@ export type PostV1DataSyncData = { body: CreateDataSyncParams; path?: never; query?: never; - url: '/api/eor/v1/data-sync'; + url: '/v1/data-sync'; }; export type PostV1DataSyncErrors = { @@ -12867,7 +12867,7 @@ export type GetV1ProbationCompletionLetterIdData = { id: string; }; query?: never; - url: '/api/eor/v1/probation-completion-letter/{id}'; + url: '/v1/probation-completion-letter/{id}'; }; export type GetV1ProbationCompletionLetterIdErrors = { @@ -12902,7 +12902,7 @@ export type GetV1SsoConfigurationData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/sso-configuration'; + url: '/v1/sso-configuration'; }; export type GetV1SsoConfigurationErrors = { @@ -12944,7 +12944,7 @@ export type PostV1SsoConfigurationData = { body: CreateSsoConfigurationParams; path?: never; query?: never; - url: '/api/eor/v1/sso-configuration'; + url: '/v1/sso-configuration'; }; export type PostV1SsoConfigurationErrors = { @@ -13014,7 +13014,7 @@ export type GetV1OffboardingsData = { */ page_size?: number; }; - url: '/api/eor/v1/offboardings'; + url: '/v1/offboardings'; }; export type GetV1OffboardingsErrors = { @@ -13060,7 +13060,7 @@ export type PostV1OffboardingsData = { body?: CreateOffboardingParams; path?: never; query?: never; - url: '/api/eor/v1/offboardings'; + url: '/v1/offboardings'; }; export type PostV1OffboardingsErrors = { @@ -13115,7 +13115,7 @@ export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents'; + url: '/v1/contractors/employments/{employment_id}/contract-documents'; }; export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsErrors = { @@ -13159,7 +13159,7 @@ export type PutV1EmploymentsEmploymentIdFederalTaxesData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/federal-taxes'; + url: '/v1/employments/{employment_id}/federal-taxes'; }; export type PutV1EmploymentsEmploymentIdFederalTaxesErrors = { @@ -13211,7 +13211,7 @@ export type GetV1CompaniesCompanyIdPricingPlansData = { company_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/pricing-plans'; + url: '/v1/companies/{company_id}/pricing-plans'; }; export type GetV1CompaniesCompanyIdPricingPlansErrors = { @@ -13254,7 +13254,7 @@ export type PostV1CompaniesCompanyIdPricingPlansData = { company_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/pricing-plans'; + url: '/v1/companies/{company_id}/pricing-plans'; }; export type PostV1CompaniesCompanyIdPricingPlansErrors = { @@ -13297,7 +13297,7 @@ export type PutV2EmploymentsEmploymentIdFederalTaxesData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/federal-taxes'; + url: '/v2/employments/{employment_id}/federal-taxes'; }; export type PutV2EmploymentsEmploymentIdFederalTaxesErrors = { @@ -13379,7 +13379,7 @@ export type GetV1TravelLetterRequestsData = { */ page_size?: number; }; - url: '/api/eor/v1/travel-letter-requests'; + url: '/v1/travel-letter-requests'; }; export type GetV1TravelLetterRequestsErrors = { @@ -13415,7 +13415,7 @@ export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details'; + url: '/v2/employments/{employment_id}/engagement-agreement-details'; }; export type GetV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { @@ -13466,7 +13466,7 @@ export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/engagement-agreement-details'; + url: '/v2/employments/{employment_id}/engagement-agreement-details'; }; export type PostV2EmploymentsEmploymentIdEngagementAgreementDetailsErrors = { @@ -13528,7 +13528,7 @@ export type GetV1WdGphPaySummaryData = { */ countryCode?: string; }; - url: '/api/eor/v1/wd/gph/paySummary'; + url: '/v1/wd/gph/paySummary'; }; export type GetV1WdGphPaySummaryErrors = { @@ -13568,7 +13568,7 @@ export type GetV1EmploymentsEmploymentIdJobData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/job'; + url: '/v1/employments/{employment_id}/job'; }; export type GetV1EmploymentsEmploymentIdJobErrors = { @@ -13606,7 +13606,7 @@ export type PostV1BulkEmploymentJobsData = { body?: BulkEmploymentCreateParams; path?: never; query?: never; - url: '/api/eor/v1/bulk-employment-jobs'; + url: '/v1/bulk-employment-jobs'; }; export type PostV1BulkEmploymentJobsErrors = { @@ -13671,7 +13671,7 @@ export type GetV1ContractAmendmentsData = { */ page_size?: number; }; - url: '/api/eor/v1/contract-amendments'; + url: '/v1/contract-amendments'; }; export type GetV1ContractAmendmentsErrors = { @@ -13723,7 +13723,7 @@ export type PostV1ContractAmendmentsData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/contract-amendments'; + url: '/v1/contract-amendments'; }; export type PostV1ContractAmendmentsErrors = { @@ -13772,7 +13772,7 @@ export type DeleteV1IncentivesRecurringIdData = { id: string; }; query?: never; - url: '/api/eor/v1/incentives/recurring/{id}'; + url: '/v1/incentives/recurring/{id}'; }; export type DeleteV1IncentivesRecurringIdErrors = { @@ -13829,7 +13829,7 @@ export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { benefit_renewal_request_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; + url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; }; export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { @@ -13886,7 +13886,7 @@ export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; + url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}'; }; export type PostV1BenefitRenewalRequestsBenefitRenewalRequestIdErrors = { @@ -13944,7 +13944,7 @@ export type GetV1CountriesCountryCodeHolidaysYearData = { */ country_subdivision_code?: string; }; - url: '/api/eor/v1/countries/{country_code}/holidays/{year}'; + url: '/v1/countries/{country_code}/holidays/{year}'; }; export type GetV1CountriesCountryCodeHolidaysYearErrors = { @@ -13993,7 +13993,7 @@ export type GetV1EmploymentsEmploymentIdCustomFieldsData = { */ page_size?: number; }; - url: '/api/eor/v1/employments/{employment_id}/custom-fields'; + url: '/v1/employments/{employment_id}/custom-fields'; }; export type GetV1EmploymentsEmploymentIdCustomFieldsErrors = { @@ -14033,7 +14033,7 @@ export type GetV1TimesheetsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/timesheets/{id}'; + url: '/v1/timesheets/{id}'; }; export type GetV1TimesheetsIdErrors = { @@ -14090,7 +14090,7 @@ export type GetV1CompanyManagersData = { */ page_size?: number; }; - url: '/api/eor/v1/company-managers'; + url: '/v1/company-managers'; }; export type GetV1CompanyManagersErrors = { @@ -14153,7 +14153,7 @@ export type PostV1CompanyManagersData = { */ actions?: string; }; - url: '/api/eor/v1/company-managers'; + url: '/v1/company-managers'; }; export type PostV1CompanyManagersErrors = { @@ -14199,7 +14199,7 @@ export type PostV1PayItemsBulkData = { body: BulkCreatePayItemsParams; path?: never; query?: never; - url: '/api/eor/v1/pay-items/bulk'; + url: '/v1/pay-items/bulk'; }; export type PostV1PayItemsBulkErrors = { @@ -14247,7 +14247,7 @@ export type GetV1TravelLetterRequestsIdData = { id: UuidSlug; }; query?: never; - url: '/api/eor/v1/travel-letter-requests/{id}'; + url: '/v1/travel-letter-requests/{id}'; }; export type GetV1TravelLetterRequestsIdErrors = { @@ -14290,7 +14290,7 @@ export type PatchV1TravelLetterRequestsId2Data = { id: string; }; query?: never; - url: '/api/eor/v1/travel-letter-requests/{id}'; + url: '/v1/travel-letter-requests/{id}'; }; export type PatchV1TravelLetterRequestsId2Errors = { @@ -14333,7 +14333,7 @@ export type PatchV1TravelLetterRequestsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/travel-letter-requests/{id}'; + url: '/v1/travel-letter-requests/{id}'; }; export type PatchV1TravelLetterRequestsIdErrors = { @@ -14382,7 +14382,7 @@ export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksData = { company_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/companies/{company_id}/bypass-eligibility-checks'; + url: '/v1/sandbox/companies/{company_id}/bypass-eligibility-checks'; }; export type PostV1SandboxCompaniesCompanyIdBypassEligibilityChecksErrors = { @@ -14425,7 +14425,7 @@ export type GetV1EmployeeLeavePoliciesData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/employee/leave-policies'; + url: '/v1/employee/leave-policies'; }; export type GetV1EmployeeLeavePoliciesErrors = { @@ -14461,7 +14461,7 @@ export type GetV1CompaniesCompanyIdWebhookCallbacksData = { company_id: string; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/webhook-callbacks'; + url: '/v1/companies/{company_id}/webhook-callbacks'; }; export type GetV1CompaniesCompanyIdWebhookCallbacksErrors = { @@ -14506,7 +14506,7 @@ export type GetV1BillingDocumentsBillingDocumentIdPdfData = { billing_document_id: string; }; query?: never; - url: '/api/eor/v1/billing-documents/{billing_document_id}/pdf'; + url: '/v1/billing-documents/{billing_document_id}/pdf'; }; export type GetV1BillingDocumentsBillingDocumentIdPdfErrors = { @@ -14555,7 +14555,7 @@ export type DeleteV1WebhookCallbacksIdData = { id: string; }; query?: never; - url: '/api/eor/v1/webhook-callbacks/{id}'; + url: '/v1/webhook-callbacks/{id}'; }; export type DeleteV1WebhookCallbacksIdErrors = { @@ -14598,7 +14598,7 @@ export type PatchV1WebhookCallbacksIdData = { id: string; }; query?: never; - url: '/api/eor/v1/webhook-callbacks/{id}'; + url: '/v1/webhook-callbacks/{id}'; }; export type PatchV1WebhookCallbacksIdErrors = { @@ -14641,7 +14641,7 @@ export type GetV1CountriesData = { }; path?: never; query?: never; - url: '/api/eor/v1/countries'; + url: '/v1/countries'; }; export type GetV1CountriesErrors = { @@ -14694,7 +14694,7 @@ export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibili legal_entity_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility'; + url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/contractor-eligibility'; }; export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdContractorEligibilityErrors = @@ -14730,7 +14730,7 @@ export type PostV1CurrencyConverterEffectiveData = { body: ConvertCurrencyParams; path?: never; query?: never; - url: '/api/eor/v1/currency-converter/effective'; + url: '/v1/currency-converter/effective'; }; export type PostV1CurrencyConverterEffectiveErrors = { @@ -14765,7 +14765,7 @@ export type GetV1EmployeePersonalInformationData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/employee/personal-information'; + url: '/v1/employee/personal-information'; }; export type GetV1EmployeePersonalInformationErrors = { @@ -14835,7 +14835,7 @@ export type GetV1CountriesCountryCodeFormData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/countries/{country_code}/{form}'; + url: '/v1/countries/{country_code}/{form}'; }; export type GetV1CountriesCountryCodeFormErrors = { @@ -14916,7 +14916,7 @@ export type GetV1TimeoffData = { */ page_size?: number; }; - url: '/api/eor/v1/timeoff'; + url: '/v1/timeoff'; }; export type GetV1TimeoffErrors = { @@ -14970,7 +14970,7 @@ export type PostV1TimeoffData = { }; path?: never; query?: never; - url: '/api/eor/v1/timeoff'; + url: '/v1/timeoff'; }; export type PostV1TimeoffErrors = { @@ -15017,7 +15017,7 @@ export type GetV1CostCalculatorCountriesData = { */ include_premium_benefits?: boolean; }; - url: '/api/eor/v1/cost-calculator/countries'; + url: '/v1/cost-calculator/countries'; }; export type GetV1CostCalculatorCountriesResponses = { @@ -15042,7 +15042,7 @@ export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/risk-reserve-proof-of-payments'; + url: '/v1/employments/{employment_id}/risk-reserve-proof-of-payments'; }; export type PostV1EmploymentsEmploymentIdRiskReserveProofOfPaymentsErrors = { @@ -15087,7 +15087,7 @@ export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdData = background_check_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/background-checks/{background_check_id}'; + url: '/v1/employments/{employment_id}/background-checks/{background_check_id}'; }; export type GetV1EmploymentsEmploymentIdBackgroundChecksBackgroundCheckIdErrors = @@ -15138,7 +15138,7 @@ export type GetV1TimeoffBalancesEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/timeoff-balances/{employment_id}'; + url: '/v1/timeoff-balances/{employment_id}'; }; export type GetV1TimeoffBalancesEmploymentIdErrors = { @@ -15181,7 +15181,7 @@ export type GetV1EmployeeExpensesData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/employee/expenses'; + url: '/v1/employee/expenses'; }; export type GetV1EmployeeExpensesErrors = { @@ -15219,7 +15219,7 @@ export type PostV1EmployeeExpensesData = { body?: ParamsToCreateEmployeeExpense; path?: never; query?: never; - url: '/api/eor/v1/employee/expenses'; + url: '/v1/employee/expenses'; }; export type PostV1EmployeeExpensesErrors = { @@ -15263,7 +15263,7 @@ export type GetV1ResignationsOffboardingRequestIdResignationLetterData = { offboarding_request_id: string; }; query?: never; - url: '/api/eor/v1/resignations/{offboarding_request_id}/resignation-letter'; + url: '/v1/resignations/{offboarding_request_id}/resignation-letter'; }; export type GetV1ResignationsOffboardingRequestIdResignationLetterErrors = { @@ -15324,7 +15324,7 @@ export type DeleteV1CompanyManagersUserIdData = { user_id: string; }; query?: never; - url: '/api/eor/v1/company-managers/{user_id}'; + url: '/v1/company-managers/{user_id}'; }; export type DeleteV1CompanyManagersUserIdErrors = { @@ -15372,7 +15372,7 @@ export type GetV1CompanyManagersUserIdData = { user_id: string; }; query?: never; - url: '/api/eor/v1/company-managers/{user_id}'; + url: '/v1/company-managers/{user_id}'; }; export type GetV1CompanyManagersUserIdErrors = { @@ -15420,7 +15420,7 @@ export type GetV1EmploymentsEmploymentIdOnboardingStepsData = { employment_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/onboarding-steps'; + url: '/v1/employments/{employment_id}/onboarding-steps'; }; export type GetV1EmploymentsEmploymentIdOnboardingStepsErrors = { @@ -15468,7 +15468,7 @@ export type PostV1ContractAmendmentsAutomatableData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/contract-amendments/automatable'; + url: '/v1/contract-amendments/automatable'; }; export type PostV1ContractAmendmentsAutomatableErrors = { @@ -15516,7 +15516,7 @@ export type GetV1PayrollRunsData = { */ page_size?: number; }; - url: '/api/eor/v1/payroll-runs'; + url: '/v1/payroll-runs'; }; export type GetV1PayrollRunsErrors = { @@ -15551,7 +15551,7 @@ export type GetV1EmployeeIncentivesData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/employee/incentives'; + url: '/v1/employee/incentives'; }; export type GetV1EmployeeIncentivesErrors = { @@ -15603,7 +15603,7 @@ export type PatchV1SandboxEmploymentsEmploymentId2Data = { employment_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/employments/{employment_id}'; + url: '/v1/sandbox/employments/{employment_id}'; }; export type PatchV1SandboxEmploymentsEmploymentId2Errors = { @@ -15667,7 +15667,7 @@ export type PatchV1SandboxEmploymentsEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/employments/{employment_id}'; + url: '/v1/sandbox/employments/{employment_id}'; }; export type PatchV1SandboxEmploymentsEmploymentIdErrors = { @@ -15733,7 +15733,7 @@ export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema'; + url: '/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema'; }; export type GetV1BenefitRenewalRequestsBenefitRenewalRequestIdSchemaErrors = { @@ -15782,7 +15782,7 @@ export type PutV2EmploymentsEmploymentIdBillingAddressDetailsData = { */ billing_address_details_json_schema_version?: number | 'latest'; }; - url: '/api/eor/v2/employments/{employment_id}/billing_address_details'; + url: '/v2/employments/{employment_id}/billing_address_details'; }; export type PutV2EmploymentsEmploymentIdBillingAddressDetailsErrors = { @@ -15847,7 +15847,7 @@ export type DeleteV1IncentivesIdData = { id: string; }; query?: never; - url: '/api/eor/v1/incentives/{id}'; + url: '/v1/incentives/{id}'; }; export type DeleteV1IncentivesIdErrors = { @@ -15908,7 +15908,7 @@ export type GetV1IncentivesIdData = { id: string; }; query?: never; - url: '/api/eor/v1/incentives/{id}'; + url: '/v1/incentives/{id}'; }; export type GetV1IncentivesIdErrors = { @@ -15968,7 +15968,7 @@ export type PatchV1IncentivesId2Data = { id: string; }; query?: never; - url: '/api/eor/v1/incentives/{id}'; + url: '/v1/incentives/{id}'; }; export type PatchV1IncentivesId2Errors = { @@ -16032,7 +16032,7 @@ export type PatchV1IncentivesIdData = { id: string; }; query?: never; - url: '/api/eor/v1/incentives/{id}'; + url: '/v1/incentives/{id}'; }; export type PatchV1IncentivesIdErrors = { @@ -16089,7 +16089,7 @@ export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetai legal_entity_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; }; export type GetV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = @@ -16141,7 +16141,7 @@ export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetai legal_entity_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; + url: '/v1/companies/{company_id}/legal-entities/{legal_entity_id}/administrative-details'; }; export type PutV1CompaniesCompanyIdLegalEntitiesLegalEntityIdAdministrativeDetailsErrors = @@ -16205,7 +16205,7 @@ export type PutV2EmploymentsEmploymentIdBankAccountDetailsData = { */ bank_account_details_json_schema_version?: number | 'latest'; }; - url: '/api/eor/v2/employments/{employment_id}/bank_account_details'; + url: '/v2/employments/{employment_id}/bank_account_details'; }; export type PutV2EmploymentsEmploymentIdBankAccountDetailsErrors = { @@ -16313,7 +16313,7 @@ export type GetV1ContractorInvoicesData = { */ page_size?: number; }; - url: '/api/eor/v1/contractor-invoices'; + url: '/v1/contractor-invoices'; }; export type GetV1ContractorInvoicesErrors = { @@ -16369,7 +16369,7 @@ export type GetV1ExpensesCategoriesData = { */ country_code?: string; }; - url: '/api/eor/v1/expenses/categories'; + url: '/v1/expenses/categories'; }; export type GetV1ExpensesCategoriesErrors = { @@ -16434,7 +16434,7 @@ export type GetV1EmploymentsEmploymentIdContractDocumentsData = { */ page_size?: number; }; - url: '/api/eor/v1/employments/{employment_id}/contract-documents'; + url: '/v1/employments/{employment_id}/contract-documents'; }; export type GetV1EmploymentsEmploymentIdContractDocumentsErrors = { @@ -16483,7 +16483,7 @@ export type GetV1CountriesCountryCodeContractorContractDetailsData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/countries/{country_code}/contractor-contract-details'; + url: '/v1/countries/{country_code}/contractor-contract-details'; }; export type GetV1CountriesCountryCodeContractorContractDetailsErrors = { @@ -16531,7 +16531,7 @@ export type GetV1ScimV2UsersIdData = { id: string; }; query?: never; - url: '/api/eor/v1/scim/v2/Users/{id}'; + url: '/v1/scim/v2/Users/{id}'; }; export type GetV1ScimV2UsersIdErrors = { @@ -16588,7 +16588,7 @@ export type GetV1EmploymentsEmploymentIdFilesData = { */ page_size?: number; }; - url: '/api/eor/v1/employments/{employment_id}/files'; + url: '/v1/employments/{employment_id}/files'; }; export type GetV1EmploymentsEmploymentIdFilesErrors = { @@ -16632,7 +16632,7 @@ export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionDa employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-plus-subscription'; + url: '/v1/contractors/employments/{employment_id}/contractor-plus-subscription'; }; export type PostV1ContractorsEmploymentsEmploymentIdContractorPlusSubscriptionErrors = @@ -16673,7 +16673,7 @@ export type PostV1ContractorsEligibilityQuestionnaireData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/contractors/eligibility-questionnaire'; + url: '/v1/contractors/eligibility-questionnaire'; }; export type PostV1ContractorsEligibilityQuestionnaireErrors = { @@ -16720,7 +16720,7 @@ export type PutV1EmploymentsEmploymentIdBasicInformationData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/basic_information'; + url: '/v1/employments/{employment_id}/basic_information'; }; export type PutV1EmploymentsEmploymentIdBasicInformationErrors = { @@ -16773,7 +16773,7 @@ export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTermina termination_request_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}'; + url: '/v1/contractors/employments/{employment_id}/cor-termination-requests/{termination_request_id}'; }; export type GetV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsTerminationRequestIdErrors = @@ -16828,7 +16828,7 @@ export type PostV1SandboxCompaniesCompanyIdLegalEntitiesData = { company_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/companies/{company_id}/legal-entities'; + url: '/v1/sandbox/companies/{company_id}/legal-entities'; }; export type PostV1SandboxCompaniesCompanyIdLegalEntitiesErrors = { @@ -16909,7 +16909,7 @@ export type GetV1WdGphPayDetailDataData = { */ periodEndDate?: Date; }; - url: '/api/eor/v1/wd/gph/payDetailData'; + url: '/v1/wd/gph/payDetailData'; }; export type GetV1WdGphPayDetailDataErrors = { @@ -16954,7 +16954,7 @@ export type GetV1CostCalculatorRegionsSlugFieldsData = { */ include_premium_benefits?: boolean; }; - url: '/api/eor/v1/cost-calculator/regions/{slug}/fields'; + url: '/v1/cost-calculator/regions/{slug}/fields'; }; export type GetV1CostCalculatorRegionsSlugFieldsErrors = { @@ -16996,7 +16996,7 @@ export type PostV1CancelOnboardingEmploymentIdData = { */ async?: boolean; }; - url: '/api/eor/v1/cancel-onboarding/{employment_id}'; + url: '/v1/cancel-onboarding/{employment_id}'; }; export type PostV1CancelOnboardingEmploymentIdErrors = { @@ -17039,7 +17039,7 @@ export type PostV1EmployeeTimeoffIdCancelData = { id: string; }; query?: never; - url: '/api/eor/v1/employee/timeoff/{id}/cancel'; + url: '/v1/employee/timeoff/{id}/cancel'; }; export type PostV1EmployeeTimeoffIdCancelErrors = { @@ -17087,7 +17087,7 @@ export type GetV1ExpensesExpenseIdReceiptData = { expense_id: string; }; query?: never; - url: '/api/eor/v1/expenses/{expense_id}/receipt'; + url: '/v1/expenses/{expense_id}/receipt'; }; export type GetV1ExpensesExpenseIdReceiptErrors = { @@ -17143,7 +17143,7 @@ export type GetV1BenefitOffersCountrySummariesData = { }; path?: never; query?: never; - url: '/api/eor/v1/benefit-offers/country-summaries'; + url: '/v1/benefit-offers/country-summaries'; }; export type GetV1BenefitOffersCountrySummariesErrors = { @@ -17179,7 +17179,7 @@ export type GetV1LeavePoliciesDetailsEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/leave-policies/details/{employment_id}'; + url: '/v1/leave-policies/details/{employment_id}'; }; export type GetV1LeavePoliciesDetailsEmploymentIdErrors = { @@ -17249,7 +17249,7 @@ export type GetV1WorkAuthorizationRequestsData = { */ page_size?: number; }; - url: '/api/eor/v1/work-authorization-requests'; + url: '/v1/work-authorization-requests'; }; export type GetV1WorkAuthorizationRequestsErrors = { @@ -17294,7 +17294,7 @@ export type GetV1EmploymentsEmploymentIdBenefitOffersData = { */ page_size?: number; }; - url: '/api/eor/v1/employments/{employment_id}/benefit-offers'; + url: '/v1/employments/{employment_id}/benefit-offers'; }; export type GetV1EmploymentsEmploymentIdBenefitOffersErrors = { @@ -17346,7 +17346,7 @@ export type PutV1EmploymentsEmploymentIdBenefitOffersData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/employments/{employment_id}/benefit-offers'; + url: '/v1/employments/{employment_id}/benefit-offers'; }; export type PutV1EmploymentsEmploymentIdBenefitOffersErrors = { @@ -17432,7 +17432,7 @@ export type GetV1EmploymentsData = { */ page_size?: number; }; - url: '/api/eor/v1/employments'; + url: '/v1/employments'; }; export type GetV1EmploymentsErrors = { @@ -17492,7 +17492,7 @@ export type PostV1EmploymentsData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/employments'; + url: '/v1/employments'; }; export type PostV1EmploymentsErrors = { @@ -17549,7 +17549,7 @@ export type GetV1TimeoffIdData = { id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{id}'; + url: '/v1/timeoff/{id}'; }; export type GetV1TimeoffIdErrors = { @@ -17609,7 +17609,7 @@ export type PatchV1TimeoffId2Data = { id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{id}'; + url: '/v1/timeoff/{id}'; }; export type PatchV1TimeoffId2Errors = { @@ -17669,7 +17669,7 @@ export type PatchV1TimeoffIdData = { id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{id}'; + url: '/v1/timeoff/{id}'; }; export type PatchV1TimeoffIdErrors = { @@ -17720,7 +17720,7 @@ export type GetV1IdentityCurrentData = { }; path?: never; query?: never; - url: '/api/eor/v1/identity/current'; + url: '/v1/identity/current'; }; export type GetV1IdentityCurrentErrors = { @@ -17786,7 +17786,7 @@ export type GetV1WdGphPayVarianceData = { */ periodEndDate?: Date; }; - url: '/api/eor/v1/wd/gph/payVariance'; + url: '/v1/wd/gph/payVariance'; }; export type GetV1WdGphPayVarianceErrors = { @@ -17835,7 +17835,7 @@ export type GetV1PayrollCalendarsCycleData = { */ page_size?: number; }; - url: '/api/eor/v1/payroll-calendars/{cycle}'; + url: '/v1/payroll-calendars/{cycle}'; }; export type GetV1PayrollCalendarsCycleErrors = { @@ -17876,7 +17876,7 @@ export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentData = employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/terminate-cor-employment'; + url: '/v1/contractors/employments/{employment_id}/terminate-cor-employment'; }; export type PostV1ContractorsEmploymentsEmploymentIdTerminateCorEmploymentErrors = @@ -17925,7 +17925,7 @@ export type PostV1TimesheetsTimesheetIdSendBackData = { timesheet_id: string; }; query?: never; - url: '/api/eor/v1/timesheets/{timesheet_id}/send-back'; + url: '/v1/timesheets/{timesheet_id}/send-back'; }; export type PostV1TimesheetsTimesheetIdSendBackErrors = { @@ -17973,7 +17973,7 @@ export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignD id: string; }; query?: never; - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign'; + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}/sign'; }; export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdSignErrors = @@ -18036,7 +18036,7 @@ export type GetV1BenefitRenewalRequestsData = { */ page_size?: number; }; - url: '/api/eor/v1/benefit-renewal-requests'; + url: '/v1/benefit-renewal-requests'; }; export type GetV1BenefitRenewalRequestsErrors = { @@ -18098,7 +18098,7 @@ export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdData = legal_entity_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}'; + url: '/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}'; }; export type PutV1SandboxCompaniesCompanyIdDefaultLegalEntityLegalEntityIdErrors = @@ -18161,7 +18161,7 @@ export type GetV1EmploymentContractsData = { */ only_active?: boolean; }; - url: '/api/eor/v1/employment-contracts'; + url: '/v1/employment-contracts'; }; export type GetV1EmploymentContractsErrors = { @@ -18206,7 +18206,7 @@ export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelData = contract_amendment_request_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel'; + url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/cancel'; }; export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdCancelErrors = @@ -18265,7 +18265,7 @@ export type GetV1PayslipsPayslipIdPdfData = { payslip_id: string; }; query?: never; - url: '/api/eor/v1/payslips/{payslip_id}/pdf'; + url: '/v1/payslips/{payslip_id}/pdf'; }; export type GetV1PayslipsPayslipIdPdfErrors = { @@ -18316,7 +18316,7 @@ export type PostV1TimeoffTimeoffIdApproveData = { timeoff_id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{timeoff_id}/approve'; + url: '/v1/timeoff/{timeoff_id}/approve'; }; export type PostV1TimeoffTimeoffIdApproveErrors = { @@ -18373,7 +18373,7 @@ export type GetV1CompaniesData = { */ external_id?: string; }; - url: '/api/eor/v1/companies'; + url: '/v1/companies'; }; export type GetV1CompaniesErrors = { @@ -18449,7 +18449,7 @@ export type PostV1CompaniesData = { */ scope?: string; }; - url: '/api/eor/v1/companies'; + url: '/v1/companies'; }; export type PostV1CompaniesErrors = { @@ -18497,7 +18497,7 @@ export type GetV1EmploymentsEmploymentIdCompanyStructureNodesData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/company-structure-nodes'; + url: '/v1/employments/{employment_id}/company-structure-nodes'; }; export type GetV1EmploymentsEmploymentIdCompanyStructureNodesErrors = { @@ -18540,7 +18540,7 @@ export type PatchV2EmploymentsEmploymentId2Data = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}'; + url: '/v2/employments/{employment_id}'; }; export type PatchV2EmploymentsEmploymentId2Errors = { @@ -18591,7 +18591,7 @@ export type PatchV2EmploymentsEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}'; + url: '/v2/employments/{employment_id}'; }; export type PatchV2EmploymentsEmploymentIdErrors = { @@ -18637,7 +18637,7 @@ export type PostV1ProbationCompletionLetterData = { body: CreateProbationCompletionLetterParams; path?: never; query?: never; - url: '/api/eor/v1/probation-completion-letter'; + url: '/v1/probation-completion-letter'; }; export type PostV1ProbationCompletionLetterErrors = { @@ -18675,7 +18675,7 @@ export type PostV1CostCalculatorEstimationPdfData = { body?: CostCalculatorEstimateParams; path?: never; query?: never; - url: '/api/eor/v1/cost-calculator/estimation-pdf'; + url: '/v1/cost-calculator/estimation-pdf'; }; export type PostV1CostCalculatorEstimationPdfErrors = { @@ -18757,7 +18757,7 @@ export type GetV1EmployeeDocumentsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/employee/documents/{id}'; + url: '/v1/employee/documents/{id}'; }; export type GetV1EmployeeDocumentsIdErrors = { @@ -18795,7 +18795,7 @@ export type PostV1WebhookEventsReplayData = { body: ReplayWebhookEventsParams; path?: never; query?: never; - url: '/api/eor/v1/webhook-events/replay'; + url: '/v1/webhook-events/replay'; }; export type PostV1WebhookEventsReplayErrors = { @@ -18833,7 +18833,7 @@ export type PostV1SandboxWebhookCallbacksTriggerData = { body?: WebhookTriggerParams; path?: never; query?: never; - url: '/api/eor/v1/sandbox/webhook-callbacks/trigger'; + url: '/v1/sandbox/webhook-callbacks/trigger'; }; export type PostV1SandboxWebhookCallbacksTriggerErrors = { @@ -18873,7 +18873,7 @@ export type GetV1BulkEmploymentJobsJobIdData = { job_id: string; }; query?: never; - url: '/api/eor/v1/bulk-employment-jobs/{job_id}'; + url: '/v1/bulk-employment-jobs/{job_id}'; }; export type GetV1BulkEmploymentJobsJobIdErrors = { @@ -18926,7 +18926,7 @@ export type GetV1BulkEmploymentJobsJobIdRowsData = { */ page_size?: number; }; - url: '/api/eor/v1/bulk-employment-jobs/{job_id}/rows'; + url: '/v1/bulk-employment-jobs/{job_id}/rows'; }; export type GetV1BulkEmploymentJobsJobIdRowsErrors = { @@ -18977,7 +18977,7 @@ export type PostV1MagicLinkData = { }; path?: never; query?: never; - url: '/api/eor/v1/magic-link'; + url: '/v1/magic-link'; }; export type PostV1MagicLinkErrors = { @@ -19018,7 +19018,7 @@ export type GetV1CompaniesCompanyIdData = { company_id: string; }; query?: never; - url: '/api/eor/v1/companies/{company_id}'; + url: '/v1/companies/{company_id}'; }; export type GetV1CompaniesCompanyIdErrors = { @@ -19088,7 +19088,7 @@ export type PatchV1CompaniesCompanyId2Data = { */ bank_account_details_json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/companies/{company_id}'; + url: '/v1/companies/{company_id}'; }; export type PatchV1CompaniesCompanyId2Errors = { @@ -19158,7 +19158,7 @@ export type PatchV1CompaniesCompanyIdData = { */ bank_account_details_json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/companies/{company_id}'; + url: '/v1/companies/{company_id}'; }; export type PatchV1CompaniesCompanyIdErrors = { @@ -19214,7 +19214,7 @@ export type GetV1CompaniesSchemaData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/companies/schema'; + url: '/v1/companies/schema'; }; export type GetV1CompaniesSchemaErrors = { @@ -19249,7 +19249,7 @@ export type GetV1PricingPlanPartnerTemplatesData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/pricing-plan-partner-templates'; + url: '/v1/pricing-plan-partner-templates'; }; export type GetV1PricingPlanPartnerTemplatesErrors = { @@ -19289,7 +19289,7 @@ export type GetV1CountriesCountryCodeEngagementAgreementDetailsData = { country_code: string; }; query?: never; - url: '/api/eor/v1/countries/{country_code}/engagement-agreement-details'; + url: '/v1/countries/{country_code}/engagement-agreement-details'; }; export type GetV1CountriesCountryCodeEngagementAgreementDetailsErrors = { @@ -19349,7 +19349,7 @@ export type PutV2EmploymentsEmploymentIdContractDetailsData = { */ skip_benefits?: boolean; }; - url: '/api/eor/v2/employments/{employment_id}/contract_details'; + url: '/v2/employments/{employment_id}/contract_details'; }; export type PutV2EmploymentsEmploymentIdContractDetailsErrors = { @@ -19405,7 +19405,7 @@ export type GetV1CompaniesCompanyIdProductPricesData = { company_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/product-prices'; + url: '/v1/companies/{company_id}/product-prices'; }; export type GetV1CompaniesCompanyIdProductPricesErrors = { @@ -19450,7 +19450,7 @@ export type PostV1CompaniesCompanyIdCreateTokenData = { */ scope?: string; }; - url: '/api/eor/v1/companies/{company_id}/create-token'; + url: '/v1/companies/{company_id}/create-token'; }; export type PostV1CompaniesCompanyIdCreateTokenErrors = { @@ -19490,7 +19490,7 @@ export type GetV1IdentityVerificationEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/identity-verification/{employment_id}'; + url: '/v1/identity-verification/{employment_id}'; }; export type GetV1IdentityVerificationEmploymentIdErrors = { @@ -19534,7 +19534,7 @@ export type GetV1ExpensesExpenseIdReceiptsReceiptIdData = { receipt_id: string; }; query?: never; - url: '/api/eor/v1/expenses/{expense_id}/receipts/{receipt_id}'; + url: '/v1/expenses/{expense_id}/receipts/{receipt_id}'; }; export type GetV1ExpensesExpenseIdReceiptsReceiptIdErrors = { @@ -19594,7 +19594,7 @@ export type GetV1ScimV2GroupsData = { */ filter?: string; }; - url: '/api/eor/v1/scim/v2/Groups'; + url: '/v1/scim/v2/Groups'; }; export type GetV1ScimV2GroupsErrors = { @@ -19647,7 +19647,7 @@ export type GetV1ExpensesIdData = { id: string; }; query?: never; - url: '/api/eor/v1/expenses/{id}'; + url: '/v1/expenses/{id}'; }; export type GetV1ExpensesIdErrors = { @@ -19698,7 +19698,7 @@ export type PatchV1ExpensesId2Data = { id: string; }; query?: never; - url: '/api/eor/v1/expenses/{id}'; + url: '/v1/expenses/{id}'; }; export type PatchV1ExpensesId2Errors = { @@ -19753,7 +19753,7 @@ export type PatchV1ExpensesIdData = { id: string; }; query?: never; - url: '/api/eor/v1/expenses/{id}'; + url: '/v1/expenses/{id}'; }; export type PatchV1ExpensesIdErrors = { @@ -19813,7 +19813,7 @@ export type PutV2EmploymentsEmploymentIdEmergencyContactData = { */ emergency_contact_details_json_schema_version?: number | 'latest'; }; - url: '/api/eor/v2/employments/{employment_id}/emergency_contact'; + url: '/v2/employments/{employment_id}/emergency_contact'; }; export type PutV2EmploymentsEmploymentIdEmergencyContactErrors = { @@ -19876,7 +19876,7 @@ export type PostV1SandboxBenefitRenewalRequestsData = { }; path?: never; query?: never; - url: '/api/eor/v1/sandbox/benefit-renewal-requests'; + url: '/v1/sandbox/benefit-renewal-requests'; }; export type PostV1SandboxBenefitRenewalRequestsErrors = { @@ -19923,7 +19923,7 @@ export type PutV2EmploymentsEmploymentIdBasicInformationData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/basic_information'; + url: '/v2/employments/{employment_id}/basic_information'; }; export type PutV2EmploymentsEmploymentIdBasicInformationErrors = { @@ -19971,7 +19971,7 @@ export type GetV1LeavePoliciesSummaryEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/leave-policies/summary/{employment_id}'; + url: '/v1/leave-policies/summary/{employment_id}'; }; export type GetV1LeavePoliciesSummaryEmploymentIdErrors = { @@ -20014,7 +20014,7 @@ export type PostV1TimeoffTimeoffIdCancelData = { timeoff_id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{timeoff_id}/cancel'; + url: '/v1/timeoff/{timeoff_id}/cancel'; }; export type PostV1TimeoffTimeoffIdCancelErrors = { @@ -20062,7 +20062,7 @@ export type GetV1HelpCenterArticlesIdData = { id: number; }; query?: never; - url: '/api/eor/v1/help-center-articles/{id}'; + url: '/v1/help-center-articles/{id}'; }; export type GetV1HelpCenterArticlesIdErrors = { @@ -20100,7 +20100,7 @@ export type PostV1DocumentsData = { }; path?: never; query?: never; - url: '/api/eor/v1/documents'; + url: '/v1/documents'; }; export type PostV1DocumentsErrors = { @@ -20140,7 +20140,7 @@ export type PostV1IdentityVerificationEmploymentIdVerifyData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/identity-verification/{employment_id}/verify'; + url: '/v1/identity-verification/{employment_id}/verify'; }; export type PostV1IdentityVerificationEmploymentIdVerifyErrors = { @@ -20184,7 +20184,7 @@ export type GetV1CustomFieldsData = { */ page_size?: number; }; - url: '/api/eor/v1/custom-fields'; + url: '/v1/custom-fields'; }; export type GetV1CustomFieldsErrors = { @@ -20222,7 +20222,7 @@ export type PostV1CustomFieldsData = { body: CreateCustomFieldDefinitionParams; path?: never; query?: never; - url: '/api/eor/v1/custom-fields'; + url: '/v1/custom-fields'; }; export type PostV1CustomFieldsErrors = { @@ -20263,7 +20263,7 @@ export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApprov employment_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve'; + url: '/v1/sandbox/employments/{employment_id}/risk-reserve-proof-of-payments/approve'; }; export type PostV1SandboxEmploymentsEmploymentIdRiskReserveProofOfPaymentsApproveErrors = @@ -20320,7 +20320,7 @@ export type PostV1WebhookCallbacksData = { }; path?: never; query?: never; - url: '/api/eor/v1/webhook-callbacks'; + url: '/v1/webhook-callbacks'; }; export type PostV1WebhookCallbacksErrors = { @@ -20355,7 +20355,7 @@ export type GetV1SsoConfigurationDetailsData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/sso-configuration/details'; + url: '/v1/sso-configuration/details'; }; export type GetV1SsoConfigurationDetailsErrors = { @@ -20407,7 +20407,7 @@ export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDoc contract_document_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign'; + url: '/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign'; }; export type PostV1ContractorsEmploymentsEmploymentIdContractDocumentsContractDocumentIdSignErrors = @@ -20461,7 +20461,7 @@ export type GetV1PayItemsData = { */ page_size?: number; }; - url: '/api/eor/v1/pay-items'; + url: '/v1/pay-items'; }; export type GetV1PayItemsErrors = { @@ -20512,7 +20512,7 @@ export type GetV1ScimV2UsersData = { */ filter?: string; }; - url: '/api/eor/v1/scim/v2/Users'; + url: '/v1/scim/v2/Users'; }; export type GetV1ScimV2UsersErrors = { @@ -20556,7 +20556,7 @@ export type GetV1ResignationsOffboardingRequestIdData = { offboarding_request_id: string; }; query?: never; - url: '/api/eor/v1/resignations/{offboarding_request_id}'; + url: '/v1/resignations/{offboarding_request_id}'; }; export type GetV1ResignationsOffboardingRequestIdErrors = { @@ -20609,7 +20609,7 @@ export type GetV1BillingDocumentsBillingDocumentIdBreakdownData = { */ type?: string; }; - url: '/api/eor/v1/billing-documents/{billing_document_id}/breakdown'; + url: '/v1/billing-documents/{billing_document_id}/breakdown'; }; export type GetV1BillingDocumentsBillingDocumentIdBreakdownErrors = { @@ -20660,7 +20660,7 @@ export type PostV1TimeoffTimeoffIdCancelRequestDeclineData = { timeoff_id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/decline'; + url: '/v1/timeoff/{timeoff_id}/cancel-request/decline'; }; export type PostV1TimeoffTimeoffIdCancelRequestDeclineErrors = { @@ -20716,7 +20716,7 @@ export type GetV1PayrollCalendarsData = { */ page_size?: number; }; - url: '/api/eor/v1/payroll-calendars'; + url: '/v1/payroll-calendars'; }; export type GetV1PayrollCalendarsErrors = { @@ -20774,7 +20774,7 @@ export type GetV1WdGphPayDetailData = { */ periodEndDate?: Date; }; - url: '/api/eor/v1/wd/gph/payDetail'; + url: '/v1/wd/gph/payDetail'; }; export type GetV1WdGphPayDetailErrors = { @@ -20835,7 +20835,7 @@ export type GetV1ContractAmendmentsSchemaData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/contract-amendments/schema'; + url: '/v1/contract-amendments/schema'; }; export type GetV1ContractAmendmentsSchemaErrors = { @@ -20875,7 +20875,7 @@ export type GetV1TestSchemaData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/test-schema'; + url: '/v1/test-schema'; }; export type GetV1TestSchemaResponses = { @@ -20900,7 +20900,7 @@ export type PatchV1EmployeeTimeoffId2Data = { id: string; }; query?: never; - url: '/api/eor/v1/employee/timeoff/{id}'; + url: '/v1/employee/timeoff/{id}'; }; export type PatchV1EmployeeTimeoffId2Errors = { @@ -20951,7 +20951,7 @@ export type PatchV1EmployeeTimeoffIdData = { id: string; }; query?: never; - url: '/api/eor/v1/employee/timeoff/{id}'; + url: '/v1/employee/timeoff/{id}'; }; export type PatchV1EmployeeTimeoffIdErrors = { @@ -20999,7 +20999,7 @@ export type GetV1ScimV2GroupsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/scim/v2/Groups/{id}'; + url: '/v1/scim/v2/Groups/{id}'; }; export type GetV1ScimV2GroupsIdErrors = { @@ -21056,7 +21056,7 @@ export type GetV1CountriesCountryCodeLegalEntityFormsFormData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/countries/{country_code}/legal_entity_forms/{form}'; + url: '/v1/countries/{country_code}/legal_entity_forms/{form}'; }; export type GetV1CountriesCountryCodeLegalEntityFormsFormErrors = { @@ -21113,7 +21113,7 @@ export type GetV1EmploymentContractsEmploymentIdPendingChangesData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employment-contracts/{employment_id}/pending-changes'; + url: '/v1/employment-contracts/{employment_id}/pending-changes'; }; export type GetV1EmploymentContractsEmploymentIdPendingChangesErrors = { @@ -21155,7 +21155,7 @@ export type PostV1SdkTelemetryErrorsData = { body: SdkErrorPayload; path?: never; query?: never; - url: '/api/eor/v1/sdk/telemetry-errors'; + url: '/v1/sdk/telemetry-errors'; }; export type PostV1SdkTelemetryErrorsErrors = { @@ -21188,7 +21188,7 @@ export type GetV1CompaniesCompanyIdComplianceProfileData = { company_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/compliance-profile'; + url: '/v1/companies/{company_id}/compliance-profile'; }; export type GetV1CompaniesCompanyIdComplianceProfileErrors = { @@ -21237,7 +21237,7 @@ export type GetV1PayslipsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/payslips/{id}'; + url: '/v1/payslips/{id}'; }; export type GetV1PayslipsIdErrors = { @@ -21285,7 +21285,7 @@ export type PostV1TimeoffTimeoffIdCancelRequestApproveData = { timeoff_id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{timeoff_id}/cancel-request/approve'; + url: '/v1/timeoff/{timeoff_id}/cancel-request/approve'; }; export type PostV1TimeoffTimeoffIdCancelRequestApproveErrors = { @@ -21357,7 +21357,7 @@ export type GetV1WebhookEventsData = { */ page_size?: number; }; - url: '/api/eor/v1/webhook-events'; + url: '/v1/webhook-events'; }; export type GetV1WebhookEventsErrors = { @@ -21406,7 +21406,7 @@ export type GetV1TimeoffTypesData = { */ type?: TimeoffTypesEmploymentType; }; - url: '/api/eor/v1/timeoff/types'; + url: '/v1/timeoff/types'; }; export type GetV1TimeoffTypesErrors = { @@ -21463,7 +21463,7 @@ export type GetV1CompaniesCompanyIdLegalEntitiesData = { */ page_size?: number; }; - url: '/api/eor/v1/companies/{company_id}/legal-entities'; + url: '/v1/companies/{company_id}/legal-entities'; }; export type GetV1CompaniesCompanyIdLegalEntitiesErrors = { @@ -21502,7 +21502,7 @@ export type PostV1EmploymentsEmploymentIdContractEligibilityData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/contract-eligibility'; + url: '/v1/employments/{employment_id}/contract-eligibility'; }; export type PostV1EmploymentsEmploymentIdContractEligibilityErrors = { @@ -21547,7 +21547,7 @@ export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesData = { */ restrict_to_guaranteed_pay_out_currencies?: boolean; }; - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-currencies'; + url: '/v1/contractors/employments/{employment_id}/contractor-currencies'; }; export type GetV1ContractorsEmploymentsEmploymentIdContractorCurrenciesErrors = @@ -21617,7 +21617,7 @@ export type GetV1PayslipsData = { */ page_size?: number; }; - url: '/api/eor/v1/payslips'; + url: '/v1/payslips'; }; export type GetV1PayslipsErrors = { @@ -21671,7 +21671,7 @@ export type PostV1SandboxEmploymentsData = { }; path?: never; query?: never; - url: '/api/eor/v1/sandbox/employments'; + url: '/v1/sandbox/employments'; }; export type PostV1SandboxEmploymentsErrors = { @@ -21719,7 +21719,7 @@ export type GetV1PayrollRunsPayrollRunIdData = { payroll_run_id: string; }; query?: never; - url: '/api/eor/v1/payroll-runs/{payroll_run_id}'; + url: '/v1/payroll-runs/{payroll_run_id}'; }; export type GetV1PayrollRunsPayrollRunIdErrors = { @@ -21760,7 +21760,7 @@ export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirem employment_id: string; }; query?: never; - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements'; + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/requirements'; }; export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsRequirementsErrors = @@ -21802,7 +21802,7 @@ export type GetV1OffboardingsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/offboardings/{id}'; + url: '/v1/offboardings/{id}'; }; export type GetV1OffboardingsIdErrors = { @@ -21863,7 +21863,7 @@ export type GetV1ExpensesData = { */ page_size?: number; }; - url: '/api/eor/v1/expenses'; + url: '/v1/expenses'; }; export type GetV1ExpensesErrors = { @@ -21917,7 +21917,7 @@ export type PostV1ExpensesData = { }; path?: never; query?: never; - url: '/api/eor/v1/expenses'; + url: '/v1/expenses'; }; export type PostV1ExpensesErrors = { @@ -21969,7 +21969,7 @@ export type GetV1EmployeePayslipFilesData = { */ page_size?: number; }; - url: '/api/eor/v1/employee/payslip-files'; + url: '/v1/employee/payslip-files'; }; export type GetV1EmployeePayslipFilesErrors = { @@ -22018,7 +22018,7 @@ export type PostV1EmploymentsEmploymentIdInviteData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/invite'; + url: '/v1/employments/{employment_id}/invite'; }; export type PostV1EmploymentsEmploymentIdInviteErrors = { @@ -22060,7 +22060,7 @@ export type PostV1ProbationExtensionsData = { body: CreateProbationExtensionParams; path?: never; query?: never; - url: '/api/eor/v1/probation-extensions'; + url: '/v1/probation-extensions'; }; export type PostV1ProbationExtensionsErrors = { @@ -22105,7 +22105,7 @@ export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveData contract_amendment_request_id: string; }; query?: never; - url: '/api/eor/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve'; + url: '/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve'; }; export type PutV1SandboxContractAmendmentsContractAmendmentRequestIdApproveErrors = @@ -22160,7 +22160,7 @@ export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStat employment_id: UuidSlug; }; query?: never; - url: '/api/eor/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status'; + url: '/v1/companies/{company_id}/employments/{employment_id}/onboarding-reserves-status'; }; export type GetV1CompaniesCompanyIdEmploymentsEmploymentIdOnboardingReservesStatusErrors = @@ -22202,7 +22202,7 @@ export type GetV1ContractorInvoicesIdData = { id: UuidSlug; }; query?: never; - url: '/api/eor/v1/contractor-invoices/{id}'; + url: '/v1/contractor-invoices/{id}'; }; export type GetV1ContractorInvoicesIdErrors = { @@ -22241,7 +22241,7 @@ export type GetV1WdGphPayProcessingFeatureData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/wd/gph/payProcessingFeature'; + url: '/v1/wd/gph/payProcessingFeature'; }; export type GetV1WdGphPayProcessingFeatureErrors = { @@ -22299,7 +22299,7 @@ export type GetV1WdGphPayProgressData = { */ periodEndDate?: Date; }; - url: '/api/eor/v1/wd/gph/payProgress'; + url: '/v1/wd/gph/payProgress'; }; export type GetV1WdGphPayProgressErrors = { @@ -22334,7 +22334,7 @@ export type GetV1CompanyCurrenciesData = { body?: never; path?: never; query?: never; - url: '/api/eor/v1/company-currencies'; + url: '/v1/company-currencies'; }; export type GetV1CompanyCurrenciesErrors = { @@ -22371,7 +22371,7 @@ export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/employments/{employment_id}/benefit-offers/schema'; + url: '/v1/employments/{employment_id}/benefit-offers/schema'; }; export type GetV1EmploymentsEmploymentIdBenefitOffersSchemaErrors = { @@ -22460,7 +22460,7 @@ export type GetV1ContractorInvoiceSchedulesData = { */ page_size?: number; }; - url: '/api/eor/v1/contractor-invoice-schedules'; + url: '/v1/contractor-invoice-schedules'; }; export type GetV1ContractorInvoiceSchedulesErrors = { @@ -22498,7 +22498,7 @@ export type PostV1ContractorInvoiceSchedulesData = { body: BulkContractorInvoiceScheduleCreateParams; path?: never; query?: never; - url: '/api/eor/v1/contractor-invoice-schedules'; + url: '/v1/contractor-invoice-schedules'; }; export type PostV1ContractorInvoiceSchedulesErrors = { @@ -22563,7 +22563,7 @@ export type GetV1WorkAuthorizationRequestsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/work-authorization-requests/{id}'; + url: '/v1/work-authorization-requests/{id}'; }; export type GetV1WorkAuthorizationRequestsIdErrors = { @@ -22602,7 +22602,7 @@ export type PatchV1WorkAuthorizationRequestsId2Data = { id: string; }; query?: never; - url: '/api/eor/v1/work-authorization-requests/{id}'; + url: '/v1/work-authorization-requests/{id}'; }; export type PatchV1WorkAuthorizationRequestsId2Errors = { @@ -22645,7 +22645,7 @@ export type PatchV1WorkAuthorizationRequestsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/work-authorization-requests/{id}'; + url: '/v1/work-authorization-requests/{id}'; }; export type PatchV1WorkAuthorizationRequestsIdErrors = { @@ -22688,7 +22688,7 @@ export type PostV1TimeoffTimeoffIdDeclineData = { timeoff_id: string; }; query?: never; - url: '/api/eor/v1/timeoff/{timeoff_id}/decline'; + url: '/v1/timeoff/{timeoff_id}/decline'; }; export type PostV1TimeoffTimeoffIdDeclineErrors = { @@ -22740,7 +22740,7 @@ export type GetV1ContractorsSchemasEligibilityQuestionnaireData = { */ json_schema_version?: number | 'latest'; }; - url: '/api/eor/v1/contractors/schemas/eligibility-questionnaire'; + url: '/v1/contractors/schemas/eligibility-questionnaire'; }; export type GetV1ContractorsSchemasEligibilityQuestionnaireErrors = { @@ -22827,7 +22827,7 @@ export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionD employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; }; export type DeleteV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = @@ -22871,7 +22871,7 @@ export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionDat employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; + url: '/v1/contractors/employments/{employment_id}/contractor-cor-subscription'; }; export type PostV1ContractorsEmploymentsEmploymentIdContractorCorSubscriptionErrors = @@ -22920,7 +22920,7 @@ export type PutV2EmploymentsEmploymentIdPersonalDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/personal_details'; + url: '/v2/employments/{employment_id}/personal_details'; }; export type PutV2EmploymentsEmploymentIdPersonalDetailsErrors = { @@ -22980,7 +22980,7 @@ export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsData = employment_id: string; }; query?: never; - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents'; + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents'; }; export type PostV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsErrors = @@ -23035,7 +23035,7 @@ export type GetV1ContractAmendmentsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/contract-amendments/{id}'; + url: '/v1/contract-amendments/{id}'; }; export type GetV1ContractAmendmentsIdErrors = { @@ -23075,7 +23075,7 @@ export type PostV1IdentityVerificationEmploymentIdDeclineData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/identity-verification/{employment_id}/decline'; + url: '/v1/identity-verification/{employment_id}/decline'; }; export type PostV1IdentityVerificationEmploymentIdDeclineErrors = { @@ -23119,7 +23119,7 @@ export type GetV1EmployeeExpenseCategoriesData = { */ expense_id?: string; }; - url: '/api/eor/v1/employee/expense-categories'; + url: '/v1/employee/expense-categories'; }; export type GetV1EmployeeExpenseCategoriesErrors = { @@ -23157,7 +23157,7 @@ export type PostV1CostCalculatorEstimationCsvData = { body?: CostCalculatorEstimateParams; path?: never; query?: never; - url: '/api/eor/v1/cost-calculator/estimation-csv'; + url: '/v1/cost-calculator/estimation-csv'; }; export type PostV1CostCalculatorEstimationCsvErrors = { @@ -23198,7 +23198,7 @@ export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdData = id: string; }; query?: never; - url: '/api/eor/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}'; + url: '/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}'; }; export type GetV1OnboardingEmploymentsEmploymentIdPreOnboardingDocumentsIdErrors = @@ -23257,7 +23257,7 @@ export type GetV1BillingDocumentsData = { */ page_size?: number; }; - url: '/api/eor/v1/billing-documents'; + url: '/v1/billing-documents'; }; export type GetV1BillingDocumentsErrors = { @@ -23311,7 +23311,7 @@ export type GetV1BillingDocumentsBillingDocumentIdData = { */ include_unrecognized_types?: boolean; }; - url: '/api/eor/v1/billing-documents/{billing_document_id}'; + url: '/v1/billing-documents/{billing_document_id}'; }; export type GetV1BillingDocumentsBillingDocumentIdErrors = { @@ -23392,7 +23392,7 @@ export type GetV1EmployeeDocumentsData = { */ order?: 'asc' | 'desc'; }; - url: '/api/eor/v1/employee/documents'; + url: '/v1/employee/documents'; }; export type GetV1EmployeeDocumentsErrors = { @@ -23432,7 +23432,7 @@ export type GetV1EmployeeTimeoffData = { */ page_size?: number; }; - url: '/api/eor/v1/employee/timeoff'; + url: '/v1/employee/timeoff'; }; export type GetV1EmployeeTimeoffErrors = { @@ -23474,7 +23474,7 @@ export type PostV1EmployeeTimeoffData = { body: CreateEmployeeTimeoffParams; path?: never; query?: never; - url: '/api/eor/v1/employee/timeoff'; + url: '/v1/employee/timeoff'; }; export type PostV1EmployeeTimeoffErrors = { @@ -23525,7 +23525,7 @@ export type PutV1EmploymentsEmploymentIdPersonalDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/employments/{employment_id}/personal_details'; + url: '/v1/employments/{employment_id}/personal_details'; }; export type PutV1EmploymentsEmploymentIdPersonalDetailsErrors = { @@ -23573,7 +23573,7 @@ export type GetV1ProbationExtensionsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/probation-extensions/{id}'; + url: '/v1/probation-extensions/{id}'; }; export type GetV1ProbationExtensionsIdErrors = { @@ -23613,7 +23613,7 @@ export type GetV1FilesIdData = { id: string; }; query?: never; - url: '/api/eor/v1/files/{id}'; + url: '/v1/files/{id}'; }; export type GetV1FilesIdErrors = { @@ -23664,7 +23664,7 @@ export type GetV1CompanyDepartmentsData = { */ page_size?: number; }; - url: '/api/eor/v1/company-departments'; + url: '/v1/company-departments'; }; export type GetV1CompanyDepartmentsErrors = { @@ -23698,7 +23698,7 @@ export type PostV1CompanyDepartmentsData = { body: CreateCompanyDepartmentParams; path?: never; query?: never; - url: '/api/eor/v1/company-departments'; + url: '/v1/company-departments'; }; export type PostV1CompanyDepartmentsErrors = { @@ -23743,7 +23743,7 @@ export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsData = { */ page_size?: number; }; - url: '/api/eor/v1/payroll-runs/{payroll_run_id}/employee-details'; + url: '/v1/payroll-runs/{payroll_run_id}/employee-details'; }; export type GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors = { @@ -23797,7 +23797,7 @@ export type GetV1EmploymentsEmploymentIdData = { */ exclude_files?: boolean; }; - url: '/api/eor/v1/employments/{employment_id}'; + url: '/v1/employments/{employment_id}'; }; export type GetV1EmploymentsEmploymentIdErrors = { @@ -23902,7 +23902,7 @@ export type PatchV1EmploymentsEmploymentId2Data = { */ actions?: string; }; - url: '/api/eor/v1/employments/{employment_id}'; + url: '/v1/employments/{employment_id}'; }; export type PatchV1EmploymentsEmploymentId2Errors = { @@ -24007,7 +24007,7 @@ export type PatchV1EmploymentsEmploymentIdData = { */ actions?: string; }; - url: '/api/eor/v1/employments/{employment_id}'; + url: '/v1/employments/{employment_id}'; }; export type PatchV1EmploymentsEmploymentIdErrors = { @@ -24059,7 +24059,7 @@ export type GetV1EmployeeTimesheetsData = { */ page_size?: number; }; - url: '/api/eor/v1/employee/timesheets'; + url: '/v1/employee/timesheets'; }; export type GetV1EmployeeTimesheetsErrors = { @@ -24103,7 +24103,7 @@ export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; export type GetV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { @@ -24150,7 +24150,7 @@ export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Data = { employment_id: string; }; query?: never; - url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentId2Errors = { @@ -24201,7 +24201,7 @@ export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdData = { employment_id: string; }; query?: never; - url: '/api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}'; + url: '/v1/custom-fields/{custom_field_id}/values/{employment_id}'; }; export type PatchV1CustomFieldsCustomFieldIdValuesEmploymentIdErrors = { @@ -24248,7 +24248,7 @@ export type PutV1ResignationsOffboardingRequestIdValidateData = { offboarding_request_id: string; }; query?: never; - url: '/api/eor/v1/resignations/{offboarding_request_id}/validate'; + url: '/v1/resignations/{offboarding_request_id}/validate'; }; export type PutV1ResignationsOffboardingRequestIdValidateErrors = { @@ -24296,7 +24296,7 @@ export type GetV1ContractorInvoiceSchedulesIdData = { id: UuidSlug; }; query?: never; - url: '/api/eor/v1/contractor-invoice-schedules/{id}'; + url: '/v1/contractor-invoice-schedules/{id}'; }; export type GetV1ContractorInvoiceSchedulesIdErrors = { @@ -24351,7 +24351,7 @@ export type PatchV1ContractorInvoiceSchedulesId2Data = { id: UuidSlug; }; query?: never; - url: '/api/eor/v1/contractor-invoice-schedules/{id}'; + url: '/v1/contractor-invoice-schedules/{id}'; }; export type PatchV1ContractorInvoiceSchedulesId2Errors = { @@ -24398,7 +24398,7 @@ export type PatchV1ContractorInvoiceSchedulesIdData = { id: UuidSlug; }; query?: never; - url: '/api/eor/v1/contractor-invoice-schedules/{id}'; + url: '/v1/contractor-invoice-schedules/{id}'; }; export type PatchV1ContractorInvoiceSchedulesIdErrors = { @@ -24445,7 +24445,7 @@ export type PutV2EmploymentsEmploymentIdPricingPlanDetailsData = { employment_id: string; }; query?: never; - url: '/api/eor/v2/employments/{employment_id}/pricing_plan_details'; + url: '/v2/employments/{employment_id}/pricing_plan_details'; }; export type PutV2EmploymentsEmploymentIdPricingPlanDetailsErrors = { @@ -24499,7 +24499,7 @@ export type PostV1RiskReserveData = { body: CreateRiskReserveParams; path?: never; query?: never; - url: '/api/eor/v1/risk-reserve'; + url: '/v1/risk-reserve'; }; export type PostV1RiskReserveErrors = { @@ -24547,7 +24547,7 @@ export type PutV2EmploymentsEmploymentIdAddressDetailsData = { */ address_details_json_schema_version?: number | 'latest'; }; - url: '/api/eor/v2/employments/{employment_id}/address_details'; + url: '/v2/employments/{employment_id}/address_details'; }; export type PutV2EmploymentsEmploymentIdAddressDetailsErrors = { @@ -24607,7 +24607,7 @@ export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdData = { id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/contract-documents/{id}'; + url: '/v1/contractors/employments/{employment_id}/contract-documents/{id}'; }; export type GetV1ContractorsEmploymentsEmploymentIdContractDocumentsIdErrors = { @@ -24649,7 +24649,7 @@ export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsData = employment_id: string; }; query?: never; - url: '/api/eor/v1/contractors/employments/{employment_id}/cor-termination-requests'; + url: '/v1/contractors/employments/{employment_id}/cor-termination-requests'; }; export type PostV1ContractorsEmploymentsEmploymentIdCorTerminationRequestsErrors = @@ -24699,7 +24699,7 @@ export type GetV1EmployeePayslipsData = { */ page_size?: number; }; - url: '/api/eor/v1/employee/payslips'; + url: '/v1/employee/payslips'; }; export type GetV1EmployeePayslipsErrors = { From 3db05c8138c6f75bb55f0055a80e98bad2c94e89 Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Fri, 15 May 2026 08:55:41 +0200 Subject: [PATCH 7/8] fix local script --- openapi-ts.config.local.ts | 8 +++++ openapi-ts.config.ts | 3 +- package.json | 1 + scripts/cleanup-local-openapi.ts | 50 ++++++++++++++++++++++++++++++++ 4 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 openapi-ts.config.local.ts create mode 100644 scripts/cleanup-local-openapi.ts diff --git a/openapi-ts.config.local.ts b/openapi-ts.config.local.ts new file mode 100644 index 000000000..78ed60594 --- /dev/null +++ b/openapi-ts.config.local.ts @@ -0,0 +1,8 @@ +import { defineConfig, defaultPlugins } from '@hey-api/openapi-ts'; + +export default defineConfig({ + // Local gateway with new endpoints + input: 'http://localhost:4000/api/eor/openapi', + output: 'src/client', + plugins: defaultPlugins, +}); diff --git a/openapi-ts.config.ts b/openapi-ts.config.ts index 2ec3f1e51..d2714bfb6 100644 --- a/openapi-ts.config.ts +++ b/openapi-ts.config.ts @@ -1,7 +1,8 @@ import { defineConfig, defaultPlugins } from '@hey-api/openapi-ts'; export default defineConfig({ - // local gateway http://localhost:4000/api/eor/openapi + // Production gateway - use npm run openapi-ts for production generation + // For local gateway with new endpoints, use npm run openapi-ts:local instead input: 'https://gateway.remote.com/v1/docs/openapi.json', output: 'src/client', plugins: defaultPlugins, diff --git a/package.json b/package.json index 703aca79b..d42ba0c4e 100644 --- a/package.json +++ b/package.json @@ -18,6 +18,7 @@ "lint:workflows:fix": "zizmor --fix .github/workflows/", "format": "oxfmt", "openapi-ts": "openapi-ts && npm run format", + "openapi-ts:local": "openapi-ts --config openapi-ts.config.local.ts && tsx scripts/cleanup-local-openapi.ts && npm run format", "test": "vitest", "test:coverage": "vitest --coverage", "coverage:extract": "tsx scripts/extract-coverage.ts", diff --git a/scripts/cleanup-local-openapi.ts b/scripts/cleanup-local-openapi.ts new file mode 100644 index 000000000..76226b62b --- /dev/null +++ b/scripts/cleanup-local-openapi.ts @@ -0,0 +1,50 @@ +import { readFileSync, writeFileSync } from 'fs'; +import { resolve } from 'path'; + +/** + * Removes /api/eor prefix from generated OpenAPI client files + * This is needed when generating from local OpenAPI spec that includes the prefix + */ +function cleanupApiEorPrefix() { + const files = [ + resolve(process.cwd(), 'src/client/sdk.gen.ts'), + resolve(process.cwd(), 'src/client/types.gen.ts'), + ]; + + let totalReplacements = 0; + + for (const filePath of files) { + try { + let content = readFileSync(filePath, 'utf-8'); + const originalContent = content; + + // Replace /api/eor/v1/ with /v1/ + content = content.replace(/url: '\/api\/eor\/v1\//g, "url: '/v1/"); + + // Replace /api/eor/v2/ with /v2/ + content = content.replace(/url: '\/api\/eor\/v2\//g, "url: '/v2/"); + + if (content !== originalContent) { + writeFileSync(filePath, content, 'utf-8'); + const fileName = filePath.split('/').pop(); + const replacements = (originalContent.match(/\/api\/eor\//g) || []) + .length; + console.log(`āœ“ Cleaned ${replacements} URLs in ${fileName}`); + totalReplacements += replacements; + } + } catch (error) { + console.error(`Error processing ${filePath}:`, error); + process.exit(1); + } + } + + if (totalReplacements > 0) { + console.log( + `\nāœ“ Successfully removed /api/eor prefix from ${totalReplacements} URLs`, + ); + } else { + console.log('\nāœ“ No /api/eor prefixes found'); + } +} + +cleanupApiEorPrefix(); From 29ba2592018c6340dc76eed50acec5b9604c1cd5 Mon Sep 17 00:00:00 2001 From: Gabriel Garcia Date: Fri, 15 May 2026 08:58:11 +0200 Subject: [PATCH 8/8] fix openapi local --- package.json | 2 +- src/client/sdk.gen.ts | 70 +++++++++---------------------------------- 2 files changed, 15 insertions(+), 57 deletions(-) diff --git a/package.json b/package.json index d42ba0c4e..f1ad44855 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "lint:workflows:fix": "zizmor --fix .github/workflows/", "format": "oxfmt", "openapi-ts": "openapi-ts && npm run format", - "openapi-ts:local": "openapi-ts --config openapi-ts.config.local.ts && tsx scripts/cleanup-local-openapi.ts && npm run format", + "openapi-ts:local": "openapi-ts -f openapi-ts.config.local.ts && tsx scripts/cleanup-local-openapi.ts && npm run format", "test": "vitest", "test:coverage": "vitest --coverage", "coverage:extract": "tsx scripts/extract-coverage.ts", diff --git a/src/client/sdk.gen.ts b/src/client/sdk.gen.ts index 16ca37995..548175df6 100644 --- a/src/client/sdk.gen.ts +++ b/src/client/sdk.gen.ts @@ -1954,10 +1954,7 @@ export const getV1CountriesCountryCodeHolidaysYear = < GetV1CountriesCountryCodeHolidaysYearResponses, GetV1CountriesCountryCodeHolidaysYearErrors, ThrowOnError - >({ - url: '/v1/countries/{country_code}/holidays/{year}', - ...options, - }); + >({ url: '/v1/countries/{country_code}/holidays/{year}', ...options }); /** * List custom field value for an employment @@ -1980,10 +1977,7 @@ export const getV1EmploymentsEmploymentIdCustomFields = < GetV1EmploymentsEmploymentIdCustomFieldsResponses, GetV1EmploymentsEmploymentIdCustomFieldsErrors, ThrowOnError - >({ - url: '/v1/employments/{employment_id}/custom-fields', - ...options, - }); + >({ url: '/v1/employments/{employment_id}/custom-fields', ...options }); /** * Show timesheet @@ -2240,10 +2234,7 @@ export const getV1CompaniesCompanyIdWebhookCallbacks = < GetV1CompaniesCompanyIdWebhookCallbacksResponses, GetV1CompaniesCompanyIdWebhookCallbacksErrors, ThrowOnError - >({ - url: '/v1/companies/{company_id}/webhook-callbacks', - ...options, - }); + >({ url: '/v1/companies/{company_id}/webhook-callbacks', ...options }); /** * Download a billing document PDF @@ -2266,10 +2257,7 @@ export const getV1BillingDocumentsBillingDocumentIdPdf = < GetV1BillingDocumentsBillingDocumentIdPdfResponses, GetV1BillingDocumentsBillingDocumentIdPdfErrors, ThrowOnError - >({ - url: '/v1/billing-documents/{billing_document_id}/pdf', - ...options, - }); + >({ url: '/v1/billing-documents/{billing_document_id}/pdf', ...options }); /** * Delete a Webhook Callback @@ -2792,10 +2780,7 @@ export const getV1EmploymentsEmploymentIdOnboardingSteps = < GetV1EmploymentsEmploymentIdOnboardingStepsResponses, GetV1EmploymentsEmploymentIdOnboardingStepsErrors, ThrowOnError - >({ - url: '/v1/employments/{employment_id}/onboarding-steps', - ...options, - }); + >({ url: '/v1/employments/{employment_id}/onboarding-steps', ...options }); /** * Automatable Contract Amendment @@ -3317,10 +3302,7 @@ export const getV1EmploymentsEmploymentIdContractDocuments = < GetV1EmploymentsEmploymentIdContractDocumentsResponses, GetV1EmploymentsEmploymentIdContractDocumentsErrors, ThrowOnError - >({ - url: '/v1/employments/{employment_id}/contract-documents', - ...options, - }); + >({ url: '/v1/employments/{employment_id}/contract-documents', ...options }); /** * Show contractor contract details @@ -3794,10 +3776,7 @@ export const getV1EmploymentsEmploymentIdBenefitOffers = < GetV1EmploymentsEmploymentIdBenefitOffersResponses, GetV1EmploymentsEmploymentIdBenefitOffersErrors, ThrowOnError - >({ - url: '/v1/employments/{employment_id}/benefit-offers', - ...options, - }); + >({ url: '/v1/employments/{employment_id}/benefit-offers', ...options }); /** * Upserts employment benefit offers @@ -5008,10 +4987,7 @@ export const getV1ExpensesExpenseIdReceiptsReceiptId = < GetV1ExpensesExpenseIdReceiptsReceiptIdResponses, GetV1ExpensesExpenseIdReceiptsReceiptIdErrors, ThrowOnError - >({ - url: '/v1/expenses/{expense_id}/receipts/{receipt_id}', - ...options, - }); + >({ url: '/v1/expenses/{expense_id}/receipts/{receipt_id}', ...options }); /** * List groups via SCIM v2.0 @@ -5355,10 +5331,7 @@ export const postV1IdentityVerificationEmploymentIdVerify = < PostV1IdentityVerificationEmploymentIdVerifyResponses, PostV1IdentityVerificationEmploymentIdVerifyErrors, ThrowOnError - >({ - url: '/v1/identity-verification/{employment_id}/verify', - ...options, - }); + >({ url: '/v1/identity-verification/{employment_id}/verify', ...options }); /** * Lists custom fields definitions @@ -5905,10 +5878,7 @@ export const getV1CompaniesCompanyIdComplianceProfile = < GetV1CompaniesCompanyIdComplianceProfileResponses, GetV1CompaniesCompanyIdComplianceProfileErrors, ThrowOnError - >({ - url: '/v1/companies/{company_id}/compliance-profile', - ...options, - }); + >({ url: '/v1/companies/{company_id}/compliance-profile', ...options }); /** * Show payslip @@ -5960,10 +5930,7 @@ export const postV1TimeoffTimeoffIdCancelRequestApprove = < PostV1TimeoffTimeoffIdCancelRequestApproveResponses, PostV1TimeoffTimeoffIdCancelRequestApproveErrors, ThrowOnError - >({ - url: '/v1/timeoff/{timeoff_id}/cancel-request/approve', - ...options, - }); + >({ url: '/v1/timeoff/{timeoff_id}/cancel-request/approve', ...options }); /** * List Webhook Events @@ -6735,10 +6702,7 @@ export const getV1ContractorsSchemasEligibilityQuestionnaire = < GetV1ContractorsSchemasEligibilityQuestionnaireResponses, GetV1ContractorsSchemasEligibilityQuestionnaireErrors, ThrowOnError - >({ - url: '/v1/contractors/schemas/eligibility-questionnaire', - ...options, - }); + >({ url: '/v1/contractors/schemas/eligibility-questionnaire', ...options }); /** * Token @@ -6956,10 +6920,7 @@ export const postV1IdentityVerificationEmploymentIdDecline = < PostV1IdentityVerificationEmploymentIdDeclineResponses, PostV1IdentityVerificationEmploymentIdDeclineErrors, ThrowOnError - >({ - url: '/v1/identity-verification/{employment_id}/decline', - ...options, - }); + >({ url: '/v1/identity-verification/{employment_id}/decline', ...options }); /** * List expense categories for the authenticated employee @@ -7325,10 +7286,7 @@ export const getV1PayrollRunsPayrollRunIdEmployeeDetails = < GetV1PayrollRunsPayrollRunIdEmployeeDetailsResponses, GetV1PayrollRunsPayrollRunIdEmployeeDetailsErrors, ThrowOnError - >({ - url: '/v1/payroll-runs/{payroll_run_id}/employee-details', - ...options, - }); + >({ url: '/v1/payroll-runs/{payroll_run_id}/employee-details', ...options }); /** * Show employment