finch-api 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

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 (293) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +50 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/finch_api/errors.rb +22 -0
  6. data/lib/finch_api/internal/individuals_page.rb +1 -1
  7. data/lib/finch_api/internal/page.rb +1 -1
  8. data/lib/finch_api/internal/type/array_of.rb +14 -1
  9. data/lib/finch_api/internal/type/base_model.rb +84 -25
  10. data/lib/finch_api/internal/type/boolean.rb +15 -1
  11. data/lib/finch_api/internal/type/converter.rb +42 -34
  12. data/lib/finch_api/internal/type/enum.rb +25 -2
  13. data/lib/finch_api/internal/type/file_input.rb +13 -1
  14. data/lib/finch_api/internal/type/hash_of.rb +14 -1
  15. data/lib/finch_api/internal/type/union.rb +27 -7
  16. data/lib/finch_api/internal/type/unknown.rb +15 -1
  17. data/lib/finch_api/internal/util.rb +62 -10
  18. data/lib/finch_api/internal.rb +3 -0
  19. data/lib/finch_api/models/account_update_event.rb +110 -109
  20. data/lib/finch_api/models/base_webhook_event.rb +1 -1
  21. data/lib/finch_api/models/company_event.rb +2 -2
  22. data/lib/finch_api/models/connect/session_new_params.rb +12 -12
  23. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +2 -2
  24. data/lib/finch_api/models/create_access_token_response.rb +7 -7
  25. data/lib/finch_api/models/directory_event.rb +4 -4
  26. data/lib/finch_api/models/employment_event.rb +4 -4
  27. data/lib/finch_api/models/hris/benefit_contribution.rb +3 -3
  28. data/lib/finch_api/models/hris/benefit_create_params.rb +11 -11
  29. data/lib/finch_api/models/hris/benefit_features_and_operations.rb +5 -120
  30. data/lib/finch_api/models/hris/benefit_type.rb +10 -10
  31. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +11 -11
  32. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +23 -23
  33. data/lib/finch_api/models/hris/benefits_support.rb +24 -24
  34. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +11 -11
  35. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +2 -2
  36. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +18 -18
  37. data/lib/finch_api/models/hris/company.rb +23 -23
  38. data/lib/finch_api/models/hris/company_benefit.rb +12 -12
  39. data/lib/finch_api/models/hris/document_list_params.rb +2 -2
  40. data/lib/finch_api/models/hris/document_list_response.rb +4 -4
  41. data/lib/finch_api/models/hris/document_response.rb +4 -4
  42. data/lib/finch_api/models/hris/document_retreive_response.rb +1 -5
  43. data/lib/finch_api/models/hris/employment_data.rb +89 -99
  44. data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
  45. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -3
  46. data/lib/finch_api/models/hris/individual.rb +20 -26
  47. data/lib/finch_api/models/hris/individual_in_directory.rb +6 -6
  48. data/lib/finch_api/models/hris/individual_response.rb +2 -2
  49. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +4 -4
  50. data/lib/finch_api/models/hris/pay_statement.rb +184 -182
  51. data/lib/finch_api/models/hris/pay_statement_data_sync_in_progress.rb +76 -0
  52. data/lib/finch_api/models/hris/pay_statement_response.rb +50 -8
  53. data/lib/finch_api/models/hris/pay_statement_response_body.rb +27 -9
  54. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +2 -2
  55. data/lib/finch_api/models/hris/payment.rb +37 -37
  56. data/lib/finch_api/models/hris/support_per_benefit_type.rb +4 -4
  57. data/lib/finch_api/models/hris/supported_benefit.rb +10 -9
  58. data/lib/finch_api/models/hris/w42005.rb +12 -12
  59. data/lib/finch_api/models/hris/w42020.rb +10 -10
  60. data/lib/finch_api/models/income.rb +8 -8
  61. data/lib/finch_api/models/individual_event.rb +4 -4
  62. data/lib/finch_api/models/introspection.rb +23 -23
  63. data/lib/finch_api/models/job_completion_event.rb +4 -4
  64. data/lib/finch_api/models/jobs/automated_async_job.rb +10 -10
  65. data/lib/finch_api/models/jobs/automated_create_params.rb +4 -4
  66. data/lib/finch_api/models/jobs/automated_list_response.rb +2 -2
  67. data/lib/finch_api/models/jobs/manual_async_job.rb +3 -3
  68. data/lib/finch_api/models/money.rb +4 -4
  69. data/lib/finch_api/models/operation_support_matrix.rb +9 -9
  70. data/lib/finch_api/models/pay_statement_event.rb +4 -4
  71. data/lib/finch_api/models/payment_event.rb +4 -4
  72. data/lib/finch_api/models/payroll/pay_group_list_response.rb +12 -12
  73. data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb +5 -5
  74. data/lib/finch_api/models/provider.rb +104 -104
  75. data/lib/finch_api/models/sandbox/company_update_params.rb +21 -21
  76. data/lib/finch_api/models/sandbox/company_update_response.rb +2 -2
  77. data/lib/finch_api/models/sandbox/connection_create_params.rb +2 -2
  78. data/lib/finch_api/models/sandbox/connections/account_create_params.rb +2 -2
  79. data/lib/finch_api/models/sandbox/connections/account_update_params.rb +2 -2
  80. data/lib/finch_api/models/sandbox/directory_create_params.rb +57 -53
  81. data/lib/finch_api/models/sandbox/employment_update_params.rb +32 -28
  82. data/lib/finch_api/models/sandbox/employment_update_response.rb +17 -14
  83. data/lib/finch_api/models/sandbox/individual_update_params.rb +16 -16
  84. data/lib/finch_api/models/sandbox/individual_update_response.rb +2 -2
  85. data/lib/finch_api/models/sandbox/job_create_params.rb +2 -2
  86. data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -6
  87. data/lib/finch_api/models/sandbox/payment_create_params.rb +160 -367
  88. data/lib/finch_api/models/webhook_event.rb +1 -16
  89. data/lib/finch_api/models.rb +30 -19
  90. data/lib/finch_api/resources/access_tokens.rb +1 -1
  91. data/lib/finch_api/resources/account.rb +2 -2
  92. data/lib/finch_api/resources/connect/sessions.rb +5 -5
  93. data/lib/finch_api/resources/hris/benefits/individuals.rb +4 -4
  94. data/lib/finch_api/resources/hris/benefits.rb +9 -9
  95. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +3 -3
  96. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +1 -1
  97. data/lib/finch_api/resources/hris/company.rb +1 -1
  98. data/lib/finch_api/resources/hris/directory.rb +1 -1
  99. data/lib/finch_api/resources/hris/documents.rb +2 -2
  100. data/lib/finch_api/resources/hris/employments.rb +2 -2
  101. data/lib/finch_api/resources/hris/individuals.rb +3 -3
  102. data/lib/finch_api/resources/hris/pay_statements.rb +2 -2
  103. data/lib/finch_api/resources/hris/payments.rb +1 -1
  104. data/lib/finch_api/resources/jobs/automated.rb +3 -3
  105. data/lib/finch_api/resources/jobs/manual.rb +1 -1
  106. data/lib/finch_api/resources/providers.rb +1 -1
  107. data/lib/finch_api/resources/sandbox/company.rb +4 -4
  108. data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -2
  109. data/lib/finch_api/resources/sandbox/connections.rb +1 -1
  110. data/lib/finch_api/resources/sandbox/directory.rb +1 -1
  111. data/lib/finch_api/resources/sandbox/employment.rb +9 -9
  112. data/lib/finch_api/resources/sandbox/individual.rb +5 -5
  113. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +4 -4
  114. data/lib/finch_api/resources/sandbox/jobs.rb +1 -1
  115. data/lib/finch_api/resources/sandbox/payment.rb +6 -3
  116. data/lib/finch_api/version.rb +1 -1
  117. data/lib/finch_api.rb +4 -2
  118. data/rbi/finch_api/errors.rbi +16 -0
  119. data/rbi/finch_api/internal/type/array_of.rbi +6 -0
  120. data/rbi/finch_api/internal/type/base_model.rbi +5 -0
  121. data/rbi/finch_api/internal/type/boolean.rbi +8 -0
  122. data/rbi/finch_api/internal/type/converter.rbi +15 -15
  123. data/rbi/finch_api/internal/type/enum.rbi +5 -0
  124. data/rbi/finch_api/internal/type/file_input.rbi +5 -0
  125. data/rbi/finch_api/internal/type/hash_of.rbi +6 -0
  126. data/rbi/finch_api/internal/type/union.rbi +10 -0
  127. data/rbi/finch_api/internal/type/unknown.rbi +8 -0
  128. data/rbi/finch_api/internal/util.rbi +36 -0
  129. data/rbi/finch_api/internal.rbi +3 -0
  130. data/rbi/finch_api/models/connect/session_new_params.rbi +4 -4
  131. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +4 -296
  132. data/rbi/finch_api/models/hris/benefit_type.rbi +16 -16
  133. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +18 -33
  134. data/rbi/finch_api/models/hris/employment_data.rbi +123 -140
  135. data/rbi/finch_api/models/hris/employment_data_response.rbi +2 -13
  136. data/rbi/finch_api/models/hris/individual_response.rbi +2 -13
  137. data/rbi/finch_api/models/hris/pay_statement.rbi +275 -307
  138. data/rbi/finch_api/models/hris/pay_statement_data_sync_in_progress.rbi +188 -0
  139. data/rbi/finch_api/models/hris/pay_statement_response.rbi +84 -20
  140. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +45 -17
  141. data/rbi/finch_api/models/hris/payment.rbi +27 -30
  142. data/rbi/finch_api/models/hris/supported_benefit.rbi +12 -8
  143. data/rbi/finch_api/models/income.rbi +3 -3
  144. data/rbi/finch_api/models/money.rbi +4 -7
  145. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +25 -43
  146. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +14 -14
  147. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +20 -26
  148. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +20 -26
  149. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +20 -26
  150. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +463 -727
  151. data/rbi/finch_api/resources/connect/sessions.rbi +2 -2
  152. data/rbi/finch_api/resources/hris/benefits.rbi +1 -3
  153. data/rbi/finch_api/resources/hris/documents.rbi +1 -1
  154. data/rbi/finch_api/resources/sandbox/employment.rbi +8 -5
  155. data/rbi/finch_api/resources/sandbox/payment.rbi +3 -2
  156. data/sig/finch_api/errors.rbs +9 -0
  157. data/sig/finch_api/internal/type/array_of.rbs +3 -0
  158. data/sig/finch_api/internal/type/base_model.rbs +2 -0
  159. data/sig/finch_api/internal/type/boolean.rbs +3 -0
  160. data/sig/finch_api/internal/type/converter.rbs +7 -1
  161. data/sig/finch_api/internal/type/enum.rbs +2 -0
  162. data/sig/finch_api/internal/type/file_input.rbs +2 -0
  163. data/sig/finch_api/internal/type/hash_of.rbs +3 -0
  164. data/sig/finch_api/internal/type/union.rbs +2 -0
  165. data/sig/finch_api/internal/type/unknown.rbs +3 -0
  166. data/sig/finch_api/internal/util.rbs +12 -0
  167. data/sig/finch_api/internal.rbs +2 -0
  168. data/sig/finch_api/models/access_token_create_params.rbs +8 -0
  169. data/sig/finch_api/models/account_disconnect_params.rbs +2 -0
  170. data/sig/finch_api/models/account_introspect_params.rbs +2 -0
  171. data/sig/finch_api/models/account_update_event.rbs +230 -12
  172. data/sig/finch_api/models/base_webhook_event.rbs +6 -0
  173. data/sig/finch_api/models/company_event.rbs +11 -6
  174. data/sig/finch_api/models/connect/session_new_params.rbs +26 -8
  175. data/sig/finch_api/models/connect/session_new_response.rbs +2 -0
  176. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +12 -4
  177. data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +2 -0
  178. data/sig/finch_api/models/create_access_token_response.rbs +21 -8
  179. data/sig/finch_api/models/directory_event.rbs +13 -6
  180. data/sig/finch_api/models/disconnect_response.rbs +2 -0
  181. data/sig/finch_api/models/employment_event.rbs +13 -6
  182. data/sig/finch_api/models/hris/benefit_contribution.rbs +12 -4
  183. data/sig/finch_api/models/hris/benefit_create_params.rbs +21 -6
  184. data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +9 -78
  185. data/sig/finch_api/models/hris/benefit_list_params.rbs +2 -0
  186. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +2 -0
  187. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +2 -0
  188. data/sig/finch_api/models/hris/benefit_type.rbs +21 -21
  189. data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -0
  190. data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +2 -0
  191. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +18 -4
  192. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +47 -18
  193. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +2 -0
  194. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +5 -0
  195. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +5 -0
  196. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +5 -0
  197. data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +2 -0
  198. data/sig/finch_api/models/hris/benefits_support.rbs +15 -0
  199. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +23 -6
  200. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +20 -0
  201. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +2 -0
  202. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +21 -0
  203. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +2 -0
  204. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +20 -0
  205. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +5 -0
  206. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +20 -0
  207. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +15 -6
  208. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +23 -20
  209. data/sig/finch_api/models/hris/company.rbs +44 -12
  210. data/sig/finch_api/models/hris/company_benefit.rbs +21 -6
  211. data/sig/finch_api/models/hris/company_retrieve_params.rbs +2 -0
  212. data/sig/finch_api/models/hris/create_company_benefits_response.rbs +2 -0
  213. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +6 -0
  214. data/sig/finch_api/models/hris/directory_list_params.rbs +6 -0
  215. data/sig/finch_api/models/hris/document_list_params.rbs +14 -6
  216. data/sig/finch_api/models/hris/document_list_response.rbs +5 -0
  217. data/sig/finch_api/models/hris/document_response.rbs +14 -6
  218. data/sig/finch_api/models/hris/document_retreive_params.rbs +2 -0
  219. data/sig/finch_api/models/hris/employment_data.rbs +91 -49
  220. data/sig/finch_api/models/hris/employment_data_response.rbs +6 -0
  221. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +7 -0
  222. data/sig/finch_api/models/hris/individual.rbs +49 -16
  223. data/sig/finch_api/models/hris/individual_in_directory.rbs +14 -0
  224. data/sig/finch_api/models/hris/individual_response.rbs +6 -0
  225. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +10 -0
  226. data/sig/finch_api/models/hris/pay_statement.rbs +179 -133
  227. data/sig/finch_api/models/hris/pay_statement_data_sync_in_progress.rbs +78 -0
  228. data/sig/finch_api/models/hris/pay_statement_response.rbs +51 -13
  229. data/sig/finch_api/models/hris/pay_statement_response_body.rbs +24 -11
  230. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +11 -0
  231. data/sig/finch_api/models/hris/payment.rbs +44 -29
  232. data/sig/finch_api/models/hris/payment_list_params.rbs +6 -0
  233. data/sig/finch_api/models/hris/support_per_benefit_type.rbs +5 -0
  234. data/sig/finch_api/models/hris/supported_benefit.rbs +22 -12
  235. data/sig/finch_api/models/hris/update_company_benefit_response.rbs +2 -0
  236. data/sig/finch_api/models/hris/w42005.rbs +30 -16
  237. data/sig/finch_api/models/hris/w42020.rbs +27 -10
  238. data/sig/finch_api/models/income.rbs +14 -7
  239. data/sig/finch_api/models/individual_event.rbs +13 -6
  240. data/sig/finch_api/models/introspection.rbs +51 -14
  241. data/sig/finch_api/models/job_completion_event.rbs +13 -6
  242. data/sig/finch_api/models/jobs/automated_async_job.rbs +22 -8
  243. data/sig/finch_api/models/jobs/automated_create_params.rbs +8 -0
  244. data/sig/finch_api/models/jobs/automated_create_response.rbs +7 -0
  245. data/sig/finch_api/models/jobs/automated_list_params.rbs +6 -0
  246. data/sig/finch_api/models/jobs/automated_list_response.rbs +18 -0
  247. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +2 -0
  248. data/sig/finch_api/models/jobs/manual_async_job.rbs +10 -4
  249. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +2 -0
  250. data/sig/finch_api/models/location.rbs +11 -0
  251. data/sig/finch_api/models/money.rbs +3 -3
  252. data/sig/finch_api/models/operation_support_matrix.rbs +7 -0
  253. data/sig/finch_api/models/paging.rbs +2 -0
  254. data/sig/finch_api/models/pay_statement_event.rbs +13 -6
  255. data/sig/finch_api/models/payment_event.rbs +13 -6
  256. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +6 -0
  257. data/sig/finch_api/models/payroll/pay_group_list_response.rbs +22 -24
  258. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +2 -0
  259. data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +17 -10
  260. data/sig/finch_api/models/provider.rbs +227 -6
  261. data/sig/finch_api/models/provider_list_params.rbs +2 -0
  262. data/sig/finch_api/models/request_forwarding_forward_params.rbs +9 -0
  263. data/sig/finch_api/models/request_forwarding_forward_response.rbs +15 -0
  264. data/sig/finch_api/models/sandbox/company_update_params.rbs +44 -12
  265. data/sig/finch_api/models/sandbox/company_update_response.rbs +31 -0
  266. data/sig/finch_api/models/sandbox/connection_create_params.rbs +8 -0
  267. data/sig/finch_api/models/sandbox/connection_create_response.rbs +11 -0
  268. data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +8 -0
  269. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +10 -0
  270. data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +5 -0
  271. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +9 -0
  272. data/sig/finch_api/models/sandbox/directory_create_params.rbs +90 -40
  273. data/sig/finch_api/models/sandbox/employment_update_params.rbs +47 -20
  274. data/sig/finch_api/models/sandbox/employment_update_response.rbs +39 -12
  275. data/sig/finch_api/models/sandbox/individual_update_params.rbs +34 -8
  276. data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
  277. data/sig/finch_api/models/sandbox/job_create_params.rbs +5 -0
  278. data/sig/finch_api/models/sandbox/job_create_response.rbs +7 -0
  279. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +2 -0
  280. data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +2 -0
  281. data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +13 -8
  282. data/sig/finch_api/models/sandbox/payment_create_params.rbs +287 -228
  283. data/sig/finch_api/models/sandbox/payment_create_response.rbs +2 -0
  284. data/sig/finch_api/resources/connect/sessions.rbs +2 -2
  285. data/sig/finch_api/resources/hris/benefits.rbs +1 -1
  286. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
  287. data/sig/finch_api/resources/hris/documents.rbs +1 -1
  288. data/sig/finch_api/resources/sandbox/employment.rbs +2 -2
  289. data/sig/finch_api/resources/sandbox/payment.rbs +2 -2
  290. metadata +5 -5
  291. data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +0 -110
  292. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +0 -290
  293. data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -79
