@remoteoss/remote-flows 1.26.0 → 1.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (328) hide show
  1. package/dist/CheckboxFieldDefault-GQZWERNF.js +2 -0
  2. package/dist/CountryFieldDefault-PKRIWPY3.js +2 -0
  3. package/dist/DatePickerFieldDefault-Y26FNCUK.js +2 -0
  4. package/dist/RadioGroupFieldDefault-DQGRKN3M.js +2 -0
  5. package/dist/TextAreaFieldDefault-EFYFWCHQ.js +2 -0
  6. package/dist/{chunk-C6ARUHCB.js → chunk-2AFRBV4P.js} +2 -2
  7. package/dist/{chunk-GHYCSTSK.js → chunk-373A3JYN.js} +2 -2
  8. package/dist/{chunk-K56VMRZ5.js → chunk-3X4CJEN4.js} +2 -2
  9. package/dist/{chunk-TUPZTWGP.js → chunk-42PPQJNB.js} +2 -2
  10. package/dist/{chunk-XUT44QU6.js → chunk-4DFWKRQR.js} +2 -2
  11. package/dist/{chunk-LX3JPBUV.js → chunk-6CUZAMXI.js} +2 -2
  12. package/dist/{chunk-I2DXGO23.js → chunk-6ICMMDER.js} +2 -2
  13. package/dist/{chunk-DEVQ2NNK.js → chunk-7CTUHB7U.js} +2 -2
  14. package/dist/chunk-7ZBLKUKE.js +2 -0
  15. package/dist/chunk-7ZBLKUKE.js.map +1 -0
  16. package/dist/{chunk-IY3ASS7L.js → chunk-AXMLPGSQ.js} +2 -2
  17. package/dist/{chunk-OCTM6K3V.js → chunk-BUDKOST6.js} +2 -2
  18. package/dist/{chunk-TFJOJCCS.js → chunk-CQDQM2IX.js} +2 -2
  19. package/dist/{chunk-KLN2FG5Y.js → chunk-CWF26ZF4.js} +2 -2
  20. package/dist/{chunk-XXXLKG43.js → chunk-DJPDKTA2.js} +2 -2
  21. package/dist/{chunk-5F5BHJQO.js → chunk-E42PBKYH.js} +2 -2
  22. package/dist/{chunk-XHZHFM2J.js → chunk-EDT4KTVE.js} +2 -2
  23. package/dist/{chunk-7VKV5G6N.js → chunk-F5Y64CVG.js} +2 -2
  24. package/dist/{chunk-RPCS3K2I.js → chunk-FEZZMB7D.js} +2 -2
  25. package/dist/chunk-FO73LJAF.js +2 -0
  26. package/dist/chunk-FO73LJAF.js.map +1 -0
  27. package/dist/{chunk-KKCYP5TA.js → chunk-FV3X3QRI.js} +2 -2
  28. package/dist/{chunk-BMLTMXEK.js → chunk-G2WWWCFS.js} +2 -2
  29. package/dist/{chunk-VLVKKSJP.js → chunk-HC3RLPCZ.js} +2 -2
  30. package/dist/{chunk-GCPDTL2M.js → chunk-HJYUTOA2.js} +2 -2
  31. package/dist/chunk-IT5PQWVR.js +2 -0
  32. package/dist/chunk-IT5PQWVR.js.map +1 -0
  33. package/dist/{chunk-3SECILYU.js → chunk-IYZVFJNC.js} +2 -2
  34. package/dist/{chunk-ZYAMVSAL.js → chunk-JFTKMQ73.js} +2 -2
  35. package/dist/chunk-JJ7EROQA.js +2 -0
  36. package/dist/chunk-JJ7EROQA.js.map +1 -0
  37. package/dist/{chunk-ZS7YCDY6.js → chunk-JOQ6LN5D.js} +2 -2
  38. package/dist/chunk-JR6VISHQ.js +2 -0
  39. package/dist/chunk-JR6VISHQ.js.map +1 -0
  40. package/dist/{chunk-LFYDEIZG.js → chunk-KJY5KHQP.js} +2 -2
  41. package/dist/{chunk-FZO24P53.js → chunk-KN3XMDCI.js} +2 -2
  42. package/dist/{chunk-R7WSWTCF.js → chunk-KVQGNPKF.js} +2 -2
  43. package/dist/{chunk-BAKE7YEE.js → chunk-LRMMQCL7.js} +2 -2
  44. package/dist/{chunk-FZVUO3UU.js → chunk-MKUSE7JK.js} +2 -2
  45. package/dist/{chunk-SP2V52RP.js → chunk-NWODDA5W.js} +2 -2
  46. package/dist/chunk-O4I5IA24.js +2 -0
  47. package/dist/chunk-O4I5IA24.js.map +1 -0
  48. package/dist/{chunk-33IPP266.js → chunk-O5WY5DXB.js} +2 -2
  49. package/dist/{chunk-KJMPEOZ7.js → chunk-OGXYAUPR.js} +2 -2
  50. package/dist/{chunk-7Z4MWUCV.js → chunk-P243ZEXS.js} +2 -2
  51. package/dist/{chunk-36NGPS63.js → chunk-PLPGCGAS.js} +2 -2
  52. package/dist/{chunk-JFD2OJ6L.js → chunk-PVXIXLI7.js} +2 -2
  53. package/dist/{chunk-45K26OSG.js → chunk-PY23FJZC.js} +2 -2
  54. package/dist/{chunk-FIM36WNY.js → chunk-RDOWNO6N.js} +2 -2
  55. package/dist/chunk-RDQJU3HZ.js +2 -0
  56. package/dist/chunk-RDQJU3HZ.js.map +1 -0
  57. package/dist/{chunk-SJVCXKRO.js → chunk-RR5AEFCF.js} +2 -2
  58. package/dist/{chunk-O6H23YQW.js → chunk-RTB5M2WF.js} +2 -2
  59. package/dist/{chunk-RD5FPT3Y.js → chunk-S6LG6MGK.js} +2 -2
  60. package/dist/{chunk-HMVU7HJL.js → chunk-T3MTHXS5.js} +2 -2
  61. package/dist/chunk-TIFHRVKA.js +2 -0
  62. package/dist/chunk-TIFHRVKA.js.map +1 -0
  63. package/dist/{chunk-R47Q7R6C.js → chunk-TNQKP2XT.js} +6 -6
  64. package/dist/chunk-TNQKP2XT.js.map +1 -0
  65. package/dist/{chunk-QLJMIWS4.js → chunk-UAPT6OBQ.js} +2 -2
  66. package/dist/{chunk-P4TKMCSQ.js → chunk-UCYB5QK7.js} +2 -2
  67. package/dist/chunk-UTXYUM6O.js +2 -0
  68. package/dist/chunk-UTXYUM6O.js.map +1 -0
  69. package/dist/chunk-VAMDTZC6.js +2 -0
  70. package/dist/chunk-VAMDTZC6.js.map +1 -0
  71. package/dist/{chunk-POKPAJNL.js → chunk-VAYZNUNH.js} +2 -2
  72. package/dist/chunk-VDAXUUZX.js +2 -0
  73. package/dist/chunk-VDAXUUZX.js.map +1 -0
  74. package/dist/{chunk-6I5FRZSX.js → chunk-VIX4RJKF.js} +2 -2
  75. package/dist/chunk-VK3Z63G4.js +2 -0
  76. package/dist/chunk-VK3Z63G4.js.map +1 -0
  77. package/dist/chunk-WDV3ECGC.js +2 -0
  78. package/dist/chunk-WDV3ECGC.js.map +1 -0
  79. package/dist/{chunk-4EDPYN5F.js → chunk-XBEX4G75.js} +2 -2
  80. package/dist/{chunk-5EHJ5HTV.js → chunk-XFDD4QPE.js} +2 -2
  81. package/dist/{chunk-3VWXALRD.js → chunk-XUTYA3JC.js} +2 -2
  82. package/dist/{chunk-BI3PHE5N.js → chunk-YKAWMDTX.js} +2 -2
  83. package/dist/{chunk-BS4A6UYL.js → chunk-YVEVEN4R.js} +2 -2
  84. package/dist/{chunk-5F5H7LZT.js → chunk-ZKOA3R57.js} +2 -2
  85. package/dist/default-components.d.ts +2 -2
  86. package/dist/default-components.js +1 -1
  87. package/dist/flows/ContractAmendment/ContractAmendmentConfirmationForm.d.ts +1 -1
  88. package/dist/flows/ContractAmendment/ContractAmendmentFlow.d.ts +3 -3
  89. package/dist/flows/ContractAmendment/ContractAmendmentFlow.js +1 -1
  90. package/dist/flows/ContractAmendment/ContractAmendmentForm.d.ts +1 -1
  91. package/dist/flows/ContractAmendment/ContractAmendmentForm.js +1 -1
  92. package/dist/flows/ContractAmendment/context.d.ts +3 -3
  93. package/dist/flows/ContractAmendment/hooks.d.ts +3 -3
  94. package/dist/flows/ContractAmendment/hooks.js +1 -1
  95. package/dist/flows/ContractAmendment/index.d.ts +3 -3
  96. package/dist/flows/ContractAmendment/index.js +1 -1
  97. package/dist/flows/ContractAmendment/types.d.ts +2 -2
  98. package/dist/flows/ContractAmendment/utils.d.ts +2 -2
  99. package/dist/flows/ContractorOnboarding/ContractorOnboarding.d.ts +5 -5
  100. package/dist/flows/ContractorOnboarding/ContractorOnboarding.js +1 -1
  101. package/dist/flows/ContractorOnboarding/api.d.ts +8 -20
  102. package/dist/flows/ContractorOnboarding/api.js +1 -1
  103. package/dist/flows/ContractorOnboarding/components/BasicInformationStep.d.ts +4 -4
  104. package/dist/flows/ContractorOnboarding/components/BasicInformationStep.js +1 -1
  105. package/dist/flows/ContractorOnboarding/components/ContractDetailsStep.d.ts +5 -5
  106. package/dist/flows/ContractorOnboarding/components/ContractDetailsStep.js +1 -1
  107. package/dist/flows/ContractorOnboarding/components/ContractPreviewHeader.d.ts +2 -2
  108. package/dist/flows/ContractorOnboarding/components/ContractPreviewStatement.d.ts +2 -2
  109. package/dist/flows/ContractorOnboarding/components/ContractPreviewStep.d.ts +5 -5
  110. package/dist/flows/ContractorOnboarding/components/ContractPreviewStep.js +1 -1
  111. package/dist/flows/ContractorOnboarding/components/ContractorOnboardingForm.d.ts +5 -5
  112. package/dist/flows/ContractorOnboarding/components/ContractorOnboardingForm.js +1 -1
  113. package/dist/flows/ContractorOnboarding/components/EligibilityQuestionnaireStep.d.ts +5 -5
  114. package/dist/flows/ContractorOnboarding/components/EligibilityQuestionnaireStep.js +1 -1
  115. package/dist/flows/ContractorOnboarding/components/OnboardingInvite.d.ts +3 -3
  116. package/dist/flows/ContractorOnboarding/components/OnboardingInvite.js +1 -1
  117. package/dist/flows/ContractorOnboarding/components/PricingPlan.d.ts +5 -5
  118. package/dist/flows/ContractorOnboarding/components/PricingPlan.js +1 -1
  119. package/dist/flows/ContractorOnboarding/components/SaveDraftButton.d.ts +3 -3
  120. package/dist/flows/ContractorOnboarding/components/SelectCountryStep.d.ts +4 -4
  121. package/dist/flows/ContractorOnboarding/components/SelectCountryStep.js +1 -1
  122. package/dist/flows/ContractorOnboarding/context.d.ts +8 -7
  123. package/dist/flows/ContractorOnboarding/hooks.d.ts +5 -5
  124. package/dist/flows/ContractorOnboarding/hooks.js +1 -1
  125. package/dist/flows/ContractorOnboarding/index.d.ts +5 -5
  126. package/dist/flows/ContractorOnboarding/index.js +1 -1
  127. package/dist/flows/ContractorOnboarding/jsfModify.d.ts +5 -5
  128. package/dist/flows/ContractorOnboarding/jsfModify.js +1 -1
  129. package/dist/flows/ContractorOnboarding/types.d.ts +5 -5
  130. package/dist/flows/ContractorOnboarding/utils.d.ts +4 -4
  131. package/dist/flows/CostCalculator/CostCalculatorFlow.d.ts +3 -3
  132. package/dist/flows/CostCalculator/CostCalculatorFlow.js +1 -1
  133. package/dist/flows/CostCalculator/CostCalculatorForm.d.ts +3 -3
  134. package/dist/flows/CostCalculator/CostCalculatorForm.js +1 -1
  135. package/dist/flows/CostCalculator/EstimationResults/EstimationResults.d.ts +2 -2
  136. package/dist/flows/CostCalculator/EstimationResults/EstimationResults.js +1 -1
  137. package/dist/flows/CostCalculator/SummaryResults/SummaryResults.d.ts +2 -2
  138. package/dist/flows/CostCalculator/api.d.ts +5 -9
  139. package/dist/flows/CostCalculator/api.js +1 -1
  140. package/dist/flows/CostCalculator/components/SalaryField.d.ts +2 -2
  141. package/dist/flows/CostCalculator/components/SalaryField.js +1 -1
  142. package/dist/flows/CostCalculator/context.d.ts +3 -3
  143. package/dist/flows/CostCalculator/hooks.d.ts +3 -3
  144. package/dist/flows/CostCalculator/hooks.js +1 -1
  145. package/dist/flows/CostCalculator/index.d.ts +4 -4
  146. package/dist/flows/CostCalculator/index.js +1 -1
  147. package/dist/flows/CostCalculator/types.d.ts +2 -2
  148. package/dist/flows/CostCalculator/utils.d.ts +3 -3
  149. package/dist/flows/CostCalculator/utils.js +1 -1
  150. package/dist/flows/CreateCompany/CreateCompany.d.ts +4 -4
  151. package/dist/flows/CreateCompany/CreateCompany.js +1 -1
  152. package/dist/flows/CreateCompany/api.d.ts +6 -14
  153. package/dist/flows/CreateCompany/api.js +1 -1
  154. package/dist/flows/CreateCompany/components/AddressDetailsStep.d.ts +4 -4
  155. package/dist/flows/CreateCompany/components/AddressDetailsStep.js +1 -1
  156. package/dist/flows/CreateCompany/components/CompanyBasicInformationStep.d.ts +4 -4
  157. package/dist/flows/CreateCompany/components/CompanyBasicInformationStep.js +1 -1
  158. package/dist/flows/CreateCompany/components/CreateCompanyForm.d.ts +2 -2
  159. package/dist/flows/CreateCompany/components/CreateCompanyForm.js +1 -1
  160. package/dist/flows/CreateCompany/context.d.ts +7 -6
  161. package/dist/flows/CreateCompany/hooks.d.ts +4 -4
  162. package/dist/flows/CreateCompany/hooks.js +1 -1
  163. package/dist/flows/CreateCompany/index.d.ts +4 -4
  164. package/dist/flows/CreateCompany/index.js +1 -1
  165. package/dist/flows/CreateCompany/types.d.ts +4 -4
  166. package/dist/flows/Onboarding/OnboardingFlow.d.ts +4 -4
  167. package/dist/flows/Onboarding/OnboardingFlow.js +1 -1
  168. package/dist/flows/Onboarding/api.d.ts +65 -18
  169. package/dist/flows/Onboarding/api.js +1 -1
  170. package/dist/flows/Onboarding/components/AnnualGrossSalary.d.ts +2 -2
  171. package/dist/flows/Onboarding/components/AnnualGrossSalary.js +1 -1
  172. package/dist/flows/Onboarding/components/BasicInformationStep.d.ts +4 -4
  173. package/dist/flows/Onboarding/components/BasicInformationStep.js +1 -1
  174. package/dist/flows/Onboarding/components/BenefitsStep.d.ts +4 -4
  175. package/dist/flows/Onboarding/components/BenefitsStep.js +1 -1
  176. package/dist/flows/Onboarding/components/ContractDetailsStep.d.ts +4 -4
  177. package/dist/flows/Onboarding/components/ContractDetailsStep.js +1 -1
  178. package/dist/flows/Onboarding/components/EngagementAgreementDetailsStep.d.ts +16 -0
  179. package/dist/flows/Onboarding/components/EngagementAgreementDetailsStep.js +2 -0
  180. package/dist/flows/Onboarding/components/EngagementAgreementDetailsStep.js.map +1 -0
  181. package/dist/flows/Onboarding/components/OnboardingForm.d.ts +5 -5
  182. package/dist/flows/Onboarding/components/OnboardingForm.js +1 -1
  183. package/dist/flows/Onboarding/components/OnboardingInvite.d.ts +3 -3
  184. package/dist/flows/Onboarding/components/OnboardingInvite.js +1 -1
  185. package/dist/flows/Onboarding/components/ReviewStep.d.ts +4 -4
  186. package/dist/flows/Onboarding/components/SaveDraftButton.d.ts +3 -3
  187. package/dist/flows/Onboarding/components/SelectCountryStep.d.ts +4 -4
  188. package/dist/flows/Onboarding/components/SelectCountryStep.js +1 -1
  189. package/dist/flows/Onboarding/context.d.ts +24 -11
  190. package/dist/flows/Onboarding/hooks.d.ts +4 -4
  191. package/dist/flows/Onboarding/hooks.js +1 -1
  192. package/dist/flows/Onboarding/index.d.ts +4 -4
  193. package/dist/flows/Onboarding/index.js +1 -1
  194. package/dist/flows/Onboarding/types.d.ts +4 -4
  195. package/dist/flows/Onboarding/utils.d.ts +4 -4
  196. package/dist/flows/Termination/AdditionalDetailsForm.d.ts +4 -4
  197. package/dist/flows/Termination/AdditionalDetailsForm.js +1 -1
  198. package/dist/flows/Termination/EmployeeComunicationForm.d.ts +4 -4
  199. package/dist/flows/Termination/EmployeeComunicationForm.js +1 -1
  200. package/dist/flows/Termination/PaidTimeOffForm.d.ts +4 -4
  201. package/dist/flows/Termination/PaidTimeOffForm.js +1 -1
  202. package/dist/flows/Termination/TerminationDetailsForm.d.ts +4 -4
  203. package/dist/flows/Termination/TerminationDetailsForm.js +1 -1
  204. package/dist/flows/Termination/TerminationFlow.d.ts +4 -4
  205. package/dist/flows/Termination/TerminationFlow.js +1 -1
  206. package/dist/flows/Termination/TerminationForm.d.ts +5 -5
  207. package/dist/flows/Termination/TerminationForm.js +1 -1
  208. package/dist/flows/Termination/api.d.ts +8 -12
  209. package/dist/flows/Termination/api.js +1 -1
  210. package/dist/flows/Termination/components/AcknowledgeInformation/AcknowledgeInformationFees.js +1 -1
  211. package/dist/flows/Termination/components/PaidTimeOff/PaidTimeOff.d.ts +7 -7
  212. package/dist/flows/Termination/components/PaidTimeOff/PaidTimeOffContainer.d.ts +7 -7
  213. package/dist/flows/Termination/components/PaidTimeOff/PaidTimeOffContainer.js +1 -1
  214. package/dist/flows/Termination/components/PaidTimeOff/types.d.ts +7 -7
  215. package/dist/flows/Termination/components/TerminationDialogInfoContent/TerminationDialogInfoContent.js +1 -1
  216. package/dist/flows/Termination/context.d.ts +4 -4
  217. package/dist/flows/Termination/hooks.d.ts +4 -4
  218. package/dist/flows/Termination/hooks.js +1 -1
  219. package/dist/flows/Termination/index.d.ts +6 -6
  220. package/dist/flows/Termination/index.js +1 -1
  221. package/dist/flows/Termination/json-schemas/schema.d.ts +4 -4
  222. package/dist/flows/Termination/types.d.ts +4 -4
  223. package/dist/flows/Termination/utils.d.ts +4 -4
  224. package/dist/flows/types.d.ts +4 -3
  225. package/dist/flows/utils.d.ts +2 -2
  226. package/dist/index.css +1 -1
  227. package/dist/index.css.map +1 -1
  228. package/dist/index.d.ts +17 -11
  229. package/dist/index.js +2 -2
  230. package/dist/index.js.map +1 -1
  231. package/dist/internals.d.ts +3 -3
  232. package/dist/internals.js +1 -1
  233. package/dist/{mutations-BlHJKh7X.d.ts → mutations-C1XMuYlk.d.ts} +1 -1
  234. package/dist/{remoteFlows-BgpcnCNA.d.ts → remoteFlows-CxOc7anq.d.ts} +1 -1
  235. package/dist/styles.css +1 -1
  236. package/dist/styles.css.map +1 -1
  237. package/dist/{types-DEzrQ-MU.d.ts → types-BYcKuJ8z.d.ts} +2 -2
  238. package/dist/{types-x02L1Qo9.d.ts → types-BqpZPw47.d.ts} +56 -15
  239. package/dist/{types-BBgv8INf.d.ts → types-Cb-1z4vt.d.ts} +4 -4
  240. package/dist/{types-CRnEmzMD.d.ts → types-DuKc_eXf.d.ts} +1 -1
  241. package/dist/{types-nfUNaXC-.d.ts → types-oX7HbacX.d.ts} +3 -3
  242. package/dist/{types.gen-Dgw1W-SB.d.ts → types.gen-CLArJ-Qx.d.ts} +712 -21
  243. package/dist/{utils-Dg9zSNDT.d.ts → utils-DsfJjYNt.d.ts} +1 -1
  244. package/package.json +62 -62
  245. package/dist/CheckboxFieldDefault-SQULI7DO.js +0 -2
  246. package/dist/CountryFieldDefault-4YHZACZ5.js +0 -2
  247. package/dist/DatePickerFieldDefault-B7WY5H6M.js +0 -2
  248. package/dist/RadioGroupFieldDefault-G637DHSW.js +0 -2
  249. package/dist/TextAreaFieldDefault-32E5FGS7.js +0 -2
  250. package/dist/chunk-AMSYQQG7.js +0 -2
  251. package/dist/chunk-AMSYQQG7.js.map +0 -1
  252. package/dist/chunk-AXGWQVCT.js +0 -2
  253. package/dist/chunk-AXGWQVCT.js.map +0 -1
  254. package/dist/chunk-CEIDSIMA.js +0 -2
  255. package/dist/chunk-CEIDSIMA.js.map +0 -1
  256. package/dist/chunk-ERY43GUW.js +0 -2
  257. package/dist/chunk-ERY43GUW.js.map +0 -1
  258. package/dist/chunk-IK27ZFUU.js +0 -2
  259. package/dist/chunk-IK27ZFUU.js.map +0 -1
  260. package/dist/chunk-JMDINYDB.js +0 -2
  261. package/dist/chunk-JMDINYDB.js.map +0 -1
  262. package/dist/chunk-JWP4HAIS.js +0 -2
  263. package/dist/chunk-JWP4HAIS.js.map +0 -1
  264. package/dist/chunk-NUD662HZ.js +0 -2
  265. package/dist/chunk-NUD662HZ.js.map +0 -1
  266. package/dist/chunk-R47Q7R6C.js.map +0 -1
  267. package/dist/chunk-T4Y4D743.js +0 -2
  268. package/dist/chunk-T4Y4D743.js.map +0 -1
  269. package/dist/chunk-TIJRONPS.js +0 -2
  270. package/dist/chunk-TIJRONPS.js.map +0 -1
  271. package/dist/chunk-TXEONNPV.js +0 -2
  272. package/dist/chunk-TXEONNPV.js.map +0 -1
  273. /package/dist/{CheckboxFieldDefault-SQULI7DO.js.map → CheckboxFieldDefault-GQZWERNF.js.map} +0 -0
  274. /package/dist/{CountryFieldDefault-4YHZACZ5.js.map → CountryFieldDefault-PKRIWPY3.js.map} +0 -0
  275. /package/dist/{DatePickerFieldDefault-B7WY5H6M.js.map → DatePickerFieldDefault-Y26FNCUK.js.map} +0 -0
  276. /package/dist/{RadioGroupFieldDefault-G637DHSW.js.map → RadioGroupFieldDefault-DQGRKN3M.js.map} +0 -0
  277. /package/dist/{TextAreaFieldDefault-32E5FGS7.js.map → TextAreaFieldDefault-EFYFWCHQ.js.map} +0 -0
  278. /package/dist/{chunk-C6ARUHCB.js.map → chunk-2AFRBV4P.js.map} +0 -0
  279. /package/dist/{chunk-GHYCSTSK.js.map → chunk-373A3JYN.js.map} +0 -0
  280. /package/dist/{chunk-K56VMRZ5.js.map → chunk-3X4CJEN4.js.map} +0 -0
  281. /package/dist/{chunk-TUPZTWGP.js.map → chunk-42PPQJNB.js.map} +0 -0
  282. /package/dist/{chunk-XUT44QU6.js.map → chunk-4DFWKRQR.js.map} +0 -0
  283. /package/dist/{chunk-LX3JPBUV.js.map → chunk-6CUZAMXI.js.map} +0 -0
  284. /package/dist/{chunk-I2DXGO23.js.map → chunk-6ICMMDER.js.map} +0 -0
  285. /package/dist/{chunk-DEVQ2NNK.js.map → chunk-7CTUHB7U.js.map} +0 -0
  286. /package/dist/{chunk-IY3ASS7L.js.map → chunk-AXMLPGSQ.js.map} +0 -0
  287. /package/dist/{chunk-OCTM6K3V.js.map → chunk-BUDKOST6.js.map} +0 -0
  288. /package/dist/{chunk-TFJOJCCS.js.map → chunk-CQDQM2IX.js.map} +0 -0
  289. /package/dist/{chunk-KLN2FG5Y.js.map → chunk-CWF26ZF4.js.map} +0 -0
  290. /package/dist/{chunk-XXXLKG43.js.map → chunk-DJPDKTA2.js.map} +0 -0
  291. /package/dist/{chunk-5F5BHJQO.js.map → chunk-E42PBKYH.js.map} +0 -0
  292. /package/dist/{chunk-XHZHFM2J.js.map → chunk-EDT4KTVE.js.map} +0 -0
  293. /package/dist/{chunk-7VKV5G6N.js.map → chunk-F5Y64CVG.js.map} +0 -0
  294. /package/dist/{chunk-RPCS3K2I.js.map → chunk-FEZZMB7D.js.map} +0 -0
  295. /package/dist/{chunk-KKCYP5TA.js.map → chunk-FV3X3QRI.js.map} +0 -0
  296. /package/dist/{chunk-BMLTMXEK.js.map → chunk-G2WWWCFS.js.map} +0 -0
  297. /package/dist/{chunk-VLVKKSJP.js.map → chunk-HC3RLPCZ.js.map} +0 -0
  298. /package/dist/{chunk-GCPDTL2M.js.map → chunk-HJYUTOA2.js.map} +0 -0
  299. /package/dist/{chunk-3SECILYU.js.map → chunk-IYZVFJNC.js.map} +0 -0
  300. /package/dist/{chunk-ZYAMVSAL.js.map → chunk-JFTKMQ73.js.map} +0 -0
  301. /package/dist/{chunk-ZS7YCDY6.js.map → chunk-JOQ6LN5D.js.map} +0 -0
  302. /package/dist/{chunk-LFYDEIZG.js.map → chunk-KJY5KHQP.js.map} +0 -0
  303. /package/dist/{chunk-FZO24P53.js.map → chunk-KN3XMDCI.js.map} +0 -0
  304. /package/dist/{chunk-R7WSWTCF.js.map → chunk-KVQGNPKF.js.map} +0 -0
  305. /package/dist/{chunk-BAKE7YEE.js.map → chunk-LRMMQCL7.js.map} +0 -0
  306. /package/dist/{chunk-FZVUO3UU.js.map → chunk-MKUSE7JK.js.map} +0 -0
  307. /package/dist/{chunk-SP2V52RP.js.map → chunk-NWODDA5W.js.map} +0 -0
  308. /package/dist/{chunk-33IPP266.js.map → chunk-O5WY5DXB.js.map} +0 -0
  309. /package/dist/{chunk-KJMPEOZ7.js.map → chunk-OGXYAUPR.js.map} +0 -0
  310. /package/dist/{chunk-7Z4MWUCV.js.map → chunk-P243ZEXS.js.map} +0 -0
  311. /package/dist/{chunk-36NGPS63.js.map → chunk-PLPGCGAS.js.map} +0 -0
  312. /package/dist/{chunk-JFD2OJ6L.js.map → chunk-PVXIXLI7.js.map} +0 -0
  313. /package/dist/{chunk-45K26OSG.js.map → chunk-PY23FJZC.js.map} +0 -0
  314. /package/dist/{chunk-FIM36WNY.js.map → chunk-RDOWNO6N.js.map} +0 -0
  315. /package/dist/{chunk-SJVCXKRO.js.map → chunk-RR5AEFCF.js.map} +0 -0
  316. /package/dist/{chunk-O6H23YQW.js.map → chunk-RTB5M2WF.js.map} +0 -0
  317. /package/dist/{chunk-RD5FPT3Y.js.map → chunk-S6LG6MGK.js.map} +0 -0
  318. /package/dist/{chunk-HMVU7HJL.js.map → chunk-T3MTHXS5.js.map} +0 -0
  319. /package/dist/{chunk-QLJMIWS4.js.map → chunk-UAPT6OBQ.js.map} +0 -0
  320. /package/dist/{chunk-P4TKMCSQ.js.map → chunk-UCYB5QK7.js.map} +0 -0
  321. /package/dist/{chunk-POKPAJNL.js.map → chunk-VAYZNUNH.js.map} +0 -0
  322. /package/dist/{chunk-6I5FRZSX.js.map → chunk-VIX4RJKF.js.map} +0 -0
  323. /package/dist/{chunk-4EDPYN5F.js.map → chunk-XBEX4G75.js.map} +0 -0
  324. /package/dist/{chunk-5EHJ5HTV.js.map → chunk-XFDD4QPE.js.map} +0 -0
  325. /package/dist/{chunk-3VWXALRD.js.map → chunk-XUTYA3JC.js.map} +0 -0
  326. /package/dist/{chunk-BI3PHE5N.js.map → chunk-YKAWMDTX.js.map} +0 -0
  327. /package/dist/{chunk-BS4A6UYL.js.map → chunk-YVEVEN4R.js.map} +0 -0
  328. /package/dist/{chunk-5F5H7LZT.js.map → chunk-ZKOA3R57.js.map} +0 -0
