@remoteoss/remote-flows 0.2.1 → 0.3.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 (180) hide show
  1. package/README.md +1 -0
  2. package/dist/chunk-2Y22JKVE.js +2 -0
  3. package/dist/{chunk-AD7ZWPEI.js → chunk-3FVI5JIC.js} +2 -2
  4. package/dist/chunk-3MAYMGXF.js +2 -0
  5. package/dist/chunk-3MAYMGXF.js.map +1 -0
  6. package/dist/chunk-4APN5ST6.js +2 -0
  7. package/dist/chunk-4APN5ST6.js.map +1 -0
  8. package/dist/chunk-4C45VY6F.js +2 -0
  9. package/dist/chunk-4C45VY6F.js.map +1 -0
  10. package/dist/{chunk-FI76EKUS.js → chunk-56BNVYTD.js} +2 -2
  11. package/dist/chunk-5ETXP2QF.js +2 -0
  12. package/dist/chunk-5ETXP2QF.js.map +1 -0
  13. package/dist/{chunk-YVC4OEFJ.js → chunk-6A3F6JG6.js} +2 -2
  14. package/dist/{chunk-YAHWFLDH.js → chunk-6YO6XWPH.js} +2 -2
  15. package/dist/{chunk-OCNLZSS7.js → chunk-7CYG2RHP.js} +2 -2
  16. package/dist/{chunk-55VACCVZ.js → chunk-AG27JG4N.js} +1 -1
  17. package/dist/chunk-AG27JG4N.js.map +1 -0
  18. package/dist/{chunk-XULIEA44.js → chunk-BDCIVWHR.js} +2 -2
  19. package/dist/{chunk-IJWDAD54.js → chunk-DGPRFQYK.js} +2 -2
  20. package/dist/{chunk-NZFES56Y.js → chunk-EAAIAMTY.js} +2 -2
  21. package/dist/{chunk-37DREOGC.js → chunk-FMT2OTOL.js} +2 -2
  22. package/dist/chunk-G4R7TPQL.js +2 -0
  23. package/dist/chunk-G4R7TPQL.js.map +1 -0
  24. package/dist/chunk-GGZV4QYL.js +2 -0
  25. package/dist/chunk-GGZV4QYL.js.map +1 -0
  26. package/dist/{chunk-XEQTLVMV.js → chunk-GMGKIQLI.js} +2 -2
  27. package/dist/{chunk-N5AQSLAU.js → chunk-IDSJI7KQ.js} +2 -2
  28. package/dist/{chunk-4F7PYKUZ.js → chunk-J55S4SEH.js} +2 -2
  29. package/dist/{chunk-J2RINDSC.js → chunk-KH6QS5OU.js} +2 -2
  30. package/dist/chunk-KQEIZSUS.js +2 -0
  31. package/dist/chunk-KQEIZSUS.js.map +1 -0
  32. package/dist/{chunk-CKGTR44U.js → chunk-KSGPQCSG.js} +2 -2
  33. package/dist/chunk-L3E32MJU.js +2 -0
  34. package/dist/chunk-L3E32MJU.js.map +1 -0
  35. package/dist/chunk-LLA3Z2PK.js +2 -0
  36. package/dist/chunk-LLA3Z2PK.js.map +1 -0
  37. package/dist/chunk-M22FKNEY.js +1 -0
  38. package/dist/{chunk-FCRDQVTB.js → chunk-MESREYTZ.js} +2 -2
  39. package/dist/{chunk-NBD4VOG3.js → chunk-P3N4X5KU.js} +2 -2
  40. package/dist/chunk-QJGFU4YO.js +2 -0
  41. package/dist/chunk-QJGFU4YO.js.map +1 -0
  42. package/dist/chunk-THCM2G6C.js +2 -0
  43. package/dist/chunk-THCM2G6C.js.map +1 -0
  44. package/dist/chunk-U3TYUMTJ.js +2 -0
  45. package/dist/chunk-U3TYUMTJ.js.map +1 -0
  46. package/dist/chunk-VTPDBEHE.js +2 -0
  47. package/dist/chunk-VTPDBEHE.js.map +1 -0
  48. package/dist/{chunk-EQBNHLR4.js → chunk-VZM3HYXN.js} +2 -2
  49. package/dist/chunk-WDV5ZDXL.js +2 -0
  50. package/dist/chunk-WDV5ZDXL.js.map +1 -0
  51. package/dist/{chunk-JLUDKN4H.js → chunk-WJPC4J3U.js} +2 -2
  52. package/dist/{chunk-DOA6BAUQ.js → chunk-WQHKB5T7.js} +2 -2
  53. package/dist/{chunk-CTG3DYJR.js → chunk-WWANHPT7.js} +2 -2
  54. package/dist/{chunk-CTG3DYJR.js.map → chunk-WWANHPT7.js.map} +1 -1
  55. package/dist/{chunk-5DQBY2TR.js → chunk-XLFHHYVS.js} +2 -2
  56. package/dist/chunk-XSHHMBMT.js +2 -0
  57. package/dist/chunk-XSHHMBMT.js.map +1 -0
  58. package/dist/{chunk-KPSFJ6BN.js → chunk-YOC3VDC7.js} +2 -2
  59. package/dist/flows/ContractAmendment/ContractAmendmentBack.js +1 -1
  60. package/dist/flows/ContractAmendment/ContractAmendmentConfirmationForm.d.ts +1 -1
  61. package/dist/flows/ContractAmendment/ContractAmendmentConfirmationForm.js +1 -1
  62. package/dist/flows/ContractAmendment/ContractAmendmentFlow.d.ts +4 -4
  63. package/dist/flows/ContractAmendment/ContractAmendmentFlow.js +1 -1
  64. package/dist/flows/ContractAmendment/ContractAmendmentForm.d.ts +1 -1
  65. package/dist/flows/ContractAmendment/ContractAmendmentForm.js +1 -1
  66. package/dist/flows/ContractAmendment/ContractAmendmentSubmit.js +1 -1
  67. package/dist/flows/ContractAmendment/context.d.ts +1 -1
  68. package/dist/flows/ContractAmendment/hooks.d.ts +1 -1
  69. package/dist/flows/ContractAmendment/hooks.js +1 -1
  70. package/dist/flows/ContractAmendment/index.d.ts +2 -2
  71. package/dist/flows/ContractAmendment/index.js +1 -1
  72. package/dist/flows/ContractAmendment/types.d.ts +3 -0
  73. package/dist/flows/ContractAmendment/utils.d.ts +1 -1
  74. package/dist/flows/CostCalculator/CostCalculatorDisclaimer.js +1 -1
  75. package/dist/flows/CostCalculator/CostCalculatorFlow.d.ts +1 -1
  76. package/dist/flows/CostCalculator/CostCalculatorFlow.js +1 -1
  77. package/dist/flows/CostCalculator/CostCalculatorForm.d.ts +1 -1
  78. package/dist/flows/CostCalculator/CostCalculatorForm.js +1 -1
  79. package/dist/flows/CostCalculator/CostCalculatorResetButton.js +1 -1
  80. package/dist/flows/CostCalculator/CostCalculatorSubmitButton.js +1 -1
  81. package/dist/flows/CostCalculator/Results/CostCalculatorBenefitsBreakdown.js +1 -1
  82. package/dist/flows/CostCalculator/Results/CostCalculatorContributionsBreakdown.js +1 -1
  83. package/dist/flows/CostCalculator/Results/CostCalculatorGrossSalary.js +1 -1
  84. package/dist/flows/CostCalculator/Results/CostCalculatorResults.d.ts +1 -1
  85. package/dist/flows/CostCalculator/Results/CostCalculatorResults.js +1 -1
  86. package/dist/flows/CostCalculator/Results/CostCalculatorResultsChart.js +1 -1
  87. package/dist/flows/CostCalculator/Results/CostCalculatorTotalCost.js +1 -1
  88. package/dist/flows/CostCalculator/context.d.ts +1 -1
  89. package/dist/flows/CostCalculator/hooks.d.ts +1 -1
  90. package/dist/flows/CostCalculator/hooks.js +1 -1
  91. package/dist/flows/CostCalculator/index.d.ts +1 -1
  92. package/dist/flows/CostCalculator/index.js +1 -1
  93. package/dist/flows/CostCalculator/types.d.ts +1 -1
  94. package/dist/flows/CostCalculator/utils.d.ts +1 -1
  95. package/dist/flows/CostCalculator/utils.js +1 -1
  96. package/dist/flows/Termination/AdditionalDetailsForm.d.ts +13 -0
  97. package/dist/flows/Termination/AdditionalDetailsForm.js +2 -0
  98. package/dist/flows/Termination/AdditionalDetailsForm.js.map +1 -0
  99. package/dist/flows/Termination/EmployeeComunicationForm.d.ts +10 -0
  100. package/dist/flows/Termination/EmployeeComunicationForm.js +2 -0
  101. package/dist/flows/Termination/EmployeeComunicationForm.js.map +1 -0
  102. package/dist/flows/Termination/PaidTimeOffForm.d.ts +10 -0
  103. package/dist/flows/Termination/PaidTimeOffForm.js +2 -0
  104. package/dist/flows/Termination/PaidTimeOffForm.js.map +1 -0
  105. package/dist/flows/Termination/TerminationBack.js +1 -1
  106. package/dist/flows/Termination/TerminationDetailsForm.d.ts +10 -0
  107. package/dist/flows/Termination/TerminationDetailsForm.js +2 -0
  108. package/dist/flows/Termination/TerminationDetailsForm.js.map +1 -0
  109. package/dist/flows/Termination/TerminationFlow.d.ts +19 -10
  110. package/dist/flows/Termination/TerminationFlow.js +1 -1
  111. package/dist/flows/Termination/TerminationForm.d.ts +5 -6
  112. package/dist/flows/Termination/TerminationForm.js +1 -1
  113. package/dist/flows/Termination/TerminationSubmit.js +1 -1
  114. package/dist/flows/Termination/TimeOff.d.ts +1 -1
  115. package/dist/flows/Termination/TimeOff.js +1 -1
  116. package/dist/flows/Termination/context.d.ts +3 -1
  117. package/dist/flows/Termination/hooks.d.ts +12 -1
  118. package/dist/flows/Termination/hooks.js +1 -1
  119. package/dist/flows/Termination/index.d.ts +8 -5
  120. package/dist/flows/Termination/index.js +1 -1
  121. package/dist/flows/Termination/json-schemas/additionalInformation.js +1 -1
  122. package/dist/flows/Termination/json-schemas/jsonSchema.js +1 -1
  123. package/dist/flows/Termination/json-schemas/schema.js +1 -1
  124. package/dist/flows/Termination/types.d.ts +1 -1
  125. package/dist/index.css +1 -1
  126. package/dist/index.css.map +1 -1
  127. package/dist/index.d.ts +12 -9
  128. package/dist/index.js +1 -1
  129. package/dist/index.js.map +1 -1
  130. package/dist/types.gen-Dta9Iy5C.d.ts +779 -0
  131. package/package.json +1 -1
  132. package/dist/chunk-2EKC7DK3.js +0 -2
  133. package/dist/chunk-2EKC7DK3.js.map +0 -1
  134. package/dist/chunk-4GRFE43K.js +0 -2
  135. package/dist/chunk-4GRFE43K.js.map +0 -1
  136. package/dist/chunk-55VACCVZ.js.map +0 -1
  137. package/dist/chunk-6LTJBLSD.js +0 -2
  138. package/dist/chunk-6LTJBLSD.js.map +0 -1
  139. package/dist/chunk-AYFHWLQZ.js +0 -2
  140. package/dist/chunk-AYFHWLQZ.js.map +0 -1
  141. package/dist/chunk-F5QJZKDL.js +0 -2
  142. package/dist/chunk-F5QJZKDL.js.map +0 -1
  143. package/dist/chunk-FZ7FWFJX.js +0 -1
  144. package/dist/chunk-GI72ZKVM.js +0 -2
  145. package/dist/chunk-GI72ZKVM.js.map +0 -1
  146. package/dist/chunk-GW7GG5ZW.js +0 -2
  147. package/dist/chunk-GW7GG5ZW.js.map +0 -1
  148. package/dist/chunk-IJPE22L7.js +0 -2
  149. package/dist/chunk-IJPE22L7.js.map +0 -1
  150. package/dist/chunk-IPZEZMLD.js +0 -2
  151. package/dist/chunk-IPZEZMLD.js.map +0 -1
  152. package/dist/chunk-SEUQNAF6.js +0 -2
  153. package/dist/chunk-SJ56GVNV.js +0 -2
  154. package/dist/chunk-SJ56GVNV.js.map +0 -1
  155. package/dist/chunk-VHL76MEG.js +0 -2
  156. package/dist/chunk-VHL76MEG.js.map +0 -1
  157. package/dist/types.gen-BgLeTAqP.d.ts +0 -10618
  158. /package/dist/{chunk-SEUQNAF6.js.map → chunk-2Y22JKVE.js.map} +0 -0
  159. /package/dist/{chunk-AD7ZWPEI.js.map → chunk-3FVI5JIC.js.map} +0 -0
  160. /package/dist/{chunk-FI76EKUS.js.map → chunk-56BNVYTD.js.map} +0 -0
  161. /package/dist/{chunk-YVC4OEFJ.js.map → chunk-6A3F6JG6.js.map} +0 -0
  162. /package/dist/{chunk-YAHWFLDH.js.map → chunk-6YO6XWPH.js.map} +0 -0
  163. /package/dist/{chunk-OCNLZSS7.js.map → chunk-7CYG2RHP.js.map} +0 -0
  164. /package/dist/{chunk-XULIEA44.js.map → chunk-BDCIVWHR.js.map} +0 -0
  165. /package/dist/{chunk-IJWDAD54.js.map → chunk-DGPRFQYK.js.map} +0 -0
  166. /package/dist/{chunk-NZFES56Y.js.map → chunk-EAAIAMTY.js.map} +0 -0
  167. /package/dist/{chunk-37DREOGC.js.map → chunk-FMT2OTOL.js.map} +0 -0
  168. /package/dist/{chunk-XEQTLVMV.js.map → chunk-GMGKIQLI.js.map} +0 -0
  169. /package/dist/{chunk-N5AQSLAU.js.map → chunk-IDSJI7KQ.js.map} +0 -0
  170. /package/dist/{chunk-4F7PYKUZ.js.map → chunk-J55S4SEH.js.map} +0 -0
  171. /package/dist/{chunk-J2RINDSC.js.map → chunk-KH6QS5OU.js.map} +0 -0
  172. /package/dist/{chunk-CKGTR44U.js.map → chunk-KSGPQCSG.js.map} +0 -0
  173. /package/dist/{chunk-FZ7FWFJX.js.map → chunk-M22FKNEY.js.map} +0 -0
  174. /package/dist/{chunk-FCRDQVTB.js.map → chunk-MESREYTZ.js.map} +0 -0
  175. /package/dist/{chunk-NBD4VOG3.js.map → chunk-P3N4X5KU.js.map} +0 -0
  176. /package/dist/{chunk-EQBNHLR4.js.map → chunk-VZM3HYXN.js.map} +0 -0
  177. /package/dist/{chunk-JLUDKN4H.js.map → chunk-WJPC4J3U.js.map} +0 -0
  178. /package/dist/{chunk-DOA6BAUQ.js.map → chunk-WQHKB5T7.js.map} +0 -0
  179. /package/dist/{chunk-5DQBY2TR.js.map → chunk-XLFHHYVS.js.map} +0 -0
  180. /package/dist/{chunk-KPSFJ6BN.js.map → chunk-YOC3VDC7.js.map} +0 -0