@@ -14,7 +14,7 @@ module FinchAPI
14
14
  # @!attribute company_contribution
15
15
  # The company match for this benefit.
16
16
  #
17
- # @return [FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil]
17
+ # @return [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil]
18
18
  required :company_contribution, -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution }, nil?: true
19
19
 
20
20
  # @!attribute description
@@ -25,31 +25,31 @@ module FinchAPI
25
25
  # @!attribute frequency
26
26
  # The frequency of the benefit deduction/contribution.
27
27
  #
28
- # @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil]
28
+ # @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
29
29
  required :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true
30
30
 
31
31
  # @!attribute type
32
32
  # Type of benefit.
33
33
  #
34
- # @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
34
+ # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
35
35
  required :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
36
36
 
37
37
  # @!method initialize(benefit_id:, company_contribution:, description:, frequency:, type:)
38
38
  # @param benefit_id [String] The id of the benefit.
39
39
  #
40
- # @param company_contribution [FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit.
40
+ # @param company_contribution [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit.
41
41
  #
42
42
  # @param description [String, nil]
43
43
  #
44
- # @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
44
+ # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
45
45
  #
46
- # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
46
+ # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
47
47
 
48
- # @see FinchAPI::HRIS::CompanyBenefit#company_contribution
48
+ # @see FinchAPI::Models::HRIS::CompanyBenefit#company_contribution
49
49
  class CompanyContribution < FinchAPI::Internal::Type::BaseModel