@@ -24,16 +24,42 @@ type MinimalRegion = {
24
24
  };
25
25
  /**
26
26
  * TerminationOffboarding
27
+ *
28
+ * An offboarding request initiated by the employer to terminate an employment. Includes termination details, risk assessment, and status tracking through Remote's review process.
27
29
  */
28
30
  type TerminationOffboarding = {
31
+ /**
32
+ * Additional comments or context about the termination provided by the employer.
33
+ */
29
34
  additional_comments: string | null;
35
+ /**
36
+ * Whether the employer agreed with the employee's PTO balance at the time of the termination request.
37
+ */
30
38
  agrees_to_pto_amount?: boolean;
39
+ /**
40
+ * Whether this offboarding request is confidential. Confidential requests are only visible to the user who authorized the token or integration; non-confidential requests are visible to all company admins.
41
+ */
31
42
  confidential: boolean;
43
+ /**
44
+ * Details about whether and when the employee was informed about their termination. Only present if the employee was informed before the offboarding request was submitted.
45
+ */
32
46
  employee_awareness?: {
47
+ /**
48
+ * The date when the employee was told about the termination.
49
+ */
33
50
  date?: string | null;
51
+ /**
52
+ * Notes about how the termination was communicated to the employee.
53
+ */
34
54
  note?: string | null;
35
55
  };
56
+ /**
57
+ * The unique identifier (UUID) of the employment being terminated.
58
+ */
36
59
  employment_id: string;
60
+ /**
61
+ * The unique identifier (UUID) of the offboarding request.
62
+ */
37
63
  id: string;
38
64
  /**
39
65
  * Remote will use this email address for post-termination communication.
@@ -41,19 +67,55 @@ type TerminationOffboarding = {
41
67
  *
42
68
  */
43
69
  personal_email?: string;
70
+ /**
71
+ * The employer's proposed termination date. The actual termination date may differ based on local labor laws and notice period requirements.
72
+ */
44
73
  proposed_termination_date: string;
74
+ /**
75
+ * A detailed description of the circumstances leading to the termination.
76
+ */
45
77
  reason_description: string;
78
+ /**
79
+ * The unique identifier (UUID) of the company admin who submitted the termination request.
80
+ */
46
81
  requested_by: string;
82
+ /**
83
+ * Reasons that may increase the legal risk of this termination (e.g., the employee is pregnant, on family leave, etc.).
84
+ */
47
85
  risk_assessment_reasons: Array<'caring_responsibilities' | 'disabled_or_health_condition' | 'family_leave' | 'member_of_union_or_works_council' | 'none_of_these' | 'pregnant_or_breastfeeding' | 'reported_concerns_with_workplace' | 'requested_medical_or_family_leave' | 'sick_leave'>;
86
+ /**
87
+ * The current status of the offboarding request.
88
+ *
89
+ * - `submitted`: The request has been submitted and is awaiting review by Remote.
90
+ * - `in_review`: Remote is reviewing the request for legal compliance and risks.
91
+ * - `done`: The offboarding has been completed and the employment is terminated.
92
+ * - `canceled`: The offboarding request was canceled before completion.
93
+ *
94
+ */
48
95
  status: 'submitted' | 'in_review' | 'done' | 'canceled';
96
+ /**
97
+ * The timestamp when the offboarding request was submitted.
98
+ */
49
99
  submitted_at: string;
50
100
  /**
51
101
  * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
52
102
  */
53
103
  termination_date: string | null;
104
+ /**
105
+ * The reason for the termination, as submitted by the employer.
106
+ */
54
107
  termination_reason: 'cancellation_before_start_date' | 'compliance_issue' | 'conversion_to_contractor' | 'dissatisfaction_with_remote_service' | 'end_of_fixed_term_contract_compliance_issue' | 'end_of_fixed_term_contract_incapacity_to_perform_inherent_duties' | 'end_of_fixed_term_contract_local_regulations_max_term_reached' | 'end_of_fixed_term_contract_misconduct' | 'end_of_fixed_term_contract_operational_reasons' | 'end_of_fixed_term_contract_other' | 'end_of_fixed_term_contract_performance' | 'end_of_fixed_term_contract_redundancy' | 'end_of_fixed_term_contract_values' | 'gross_misconduct' | 'incapacity_to_perform_inherent_duties' | 'job_abandonment' | 'mutual_agreement' | 'other' | 'performance' | 'values' | 'workforce_reduction';
108
+ /**
109
+ * The type of offboarding. Always `"termination"` for employer-initiated terminations.
110
+ */
55
111
  type: 'termination';
112
+ /**
113
+ * Whether the employer believes the employee is likely to challenge their termination.
114
+ */
56
115
  will_challenge_termination: boolean;
116
+ /**
117
+ * Additional details about why the employee may challenge the termination, if applicable.
118
+ */
57
119
  will_challenge_termination_description?: string;
58
120
  };