@@ -0,0 +1,779 @@
1
+ type MinimalRegion = {
2
+ child_regions?: Array<MinimalRegion>;
3
+ code?: string | null;
4
+ name: string;
5
+ slug: string;
6
+ status?: RegionStatus;
7
+ };
8
+ type TerminationOffboarding = {
9
+ additional_comments: string;
10
+ agrees_to_pto_amount?: string;
11
+ confidential: boolean;
12
+ employee_awareness?: {
13
+ date?: string | null;
14
+ note?: string | null;
15
+ };
16
+ employment_id: string;
17
+ id: string;
18
+ proposed_termination_date: string;
19
+ reason_description: string;
20
+ requested_by: string;
21
+ 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'>;
22
+ status: 'submitted' | 'in_review' | 'done' | 'canceled';
23
+ submitted_at: string;
24
+ /**
25
+ * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
26
+ */
27
+ termination_date: string | null;
28
+ 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';
29
+ type: 'termination';
30
+ will_challenge_termination: boolean;
31
+ will_challenge_termination_description?: string;
32
+ };
33
+ type MinimalCountry = {
34
+ alpha_2_code: string;
35
+ code: string;
36
+ features?: Array<string>;
37
+ name: string;
38
+ slug: string;
39
+ };
40
+ /**
41
+ * Complete information of an employment
42
+ */
43
+ type Employment = {
44
+ /**
45
+ * Personal details information. Its properties may vary depending on the country.
46
+ */
47
+ personal_details: {
48
+ [key: string]: unknown;
49
+ };
50
+ short_id?: ShortId;
51
+ /**
52
+ * Name of related department, if any. Otherwise, null.
53
+ */
54
+ department?: string | null;
55
+ manager_email: string | null;
56
+ provisional_start_date?: ProvisionalStartDate;
57
+ /**
58
+ * Home address information. Its properties may vary depending on the country.
59
+ */
60
+ address_details: {
61
+ [key: string]: unknown;
62
+ };
63
+ pricing_plan_details: PricingPlanDetails;
64
+ full_name: string;
65
+ /**
66
+ * For the employment types `contractor`, `global_payroll_employee` and `direct_employee`, only [List employments](#operation/get_index_employment) and
67
+ * [Show employment](#operation/get_show_employment) operations are available.
68
+ *
69
+ */
70
+ type: 'employee' | 'contractor' | 'direct_employee' | 'global_payroll_employee';
71
+ employment_lifecycle_stage: EmploymentLifecycleStage;
72
+ /**
73
+ * Administrative information. Its properties may vary depending on the country.
74
+ */
75
+ administrative_details: {
76
+ [key: string]: unknown;
77
+ };
78
+ company_id: string;
79
+ work_email: string;
80
+ status: EmploymentStatus;
81
+ updated_at: string;
82
+ /**
83
+ * Employment basic information. Its properties may vary depending on the country.
84
+ *
85
+ */
86
+ basic_information?: {
87
+ [key: string]: unknown;
88
+ };
89
+ job_title: string;
90
+ id: string;
91
+ probation_period_end_date?: string;
92
+ /**
93
+ * Unique ID of related department, if any. Otherwise, null.
94
+ */
95
+ department_id?: string | null;
96
+ manager?: string;
97
+ /**
98
+ * 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.
99
+ */
100
+ external_id?: string;
101
+ personal_email: string;
102
+ country: Country;
103
+ user_status?: UserStatus;
104
+ seniority_date?: EmploymentSeniorityDate;
105
+ bank_account_details: Array<{
106
+ [key: string]: unknown;
107
+ }>;
108
+ files: Array<File>;
109
+ active_contract_id?: string;
110
+ /**
111
+ * Billing address information. Its properties may vary depending on the country.
112
+ */
113
+ billing_address_details: {
114
+ [key: string]: unknown;
115
+ };
116
+ onboarding_tasks: OnboardingTasks;
117
+ /**
118
+ * Contract information. Its properties may vary depending on the country.
119
+ */
120
+ contract_details: {
121
+ [key: string]: unknown;
122
+ };
123
+ /**
124
+ * Emergency contact information. Its properties may vary depending on the country.
125
+ */
126
+ emergency_contact_details: {
127
+ [key: string]: unknown;
128
+ };
129
+ eligible_for_onboarding_cancellation: boolean;
130
+ manager_employment_id: string | null;
131
+ created_at: string;
132
+ };
133
+ type CostCalculatorEstimatePdfResponse = {
134
+ data: {
135
+ content: GenericFile;
136
+ };
137
+ };
138
+ type ActionError = {
139
+ /**
140
+ * The action that lead to the error message.
141
+ */
142
+ action: string;
143
+ /**
144
+ * An error code that describes the nature of the error.
145
+ */
146
+ code: string;
147
+ /**
148
+ * A developer friendly error message that gives details on what the error was and how it may be remedied.
149
+ */
150
+ message: string;
151
+ };
152
+ /**
153
+ * Complete information of an employment
154
+ */
155
+ type EmploymentShowResponse = {
156
+ data: {
157
+ employment?: Employment & {
158
+ /**
159
+ * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
160
+ */
161
+ termination_date?: string | null;
162
+ };
163
+ };
164
+ };
165
+ /**
166
+ * Optional UTC date time in YYYY-MM-DDTHH:mm:ss format
167
+ */
168
+ type NullableDateTime = string | null;
169
+ type CostCalculatorEmploymentParam = {
170
+ age?: number;
171
+ annual_gross_salary?: number;
172
+ annual_gross_salary_in_employer_currency?: number;
173
+ benefits?: Array<CostCalculatorBenefitParam>;
174
+ employment_term?: EmploymentTermType;
175
+ region_slug: string;
176
+ regional_to_employer_exchange_rate?: string;
177
+ title?: string;
178
+ };
179
+ /**
180
+ * A supported country on Remote
181
+ */
182
+ type Country = {
183
+ alpha_2_code: string;
184
+ code: string;
185
+ country_subdivisions?: Array<CountrySubdivision> | null;
186
+ eor_onboarding?: boolean;
187
+ locked_benefits?: string;
188
+ name: string;
189
+ region?: string;
190
+ subregion?: string | null;
191
+ supported_json_schemas?: Array<string>;
192
+ };
193
+ /**
194
+ * The status of the user
195
+ */
196
+ type UserStatus = 'active' | 'created' | 'initiated' | 'cancelled' | 'inactive' | 'deleted';
197
+ type CostCalculatorEstimateParams = {
198
+ /**
199
+ * Currency Slug
200
+ */
201
+ employer_currency_slug: string;
202
+ employments: Array<CostCalculatorEmploymentParam>;
203
+ include_benefits?: boolean;
204
+ include_cost_breakdowns?: boolean;
205
+ include_premium_benefits?: boolean;
206
+ };
207
+ /**
208
+ * Offboarding
209
+ */
210
+ type Offboarding = {
211
+ offboarding?: ResignationOffboarding | TerminationOffboarding;
212
+ };
213
+ type NotFoundResponse = {
214
+ message?: string;
215
+ };
216
+ type CostCalculatorEstimateResponse = {
217
+ data: {
218
+ employments?: Array<CostCalculatorEmployment>;
219
+ };
220
+ };
221
+ /**
222
+ * [TZ identifier](https://www.iana.org/time-zones)
223
+ */
224
+ type Timezone = string;
225
+ type ResignationOffboarding = {
226
+ additional_comments?: string;
227
+ employer_awareness?: string;
228
+ employment_id: string;
229
+ id: string;
230
+ proposed_last_working_day: string;
231
+ reason_description?: string;
232
+ requested_by: string;
233
+ resignation_reason: 'cancellation_before_start_date' | 'company_culture_or_values' | 'conversion_to_contractor' | 'conversion_to_global_payroll' | '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';
234
+ status: 'submitted' | 'in_review' | 'done' | 'canceled';
235
+ submitted_at: string;
236
+ /**
237
+ * Most updated termination date for the offboarding. This date is subject to change through the offboarding process even after it is finalized.
238
+ */
239
+ termination_date: string | null;
240
+ type: 'resignation';
241
+ };
242
+ /**
243
+ * A supported file
244
+ */
245
+ type File = {
246
+ id: string;
247
+ inserted_at: DateTimeIso8601;
248
+ name: string;
249
+ sub_type?: string | null;
250
+ type: string;
251
+ };
252
+ /**
253
+ * Offboarding response
254
+ */
255
+ type OffboardingResponse = {
256
+ data?: Offboarding;
257
+ };
258
+ /**
259
+ * Unique short identifier for the employment, automatically generated and visible in select areas of the Remote platform. Not intended as a replacement for the employment `id` field.
260
+ */
261
+ type ShortId = string;
262
+ /**
263
+ * The field matches the `id` of a user in the
264
+ * Remote Platform that has permission to approve time off
265
+ * requests. [Available users][] can be found fetching
266
+ * the [List Company Manager][] endpoint.
267
+ *
268
+ * [Available users]: https://support.remote.com/hc/en-us/articles/360054668651-Approving-Declining-time-off-requests#h_01G0014GZKZ3EMN6P7C99HAK55
269
+ * [List Company Manager]: https://gateway.remote.com/v1/docs/openapi.html#tag/Company-Managers
270
+ *
271
+ */
272
+ type NullableApproverId = string | null;
273
+ type OffboardingFile = {
274
+ /**
275
+ * The content in base64 encoding
276
+ */
277
+ content: Blob | File;
278
+ /**
279
+ * The file name
280
+ */
281
+ name: string;
282
+ };
283
+ type UnprocessableEntityResponse = {
284
+ errors: {
285
+ [key: string]: unknown;
286
+ };
287
+ } | {
288
+ message: string | ParameterError | Array<ParameterError> | ActionError | Array<ActionError>;
289
+ };
290
+ type EmploymentTermType = 'fixed' | 'indefinite';
291
+ /**
292
+ * The type of money in general use in a particular country
293
+ */
294
+ type Currency = {
295
+ code: string;
296
+ name?: string;
297
+ slug: string;
298
+ symbol: string;
299
+ };
300
+ /**
301
+ * The date the employee first started working for your company. If you don’t include a seniority date,
302
+ * the employee’s start date with Remote will be deemed as the start of the employee’s seniority.
303
+ *
304
+ * **Example**: Your employee started working for your company on Feb 1, 2022.
305
+ * On Aug 1, 2022, you transferred the employee to Remote and started managing them on the platform.
306
+ * Feb 1, 2022 would be their seniority date. Aug 1, 2022 would be their starting date.
307
+ *
308
+ */
309
+ type EmploymentSeniorityDate = string;
310
+ type RegionStatus = 'active' | 'inactive';
311
+ type CostCalculatorCost = {
312
+ amount: number;
313
+ description: string | null;
314
+ name: string;
315
+ zendesk_article_url: string | null;
316
+ };
317
+ type CostCalculatorCosts = {
318
+ /**
319
+ * The list of all annual benefit costs
320
+ */
321
+ annual_benefits_breakdown?: Array<CostCalculatorCost>;
322
+ /**
323
+ * The annual benefits total that a company must pay for this employment
324
+ */
325
+ annual_benefits_total?: number;
326
+ /**
327
+ * The list of all annual employer contribution costs
328
+ */
329
+ annual_contributions_breakdown?: Array<CostCalculatorCost>;
330
+ /**
331
+ * The annual contributions that a company must pay for this employment
332
+ */
333
+ annual_contributions_total: number;
334
+ /**
335
+ * The annual gross salary that the employee is going to earn
336
+ */
337
+ annual_gross_salary: number;
338
+ annual_indirect_tax?: number;
339
+ /**
340
+ * The annual gross salary + annual contributions + annual fee (monthly fee * 12) + extra statutory payments if applicable
341
+ */
342
+ annual_total: number;
343
+ currency: Currency;
344
+ /**
345
+ * The list of all annual extra statutory payment costs
346
+ */
347
+ extra_statutory_payments_breakdown?: Array<CostCalculatorCost>;
348
+ /**
349
+ * 13th month salary, this happens for countries such as Philippines
350
+ */
351
+ extra_statutory_payments_total: number;
352
+ /**
353
+ * The list of all monthly benefit costs
354
+ */
355
+ monthly_benefits_breakdown?: Array<CostCalculatorCost>;
356
+ /**
357
+ * The benefits total that the company pays monthly
358
+ */
359
+ monthly_benefits_total?: number;
360
+ /**
361
+ * The list of all monthly employer contribution costs
362
+ */
363
+ monthly_contributions_breakdown?: Array<CostCalculatorCost>;
364
+ /**
365
+ * The contributions that the company pays monthly
366
+ */
367
+ monthly_contributions_total: number;
368
+ /**
369
+ * The gross monthly salary for the Employee
370
+ */
371
+ monthly_gross_salary: number;
372
+ monthly_indirect_tax?: number;
373
+ /**
374
+ * Monthly gross salary + monthly contributions (doesn't include fee)
375
+ */
376
+ monthly_tce: number;
377
+ /**
378
+ * Monthly gross salary + monthly contributions + monthly fee
379
+ */
380
+ monthly_total: number;
381
+ };
382
+ /**
383
+ * The details of the requested changes for the contract amendment.
384
+ */
385
+ type RequestDetails = {
386
+ additional_comments?: string | null;
387
+ effective_date?: string;
388
+ reason_for_change?: 'annual_pay_adjustment' | 'country_rule_change' | 'error_correction' | 'job_change_reevaluation' | 'promotion' | 'other';
389
+ /**
390
+ * This is filled when the reason_for_change is 'other'.
391
+ */
392
+ reason_for_change_description?: string | null;
393
+ salary_decrease_details?: SalaryDecreaseDetails;
394
+ };
395
+ /**
396
+ * Indicates the expected start date of the employee or contractor.
397
+ *
398
+ * Required for employees, but optional for contractors. Date format is in ISO8601 without the time component.
399
+ *
400
+ * See the **Date and Time Format** documentation for more details on how the Remote API works with dates.
401
+ *
402
+ */
403
+ type ProvisionalStartDate = string;
404
+ /**
405
+ * Contract Amendment
406
+ */
407
+ type ContractAmendment = {
408
+ amendment_contract_id: string | null;
409
+ /**
410
+ * Describes all the changes requested for the contract and contract details with all their previous and current values.
411
+ */
412
+ changes: {
413
+ [key: string]: unknown;
414
+ };
415
+ employment_id: string;
416
+ id: string;
417
+ request_details: RequestDetails;
418
+ requested_by: string;
419
+ status: ContractAmendmentStatus;
420
+ submitted_at: string;
421
+ zendesk_ticket_url: string | null;
422
+ };
423
+ /**
424
+ * Description and status of an onboarding task.
425
+ */
426
+ type TaskDescription = {
427
+ description?: string;
428
+ /**
429
+ * The status of the task
430
+ */
431
+ status?: 'completed' | 'pending';
432
+ };
433
+ /**
434
+ * A subdivision of a supported country on Remote
435
+ */
436
+ type CountrySubdivision = {
437
+ code?: string;
438
+ name: string;
439
+ subdivision_type?: string;
440
+ };
441
+ /**
442
+ * Response schema listing many timeoffs
443
+ */
444
+ type ListTimeoffResponse = {
445
+ data?: {
446
+ /**
447
+ * The current page among all of the total_pages
448
+ */
449
+ current_page?: number;
450
+ timeoffs?: Array<Timeoff>;
451
+ /**
452
+ * The total number of records in the result
453
+ */
454
+ total_count?: number;
455
+ /**
456
+ * The total number of pages the user can go through
457
+ */
458
+ total_pages?: number;
459
+ };
460
+ };
461
+ /**
462
+ * The stage of employment lifecycle. When it's `onboarded` means the employee is ready to commence or has already commenced.
463
+ */
464
+ type EmploymentLifecycleStage = 'employment_creation' | 'employee_self_enrollment' | 'right_to_work_check' | 'contract_signing' | 'remote_enrollment' | 'onboarded' | 'offboarded';
465
+ /**
466
+ * Contract Amendment Automatable response
467
+ */
468
+ type ContractAmendmentAutomatableResponse = {
469
+ data?: {
470
+ /**
471
+ * If true, it means that the contract amendment request is automatable.
472
+ */
473
+ automatable?: boolean;
474
+ /**
475
+ * The message to explain how the contract amendment request will be processed depending if it is automatable or not.
476
+ */
477
+ message?: string;
478
+ };
479
+ };
480
+ /**
481
+ * All tasks that need to be completed before marking the employment as ready
482
+ */
483
+ type OnboardingTasks = {
484
+ address_details: TaskDescription;
485
+ administrative_details: TaskDescription;
486
+ bank_account_details: TaskDescription;
487
+ billing_address_details: TaskDescription;
488
+ contract_details: TaskDescription;
489
+ emergency_contact_details: TaskDescription;
490
+ employment_document_details: TaskDescription;
491
+ personal_details: TaskDescription;
492
+ pricing_plan_details: TaskDescription;
493
+ };
494
+ /**
495
+ * The status of employment
496
+ */
497
+ type EmploymentStatus = 'active' | 'created' | 'created_awaiting_reserve' | 'created_reserve_paid' | 'initiated' | 'invited' | 'pending' | 'review' | 'archived' | 'deleted';
498
+ type CostCalculatorEmployment = {
499
+ country: MinimalCountry;
500
+ employer_currency_costs: CostCalculatorCosts;
501
+ has_extra_statutory_payment: boolean;
502
+ region: MinimalRegion;
503
+ regional_currency_costs: CostCalculatorCosts;
504
+ };
505
+ type LeavePolicy = {
506
+ leave_policy_variant_slug: string;
507
+ leave_type: TimeoffType;
508
+ name: string;
509
+ };
510
+ type TooManyRequestsResponse = {
511
+ message?: string;
512
+ };
513
+ /**
514
+ * TimeoffDay schema
515
+ */
516
+ type TimeoffDay = {
517
+ day: _Date;
518
+ hours: number;
519
+ };
520
+ type BadRequestResponse = {
521
+ message: string;
522
+ } | {
523
+ message?: {
524
+ code: string;
525
+ message: string;
526
+ };
527
+ };
528
+ type UnauthorizedResponse = {
529
+ message: string;
530
+ };
531
+ /**
532
+ * Selected type of payment.
533
+ */
534
+ type PricingPlanDetails = {
535
+ frequency: 'annually' | 'monthly';
536
+ };
537
+ type ContractAmendmentStatus = 'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted';
538
+ /**
539
+ * UTC date time in [ISO 8601][] format.
540
+ *
541
+ * [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
542
+ *
543
+ */
544
+ type DateTimeIso8601 = string;
545
+ type CostCalculatorBenefitParam = {
546
+ /**
547
+ * Benefit Group Slug
548
+ */
549
+ benefit_group_slug: string;
550
+ /**
551
+ * Benefit Tier Slug
552
+ */
553
+ benefit_tier_slug: string;
554
+ };
555
+ type TerminationDetailsParams = {
556
+ acknowledge_termination_procedure?: boolean | null;
557
+ /**
558
+ * Additional details regarding the termination process.
559
+ */
560
+ additional_comments?: string;
561
+ agrees_to_pto_amount?: boolean | null;
562
+ agrees_to_pto_amount_notes?: string | null;
563
+ /**
564
+ * Confidential requests are visible for who authorized the token or integration. Non-confidential requests are visible to all admins in the company.
565
+ */
566
+ confidential: boolean;
567
+ customer_informed_employee?: boolean | null;
568
+ /**
569
+ * 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.
570
+ */
571
+ employee_awareness?: {
572
+ /**
573
+ * When the employee was told about the termination.
574
+ */
575
+ date?: string | null;
576
+ /**
577
+ * Notes describing how the termination was shared with the employee. Remote advises being as specific as possible, and include details about the employee’s response, if applicable.
578
+ */
579
+ note?: string | null;
580
+ };
581
+ /**
582
+ * Remote will use this email address for post-termination communication.
583
+ * If it is not provided, this field will be derived from the employment record. Therefore, it is important to ensure that it is not a company email.
584
+ *
585
+ */
586
+ personal_email?: string;
587
+ /**
588
+ * In most cases, employee needs to be notified before termination. The required notice period depends on local labor laws, the employment agreement, and other factors. Remote will use those factors to determine the required notice period. Please note that we cannot commit to a termination date until we conduct a full review of the information you submit.
589
+ */
590
+ proposed_termination_date: string;
591
+ /**
592
+ * Description of the reason for termination
593
+ */
594
+ reason_description: string;
595
+ /**
596
+ * Possible reasons for offboarding risk assessment
597
+ */
598
+ 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'>;
599
+ /**
600
+ * Choose an accurate termination reason to avoid unfair or unlawful dismissal claims.
601
+ *
602
+ * If the termination is created before the employee's start date, this field
603
+ * will be set to `cancellation_before_start_date`.
604
+ *
605
+ */
606
+ 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';
607
+ /**
608
+ * Any supporting documents regarding the termination reason
609
+ */
610
+ termination_reason_files?: Array<OffboardingFile>;
611
+ /**
612
+ * Paid time off accuracy
613
+ *
614
+ * Typically, any vacation pay accrued and unpaid at the time
615
+ * of termination must be paid out to the employee. To avoid overpaying or underpaying,
616
+ * please make sure we have an accurate account of their paid time off by querying the
617
+ * [Show Time Off Balance](#operation/get_show_timeoff_balance) endpoint,
618
+ * filtering by the `employment_id`.
619
+ * This optional document should be sent in case of any discrepancies.
620
+ *
621
+ */
622
+ timesheet_file?: OffboardingFile;
623
+ /**
624
+ * Whether is it likely or not that the employee will challenge their termination
625
+ */
626
+ will_challenge_termination: boolean;
627
+ /**
628
+ * If it is likely that the employee will challenge their termination, please provide additional details explaining the risk
629
+ */
630
+ will_challenge_termination_description?: string;
631
+ };
632
+ /**
633
+ * UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
634
+ */
635
+ type _Date = string;
636
+ type ParameterError = {
637
+ /**
638
+ * An error code that describes the nature of the error.
639
+ */
640
+ code: string;
641
+ /**
642
+ * A developer friendly error message that gives details on what the error was and how it may be remedied.
643
+ */
644
+ message: string;
645
+ /**
646
+ * The parameter that lead to the error message.
647
+ */
648
+ param: string;
649
+ };
650
+ type GenericFile = Blob | File;
651
+ type TimeoffType = 'paid_time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other';
652
+ /**
653
+ * The details of the salary decrease request if there is one
654
+ */
655
+ type SalaryDecreaseDetails = {
656
+ salary_decrease_reason?: 'change_in_working_hours' | 'trade_salary_for_equity' | 'error_in_initial_salary' | 'role_change_or_demotion' | 'compensation_restructure' | 'other';
657
+ salary_decrease_reason_description?: string | null;
658
+ was_employee_informed?: string;
659
+ } | null;
660
+ type RequestError = {
661
+ errors: {
662
+ /**
663
+ * An error code that describes the nature of the error.
664
+ */
665
+ code: string;
666
+ /**
667
+ * A developer friendly error message that gives details on what the error was and how it may be remedied.
668
+ */
669
+ message: string;
670
+ };
671
+ };
672
+ type Timeoff = {
673
+ approved_at?: string | null;
674
+ approver_id?: NullableApproverId;
675
+ automatic?: boolean;
676
+ cancel_reason?: string | null;
677
+ cancelled_at?: NullableDateTime;
678
+ document?: File;
679
+ employment_id: string;
680
+ end_date: string;
681
+ id: string;
682
+ leave_policy: LeavePolicy;
683
+ notes?: string | null;
684
+ start_date: string;
685
+ status: 'requested' | 'approved' | 'cancelled' | 'declined' | 'taken' | 'cancel_requested';
686
+ timeoff_days: Array<TimeoffDay>;
687
+ timeoff_type: TimeoffType;
688
+ timezone: Timezone;
689
+ };
690
+ type TimeoffStatus = 'approved' | 'cancelled' | 'declined' | 'requested' | 'taken' | 'cancel_requested';
691
+ /**
692
+ * Contract Amendment response
693
+ */
694
+ type ContractAmendmentResponse = {
695
+ data?: {
696
+ contract_amendment: ContractAmendment;
697
+ };
698
+ };
699
+ type PostCreateOffboardingErrors = {
700
+ /**
701
+ * Bad Request
702
+ */
703
+ 400: BadRequestResponse;
704
+ /**
705
+ * Unauthorized
706
+ */
707
+ 401: UnauthorizedResponse;
708
+ /**
709
+ * Not Found
710
+ */
711
+ 404: NotFoundResponse;
712
+ /**
713
+ * Unprocessable Entity
714
+ */
715
+ 422: UnprocessableEntityResponse;
716
+ /**
717
+ * Too many requests
718
+ */
719
+ 429: TooManyRequestsResponse;
720
+ /**
721
+ * Internal Server Error
722
+ */
723
+ 500: RequestError;
724
+ };
725
+ type PostCreateOffboardingError = PostCreateOffboardingErrors[keyof PostCreateOffboardingErrors];
726
+ type PostCreateEstimationErrors = {
727
+ /**
728
+ * Not Found
729
+ */
730
+ 404: NotFoundResponse;
731
+ /**
732
+ * Unprocessable Entity
733
+ */
734
+ 422: UnprocessableEntityResponse;
735
+ };
736
+ type PostCreateEstimationError = PostCreateEstimationErrors[keyof PostCreateEstimationErrors];
737
+ type PostCreateEstimationPdfErrors = {
738
+ /**
739
+ * Not Found
740
+ */
741
+ 404: NotFoundResponse;
742
+ /**
743
+ * Unprocessable Entity
744
+ */
745
+ 422: UnprocessableEntityResponse;
746
+ };
747
+ type PostCreateEstimationPdfError = PostCreateEstimationPdfErrors[keyof PostCreateEstimationPdfErrors];
748
+ type PostCreateContractAmendmentErrors = {
749
+ /**
750
+ * Unauthorized
751
+ */
752
+ 401: UnauthorizedResponse;
753
+ /**
754
+ * Not Found
755
+ */
756
+ 404: NotFoundResponse;
757
+ /**
758
+ * Unprocessable Entity
759
+ */
760
+ 422: UnprocessableEntityResponse;
761
+ };
762
+ type PostCreateContractAmendmentError = PostCreateContractAmendmentErrors[keyof PostCreateContractAmendmentErrors];
763
+ type PostAutomatableContractAmendmentErrors = {
764
+ /**
765
+ * Unauthorized
766
+ */
767
+ 401: UnauthorizedResponse;
768
+ /**
769
+ * Not Found
770
+ */
771
+ 404: NotFoundResponse;
772
+ /**
773
+ * Unprocessable Entity
774
+ */
775
+ 422: UnprocessableEntityResponse;
776
+ };
777
+ type PostAutomatableContractAmendmentError = PostAutomatableContractAmendmentErrors[keyof PostAutomatableContractAmendmentErrors];
778
+
779
+ export type { ContractAmendmentAutomatableResponse as C, EmploymentShowResponse as E, ListTimeoffResponse as L, OffboardingResponse as O, PostAutomatableContractAmendmentError as P, TerminationDetailsParams as T, ContractAmendmentResponse as a, PostCreateContractAmendmentError as b, CostCalculatorEstimateResponse as c, PostCreateEstimationError as d, CostCalculatorEstimatePdfResponse as e, PostCreateEstimationPdfError as f, CostCalculatorEstimateParams as g, EmploymentTermType as h, PostCreateOffboardingError as i, TimeoffStatus as j };