50
50
  # @!attribute tiers
51
51
  #
52
- # @return [Array<FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier>, nil]
52
+ # @return [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>, nil]
53
53
  optional :tiers,
54
54
  -> {
55
55
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]
@@ -57,14 +57,14 @@ module FinchAPI
57
57
 
58
58
  # @!attribute type
59
59
  #
60
- # @return [Symbol, FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type, nil]
60
+ # @return [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type, nil]
61
61
  optional :type, enum: -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type }
62
62
 
63
63
  # @!method initialize(tiers: nil, type: nil)
64
64
  # The company match for this benefit.
65
65
  #
66
- # @param tiers [Array<FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier>]
67
- # @param type [Symbol, FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type]
66
+ # @param tiers [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>]
67
+ # @param type [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type]
68
68
 
69
69
  class Tier < FinchAPI::Internal::Type::BaseModel
70
70
  # @!attribute match
@@ -82,7 +82,7 @@ module FinchAPI
82
82
  # @param threshold [Integer]
83
83
  end
84
84
 
85
- # @see FinchAPI::HRIS::CompanyBenefit::CompanyContribution#type
85
+ # @see FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution#type
86
86
  module Type
87
87
  extend FinchAPI::Internal::Type::Enum
88
88
 
@@ -31,7 +31,7 @@ module FinchAPI
31
31
  # Comma-delimited list of document types to filter on. If empty, defaults to all