59
121
  /**
@@ -111,18 +173,35 @@ type ResignationOrTerminationOffboarding = ResignationOffboarding | TerminationO
111
173
  type CycleFrequency = 'monthly' | 'bi_monthly' | 'bi_weekly' | 'weekly';
112
174
  /**
113
175
  * MinimalCountry
176
+ *
177
+ * A lightweight country representation with basic identification fields.
114
178
  */
115
179
  type MinimalCountry = {
180
+ /**
181
+ * The ISO 3166-1 alpha-2 country code (e.g., "PT", "US", "GB").
182
+ */
116
183
  alpha_2_code: string;
184
+ /**
185
+ * The ISO 3166-1 alpha-3 country code (e.g., "PRT", "USA", "GBR"). This is the primary code used across the Remote API.
186
+ */
117
187
  code: string;
188
+ /**
189
+ * Feature flags indicating which Remote services are available in this country.
190
+ */
118
191
  features?: Array<string>;
192
+ /**
193
+ * The country's full English name.
194
+ */
119
195
  name: string;
196
+ /**
197
+ * A unique URL-friendly identifier for the country.
198
+ */
120
199
  slug: string;
121
200
  };
122
201
  /**
123
202
  * Employment
124
203
  *
125
- * Complete information of an employment
204
+ * Complete information of an employment, including all onboarding task statuses, country-specific form data (address, contract, administrative, etc.), and contractor-specific settings where applicable.
126
205
  */