32
32
  # types
33
33
  #
34
- # @return [Array<Symbol, FinchAPI::HRIS::DocumentListParams::Type>, nil]
34
+ # @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil]
35
35
  optional :types,
36
36
  -> {
37
37
  FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::DocumentListParams::Type]
@@ -47,7 +47,7 @@ module FinchAPI
47
47
  #
48
48
  # @param offset [Integer] Index to start from (defaults to 0)
49
49
  #
50
- # @param types [Array<Symbol, FinchAPI::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
50
+ # @param types [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
51
51
  #
52
52
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
53
53
 
@@ -7,17 +7,17 @@ module FinchAPI
7
7
  class DocumentListResponse < FinchAPI::Internal::Type::BaseModel
8
8
  # @!attribute documents
9
9
  #
10
- # @return [Array<FinchAPI::HRIS::DocumentResponse>]
10
+ # @return [Array<FinchAPI::Models::HRIS::DocumentResponse>]
11
11
  required :documents, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::DocumentResponse] }
12
12
 
13
13
  # @!attribute paging
14
14
  #
15
- # @return [FinchAPI::Paging]
15
+ # @return [FinchAPI::Models::Paging]
16
16
  required :paging, -> { FinchAPI::Paging }
17
17
 
18
18
  # @!method initialize(documents:, paging:)