127
206
  type Employment = {
128
207
  /**
@@ -136,6 +215,9 @@ type Employment = {
136
215
  * Name of related department, if any. Otherwise, null.
137
216
  */
138
217
  department?: string | null;
218
+ /**
219
+ * The email address of the employee's manager. Null if no manager is assigned.
220
+ */
139
221
  manager_email: string | null;
140
222
  provisional_start_date?: ProvisionalStartDate;
141
223
  /**
@@ -145,6 +227,9 @@ type Employment = {
145
227
  [key: string]: unknown;
146
228
  };
147
229
  pricing_plan_details: PricingPlanDetails;
230
+ /**
231
+ * The employee's full name.
232
+ */
148
233
  full_name: string;
149
234
  /**
150
235
  * For the employment types `contractor`, `global_payroll_employee` and `direct_employee`, only [List employments](#operation/get_index_employment) and
@@ -201,6 +286,9 @@ type Employment = {
201
286
  */
202
287
  type?: 'hourly' | 'daily' | 'weekly' | 'monthly' | 'one_off';
203
288
  } | null;
289
+ /**
290
+ * The unique identifier (UUID) of the company this employment belongs to.
291
+ */
204
292
  company_id: string;
205
293
  /**
206
294
  * Work address information. Its properties may vary depending on the country.
@@ -208,8 +296,14 @@ type Employment = {
208
296
  work_address_details: {
209
297
  [key: string]: unknown;
210
298
  };
299
+ /**
300
+ * The employee's work email address, typically provided by the employer.
301
+ */
211
302
  work_email: string;
212
303
  status: EmploymentStatus;
304
+ /**
305
+ * The timestamp when this employment record was last updated.
306
+ */
213
307
  updated_at: string;
214
308
  /**
215
309
  * Employment basic information. Its properties may vary depending on the country.
@@ -218,8 +312,17 @@ type Employment = {
218
312
  basic_information?: {
219
313
  [key: string]: unknown;
220
314
  };
315
+ /**
316
+ * The employee's job title. May be null if not yet set.
317
+ */
221
318
  job_title: string | null;
319
+ /**
320
+ * The unique identifier (UUID) of the employment.
321
+ */
222
322
  id: string;
323
+ /**
324
+ * The date when the employee's probation period ends, if applicable.
325
+ */
223
326
  probation_period_end_date?: string;
224
327
  /**
225
328
  * DepartmentID
@@ -227,7 +330,13 @@ type Employment = {
227
330
  * Unique ID of related department, if any. Otherwise, null.
228
331
  */
229
332
  department_id?: string | null;
333
+ /**
334
+ * The full name of the employee's manager.
335
+ */
230
336
  manager?: string;
337
+ /**
338
+ * The email address the employee uses to log in to the Remote platform.
339
+ */
231
340
  login_email: string;
232
341
  /**
233
342
  * A unique reference code for the employment record in a non-Remote system. While uniqueness is recommended, it is not strictly enforced within Remote's system.
@@ -239,6 +348,9 @@ type Employment = {
239
348
  *
240
349
  */
241
350
  employment_model: 'global_payroll' | 'peo' | 'eor';
351
+ /**
352
+ * The employee's personal email address, used for account-related communications.
353
+ */
242
354
  personal_email: string;
243
355
  country: NullableCountry;
244
356
  user_status?: UserStatus;
@@ -246,7 +358,13 @@ type Employment = {
246
358
  bank_account_details: Array<{
247
359
  [key: string]: unknown;
248
360
  }>;
361
+ /**
362
+ * Documents associated with this employment (e.g., contracts, tax forms, identity documents).
363
+ */
249
364
  files: Array<File>;
365
+ /**
366
+ * The unique identifier (UUID) of the currently active contract for this employment.
367
+ */
250
368
  active_contract_id?: string;
251
369
  /**
252
370
  * Billing address information. Its properties may vary depending on the country.
@@ -267,8 +385,17 @@ type Employment = {
267
385
  emergency_contact_details: {
268
386
  [key: string]: unknown;
269
387
  };
388
+ /**
389
+ * Whether this employment can still be cancelled during the onboarding process. Once the employment is active, this will be false.
390
+ */
270
391
  eligible_for_onboarding_cancellation: boolean;
392
+ /**
393
+ * The employment ID of the employee's manager on Remote, if the manager is also managed through Remote. Null otherwise.
394
+ */
271
395
  manager_employment_id: string | null;
396
+ /**
397
+ * The timestamp when this employment record was created.
398
+ */
272
399
  created_at: string;
273
400
  };
274
401
  /**
@@ -299,7 +426,7 @@ type ActionError = {
299
426
  /**
300
427
  * EmploymentShowResponse
301
428
  *
302
- * Complete information of an employment
429
+ * Response containing the full employment record, including the termination date if the employment has an active offboarding.
303
430
  */
304
431
  type EmploymentShowResponse = {
305
432
  data: {
@@ -317,17 +444,31 @@ type EmploymentShowResponse = {
317
444
  type ConflictErrorResponse = ValidationError | MessageResponse;
318
445
  /**
319
446
  * CostCalculatorDiscountResponse
447
+ *
448
+ * The discount applied to a cost estimate, showing the annual and monthly savings.
320
449
  */
321
450
  type CostCalculatorDiscountResponse = {
451
+ /**
452
+ * The annual discount amount in cents.
453
+ */
322
454
  annual_amount: number;
455
+ /**
456
+ * The monthly discount amount in cents.
457
+ */
323
458
  monthly_amount: number;
459
+ /**
460
+ * The number of months the discount applies to.
461
+ */
324
462
  months: number;
463
+ /**
464
+ * A human-readable label for the discount.
465
+ */
325
466
  text: string;
326
467
  };
327
468
  /**
328
469
  * EmploymentBasicResponse
329
470
  *
330
- * Complete information of an employment
471
+ * A lightweight employment representation returned after creation. Contains basic identification, country, and status fields but not the full onboarding details or country-specific form data.
331
472
  */
332
473
  type EmploymentBasicResponse = {
333
474
  /**
@@ -338,20 +479,47 @@ type EmploymentBasicResponse = {
338
479
  basic_information?: {
339
480
  [key: string]: unknown;
340
481
  };
482
+ /**
483
+ * The unique identifier (UUID) of the company.
484
+ */
341
485
  company_id?: string;
486
+ /**
487
+ * The ISO 3166-1 3-letter country code for this employment.
488
+ */
342
489
  country_code?: string;
490
+ /**
491
+ * When this employment was created.
492
+ */
343
493
  created_at?: string;
344
494
  employment_lifecycle_stage?: EmploymentLifecycleStage;
495
+ /**
496
+ * The employee's full name.
497
+ */
345
498
  full_name?: string;
346
499
  id?: UuidSlug;
500
+ /**
501
+ * The employee's job title. May be null if not yet set.
502
+ */
347
503
  job_title?: string | null;
504
+ /**
505
+ * The email the employee uses to log in to Remote.
506
+ */
348
507
  login_email?: string;
508
+ /**
509
+ * The employee's personal email address.
510
+ */
349
511
  personal_email?: string;
350
512
  /**
351
513
  * Required for employees, optional for contractors
352
514
  */
353
515
  provisional_start_date?: string;
516
+ /**
517
+ * The type of employment.
518
+ */
354
519
  type?: 'employee' | 'contractor';
520
+ /**
521
+ * When this employment was last updated.
522
+ */
355
523
  updated_at?: string;
356
524
  };
357
525
  /**
@@ -394,18 +562,47 @@ type CompanyAlreadyExistsErrorResponse = {
394
562
  };
395
563
  /**
396
564
  * CostCalculatorEmploymentParam
565
+ *
566
+ * Parameters for a single employment to include in the cost estimate. Provide the region and salary (or total cost) — the calculator will compute all employer costs, contributions, and benefits.
397
567
  */
398
568
  type CostCalculatorEmploymentParam = {
569
+ /**
570
+ * The employee's age. Used in some countries to calculate age-dependent benefits or contributions.
571
+ */
399
572
  age?: number;
573
+ /**
574
+ * The annual gross salary in the region's local currency, in cents. Provide this OR `annual_total_cost`, not both.
575
+ */
400
576
  annual_gross_salary?: number;
577
+ /**
578
+ * The annual gross salary in the employer's preferred currency, in cents. Used when you want to specify salary in a different currency than the region's.
579
+ */
401
580
  annual_gross_salary_in_employer_currency?: number;
581
+ /**
582
+ * The target total annual cost (salary + all employer costs) in the region's local currency, in cents. The calculator will derive the gross salary. Provide this OR `annual_gross_salary`, not both.
583
+ */
402
584
  annual_total_cost?: number;
585
+ /**
586
+ * The target total annual cost in the employer's preferred currency, in cents.
587
+ */
403
588
  annual_total_cost_in_employer_currency?: number;
589
+ /**
590
+ * Specific benefit selections to include in the estimate.
591
+ */
404
592
  benefits?: Array<CostCalculatorBenefitParam>;
405
593
  discount?: CostCalculatorDiscount;
406
594
  employment_term?: EmploymentTermType;
595
+ /**
596
+ * The unique identifier (slug) of the region/country for this employment. Required.
597
+ */
407
598
  region_slug: string;
599
+ /**
600
+ * A custom exchange rate from the regional currency to the employer currency. If not provided, the current market rate is used.
601
+ */
408
602
  regional_to_employer_exchange_rate?: string;
603
+ /**
604
+ * An optional label for this employment in the estimate (e.g., the job title or role name).
605
+ */
409
606
  title?: string;
410
607
  };
411
608
  /**
@@ -430,24 +627,54 @@ type LimitedDaysandHoursResponse = {
430
627
  * A supported country on Remote
431
628
  */
432
629
  type Country = {
630
+ /**
631
+ * The ISO 3166-1 alpha-2 country code (e.g., "PT").
632
+ */
433
633
  alpha_2_code: string;
634
+ /**
635
+ * The ISO 3166-1 alpha-3 country code (e.g., "PRT"). This is the primary code used across the Remote API.
636
+ */
434
637
  code: string;
435
638
  /**
436
639
  * Contractor product names available for this country
437
640
  */
438
641
  contractor_products_available?: Array<'standard' | 'plus' | 'cor'>;
642
+ /**
643
+ * Administrative subdivisions of the country (e.g., states, provinces, districts). Null if the country has no subdivisions relevant to Remote's services.
644
+ */
439
645
  country_subdivisions?: Array<CountrySubdivision> | null;
646
+ /**
647
+ * Whether EOR (Employer of Record) onboarding is available in this country.
648
+ */
440
649
  eor_onboarding?: boolean;
650
+ /**
651
+ * When benefit plan selections become locked for this country (e.g., "after_first_hire" means benefits cannot be changed after the first employee is hired).
652
+ */
441
653
  locked_benefits?: string;
654
+ /**
655
+ * The country's full English name.
656
+ */
442
657
  name: string;
658
+ /**
659
+ * The geographic region the country belongs to (e.g., "Europe", "Asia", "Americas").
660
+ */
443
661
  region?: string;
662
+ /**
663
+ * The geographic subregion (e.g., "Southern Europe", "Southeast Asia"). Null for some countries.
664
+ */
444
665
  subregion?: string | null;
666
+ /**
667
+ * The list of JSON schema form names available for this country (e.g., "address_details", "contract_details"). Use these with the Show form schema endpoint to get country-specific field requirements.
668
+ */
445
669
  supported_json_schemas?: Array<string>;
446
670
  };
447
671
  /**
448
672
  * CreateOffboardingParams
449
673
  */
450
674
  type CreateOffboardingParams = {
675
+ /**
676
+ * The unique identifier (UUID) of the employment to be terminated.
677
+ */
451
678
  employment_id: string;
452
679
  termination_details: TerminationDetailsParams;
453
680
  /**
@@ -458,7 +685,15 @@ type CreateOffboardingParams = {
458
685
  /**
459
686
  * UserStatus
460
687
  *
461
- * The status of the user
688
+ * The status of the user account associated with this employment.
689
+ *
690
+ * - `active`: The user account is active and the user can log in.
691
+ * - `created`: The user account has been created but not yet activated.
692
+ * - `initiated`: The user has been invited but has not completed registration.
693
+ * - `cancelled`: The user account was cancelled before activation.
694
+ * - `inactive`: The user account has been deactivated (e.g., after offboarding).
695
+ * - `deleted`: The user account has been deleted.
696
+ *
462
697
  */
463
698
  type UserStatus = 'active' | 'created' | 'initiated' | 'cancelled' | 'inactive' | 'deleted';
464
699
  /**
@@ -470,40 +705,67 @@ type CompanyCreationResponse = {
470
705
  /**
471
706
  * ContractorContractDocumentStatus
472
707
  *
473
- * Contract document status.
708
+ * The signing status of a contract document.
709
+ *
710
+ * - `draft`: The document is being prepared and has not been sent for signing.
711
+ * - `awaiting_signatures`: The document has been sent and is waiting for one or more parties to sign.
712
+ * - `finished`: All required signatures have been collected and the contract is fully executed.
713
+ *
474
714
  */
475
715
  type ContractorContractDocumentStatus = 'draft' | 'awaiting_signatures' | 'finished';
476
716
  /**
477
717
  * CostCalculatorEstimateParams
718
+ *
719
+ * Parameters for generating a cost estimate for one or more employments across different countries/regions.
478
720
  */
479
721
  type CostCalculatorEstimateParams = {
480
722
  /**
481
- * Company name
723
+ * The company name, used for labeling in PDF/CSV exports.
482
724
  */
483
725
  company_name?: string;
484
726
  /**
485
- * Currency Slug
727
+ * The ISO 4217 currency code for the employer's preferred currency (e.g., "USD"). All costs will be converted to this currency.
486
728
  */
487
729
  employer_currency_slug: string;
730
+ /**
731
+ * One or more employments to estimate costs for.
732
+ */
488
733
  employments: Array<CostCalculatorEmploymentParam>;
489
734
  global_discount?: CostCalculatorDiscount;
735
+ /**
736
+ * Whether to include benefit costs in the estimate. Defaults to false if not provided.
737
+ */
490
738
  include_benefits?: boolean;
739
+ /**
740
+ * Whether to include detailed cost breakdowns (individual contributions, benefits, etc.) in the response.
741
+ */
491
742
  include_cost_breakdowns?: boolean;
743
+ /**
744
+ * Whether to include Remote's management fee in the total cost calculation.
745
+ */
492
746
  include_management_fee?: boolean;
747
+ /**
748
+ * Whether to include premium benefit options in the estimate.
749
+ */
493
750
  include_premium_benefits?: boolean;
494
751
  };
495
752
  /**
496
753
  * Offboarding
497
754
  *
498
- * Offboarding
755
+ * A wrapper containing an offboarding record, which can be either a termination (employer-initiated) or a resignation (employee-initiated).
499
756
  */
500
757
  type Offboarding = {
501
758
  offboarding?: ResignationOrTerminationOffboarding;
502
759
  };
503
760
  /**
504
761
  * NotFoundResponse
762
+ *
763
+ * Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
505
764
  */
506
765
  type NotFoundResponse = {
766
+ /**
767
+ * A message indicating which resource was not found.
768
+ */
507
769
  message?: string;
508
770
  };
509
771
  /**
@@ -540,41 +802,97 @@ type SubmitEligibilityQuestionnaireRequest = {
540
802
  type Timezone = string;
541
803
  /**
542
804
  * ResignationOffboarding
805
+ *
806
+ * An offboarding request initiated by the employee (a resignation). Includes the employee's proposed last working day, reason, and status tracking through Remote's process.
543
807
  */
544
808
  type ResignationOffboarding = {
809
+ /**
810
+ * Additional comments or context about the resignation.
811
+ */
545
812
  additional_comments?: string | null;
813
+ /**
814
+ * Whether the employer agrees with the employee's PTO balance.
815
+ */
546
816
  agrees_to_pto_amount?: boolean;
817
+ /**
818
+ * A description of how and when the employer was made aware of the resignation.
819
+ */
547
820
  employer_awareness?: string;
821
+ /**
822
+ * The unique identifier (UUID) of the employment being resigned from.
823
+ */
548
824
  employment_id: string;
825
+ /**
826
+ * The unique identifier (UUID) of the offboarding request.
827
+ */
549
828
  id: string;
829
+ /**
830
+ * The employee's proposed last working day. The actual last day may differ based on notice period requirements.
831
+ */
550
832
  proposed_last_working_day: string;
833
+ /**
834
+ * A detailed description of the employee's reason for resigning.
835
+ */
551
836
  reason_description?: string;
837
+ /**
838
+ * The unique identifier (UUID) of the employee who submitted the resignation.
839
+ */
552
840
  requested_by: string;
841
+ /**
842
+ * The reason the employee gave for their resignation.
843
+ */
553
844
  resignation_reason: 'cancellation_before_start_date' | 'company_culture_or_values' | 'conversion_to_contractor' | 'conversion_to_global_payroll' | 'conversion_to_peo' | 'dissatisfaction_with_remote_service' | 'incapacity_to_perform_inherent_duties' | 'infrastructure_challenges' | 'lack_of_recognition' | 'leadership' | 'mutual_agreement' | 'other' | 'other_job_opportunity' | 'personal_reasons' | 'position_does_not_meet_expectations' | 'relationship_with_coworkers' | 'relocation_from_entity_to_entity_by_employee' | 'relocation_leaving_remote' | 'remuneration_and_benefits' | 'retirement' | 'transfer_and_relocation_new_customer_and_new_country' | 'transfer_between_remote_customer' | 'transfer_from_remote_to_customer' | 'transfer_from_remote_to_other_eor';
845
+ /**
846
+ * The current status of the offboarding request.
847
+ *
848
+ * - `submitted`: The resignation has been submitted and is awaiting review.
849
+ * - `in_review`: Remote is processing the resignation.
850
+ * - `done`: The offboarding has been completed.
851
+ * - `canceled`: The resignation was withdrawn or canceled.
852
+ *
853
+ */
554
854
  status: 'submitted' | 'in_review' | 'done' | 'canceled';
855
+ /**
856
+ * The timestamp when the resignation was submitted.
857
+ */
555
858
  submitted_at: string;
556
859
  /**
557
860
  * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
558
861
  */
559
862
  termination_date: string | null;
863
+ /**
864
+ * The type of offboarding. Always `"resignation"` for employee-initiated resignations.
865
+ */
560
866
  type: 'resignation';
561
867
  };
562
868
  /**
563
869
  * File
564
870
  *
565
- * A supported file
871
+ * A file associated with an employment, such as a contract, tax form, or identity document.
566
872
  */
567
873
  type File = {
874
+ /**
875
+ * The unique identifier (UUID) of the file.
876
+ */
568
877
  id: string;
569
878
  inserted_at: DateTimeIso8601;
879
+ /**
880
+ * The file name including extension (e.g., "id.pdf", "contract.pdf").
881
+ */
570
882
  name: string;
883
+ /**
884
+ * A more specific classification of the file within its type (e.g., "personal_id" within type "id", or "ir_35" within type "contract"). Null if no sub-type applies.
885
+ */
571
886
  sub_type?: string | null;
887
+ /**
888
+ * The broad category of the file (e.g., "id", "contract", "tax_form").
889
+ */
572
890
  type: string;
573
891
  };
574
892
  /**
575
893
  * OffboardingResponse
576
894
  *
577
- * Offboarding response
895
+ * Response containing a single offboarding record with full details.
578
896
  */
579
897
  type OffboardingResponse = {
580
898
  data?: Offboarding;
@@ -646,6 +964,9 @@ type EmploymentFullParams = {
646
964
  billing_address_details?: {
647
965
  [key: string]: unknown;
648
966
  };
967
+ /**
968
+ * The unique identifier (UUID) of the company. Optional when updating.
969
+ */
649
970
  company_id?: string;
650
971
  /**
651
972
  * Contract information. As its properties may vary depending on the country,
@@ -656,6 +977,9 @@ type EmploymentFullParams = {
656
977
  [key: string]: unknown;
657
978
  };
658
979
  country?: Country;
980
+ /**
981
+ * The ISO 3166-1 3-letter country code for this employment.
982
+ */
659
983
  country_code?: string;
660
984
  /**
661
985
  * The department of the employment. The department must belong to the same company as the employment.
@@ -781,12 +1105,29 @@ type EmploymentSeniorityDate = string;
781
1105
  type RegionStatus = 'active' | 'inactive';
782
1106
  /**
783
1107
  * CostCalculatorCost
1108
+ *
1109
+ * A single cost line item within a cost breakdown (e.g., a specific employer contribution, benefit, or statutory payment).
784
1110
  */
785
1111
  type CostCalculatorCost = {
1112
+ /**
1113
+ * The cost amount in cents.
1114
+ */
786
1115
  amount: number;
1116
+ /**
1117
+ * A human-readable explanation of how this cost is calculated or what it covers.
1118
+ */
787
1119
  description: string | null;
1120
+ /**
1121
+ * The name of this cost item (e.g., "Health Insurance", "Social Security").
1122
+ */
788
1123
  name: string;
1124
+ /**
1125
+ * The ID of the related help article, if available.
1126
+ */
789
1127
  zendesk_article_id: string | null;
1128
+ /**
1129
+ * A link to a help article with more information about this cost, if available.
1130
+ */
790
1131
  zendesk_article_url: string | null;
791
1132
  };
792
1133
  /**
@@ -879,15 +1220,36 @@ type CostCalculatorCosts = {
879
1220
  /**
880
1221
  * Product
881
1222
  *
882
- * Product
1223
+ * A Remote product offering (e.g., EOR, Contractor Management) with its tier and billing frequency.
883
1224
  */
884
1225
  type Product = {
1226
+ /**
1227
+ * A description of the product.
1228
+ */
885
1229
  description?: string;
1230
+ /**
1231
+ * Features included in this product tier.
1232
+ */
886
1233
  features?: Array<string>;
1234
+ /**
1235
+ * The billing frequency (e.g., "monthly", "annually").
1236
+ */
887
1237
  frequency: string;
1238
+ /**
1239
+ * A unique machine-readable identifier for this product.
1240
+ */
888
1241
  identifier?: string;
1242
+ /**
1243
+ * The full product name (e.g., "EOR Monthly").
1244
+ */
889
1245
  name: string;
1246
+ /**
1247
+ * A short display name for the product (e.g., "EOR").
1248
+ */
890
1249
  short_name?: string;
1250
+ /**
1251
+ * The product tier (e.g., "standard", "premium").
1252
+ */
891
1253
  tier: string;
892
1254
  };
893
1255
  /**
@@ -971,9 +1333,12 @@ type ProvisionalStartDate = string;
971
1333
  /**
972
1334
  * ContractAmendment
973
1335
  *
974
- * Contract Amendment
1336
+ * A full contract amendment record, including the requested changes with their previous and current values.
975
1337
  */
976
1338
  type ContractAmendment = {
1339
+ /**
1340
+ * The unique identifier of the contract being amended. Null if no specific contract was targeted.
1341
+ */
977
1342
  amendment_contract_id: string | null;
978
1343
  /**
979
1344
  * Describes all the changes requested for the contract and contract details with all their previous and current values.
@@ -981,12 +1346,27 @@ type ContractAmendment = {
981
1346
  changes: {
982
1347
  [key: string]: unknown;
983
1348
  };
1349
+ /**
1350
+ * The unique identifier (UUID) of the employment.
1351
+ */
984
1352
  employment_id: string;
1353
+ /**
1354
+ * The unique identifier (UUID) of the contract amendment.
1355
+ */
985
1356
  id: string;
986
1357
  request_details: RequestDetails;
1358
+ /**
1359
+ * The unique identifier (UUID) of the user who submitted the amendment.
1360
+ */
987
1361
  requested_by: string;
988
1362
  status: ContractAmendmentStatus;
1363
+ /**
1364
+ * The timestamp when the amendment was submitted.
1365
+ */
989
1366
  submitted_at: string;
1367
+ /**
1368
+ * A link to the support ticket associated with this amendment, if one was created. Null otherwise.
1369
+ */
990
1370
  zendesk_ticket_url: string | null;
991
1371
  };
992
1372
  /**
@@ -1027,6 +1407,9 @@ type ContractDocumentItem = {
1027
1407
  * Description and status of an onboarding task.
1028
1408
  */
1029
1409
  type TaskDescription = {
1410
+ /**
1411
+ * A human-readable description of what this onboarding task requires.
1412
+ */
1030
1413
  description?: string;
1031
1414
  /**
1032
1415
  * TaskStatus
@@ -1041,8 +1424,17 @@ type TaskDescription = {
1041
1424
  * A subdivision of a supported country on Remote
1042
1425
  */
1043
1426
  type CountrySubdivision = {
1427
+ /**
1428
+ * The ISO 3166-2 subdivision code (e.g., "PT-11" for Lisboa).
1429
+ */
1044
1430
  code?: string;
1431
+ /**
1432
+ * The subdivision's name (e.g., "Lisboa", "California").
1433
+ */
1045
1434
  name: string;
1435
+ /**
1436
+ * The type of subdivision (e.g., "District", "State", "Province").
1437
+ */
1046
1438
  subdivision_type?: string;
1047
1439
  };
1048
1440
  /**
@@ -1159,18 +1551,45 @@ type Signatory = {
1159
1551
  * A supported country on Remote
1160
1552
  */
1161
1553
  type NullableCountry = {
1554
+ /**
1555
+ * The ISO 3166-1 alpha-2 country code (e.g., "PT").
1556
+ */
1162
1557
  alpha_2_code: string;
1558
+ /**
1559
+ * The ISO 3166-1 alpha-3 country code (e.g., "PRT"). This is the primary code used across the Remote API.
1560
+ */
1163
1561
  code: string;
1164
1562
  /**
1165
1563
  * Contractor product names available for this country
1166
1564
  */
1167
1565
  contractor_products_available?: Array<'standard' | 'plus' | 'cor'>;
1566
+ /**
1567
+ * Administrative subdivisions of the country (e.g., states, provinces, districts). Null if the country has no subdivisions relevant to Remote's services.
1568
+ */
1168
1569
  country_subdivisions?: Array<CountrySubdivision> | null;
1570
+ /**
1571
+ * Whether EOR (Employer of Record) onboarding is available in this country.
1572
+ */
1169
1573
  eor_onboarding?: boolean;
1574
+ /**
1575
+ * When benefit plan selections become locked for this country (e.g., "after_first_hire" means benefits cannot be changed after the first employee is hired).
1576
+ */
1170
1577
  locked_benefits?: string;
1578
+ /**
1579
+ * The country's full English name.
1580
+ */
1171
1581
  name: string;
1582
+ /**
1583
+ * The geographic region the country belongs to (e.g., "Europe", "Asia", "Americas").
1584
+ */
1172
1585
  region?: string;
1586
+ /**
1587
+ * The geographic subregion (e.g., "Southern Europe", "Southeast Asia"). Null for some countries.
1588
+ */
1173
1589
  subregion?: string | null;
1590
+ /**
1591
+ * The list of JSON schema form names available for this country (e.g., "address_details", "contract_details"). Use these with the Show form schema endpoint to get country-specific field requirements.
1592
+ */
1174
1593
  supported_json_schemas?: Array<string>;
1175
1594
  } | null;
1176
1595
  /**
@@ -1195,9 +1614,21 @@ type OnboardingTasks = {
1195
1614
  * Parameters to upload a file
1196
1615
  */
1197
1616
  type FileParams = {
1617
+ /**
1618
+ * The unique identifier (UUID) of the employment to attach this file to.
1619
+ */
1198
1620
  employment_id: string;
1621
+ /**
1622
+ * The file content, base64-encoded.
1623
+ */
1199
1624
  file: Blob | File;
1625
+ /**
1626
+ * A more specific classification within the type (e.g., "ir_35" for a UK contractor tax determination).
1627
+ */
1200
1628
  sub_type?: string;
1629
+ /**
1630
+ * The broad category of the file (e.g., "contract", "id", "tax_form").
1631
+ */
1201
1632
  type?: string;
1202
1633
  };
1203
1634
  /**
@@ -1300,18 +1731,45 @@ type EmploymentCreationResponse = {
1300
1731
  /**
1301
1732
  * EmploymentStatus
1302
1733
  *
1303
- * The status of employment
1734
+ * The current status of the employment record.
1735
+ *
1736
+ * - `active`: The employee is fully onboarded and actively working.
1737
+ * - `created`: The employment has been created but onboarding has not started.
1738
+ * - `pre_hire`: A pre-hire employment record, created before formal onboarding begins.
1739
+ * - `created_awaiting_reserve`: The employment is created but waiting for a risk reserve deposit to be paid.
1740
+ * - `created_reserve_paid`: The risk reserve has been paid and the employment can proceed with onboarding.
1741
+ * - `initiated`: Onboarding has been started by the employer.
1742
+ * - `invited`: The employee has been invited to complete their self-enrollment on Remote.
1743
+ * - `pending`: The employment is pending review or further action before it can become active.
1744
+ * - `review`: The employment is under review by Remote (e.g., contract or compliance review).
1745
+ * - `archived`: The employment has been terminated or offboarded.
1746
+ * - `deleted`: The employment record has been deleted.
1747
+ *
1304
1748
  */
1305
1749
  type EmploymentStatus = 'active' | 'created' | 'pre_hire' | 'created_awaiting_reserve' | 'created_reserve_paid' | 'initiated' | 'invited' | 'pending' | 'review' | 'archived' | 'deleted';
1306
1750
  /**
1307
1751
  * CostCalculatorEmployment
1752
+ *
1753
+ * A cost estimate for a single employment, including costs in both the regional (local) currency and the employer's preferred currency.
1308
1754
  */
1309
1755
  type CostCalculatorEmployment = {
1310
1756
  country: MinimalCountry;
1757
+ /**
1758
+ * A link to Remote's guide on benefits available in this country. Null if not available.
1759
+ */
1311
1760
  country_benefits_details_url: string | null;
1761
+ /**
1762
+ * A link to Remote's country hiring guide. Null if not available.
1763
+ */
1312
1764
  country_guide_url: string | null;
1313
1765
  employer_currency_costs: CostCalculatorCosts;
1766
+ /**
1767
+ * Whether this country has extra statutory payments (e.g., 13th month salary in the Philippines).
1768
+ */
1314
1769
  has_extra_statutory_payment: boolean;
1770
+ /**
1771
+ * The minimum number of business days required to onboard an employee in this country. Null if not determined.
1772
+ */
1315
1773
  minimum_onboarding_time: number | null;
1316
1774
  region: MinimalRegion;
1317
1775
  regional_currency_costs: CostCalculatorCosts;
@@ -1417,9 +1875,14 @@ type BaseTokenResponse = {
1417
1875
  };
1418
1876
  /**
1419
1877
  * SuccessResponse
1878
+ *
1879
+ * A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1420
1880
  */
1421
1881
  type SuccessResponse = {
1422
1882
  data: {
1883
+ /**
1884
+ * The result status. Always `"ok"` for successful operations.
1885
+ */
1423
1886
  status?: string;
1424
1887
  };
1425
1888
  };
@@ -1521,21 +1984,44 @@ type MagicLinkParams = {
1521
1984
  /**
1522
1985
  * CostCalculatorDiscount
1523
1986
  *
1524
- * Allows to apply discounts to estimates
1987
+ * Configuration for applying a discount to a cost estimate. Provide either an `amount` or `percent` — not both.
1525
1988
  */
1526
1989
  type CostCalculatorDiscount = {
1990
+ /**
1991
+ * The fixed discount amount in cents. Mutually exclusive with `percent`.
1992
+ */
1527
1993
  amount?: number;
1994
+ /**
1995
+ * The number of months the discount applies to (1-12). Defaults to 12.
1996
+ */
1528
1997
  months?: number;
1998
+ /**
1999
+ * The discount as a decimal fraction (e.g., 0.1 for 10%). Mutually exclusive with `amount`.
2000
+ */
1529
2001
  percent?: number;
2002
+ /**
2003
+ * The originally quoted amount before discount, in cents.
2004
+ */
1530
2005
  quoted_amount?: number;
2006
+ /**
2007
+ * A human-readable label for the discount (e.g., "10% Discount").
2008
+ */
1531
2009
  text: string;
1532
2010
  };
1533
2011
  /**
1534
2012
  * LeavePolicy
2013
+ *
2014
+ * The leave policy associated with a time off request. Policies define the rules and entitlements for specific types of leave.
1535
2015
  */
1536
2016
  type LeavePolicy = {
2017
+ /**
2018
+ * The unique identifier (slug) of the specific policy variant.
2019
+ */
1537
2020
  leave_policy_variant_slug: string;
1538
2021
  leave_type: TimeoffType;
2022
+ /**
2023
+ * The display name of the leave policy (e.g., "Self-Care", "Annual Leave").
2024
+ */
1539
2025
  name: string;
1540
2026
  };
1541
2027
  /**
@@ -1546,6 +2032,9 @@ type CompanyLegalEntity = {
1546
2032
  * ISO 3166-1 alpha-3 country code (e.g., 'USA', 'GBR', 'DEU')
1547
2033
  */
1548
2034
  country_code?: string | null;
2035
+ /**
2036
+ * Whether Global Payroll services are enabled for this legal entity.
2037
+ */
1549
2038
  global_payroll_enabled: boolean;
1550
2039
  /**
1551
2040
  * Company slug
@@ -1555,6 +2044,9 @@ type CompanyLegalEntity = {
1555
2044
  * Indicates if this is the default legal entity for the company
1556
2045
  */
1557
2046
  is_default?: boolean;
2047
+ /**
2048
+ * The registered name of the legal entity.
2049
+ */
1558
2050
  name: string;
1559
2051
  };
1560
2052
  /**
@@ -1579,10 +2071,25 @@ type Company = {
1579
2071
  bank_account_details?: {
1580
2072
  [key: string]: unknown;
1581
2073
  };
2074
+ /**
2075
+ * The email address of the company owner who administers the Remote account.
2076
+ */
1582
2077
  company_owner_email: string;
2078
+ /**
2079
+ * The full name of the company owner. Cannot be changed after company creation.
2080
+ */
1583
2081
  company_owner_name?: string;
2082
+ /**
2083
+ * The unique identifier (UUID) of the company owner's user account on Remote.
2084
+ */
1584
2085
  company_owner_user_id: string;
2086
+ /**
2087
+ * The ISO 3166-1 3-letter country code where the company is registered.
2088
+ */
1585
2089
  country_code: string;
2090
+ /**
2091
+ * The timestamp when the company was created on Remote.
2092
+ */
1586
2093
  created_at: string;
1587
2094
  /**
1588
2095
  * The credit risk status of the company default legal entity.
@@ -1596,11 +2103,29 @@ type Company = {
1596
2103
  *
1597
2104
  */
1598
2105
  default_legal_entity_credit_risk_status: 'not_started' | 'ready' | 'in_progress' | 'referred' | 'fail' | 'deposit_required' | 'no_deposit_required';
2106
+ /**
2107
+ * The ISO 4217 currency code the company prefers for billing and invoicing (e.g., "USD", "EUR").
2108
+ */
1599
2109
  desired_currency: string;
2110
+ /**
2111
+ * A unique reference code for this company in a non-Remote system. Null if not set.
2112
+ */
1600
2113
  external_id?: string | null;
2114
+ /**
2115
+ * The unique identifier (UUID) of the company.
2116
+ */
1601
2117
  id: string;
2118
+ /**
2119
+ * The company's registered name. Can only be changed while the company is in `pending` status.
2120
+ */
1602
2121
  name: string;
2122
+ /**
2123
+ * The company's contact phone number.
2124
+ */
1603
2125
  phone_number?: string;
2126
+ /**
2127
+ * The company's business registration number. Null if not provided. Can only be set while the company is in `pending` status.
2128
+ */
1604
2129
  registration_number?: string | null;
1605
2130
  /**
1606
2131
  * The company status determines what a company is allowed to do:
@@ -1613,8 +2138,17 @@ type Company = {
1613
2138
  *
1614
2139
  */
1615
2140
  status: 'pending' | 'review' | 'active' | 'archived';
2141
+ /**
2142
+ * The company's tax identification number. Null if not provided. Can only be set while the company is in `pending` status.
2143
+ */
1616
2144
  tax_number?: string | null;
2145
+ /**
2146
+ * The timestamp when the company owner accepted Remote's Terms of Service.
2147
+ */
1617
2148
  terms_of_service_accepted_at: string;
2149
+ /**
2150
+ * The timestamp when the company record was last updated.
2151
+ */
1618
2152
  updated_at: string;
1619
2153
  };
1620
2154
  /**
@@ -1646,6 +2180,8 @@ type ContractorSubscriptionsSummary = {
1646
2180
  };
1647
2181
  /**
1648
2182
  * TooManyRequestsResponse
2183
+ *
2184
+ * Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the `Retry-After` response header for the recommended wait time.
1649
2185
  */
1650
2186
  type TooManyRequestsResponse = {
1651
2187
  message?: string;
@@ -1677,7 +2213,7 @@ type EligibilityQuestionnaire = {
1677
2213
  /**
1678
2214
  * UploadFileResponse
1679
2215
  *
1680
- * A supported file
2216
+ * Response returned after successfully uploading a file.
1681
2217
  */
1682
2218
  type UploadFileResponse = {
1683
2219
  data?: {
@@ -1686,8 +2222,13 @@ type UploadFileResponse = {
1686
2222
  };
1687
2223
  /**
1688
2224
  * ConflictResponse
2225
+ *
2226
+ * Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing an action that requires the resource to be in a different state.
1689
2227
  */
1690
2228
  type ConflictResponse = {
2229
+ /**
2230
+ * A human-readable message describing the conflict and the expected state.
2231
+ */
1691
2232
  message?: string;
1692
2233
  };
1693
2234
  /**
@@ -1728,16 +2269,24 @@ type ListSignatory = {
1728
2269
  /**
1729
2270
  * TimeoffDay
1730
2271
  *
1731
- * TimeoffDay schema
2272
+ * A single day within a time off request, specifying the date and the number of hours taken off that day.
1732
2273
  */
1733
2274
  type TimeoffDay = {
1734
2275
  day: Date;
2276
+ /**
2277
+ * The number of hours taken off on this day (e.g., 8 for a full day, 4 for a half day).
2278
+ */
1735
2279
  hours: number;
1736
2280
  };
1737
2281
  /**
1738
2282
  * BadRequestResponse
2283
+ *
2284
+ * Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed message.
1739
2285
  */
1740
2286
  type BadRequestResponse = {
2287
+ /**
2288
+ * A human-readable error message describing what was wrong with the request.
2289
+ */
1741
2290
  message: string;
1742
2291
  } | {
1743
2292
  message?: {
@@ -1747,6 +2296,8 @@ type BadRequestResponse = {
1747
2296
  };
1748
2297
  /**
1749
2298
  * UnauthorizedResponse
2299
+ *
2300
+ * Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorization header.
1750
2301
  */
1751
2302
  type UnauthorizedResponse = {
1752
2303
  message: string;
@@ -1757,6 +2308,9 @@ type UnauthorizedResponse = {
1757
2308
  * Selected type of payment.
1758
2309
  */
1759
2310
  type PricingPlanDetails = {
2311
+ /**
2312
+ * How often Remote bills the employer for management fees. Annual billing typically offers a discount.
2313
+ */
1760
2314
  frequency: 'annually' | 'monthly';
1761
2315
  };
1762
2316
  /**
@@ -1822,10 +2376,22 @@ type UpdateCompanyParams = {
1822
2376
  * SignContractDocument schema
1823
2377
  */
1824
2378
  type SignContractDocument = {
2379
+ /**
2380
+ * The signer's full legal name as their electronic signature.
2381
+ */
1825
2382
  signature: string;
1826
2383
  };
1827
2384
  /**
1828
2385
  * ContractAmendmentStatus
2386
+ *
2387
+ * The current status of a contract amendment request.
2388
+ *
2389
+ * - `submitted`: The amendment has been submitted and is awaiting Remote's review.
2390
+ * - `in_review`: Remote is reviewing the amendment for compliance and feasibility.
2391
+ * - `done`: The amendment has been approved and applied to the contract.
2392
+ * - `canceled`: The amendment request was canceled before completion.
2393
+ * - `deleted`: The amendment request was deleted.
2394
+ *
1829
2395
  */
1830
2396
  type ContractAmendmentStatus = 'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted';
1831
2397
  /**
@@ -1842,11 +2408,11 @@ type DateTimeIso8601 = string;
1842
2408
  */
1843
2409
  type CostCalculatorBenefitParam = {
1844
2410
  /**
1845
- * Benefit Group Slug
2411
+ * The unique identifier (slug) of the benefit group to include in the estimate.
1846
2412
  */
1847
2413
  benefit_group_slug: string;
1848
2414
  /**
1849
- * Benefit Tier Slug
2415
+ * The unique identifier (slug) of the benefit tier within the group. Determines the level of coverage and cost.
1850
2416
  */
1851
2417
  benefit_tier_slug: string;
1852
2418
  };
@@ -1854,17 +2420,29 @@ type CostCalculatorBenefitParam = {
1854
2420
  * TerminationDetailsParams
1855
2421
  */
1856
2422
  type TerminationDetailsParams = {
2423
+ /**
2424
+ * Whether the employer acknowledges and agrees to follow Remote's termination procedure for this jurisdiction.
2425
+ */
1857
2426
  acknowledge_termination_procedure?: boolean | null;
1858
2427
  /**
1859
2428
  * Additional details regarding the termination process.
1860
2429
  */
1861
2430
  additional_comments?: string | null;
2431
+ /**
2432
+ * Whether the employer agrees with the employee's current paid time off balance. If false, you may provide a timesheet file documenting any discrepancies.
2433
+ */
1862
2434
  agrees_to_pto_amount?: boolean | null;
2435
+ /**
2436
+ * Additional notes about the PTO balance, especially if there are discrepancies.
2437
+ */
1863
2438
  agrees_to_pto_amount_notes?: string | null;
1864
2439
  /**
1865
2440
  * Confidential requests are visible for who authorized the token or integration. Non-confidential requests are visible to all admins in the company.
1866
2441
  */
1867
2442
  confidential: boolean;
2443
+ /**
2444
+ * Whether the employer has already informed the employee about the termination. Remote advises not informing the employee until the request has been reviewed for legal risks.
2445
+ */
1868
2446
  customer_informed_employee?: boolean | null;
1869
2447
  /**
1870
2448
  * Remote advises not to inform the employee of their termination until we review your request for legal risks. When we approve your request, you can inform the employee and we’ll take it from there. This field is only required if employee was informed before creating the offboarding request.
@@ -1965,6 +2543,8 @@ type ParameterError = {
1965
2543
  };
1966
2544
  /**
1967
2545
  * GenericFile
2546
+ *
2547
+ * A file represented as a base64-encoded string.
1968
2548
  */
1969
2549
  type GenericFile = Blob | File;
1970
2550
  /**
@@ -1986,6 +2566,8 @@ type CreateContractEligibilityParams = {
1986
2566
  type TimeoffType = 'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita';
1987
2567
  /**
1988
2568
  * Decimal
2569
+ *
2570
+ * A decimal number represented as a string to preserve precision. Supports negative values and fractional digits.
1989
2571
  */
1990
2572
  type Decimal = string;
1991
2573
  /**
@@ -2042,21 +2624,61 @@ type RequestError = {
2042
2624
  };
2043
2625
  /**
2044
2626
  * Timeoff
2627
+ *
2628
+ * A time off record for an employee, representing a period of leave (e.g., vacation, sick leave, parental leave).
2045
2629
  */
2046
2630
  type Timeoff = {
2631
+ /**
2632
+ * The timestamp when the time off was approved. Null if not yet approved.
2633
+ */
2047
2634
  approved_at?: string | null;
2048
2635
  approver_id?: NullableApproverId;
2636
+ /**
2637
+ * Whether this time off was automatically created by the system (e.g., public holidays) rather than requested by the employee.
2638
+ */
2049
2639
  automatic?: boolean;
2640
+ /**
2641
+ * The reason provided when the time off was cancelled. Null if not cancelled.
2642
+ */
2050
2643
  cancel_reason?: string | null;
2051
2644
  cancelled_at?: NullableDateTime;
2052
2645
  document?: File;
2646
+ /**
2647
+ * The unique identifier (UUID) of the employment this time off belongs to.
2648
+ */
2053
2649
  employment_id: string;
2650
+ /**
2651
+ * The last day of the time off period (ISO 8601 date).
2652
+ */
2054
2653
  end_date: string;
2654
+ /**
2655
+ * The unique identifier (UUID) of the time off record.
2656
+ */
2055
2657
  id: string;
2056
2658
  leave_policy: LeavePolicy;
2659
+ /**
2660
+ * Optional notes provided by the employee when requesting the time off.
2661
+ */
2057
2662
  notes?: string | null;
2663
+ /**
2664
+ * The first day of the time off period (ISO 8601 date).
2665
+ */
2058
2666
  start_date: string;
2667
+ /**
2668
+ * The current status of a time off request.
2669
+ *
2670
+ * - `requested`: The employee has submitted a time off request and it is awaiting approval.
2671
+ * - `approved`: The time off request has been approved by a manager.
2672
+ * - `cancelled`: The time off request was cancelled by the employee or an admin.
2673
+ * - `declined`: The time off request was declined by a manager.
2674
+ * - `taken`: The approved time off has been taken (the dates have passed).
2675
+ * - `cancel_requested`: The employee has requested cancellation of a previously approved time off, pending manager approval.
2676
+ *
2677
+ */
2059
2678
  status: 'requested' | 'approved' | 'cancelled' | 'declined' | 'taken' | 'cancel_requested';
2679
+ /**
2680
+ * The individual days and hours within this time off period.
2681
+ */
2060
2682
  timeoff_days: Array<TimeoffDay>;
2061
2683
  timeoff_type: TimeoffType;
2062
2684
  timezone: Timezone;
@@ -2081,6 +2703,9 @@ type EmploymentCreateParams = {
2081
2703
  * This optional field is deprecated.
2082
2704
  */
2083
2705
  company_id?: string;
2706
+ /**
2707
+ * The ISO 3166-1 3-letter country code where the employee will be based (e.g., `AUS`, `GBR`, `USA`).
2708
+ */
2084
2709
  country_code: string;
2085
2710
  /**
2086
2711
  * This field is required to create a global payroll employee.
@@ -2095,12 +2720,75 @@ type EmploymentCreateParams = {
2095
2720
  */
2096
2721
  type?: 'employee' | 'contractor' | 'global_payroll_employee' | 'hris';
2097
2722
  };
2723
+ /**
2724
+ * EmploymentEngagementAgreementDetailsParams
2725
+ *
2726
+ * Engagement agreement details schema compatible params.
2727
+ *
2728
+ */
2729
+ type EmploymentEngagementAgreementDetailsParams = {
2730
+ /**
2731
+ * EngagementAgreementDetailsParamsDEU
2732
+ *
2733
+ * Engagement agreement details params. As its properties may vary depending on the country,
2734
+ * you must query the [Show form schema](#tag/Countries/operation/get_show_engagement_agreement_details_country) endpoint
2735
+ * passing the country code.
2736
+ *
2737
+ */
2738
+ engagement_agreement_details: {
2739
+ allowances_details?: Array<string> | null;
2740
+ available_pto?: number | null;
2741
+ break_time_per_day?: number | null;
2742
+ business_expenses?: string | null;
2743
+ cba?: string | null;
2744
+ cba_document?: {
2745
+ [key: string]: unknown;
2746
+ } | null;
2747
+ covenants?: Array<string> | null;
2748
+ has_allowances?: string | null;
2749
+ has_bonus?: string | null;
2750
+ has_business_expenses?: string | null;
2751
+ has_business_presence?: string;
2752
+ has_cba?: string | null;
2753
+ has_commissions?: string | null;
2754
+ has_covenants?: string | null;
2755
+ has_illness_remuneration?: string | null;
2756
+ has_overtime_compensation?: string | null;
2757
+ has_pension_scheme?: string | null;
2758
+ has_signing_bonus?: string | null;
2759
+ has_similar_roles?: string;
2760
+ has_similar_work_conditions?: string | null;
2761
+ illness_remuneration_details?: string | null;
2762
+ max_annual_gross_salary?: number | null;
2763
+ min_annual_gross_salary?: number | null;
2764
+ overtime_compensation_begins?: number | null;
2765
+ overtime_compensation_type?: string | null;
2766
+ overtime_pay_percentage?: number | null;
2767
+ pension_scheme?: string | null;
2768
+ similar_roles?: string | null;
2769
+ similar_work_conditions_details?: string | null;
2770
+ work_hours_per_week?: number | null;
2771
+ working_days?: Array<string> | null;
2772
+ };
2773
+ };
2098
2774
  /**
2099
2775
  * TimeoffStatus
2776
+ *
2777
+ * The current status of a time off request.
2778
+ *
2779
+ * - `requested`: The employee has submitted a time off request and it is awaiting approval.
2780
+ * - `approved`: The time off request has been approved by a manager.
2781
+ * - `cancelled`: The time off request was cancelled by the employee or an admin.
2782
+ * - `declined`: The time off request was declined by a manager.
2783
+ * - `taken`: The approved time off has been taken (the dates have passed).
2784
+ * - `cancel_requested`: The employee has requested cancellation of a previously approved time off, pending manager approval.
2785
+ *
2100
2786
  */
2101
2787
  type TimeoffStatus = 'approved' | 'cancelled' | 'declined' | 'requested' | 'taken' | 'cancel_requested';
2102
2788
  /**
2103
2789
  * ForbiddenResponse
2790
+ *
2791
+ * Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and that the user has the necessary role.
2104
2792
  */
2105
2793
  type ForbiddenResponse = {
2106
2794
  message: string;
@@ -2137,7 +2825,7 @@ type CompanyCreationConflictErrorResponse = {
2137
2825
  /**
2138
2826
  * EmploymentResponse
2139
2827
  *
2140
- * Complete information of an employment
2828
+ * Response containing the full employment record after an update operation.
2141
2829
  */
2142
2830
  type EmploymentResponse = {
2143
2831
  data: {
@@ -2147,9 +2835,12 @@ type EmploymentResponse = {
2147
2835
  /**
2148
2836
  * ContractDocument
2149
2837
  *
2150
- * ContractDocument schema
2838
+ * A contract document for a contractor employment, tracking its signing status.
2151
2839
  */
2152
2840
  type ContractDocument = {
2841
+ /**
2842
+ * The unique identifier (UUID) of the contract document.
2843
+ */
2153
2844
  id: string;
2154
2845
  status: ContractorContractDocumentStatus;
2155
2846
  };
@@ -2222,4 +2913,4 @@ type PostAutomatableContractAmendmentErrors = {
2222
2913
  };
2223
2914
  type PostAutomatableContractAmendmentError = PostAutomatableContractAmendmentErrors[keyof PostAutomatableContractAmendmentErrors];
2224
2915
 
2225
- export type { ContractDocumentItem as $, UnifiedEmploymentUpsertBenefitOffersRequest as A, BadRequestResponse as B, ContractAmendmentAutomatableResponse as C, ConvertCurrencyResponse as D, Employment as E, ForbiddenResponse as F, ConvertCurrencyParams as G, CreateContractEligibilityParams as H, TerminationDetailsParams as I, UploadFileResponse as J, FileParams as K, SignContractDocument as L, MinimalRegion as M, NotFoundResponse as N, OffboardingResponse as O, PostCreateContractAmendmentError as P, ContractorSubscriptionsSummary as Q, RequestError as R, SuccessResponse as S, TooManyRequestsResponse as T, UnprocessableEntityResponse as U, ValidationError as V, ManageContractorPlusSubscriptionOperationsParams as W, CreateContractDocument as X, Country as Y, File as Z, DateTimeIso8601 as _, UnauthorizedResponse as a, EligibilityQuestionnaireResponse as a0, ConflictErrorResponse as a1, SubmitEligibilityQuestionnaireRequest as a2, ListTimeoffResponse as a3, TimeoffStatus as a4, TimeoffType as a5, ListLeavePoliciesSummaryResponse as a6, CreateOffboardingParams as a7, MagicLinkResponse as a8, MagicLinkParams as a9, GetShowEmploymentResponse as aa, Currency as ab, PayrollCalendarEor as ac, HelpCenterArticle as ad, ContractAmendmentResponse as b, PostAutomatableContractAmendmentError as c, EmploymentCreationResponse as d, EmploymentResponse as e, CreateContractDocumentResponse as f, Signatory as g, ContractorContractDocumentStatus as h, CompanyLegalEntity as i, CostCalculatorEstimateResponse as j, CostCalculatorEstimatePdfResponse as k, CostCalculatorEstimateParams as l, CostCalculatorEstimateCsvResponse as m, MinimalCountry as n, EmploymentTermType as o, CostCalculatorEmployment as p, PostCreateEstimationError as q, CompanyCreationResponse as r, CompanyCreationConflictErrorResponse as s, CreateCompanyParams as t, CompanyResponse as u, UpdateCompanyParams as v, Company as w, ConflictResponse as x, EmploymentCreateParams as y, EmploymentFullParams as z };
2916
+ export type { DateTimeIso8601 as $, EmploymentEngagementAgreementDetailsParams as A, BadRequestResponse as B, ContractAmendmentAutomatableResponse as C, UnifiedEmploymentUpsertBenefitOffersRequest as D, Employment as E, ForbiddenResponse as F, ConvertCurrencyResponse as G, ConvertCurrencyParams as H, CreateContractEligibilityParams as I, TerminationDetailsParams as J, UploadFileResponse as K, FileParams as L, MinimalRegion as M, NotFoundResponse as N, OffboardingResponse as O, PostCreateContractAmendmentError as P, SignContractDocument as Q, RequestError as R, SuccessResponse as S, TooManyRequestsResponse as T, UnprocessableEntityResponse as U, ValidationError as V, ContractorSubscriptionsSummary as W, ManageContractorPlusSubscriptionOperationsParams as X, CreateContractDocument as Y, Country as Z, File as _, UnauthorizedResponse as a, ContractDocumentItem as a0, EligibilityQuestionnaireResponse as a1, ConflictErrorResponse as a2, SubmitEligibilityQuestionnaireRequest as a3, ListTimeoffResponse as a4, TimeoffStatus as a5, TimeoffType as a6, ListLeavePoliciesSummaryResponse as a7, CreateOffboardingParams as a8, MagicLinkResponse as a9, MagicLinkParams as aa, GetShowEmploymentResponse as ab, Currency as ac, PayrollCalendarEor as ad, HelpCenterArticle as ae, ContractAmendmentResponse as b, PostAutomatableContractAmendmentError as c, EmploymentCreationResponse as d, EmploymentResponse as e, CreateContractDocumentResponse as f, Signatory as g, ContractorContractDocumentStatus as h, CompanyLegalEntity as i, CompanyCreationResponse as j, CompanyCreationConflictErrorResponse as k, CreateCompanyParams as l, CompanyResponse as m, UpdateCompanyParams as n, CostCalculatorEstimateResponse as o, CostCalculatorEstimatePdfResponse as p, CostCalculatorEstimateParams as q, CostCalculatorEstimateCsvResponse as r, MinimalCountry as s, EmploymentTermType as t, CostCalculatorEmployment as u, PostCreateEstimationError as v, Company as w, ConflictResponse as x, EmploymentCreateParams as y, EmploymentFullParams as z };