19
- # @param documents [Array<FinchAPI::HRIS::DocumentResponse>]
20
- # @param paging [FinchAPI::Paging]
19
+ # @param documents [Array<FinchAPI::Models::HRIS::DocumentResponse>]
20
+ # @param paging [FinchAPI::Models::Paging]
21
21
  end
22
22
  end
23
23
  end
@@ -20,7 +20,7 @@ module FinchAPI
20
20
  # @!attribute type
21
21
  # The type of document.
22
22
  #
23
- # @return [Symbol, FinchAPI::HRIS::DocumentResponse::Type, nil]
23
+ # @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil]
24
24
  optional :type, enum: -> { FinchAPI::HRIS::DocumentResponse::Type }
25
25
 
26
26
  # @!attribute url
@@ -38,13 +38,13 @@ module FinchAPI
38
38
 
39
39
  # @!method initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil)
40
40
  # Some parameter documentations has been truncated, see
41
- # {FinchAPI::HRIS::DocumentResponse} for more details.
41
+ # {FinchAPI::Models::HRIS::DocumentResponse} for more details.
42
42
  #
43
43
  # @param id [String] A stable Finch id for the document.
44
44
  #
45
45
  # @param individual_id [String, nil] The ID of the individual associated with the document. This will be null for emp
46
46
  #
47
- # @param type [Symbol, FinchAPI::HRIS::DocumentResponse::Type] The type of document.
47
+ # @param type [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type] The type of document.
48
48
  #
49
49
  # @param url [String] A URL to access the document. Format: `https://api.tryfinch.com/employer/documen
50
50
  #
@@ -52,7 +52,7 @@ module FinchAPI
52
52
 
53
53
  # The type of document.
54
54
  #
55
- # @see FinchAPI::HRIS::DocumentResponse#type
55
+ # @see FinchAPI::Models::HRIS::DocumentResponse#type
56
56
  module Type
57
57
  extend FinchAPI::Internal::Type::Enum
58
58
 
@@ -19,11 +19,7 @@ module FinchAPI
19
19
  variant :w4_2005, -> { FinchAPI::HRIS::W42005 }
20
20
 
21
21
  # @!method self.variants
22
- # @return [Array(FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005)]
23
-
24
- define_sorbet_constant!(:Variants) do
25
- T.type_alias { T.any(FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005) }
26
- end
22
+ # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)]
27
23
  end
28
24
  end
29
25
  end
@@ -23,34 +23,23 @@ module FinchAPI
23
23
  # @return [String, nil]
24
24
  required :class_code, String, nil?: true
25
25
 
26
- # @!attribute custom_fields
27
- # Custom fields for the individual. These are fields which are defined by the
28
- # employer in the system.
29
- #
30
- # @return [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
31
- required :custom_fields,
32
- -> {
33
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]
34
- },
35
- nil?: true
36
-
37
26
  # @!attribute department
38
27
  # The department object.
39
28
  #
40
- # @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Department, nil]
29
+ # @return [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Department, nil]
41
30
  required :department, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Department }, nil?: true
42
31
 
43
32
  # @!attribute employment
44
33
  # The employment object.
45
34
  #
46
- # @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Employment, nil]
35
+ # @return [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment, nil]
47
36
  required :employment, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment }, nil?: true
48
37
 
49
38
  # @!attribute employment_status
50
39
  # The detailed employment status of the individual. Available options: `active`,
51
40
  # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
52
41
  #
53
- # @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil]
42
+ # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil]
54
43
  required :employment_status,
55
44
  enum: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus },
56
45
  nil?: true
@@ -85,13 +74,13 @@ module FinchAPI
85
74
 
86
75
  # @!attribute location
87
76
  #
88
- # @return [FinchAPI::Location, nil]
77
+ # @return [FinchAPI::Models::Location, nil]
89
78
  required :location, -> { FinchAPI::Location }, nil?: true
90
79
 
91
80
  # @!attribute manager
92
81
  # The manager object representing the manager of the individual within the org.
93
82
  #
94
- # @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Manager, nil]
83
+ # @return [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Manager, nil]
95
84
  required :manager, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Manager }, nil?: true
96
85
 
97
86
  # @!attribute middle_name
@@ -111,26 +100,30 @@ module FinchAPI
111
100
  # @return [String, nil]
112
101
  required :title, String, nil?: true
113
102
 
114
- # @!attribute work_id
115
- # @deprecated
116
- #
117
- # This field is deprecated in favour of `source_id`
103
+ # @!attribute custom_fields
104
+ # Custom fields for the individual. These are fields which are defined by the
105
+ # employer in the system. Custom fields are not currently supported for assisted
106
+ # connections.
118
107
  #
119
- # @return [String, nil]
120
- required :work_id, String, nil?: true
108
+ # @return [Array<FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
109
+ optional :custom_fields,
110
+ -> {
111
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]
112
+ },
113
+ nil?: true
121
114
 
122
115
  # @!attribute income
123
116
  # The employee's income as reported by the provider. This may not always be
124
117
  # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
125
118
  # depending on what information the provider returns.
126
119
  #
127
- # @return [FinchAPI::Income, nil]
120
+ # @return [FinchAPI::Models::Income, nil]
128
121
  optional :income, -> { FinchAPI::Income }, nil?: true
129
122
 
130
123
  # @!attribute income_history
131
124
  # The array of income history.
132
125
  #
133
- # @return [Array<FinchAPI::Income, nil>, nil]
126
+ # @return [Array<FinchAPI::Models::Income, nil>, nil]
134
127
  optional :income_history,
135
128
  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] },
136
129
  nil?: true
@@ -141,21 +134,27 @@ module FinchAPI
141
134
  # @return [String, nil]
142
135
  optional :source_id, String, nil?: true
143
136
 
144
- # @!method initialize(id:, class_code:, custom_fields:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, work_id:, income: nil, income_history: nil, source_id: nil)
137
+ # @!attribute work_id
138
+ # @deprecated
139
+ #
140
+ # This field is deprecated in favour of `source_id`
141
+ #
142
+ # @return [String, nil]
143
+ optional :work_id, String, nil?: true
144
+
145
+ # @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
145
146
  # Some parameter documentations has been truncated, see
146
- # {FinchAPI::HRIS::EmploymentData::UnionMember0} for more details.
147
+ # {FinchAPI::Models::HRIS::EmploymentData::UnionMember0} for more details.
147
148
  #
148
149
  # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
149
150
  #
150
151
  # @param class_code [String, nil] Worker's compensation classification code for this employee
151
152
  #
152
- # @param custom_fields [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
153
+ # @param department [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Department, nil] The department object.
153
154
  #
154
- # @param department [FinchAPI::HRIS::EmploymentData::UnionMember0::Department, nil] The department object.
155
+ # @param employment [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object.
155
156
  #
156
- # @param employment [FinchAPI::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object.
157
- #
158
- # @param employment_status [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
157
+ # @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
159
158
  #
160
159
  # @param end_date [String, nil]
161
160
  #
@@ -167,9 +166,9 @@ module FinchAPI
167
166
  #
168
167
  # @param latest_rehire_date [String, nil]
169
168
  #
170
- # @param location [FinchAPI::Location, nil]
169
+ # @param location [FinchAPI::Models::Location, nil]
171
170
  #
172
- # @param manager [FinchAPI::HRIS::EmploymentData::UnionMember0::Manager, nil] The manager object representing the manager of the individual within the org.
171
+ # @param manager [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Manager, nil] The manager object representing the manager of the individual within the org.
173
172
  #
174
173
  # @param middle_name [String, nil] The legal middle name of the individual.
175
174
  #
@@ -177,60 +176,17 @@ module FinchAPI
177
176
  #
178
177
  # @param title [String, nil] The current title of the individual.
179
178
  #
180
- # @param work_id [String, nil] This field is deprecated in favour of `source_id`
179
+ # @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
181
180
  #
182
- # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
181
+ # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
183
182
  #
184
- # @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
183
+ # @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
185
184
  #
186
185
  # @param source_id [String, nil] The source system's unique employment identifier for this individual
186
+ #
187
+ # @param work_id [String, nil] This field is deprecated in favour of `source_id`
187
188
 
188
- class CustomField < FinchAPI::Internal::Type::BaseModel
189
- # @!attribute name
190
- #
191
- # @return [String, nil]
192
- optional :name, String
193
-
194
- # @!attribute value
195
- #
196
- # @return [String, Array<Object>, Object, Float, Boolean, nil]
197
- optional :value,
198
- union: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value },
199
- nil?: true
200
-
201
- # @!method initialize(name: nil, value: nil)
202
- # @param name [String]
203
- # @param value [String, Array<Object>, Object, Float, Boolean, nil]
204
-
205
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value
206
- module Value
207
- extend FinchAPI::Internal::Type::Union
208
-
209
- variant String
210
-
211
- variant -> {
212
- FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::UnionMember1Array
213
- }
214
-
215
- variant FinchAPI::Internal::Type::Unknown
216
-
217
- variant Float
218
-
219
- variant FinchAPI::Internal::Type::Boolean
220
-
221
- # @!method self.variants
222
- # @return [Array(String, Array<Object>, Object, Float, Boolean)]
223
-
224
- define_sorbet_constant!(:Variants) do
225
- T.type_alias { T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean) }
226
- end
227
-
228
- # @type [FinchAPI::Internal::Type::Converter]
229
- UnionMember1Array = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]
230
- end
231
- end
232
-
233
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0#department
189
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#department
234
190
  class Department < FinchAPI::Internal::Type::BaseModel
235
191
  # @!attribute name
236
192
  # The name of the department associated with the individual.
@@ -244,13 +200,13 @@ module FinchAPI
244
200
  # @param name [String, nil] The name of the department associated with the individual.
245
201
  end
246
202
 
247
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0#employment
203
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#employment
248
204
  class Employment < FinchAPI::Internal::Type::BaseModel
249
205
  # @!attribute subtype
250
206
  # The secondary employment type of the individual. Options: `full_time`,
251
207
  # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
252
208
  #
253
- # @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil]
209
+ # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil]
254
210
  required :subtype,
255
211
  enum: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype },
256
212
  nil?: true
@@ -258,7 +214,7 @@ module FinchAPI
258
214
  # @!attribute type
259
215
  # The main employment type of the individual.
260
216
  #
261
- # @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type, nil]
217
+ # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment::Type, nil]
262
218
  required :type,
263
219
  enum: -> {
264
220
  FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type
@@ -267,18 +223,19 @@ module FinchAPI
267
223
 
268
224
  # @!method initialize(subtype:, type:)
269
225
  # Some parameter documentations has been truncated, see
270
- # {FinchAPI::HRIS::EmploymentData::UnionMember0::Employment} for more details.
226
+ # {FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment} for more
227
+ # details.
271
228
  #
272
229
  # The employment object.
273
230
  #
274
- # @param subtype [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
231
+ # @param subtype [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
275
232
  #
276
- # @param type [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type, nil] The main employment type of the individual.
233
+ # @param type [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment::Type, nil] The main employment type of the individual.
277
234
 
278
235
  # The secondary employment type of the individual. Options: `full_time`,
279
236
  # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
280
237
  #
281
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0::Employment#subtype
238
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment#subtype
282
239
  module Subtype
283
240
  extend FinchAPI::Internal::Type::Enum
284
241
 
@@ -295,7 +252,7 @@ module FinchAPI
295
252
 
296
253
  # The main employment type of the individual.
297
254
  #
298
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0::Employment#type
255
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment#type
299
256
  module Type
300
257
  extend FinchAPI::Internal::Type::Enum
301
258
 
@@ -310,7 +267,7 @@ module FinchAPI
310
267
  # The detailed employment status of the individual. Available options: `active`,
311
268
  # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
312
269
  #
313
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0#employment_status
270
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#employment_status
314
271
  module EmploymentStatus
315
272
  extend FinchAPI::Internal::Type::Enum
316
273
 
@@ -326,7 +283,7 @@ module FinchAPI
326
283
  # @return [Array<Symbol>]
327
284
  end
328
285
 
329
- # @see FinchAPI::HRIS::EmploymentData::UnionMember0#manager
286
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#manager
330
287
  class Manager < FinchAPI::Internal::Type::BaseModel
331
288
  # @!attribute id
332
289
  # A stable Finch `id` (UUID v4) for an individual in the company.
@@ -339,6 +296,45 @@ module FinchAPI
339
296
  #
340
297
  # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
341
298
  end
299
+
300
+ class CustomField < FinchAPI::Internal::Type::BaseModel
301
+ # @!attribute name
302
+ #
303
+ # @return [String, nil]
304
+ optional :name, String, nil?: true
305
+
306
+ # @!attribute value
307
+ #
308
+ # @return [String, Array<Object>, Object, Float, Boolean, nil]
309
+ optional :value,
310
+ union: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value },
311
+ nil?: true
312
+
313
+ # @!method initialize(name: nil, value: nil)
314
+ # @param name [String, nil]
315
+ # @param value [String, Array<Object>, Object, Float, Boolean, nil]
316
+
317
+ # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField#value
318
+ module Value
319
+ extend FinchAPI::Internal::Type::Union
320
+
321
+ variant String
322
+
323
+ variant -> { FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField::Value::UnionMember1Array }
324
+
325
+ variant FinchAPI::Internal::Type::Unknown
326
+
327
+ variant Float
328
+
329
+ variant FinchAPI::Internal::Type::Boolean
330
+
331
+ # @!method self.variants
332
+ # @return [Array(String, Array<Object>, Object, Float, Boolean)]
333
+
334
+ # @type [FinchAPI::Internal::Type::Converter]
335
+ UnionMember1Array = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]
336
+ end
337
+ end
342
338
  end
343
339
 
344
340
  class BatchError < FinchAPI::Internal::Type::BaseModel
@@ -370,13 +366,7 @@ module FinchAPI
370
366
  end
371
367
 
372
368
  # @!method self.variants
373
- # @return [Array(FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError)]
374
-
375
- define_sorbet_constant!(:Variants) do
376
- T.type_alias do
377
- T.any(FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError)
378
- end
379
- end
369
+ # @return [Array(FinchAPI::Models::HRIS::EmploymentData::UnionMember0, FinchAPI::Models::HRIS::EmploymentData::BatchError)]
380
370
  end
381
371
  end
382
372
  end
@@ -7,7 +7,7 @@ module FinchAPI
7
7
  class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel
8
8
  # @!attribute body
9
9
  #
10
- # @return [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError]
10
+ # @return [FinchAPI::Models::HRIS::EmploymentData::UnionMember0, FinchAPI::Models::HRIS::EmploymentData::BatchError]
11
11
  required :body, union: -> { FinchAPI::HRIS::EmploymentData }
12
12
 
13
13
  # @!attribute code
@@ -22,7 +22,7 @@ module FinchAPI
22
22
  required :individual_id, String
23
23
 
24
24
  # @!method initialize(body:, code:, individual_id:)
25
- # @param body [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError]
25
+ # @param body [FinchAPI::Models::HRIS::EmploymentData::UnionMember0, FinchAPI::Models::HRIS::EmploymentData::BatchError]
26
26
  #
27
27
  # @param code [Integer]
28
28
  #
@@ -11,14 +11,14 @@ module FinchAPI
11
11
  # @!attribute requests
12
12
  # The array of batch requests.
13
13
  #
14
- # @return [Array<FinchAPI::HRIS::EmploymentRetrieveManyParams::Request>]
14
+ # @return [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>]
15
15
  required :requests,
16
16
  -> {
17
17
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
18
18
  }
19
19
 
20
20
  # @!method initialize(requests:, request_options: {})
21
- # @param requests [Array<FinchAPI::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
21
+ # @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
22
22
  #
23
23
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
24
24
 
@@ -33,7 +33,8 @@ module FinchAPI
33
33
 
34
34
  # @!method initialize(individual_id:)
35
35
  # Some parameter documentations has been truncated, see
36
- # {FinchAPI::HRIS::EmploymentRetrieveManyParams::Request} for more details.
36
+ # {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request} for more
37
+ # details.
37
38
  #
38
39
  # @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company. There is no limi
39
40
  end