finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

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 (417) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +63 -20
  3. data/lib/finch-api/base_client.rb +52 -59
  4. data/lib/finch-api/base_model.rb +453 -415
  5. data/lib/finch-api/base_page.rb +34 -15
  6. data/lib/finch-api/client.rb +3 -7
  7. data/lib/finch-api/errors.rb +12 -17
  8. data/lib/finch-api/extern.rb +1 -4
  9. data/lib/finch-api/individuals_page.rb +28 -34
  10. data/lib/finch-api/models/account_update_event.rb +6 -31
  11. data/lib/finch-api/models/company_event.rb +3 -11
  12. data/lib/finch-api/models/connect/session_new_params.rb +9 -52
  13. data/lib/finch-api/models/connect/session_reauthenticate_params.rb +3 -22
  14. data/lib/finch-api/models/connection_status_type.rb +3 -21
  15. data/lib/finch-api/models/create_access_token_response.rb +6 -30
  16. data/lib/finch-api/models/directory_event.rb +3 -15
  17. data/lib/finch-api/models/employment_event.rb +3 -15
  18. data/lib/finch-api/models/hris/benefit_contribution.rb +3 -14
  19. data/lib/finch-api/models/hris/benefit_features_and_operations.rb +9 -39
  20. data/lib/finch-api/models/hris/benefit_frequency.rb +3 -15
  21. data/lib/finch-api/models/hris/benefit_type.rb +3 -22
  22. data/lib/finch-api/models/hris/benefits/enrolled_individual.rb +3 -18
  23. data/lib/finch-api/models/hris/benefits/individual_benefit.rb +3 -14
  24. data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +9 -40
  25. data/lib/finch-api/models/hris/company.rb +9 -52
  26. data/lib/finch-api/models/hris/document_list_params.rb +3 -13
  27. data/lib/finch-api/models/hris/document_response.rb +3 -14
  28. data/lib/finch-api/models/hris/document_retreive_response.rb +7 -23
  29. data/lib/finch-api/models/hris/employment_data.rb +9 -58
  30. data/lib/finch-api/models/hris/individual.rb +12 -66
  31. data/lib/finch-api/models/hris/pay_statement.rb +12 -70
  32. data/lib/finch-api/models/hris/payment.rb +3 -21
  33. data/lib/finch-api/models/hris/supported_benefit.rb +9 -39
  34. data/lib/finch-api/models/hris/w42005.rb +12 -49
  35. data/lib/finch-api/models/hris/w42020.rb +8 -29
  36. data/lib/finch-api/models/income.rb +3 -22
  37. data/lib/finch-api/models/individual_event.rb +3 -15
  38. data/lib/finch-api/models/introspection.rb +9 -50
  39. data/lib/finch-api/models/job_completion_event.rb +3 -21
  40. data/lib/finch-api/models/jobs/automated_async_job.rb +6 -35
  41. data/lib/finch-api/models/jobs/automated_create_params.rb +3 -12
  42. data/lib/finch-api/models/jobs/automated_list_response.rb +100 -0
  43. data/lib/finch-api/models/jobs/manual_async_job.rb +3 -17
  44. data/lib/finch-api/models/operation_support.rb +3 -18
  45. data/lib/finch-api/models/pay_statement_event.rb +3 -15
  46. data/lib/finch-api/models/payment_event.rb +3 -15
  47. data/lib/finch-api/models/payroll/pay_group_list_response.rb +3 -21
  48. data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +3 -21
  49. data/lib/finch-api/models/provider.rb +3 -20
  50. data/lib/finch-api/models/sandbox/company_update_params.rb +9 -52
  51. data/lib/finch-api/models/sandbox/company_update_response.rb +9 -52
  52. data/lib/finch-api/models/sandbox/connection_create_params.rb +3 -17
  53. data/lib/finch-api/models/sandbox/connection_create_response.rb +3 -17
  54. data/lib/finch-api/models/sandbox/connections/account_create_params.rb +3 -17
  55. data/lib/finch-api/models/sandbox/connections/account_create_response.rb +3 -17
  56. data/lib/finch-api/models/sandbox/connections/account_update_response.rb +3 -17
  57. data/lib/finch-api/models/sandbox/directory_create_params.rb +21 -124
  58. data/lib/finch-api/models/sandbox/employment_update_params.rb +9 -58
  59. data/lib/finch-api/models/sandbox/employment_update_response.rb +9 -58
  60. data/lib/finch-api/models/sandbox/individual_update_params.rb +12 -66
  61. data/lib/finch-api/models/sandbox/individual_update_response.rb +12 -66
  62. data/lib/finch-api/models/sandbox/job_create_params.rb +3 -12
  63. data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +2 -1
  64. data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -28
  65. data/lib/finch-api/models/sandbox/payment_create_params.rb +12 -70
  66. data/lib/finch-api/models/webhook_event.rb +10 -27
  67. data/lib/finch-api/page.rb +28 -34
  68. data/lib/finch-api/pooled_net_requester.rb +51 -46
  69. data/lib/finch-api/request_options.rb +5 -12
  70. data/lib/finch-api/resources/access_tokens.rb +0 -2
  71. data/lib/finch-api/resources/account.rb +0 -3
  72. data/lib/finch-api/resources/connect/sessions.rb +0 -3
  73. data/lib/finch-api/resources/connect.rb +0 -1
  74. data/lib/finch-api/resources/hris/benefits/individuals.rb +2 -6
  75. data/lib/finch-api/resources/hris/benefits.rb +0 -6
  76. data/lib/finch-api/resources/hris/company.rb +0 -2
  77. data/lib/finch-api/resources/hris/directory.rb +1 -24
  78. data/lib/finch-api/resources/hris/documents.rb +4 -7
  79. data/lib/finch-api/resources/hris/employments.rb +0 -2
  80. data/lib/finch-api/resources/hris/individuals.rb +0 -2
  81. data/lib/finch-api/resources/hris/pay_statements.rb +0 -2
  82. data/lib/finch-api/resources/hris/payments.rb +0 -2
  83. data/lib/finch-api/resources/hris.rb +0 -1
  84. data/lib/finch-api/resources/jobs/automated.rb +2 -7
  85. data/lib/finch-api/resources/jobs/manual.rb +0 -2
  86. data/lib/finch-api/resources/jobs.rb +0 -1
  87. data/lib/finch-api/resources/payroll/pay_groups.rb +0 -3
  88. data/lib/finch-api/resources/payroll.rb +0 -1
  89. data/lib/finch-api/resources/providers.rb +0 -2
  90. data/lib/finch-api/resources/request_forwarding.rb +0 -2
  91. data/lib/finch-api/resources/sandbox/company.rb +0 -2
  92. data/lib/finch-api/resources/sandbox/connections/accounts.rb +0 -3
  93. data/lib/finch-api/resources/sandbox/connections.rb +0 -2
  94. data/lib/finch-api/resources/sandbox/directory.rb +0 -2
  95. data/lib/finch-api/resources/sandbox/employment.rb +0 -2
  96. data/lib/finch-api/resources/sandbox/individual.rb +0 -2
  97. data/lib/finch-api/resources/sandbox/jobs/configuration.rb +0 -3
  98. data/lib/finch-api/resources/sandbox/jobs.rb +0 -2
  99. data/lib/finch-api/resources/sandbox/payment.rb +0 -2
  100. data/lib/finch-api/resources/sandbox.rb +0 -1
  101. data/lib/finch-api/resources/webhooks.rb +0 -1
  102. data/lib/finch-api/responses_page.rb +24 -31
  103. data/lib/finch-api/single_page.rb +23 -31
  104. data/lib/finch-api/util.rb +216 -124
  105. data/lib/finch-api/version.rb +1 -1
  106. data/lib/finch-api.rb +17 -0
  107. data/manifest.yaml +1 -0
  108. data/rbi/lib/finch-api/base_client.rbi +89 -66
  109. data/rbi/lib/finch-api/base_model.rbi +403 -236
  110. data/rbi/lib/finch-api/base_page.rbi +3 -6
  111. data/rbi/lib/finch-api/client.rbi +23 -28
  112. data/rbi/lib/finch-api/errors.rbi +20 -22
  113. data/rbi/lib/finch-api/extern.rbi +1 -1
  114. data/rbi/lib/finch-api/individuals_page.rbi +5 -23
  115. data/rbi/lib/finch-api/models/access_token_create_params.rbi +13 -24
  116. data/rbi/lib/finch-api/models/account_disconnect_params.rbi +9 -2
  117. data/rbi/lib/finch-api/models/account_introspect_params.rbi +9 -2
  118. data/rbi/lib/finch-api/models/account_update_event.rbi +871 -983
  119. data/rbi/lib/finch-api/models/base_webhook_event.rbi +13 -19
  120. data/rbi/lib/finch-api/models/company_event.rbi +28 -20
  121. data/rbi/lib/finch-api/models/connect/session_new_params.rbi +90 -104
  122. data/rbi/lib/finch-api/models/connect/session_new_response.rbi +6 -14
  123. data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +37 -47
  124. data/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +6 -14
  125. data/rbi/lib/finch-api/models/connection_status_type.rbi +13 -9
  126. data/rbi/lib/finch-api/models/create_access_token_response.rbi +61 -78
  127. data/rbi/lib/finch-api/models/directory_event.rbi +42 -27
  128. data/rbi/lib/finch-api/models/disconnect_response.rbi +4 -8
  129. data/rbi/lib/finch-api/models/employment_event.rbi +42 -27
  130. data/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +29 -21
  131. data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +18 -26
  132. data/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +199 -86
  133. data/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +9 -6
  134. data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +9 -2
  135. data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +9 -2
  136. data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +9 -2
  137. data/rbi/lib/finch-api/models/hris/benefit_type.rbi +26 -22
  138. data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +7 -11
  139. data/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +43 -49
  140. data/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +74 -63
  141. data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +249 -104
  142. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +9 -2
  143. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +4 -14
  144. data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -8
  145. data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +7 -8
  146. data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +23 -39
  147. data/rbi/lib/finch-api/models/hris/benefits_support.rbi +88 -86
  148. data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +1 -1
  149. data/rbi/lib/finch-api/models/hris/company.rbi +119 -171
  150. data/rbi/lib/finch-api/models/hris/company_benefit.rbi +13 -32
  151. data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +9 -2
  152. data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +3 -8
  153. data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +11 -13
  154. data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +11 -13
  155. data/rbi/lib/finch-api/models/hris/document_list_params.rbi +32 -31
  156. data/rbi/lib/finch-api/models/hris/document_list_response.rbi +10 -17
  157. data/rbi/lib/finch-api/models/hris/document_response.rbi +40 -43
  158. data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +9 -2
  159. data/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +6 -4
  160. data/rbi/lib/finch-api/models/hris/employment_data.rbi +163 -205
  161. data/rbi/lib/finch-api/models/hris/employment_data_response.rbi +18 -17
  162. data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +12 -21
  163. data/rbi/lib/finch-api/models/hris/individual.rbi +126 -151
  164. data/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +42 -68
  165. data/rbi/lib/finch-api/models/hris/individual_response.rbi +18 -17
  166. data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +27 -31
  167. data/rbi/lib/finch-api/models/hris/pay_statement.rbi +290 -341
  168. data/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +18 -20
  169. data/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +13 -16
  170. data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +18 -31
  171. data/rbi/lib/finch-api/models/hris/payment.rbi +63 -103
  172. data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +9 -15
  173. data/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +10 -14
  174. data/rbi/lib/finch-api/models/hris/supported_benefit.rbi +83 -79
  175. data/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +3 -8
  176. data/rbi/lib/finch-api/models/hris/w42005.rbi +86 -70
  177. data/rbi/lib/finch-api/models/hris/w42020.rbi +84 -86
  178. data/rbi/lib/finch-api/models/income.rbi +34 -41
  179. data/rbi/lib/finch-api/models/individual_event.rbi +42 -27
  180. data/rbi/lib/finch-api/models/introspection.rbi +138 -178
  181. data/rbi/lib/finch-api/models/job_completion_event.rbi +48 -37
  182. data/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +66 -94
  183. data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +26 -33
  184. data/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +11 -31
  185. data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +11 -13
  186. data/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +126 -0
  187. data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +9 -2
  188. data/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +32 -27
  189. data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +9 -2
  190. data/rbi/lib/finch-api/models/location.rbi +16 -59
  191. data/rbi/lib/finch-api/models/money.rbi +7 -13
  192. data/rbi/lib/finch-api/models/operation_support.rbi +18 -7
  193. data/rbi/lib/finch-api/models/operation_support_matrix.rbi +65 -27
  194. data/rbi/lib/finch-api/models/paging.rbi +10 -12
  195. data/rbi/lib/finch-api/models/pay_statement_event.rbi +46 -32
  196. data/rbi/lib/finch-api/models/payment_event.rbi +39 -34
  197. data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +9 -13
  198. data/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +55 -30
  199. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +9 -2
  200. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +45 -46
  201. data/rbi/lib/finch-api/models/provider.rbi +873 -964
  202. data/rbi/lib/finch-api/models/provider_list_params.rbi +9 -2
  203. data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +20 -33
  204. data/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +40 -59
  205. data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +144 -166
  206. data/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +145 -174
  207. data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +43 -39
  208. data/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +38 -59
  209. data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +62 -39
  210. data/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +54 -62
  211. data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +17 -11
  212. data/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +55 -54
  213. data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +380 -332
  214. data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +1 -1
  215. data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +190 -194
  216. data/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +195 -198
  217. data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +151 -145
  218. data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +163 -151
  219. data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +22 -19
  220. data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +11 -31
  221. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +9 -2
  222. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +2 -1
  223. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +9 -2
  224. data/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +56 -26
  225. data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +409 -393
  226. data/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +6 -14
  227. data/rbi/lib/finch-api/models/webhook_event.rbi +4 -4
  228. data/rbi/lib/finch-api/page.rbi +5 -23
  229. data/rbi/lib/finch-api/pooled_net_requester.rbi +39 -16
  230. data/rbi/lib/finch-api/request_options.rbi +33 -54
  231. data/rbi/lib/finch-api/resources/access_tokens.rbi +4 -3
  232. data/rbi/lib/finch-api/resources/account.rbi +6 -4
  233. data/rbi/lib/finch-api/resources/connect/sessions.rbi +17 -8
  234. data/rbi/lib/finch-api/resources/connect.rbi +3 -4
  235. data/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +33 -10
  236. data/rbi/lib/finch-api/resources/hris/benefits.rbi +32 -13
  237. data/rbi/lib/finch-api/resources/hris/company.rbi +4 -3
  238. data/rbi/lib/finch-api/resources/hris/directory.rbi +11 -15
  239. data/rbi/lib/finch-api/resources/hris/documents.rbi +27 -7
  240. data/rbi/lib/finch-api/resources/hris/employments.rbi +10 -5
  241. data/rbi/lib/finch-api/resources/hris/individuals.rbi +6 -5
  242. data/rbi/lib/finch-api/resources/hris/pay_statements.rbi +13 -5
  243. data/rbi/lib/finch-api/resources/hris/payments.rbi +13 -4
  244. data/rbi/lib/finch-api/resources/hris.rbi +10 -18
  245. data/rbi/lib/finch-api/resources/jobs/automated.rbi +39 -10
  246. data/rbi/lib/finch-api/resources/jobs/manual.rbi +5 -3
  247. data/rbi/lib/finch-api/resources/jobs.rbi +4 -6
  248. data/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +6 -4
  249. data/rbi/lib/finch-api/resources/payroll.rbi +3 -4
  250. data/rbi/lib/finch-api/resources/providers.rbi +4 -3
  251. data/rbi/lib/finch-api/resources/request_forwarding.rbi +27 -4
  252. data/rbi/lib/finch-api/resources/sandbox/company.rbi +19 -7
  253. data/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +19 -7
  254. data/rbi/lib/finch-api/resources/sandbox/connections.rbi +10 -6
  255. data/rbi/lib/finch-api/resources/sandbox/directory.rbi +12 -6
  256. data/rbi/lib/finch-api/resources/sandbox/employment.rbi +30 -11
  257. data/rbi/lib/finch-api/resources/sandbox/individual.rbi +26 -8
  258. data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +9 -7
  259. data/rbi/lib/finch-api/resources/sandbox/jobs.rbi +11 -7
  260. data/rbi/lib/finch-api/resources/sandbox/payment.rbi +5 -4
  261. data/rbi/lib/finch-api/resources/sandbox.rbi +9 -16
  262. data/rbi/lib/finch-api/resources/webhooks.rbi +2 -2
  263. data/rbi/lib/finch-api/responses_page.rbi +4 -17
  264. data/rbi/lib/finch-api/single_page.rbi +4 -12
  265. data/rbi/lib/finch-api/util.rbi +228 -115
  266. data/rbi/lib/finch-api/version.rbi +1 -1
  267. data/sig/finch-api/base_client.rbs +20 -15
  268. data/sig/finch-api/base_model.rbs +36 -18
  269. data/sig/finch-api/base_page.rbs +1 -1
  270. data/sig/finch-api/client.rbs +8 -8
  271. data/sig/finch-api/errors.rbs +21 -21
  272. data/sig/finch-api/individuals_page.rbs +2 -7
  273. data/sig/finch-api/models/access_token_create_params.rbs +7 -12
  274. data/sig/finch-api/models/account_disconnect_params.rbs +1 -6
  275. data/sig/finch-api/models/account_introspect_params.rbs +1 -6
  276. data/sig/finch-api/models/account_update_event.rbs +204 -361
  277. data/sig/finch-api/models/base_webhook_event.rbs +5 -5
  278. data/sig/finch-api/models/company_event.rbs +13 -11
  279. data/sig/finch-api/models/connect/session_new_params.rbs +28 -32
  280. data/sig/finch-api/models/connect/session_new_response.rbs +1 -6
  281. data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +11 -14
  282. data/sig/finch-api/models/connect/session_reauthenticate_response.rbs +1 -6
  283. data/sig/finch-api/models/connection_status_type.rbs +4 -2
  284. data/sig/finch-api/models/create_access_token_response.rbs +20 -21
  285. data/sig/finch-api/models/directory_event.rbs +13 -19
  286. data/sig/finch-api/models/disconnect_response.rbs +1 -5
  287. data/sig/finch-api/models/employment_event.rbs +13 -19
  288. data/sig/finch-api/models/hris/benefit_contribution.rbs +8 -11
  289. data/sig/finch-api/models/hris/benefit_create_params.rbs +6 -11
  290. data/sig/finch-api/models/hris/benefit_features_and_operations.rbs +25 -29
  291. data/sig/finch-api/models/hris/benefit_frequency.rbs +4 -2
  292. data/sig/finch-api/models/hris/benefit_list_params.rbs +1 -6
  293. data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +1 -6
  294. data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +1 -6
  295. data/sig/finch-api/models/hris/benefit_type.rbs +4 -2
  296. data/sig/finch-api/models/hris/benefit_update_params.rbs +4 -6
  297. data/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +14 -18
  298. data/sig/finch-api/models/hris/benefits/individual_benefit.rbs +16 -25
  299. data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +35 -54
  300. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +1 -6
  301. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +4 -6
  302. data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +4 -9
  303. data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +4 -9
  304. data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +10 -16
  305. data/sig/finch-api/models/hris/benefits_support.rbs +14 -18
  306. data/sig/finch-api/models/hris/benfit_contribution.rbs +0 -1
  307. data/sig/finch-api/models/hris/company.rbs +39 -57
  308. data/sig/finch-api/models/hris/company_benefit.rbs +6 -10
  309. data/sig/finch-api/models/hris/company_retrieve_params.rbs +1 -6
  310. data/sig/finch-api/models/hris/create_company_benefits_response.rbs +1 -6
  311. data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +5 -10
  312. data/sig/finch-api/models/hris/directory_list_params.rbs +5 -10
  313. data/sig/finch-api/models/hris/document_list_params.rbs +11 -14
  314. data/sig/finch-api/models/hris/document_list_response.rbs +4 -9
  315. data/sig/finch-api/models/hris/document_response.rbs +11 -14
  316. data/sig/finch-api/models/hris/document_retreive_params.rbs +1 -6
  317. data/sig/finch-api/models/hris/document_retreive_response.rbs +4 -2
  318. data/sig/finch-api/models/hris/employment_data.rbs +41 -59
  319. data/sig/finch-api/models/hris/employment_data_response.rbs +5 -10
  320. data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +5 -15
  321. data/sig/finch-api/models/hris/individual.rbs +39 -45
  322. data/sig/finch-api/models/hris/individual_in_directory.rbs +11 -26
  323. data/sig/finch-api/models/hris/individual_response.rbs +5 -10
  324. data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +7 -22
  325. data/sig/finch-api/models/hris/pay_statement.rbs +75 -131
  326. data/sig/finch-api/models/hris/pay_statement_response.rbs +5 -10
  327. data/sig/finch-api/models/hris/pay_statement_response_body.rbs +4 -9
  328. data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +9 -15
  329. data/sig/finch-api/models/hris/payment.rbs +19 -26
  330. data/sig/finch-api/models/hris/payment_list_params.rbs +5 -10
  331. data/sig/finch-api/models/hris/support_per_benefit_type.rbs +4 -9
  332. data/sig/finch-api/models/hris/supported_benefit.rbs +22 -21
  333. data/sig/finch-api/models/hris/update_company_benefit_response.rbs +1 -6
  334. data/sig/finch-api/models/hris/w42005.rbs +26 -30
  335. data/sig/finch-api/models/hris/w42020.rbs +23 -25
  336. data/sig/finch-api/models/income.rbs +10 -10
  337. data/sig/finch-api/models/individual_event.rbs +13 -19
  338. data/sig/finch-api/models/introspection.rbs +43 -54
  339. data/sig/finch-api/models/job_completion_event.rbs +13 -20
  340. data/sig/finch-api/models/jobs/automated_async_job.rbs +20 -26
  341. data/sig/finch-api/models/jobs/automated_create_params.rbs +10 -18
  342. data/sig/finch-api/models/jobs/automated_create_response.rbs +6 -11
  343. data/sig/finch-api/models/jobs/automated_list_params.rbs +5 -10
  344. data/sig/finch-api/models/jobs/automated_list_response.rbs +82 -0
  345. data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +1 -6
  346. data/sig/finch-api/models/jobs/manual_async_job.rbs +9 -11
  347. data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +1 -6
  348. data/sig/finch-api/models/location.rbs +10 -12
  349. data/sig/finch-api/models/money.rbs +1 -3
  350. data/sig/finch-api/models/operation_support.rbs +4 -2
  351. data/sig/finch-api/models/operation_support_matrix.rbs +6 -10
  352. data/sig/finch-api/models/paging.rbs +1 -3
  353. data/sig/finch-api/models/pay_statement_event.rbs +13 -20
  354. data/sig/finch-api/models/payment_event.rbs +13 -17
  355. data/sig/finch-api/models/payroll/pay_group_list_params.rbs +5 -10
  356. data/sig/finch-api/models/payroll/pay_group_list_response.rbs +9 -12
  357. data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +1 -6
  358. data/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +10 -13
  359. data/sig/finch-api/models/provider.rbs +200 -347
  360. data/sig/finch-api/models/provider_list_params.rbs +1 -5
  361. data/sig/finch-api/models/request_forwarding_forward_params.rbs +8 -13
  362. data/sig/finch-api/models/request_forwarding_forward_response.rbs +13 -23
  363. data/sig/finch-api/models/sandbox/company_update_params.rbs +39 -58
  364. data/sig/finch-api/models/sandbox/company_update_response.rbs +38 -57
  365. data/sig/finch-api/models/sandbox/connection_create_params.rbs +11 -14
  366. data/sig/finch-api/models/sandbox/connection_create_response.rbs +14 -17
  367. data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +11 -14
  368. data/sig/finch-api/models/sandbox/connections/account_create_response.rbs +13 -16
  369. data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +4 -9
  370. data/sig/finch-api/models/sandbox/connections/account_update_response.rbs +12 -15
  371. data/sig/finch-api/models/sandbox/directory_create_params.rbs +76 -102
  372. data/sig/finch-api/models/sandbox/employment_update_params.rbs +40 -59
  373. data/sig/finch-api/models/sandbox/employment_update_response.rbs +40 -59
  374. data/sig/finch-api/models/sandbox/individual_update_params.rbs +39 -46
  375. data/sig/finch-api/models/sandbox/individual_update_response.rbs +39 -46
  376. data/sig/finch-api/models/sandbox/job_create_params.rbs +8 -11
  377. data/sig/finch-api/models/sandbox/job_create_response.rbs +6 -11
  378. data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +1 -6
  379. data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +1 -6
  380. data/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +12 -13
  381. data/sig/finch-api/models/sandbox/payment_create_params.rbs +81 -143
  382. data/sig/finch-api/models/sandbox/payment_create_response.rbs +1 -6
  383. data/sig/finch-api/models/webhook_event.rbs +5 -3
  384. data/sig/finch-api/page.rbs +2 -7
  385. data/sig/finch-api/pooled_net_requester.rbs +13 -4
  386. data/sig/finch-api/request_options.rbs +6 -2
  387. data/sig/finch-api/resources/access_tokens.rbs +7 -11
  388. data/sig/finch-api/resources/account.rbs +6 -16
  389. data/sig/finch-api/resources/connect/sessions.rbs +19 -29
  390. data/sig/finch-api/resources/hris/benefits/individuals.rbs +19 -43
  391. data/sig/finch-api/resources/hris/benefits.rbs +21 -48
  392. data/sig/finch-api/resources/hris/company.rbs +3 -8
  393. data/sig/finch-api/resources/hris/directory.rbs +6 -20
  394. data/sig/finch-api/resources/hris/documents.rbs +11 -22
  395. data/sig/finch-api/resources/hris/employments.rbs +4 -9
  396. data/sig/finch-api/resources/hris/individuals.rbs +5 -10
  397. data/sig/finch-api/resources/hris/pay_statements.rbs +4 -9
  398. data/sig/finch-api/resources/hris/payments.rbs +5 -10
  399. data/sig/finch-api/resources/jobs/automated.rbs +14 -30
  400. data/sig/finch-api/resources/jobs/manual.rbs +4 -10
  401. data/sig/finch-api/resources/payroll/pay_groups.rbs +9 -20
  402. data/sig/finch-api/resources/providers.rbs +3 -7
  403. data/sig/finch-api/resources/request_forwarding.rbs +8 -13
  404. data/sig/finch-api/resources/sandbox/company.rbs +11 -16
  405. data/sig/finch-api/resources/sandbox/connections/accounts.rbs +11 -21
  406. data/sig/finch-api/resources/sandbox/connections.rbs +7 -12
  407. data/sig/finch-api/resources/sandbox/directory.rbs +4 -9
  408. data/sig/finch-api/resources/sandbox/employment.rbs +22 -28
  409. data/sig/finch-api/resources/sandbox/individual.rbs +16 -22
  410. data/sig/finch-api/resources/sandbox/jobs/configuration.rbs +8 -18
  411. data/sig/finch-api/resources/sandbox/jobs.rbs +4 -9
  412. data/sig/finch-api/resources/sandbox/payment.rbs +6 -11
  413. data/sig/finch-api/responses_page.rbs +2 -7
  414. data/sig/finch-api/single_page.rbs +2 -7
  415. data/sig/finch-api/util.rbs +37 -12
  416. data/sig/finch-api/version.rbs +1 -1
  417. metadata +7 -4
@@ -7,25 +7,27 @@ module FinchAPI
7
7
  extend FinchAPI::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
+ # Array of individuals to create. Takes all combined fields from `/individual` and
11
+ # `/employment` endpoints. All fields are optional.
10
12
  sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body])) }
11
- def body
12
- end
13
+ attr_reader :body
13
14
 
14
15
  sig do
15
- params(_: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body])
16
- .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body])
17
- end
18
- def body=(_)
16
+ params(
17
+ body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)]
18
+ )
19
+ .void
19
20
  end
21
+ attr_writer :body
20
22
 
21
23
  sig do
22
24
  params(
23
- body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body],
24
- request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
25
+ body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)],
26
+ request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
25
27
  )
26
- .void
28
+ .returns(T.attached_class)
27
29
  end
28
- def initialize(body: nil, request_options: {})
30
+ def self.new(body: nil, request_options: {})
29
31
  end
30
32
 
31
33
  sig do
@@ -41,284 +43,212 @@ module FinchAPI
41
43
  end
42
44
 
43
45
  class Body < FinchAPI::BaseModel
46
+ # Worker's compensation classification code for this employee
44
47
  sig { returns(T.nilable(String)) }
45
- def class_code
46
- end
47
-
48
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
49
- def class_code=(_)
50
- end
48
+ attr_accessor :class_code
51
49
 
50
+ # Custom fields for the individual. These are fields which are defined by the
51
+ # employer in the system. Custom fields are not currently supported for assisted
52
+ # connections.
52
53
  sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField])) }
53
- def custom_fields
54
- end
54
+ attr_reader :custom_fields
55
55
 
56
56
  sig do
57
- params(_: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField])
58
- .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField])
59
- end
60
- def custom_fields=(_)
57
+ params(
58
+ custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)]
59
+ )
60
+ .void
61
61
  end
62
+ attr_writer :custom_fields
62
63
 
64
+ # The department object.
63
65
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department)) }
64
- def department
65
- end
66
+ attr_reader :department
66
67
 
67
68
  sig do
68
- params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department))
69
- .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department))
70
- end
71
- def department=(_)
69
+ params(
70
+ department: T.nilable(
71
+ T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash)
72
+ )
73
+ )
74
+ .void
72
75
  end
76
+ attr_writer :department
73
77
 
74
78
  sig { returns(T.nilable(String)) }
75
- def dob
76
- end
77
-
78
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
79
- def dob=(_)
80
- end
79
+ attr_accessor :dob
81
80
 
82
81
  sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email])) }
83
- def emails
84
- end
85
-
86
- sig do
87
- params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]))
88
- .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]))
89
- end
90
- def emails=(_)
91
- end
82
+ attr_accessor :emails
92
83
 
84
+ # The employment object.
93
85
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment)) }
94
- def employment
95
- end
86
+ attr_reader :employment
96
87
 
97
88
  sig do
98
- params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment))
99
- .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment))
100
- end
101
- def employment=(_)
102
- end
103
-
104
- sig { returns(T.nilable(Symbol)) }
105
- def employment_status
89
+ params(
90
+ employment: T.nilable(
91
+ T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash)
92
+ )
93
+ )
94
+ .void
106
95
  end
96
+ attr_writer :employment
107
97
 
108
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
109
- def employment_status=(_)
110
- end
98
+ # The detailed employment status of the individual.
99
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) }
100
+ attr_accessor :employment_status
111
101
 
102
+ # Social Security Number of the individual in **encrypted** format. This field is
103
+ # only available with the `ssn` scope enabled and the
104
+ # `options: { include: ['ssn'] }` param set in the body.
112
105
  sig { returns(T.nilable(String)) }
113
- def encrypted_ssn
114
- end
115
-
116
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
117
- def encrypted_ssn=(_)
118
- end
106
+ attr_accessor :encrypted_ssn
119
107
 
120
108
  sig { returns(T.nilable(String)) }
121
- def end_date
122
- end
123
-
124
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
125
- def end_date=(_)
126
- end
127
-
128
- sig { returns(T.nilable(Symbol)) }
129
- def ethnicity
130
- end
109
+ attr_accessor :end_date
131
110
 
132
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
133
- def ethnicity=(_)
134
- end
111
+ # The EEOC-defined ethnicity of the individual.
112
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) }
113
+ attr_accessor :ethnicity
135
114
 
115
+ # The legal first name of the individual.
136
116
  sig { returns(T.nilable(String)) }
137
- def first_name
138
- end
139
-
140
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
141
- def first_name=(_)
142
- end
117
+ attr_accessor :first_name
143
118
 
144
- sig { returns(T.nilable(Symbol)) }
145
- def gender
146
- end
147
-
148
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
149
- def gender=(_)
150
- end
119
+ # The gender of the individual.
120
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) }
121
+ attr_accessor :gender
151
122
 
123
+ # The employee's income as reported by the provider. This may not always be
124
+ # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
125
+ # depending on what information the provider returns.
152
126
  sig { returns(T.nilable(FinchAPI::Models::Income)) }
153
- def income
154
- end
127
+ attr_reader :income
155
128
 
156
- sig { params(_: T.nilable(FinchAPI::Models::Income)).returns(T.nilable(FinchAPI::Models::Income)) }
157
- def income=(_)
158
- end
129
+ sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))).void }
130
+ attr_writer :income
159
131
 
132
+ # The array of income history.
160
133
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) }
161
- def income_history
162
- end
163
-
164
- sig do
165
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]))
166
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]))
167
- end
168
- def income_history=(_)
169
- end
134
+ attr_accessor :income_history
170
135
 
136
+ # `true` if the individual an an active employee or contractor at the company.
171
137
  sig { returns(T.nilable(T::Boolean)) }
172
- def is_active
173
- end
174
-
175
- sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
176
- def is_active=(_)
177
- end
138
+ attr_accessor :is_active
178
139
 
140
+ # The legal last name of the individual.
179
141
  sig { returns(T.nilable(String)) }
180
- def last_name
181
- end
182
-
183
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
184
- def last_name=(_)
185
- end
142
+ attr_accessor :last_name
186
143
 
187
144
  sig { returns(T.nilable(String)) }
188
- def latest_rehire_date
189
- end
190
-
191
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
192
- def latest_rehire_date=(_)
193
- end
145
+ attr_accessor :latest_rehire_date
194
146
 
195
147
  sig { returns(T.nilable(FinchAPI::Models::Location)) }
196
- def location
197
- end
148
+ attr_reader :location
198
149
 
199
- sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) }
200
- def location=(_)
201
- end
150
+ sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void }
151
+ attr_writer :location
202
152
 
153
+ # The manager object representing the manager of the individual within the org.
203
154
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager)) }
204
- def manager
205
- end
155
+ attr_reader :manager
206
156
 
207
157
  sig do
208
- params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager))
209
- .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager))
210
- end
211
- def manager=(_)
158
+ params(
159
+ manager: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash))
160
+ )
161
+ .void
212
162
  end
163
+ attr_writer :manager
213
164
 
165
+ # The legal middle name of the individual.
214
166
  sig { returns(T.nilable(String)) }
215
- def middle_name
216
- end
217
-
218
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
219
- def middle_name=(_)
220
- end
167
+ attr_accessor :middle_name
221
168
 
222
169
  sig do
223
170
  returns(
224
171
  T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)])
225
172
  )
226
173
  end
227
- def phone_numbers
228
- end
229
-
230
- sig do
231
- params(
232
- _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)])
233
- )
234
- .returns(
235
- T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)])
236
- )
237
- end
238
- def phone_numbers=(_)
239
- end
174
+ attr_accessor :phone_numbers
240
175
 
176
+ # The preferred name of the individual.
241
177
  sig { returns(T.nilable(String)) }
242
- def preferred_name
243
- end
244
-
245
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
246
- def preferred_name=(_)
247
- end
178
+ attr_accessor :preferred_name
248
179
 
249
180
  sig { returns(T.nilable(FinchAPI::Models::Location)) }
250
- def residence
251
- end
181
+ attr_reader :residence
252
182
 
253
- sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) }
254
- def residence=(_)
255
- end
183
+ sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void }
184
+ attr_writer :residence
256
185
 
186
+ # The source system's unique employment identifier for this individual
257
187
  sig { returns(T.nilable(String)) }
258
- def source_id
259
- end
188
+ attr_reader :source_id
260
189
 
261
- sig { params(_: String).returns(String) }
262
- def source_id=(_)
263
- end
190
+ sig { params(source_id: String).void }
191
+ attr_writer :source_id
264
192
 
193
+ # Social Security Number of the individual. This field is only available with the
194
+ # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
195
+ # body.
196
+ # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
265
197
  sig { returns(T.nilable(String)) }
266
- def ssn
267
- end
268
-
269
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
270
- def ssn=(_)
271
- end
198
+ attr_accessor :ssn
272
199
 
273
200
  sig { returns(T.nilable(String)) }
274
- def start_date
275
- end
276
-
277
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
278
- def start_date=(_)
279
- end
201
+ attr_accessor :start_date
280
202
 
203
+ # The current title of the individual.
281
204
  sig { returns(T.nilable(String)) }
282
- def title
283
- end
284
-
285
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
286
- def title=(_)
287
- end
205
+ attr_accessor :title
288
206
 
289
207
  sig do
290
208
  params(
291
209
  class_code: T.nilable(String),
292
- custom_fields: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField],
293
- department: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department),
210
+ custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)],
211
+ department: T.nilable(
212
+ T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash)
213
+ ),
294
214
  dob: T.nilable(String),
295
- emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]),
296
- employment: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment),
297
- employment_status: T.nilable(Symbol),
215
+ emails: T.nilable(
216
+ T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email, FinchAPI::Util::AnyHash)]
217
+ ),
218
+ employment: T.nilable(
219
+ T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash)
220
+ ),
221
+ employment_status: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol),
298
222
  encrypted_ssn: T.nilable(String),
299
223
  end_date: T.nilable(String),
300
- ethnicity: T.nilable(Symbol),
224
+ ethnicity: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol),
301
225
  first_name: T.nilable(String),
302
- gender: T.nilable(Symbol),
303
- income: T.nilable(FinchAPI::Models::Income),
304
- income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]),
226
+ gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol),
227
+ income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)),
228
+ income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]),
305
229
  is_active: T.nilable(T::Boolean),
306
230
  last_name: T.nilable(String),
307
231
  latest_rehire_date: T.nilable(String),
308
- location: T.nilable(FinchAPI::Models::Location),
309
- manager: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager),
232
+ location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)),
233
+ manager: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)),
310
234
  middle_name: T.nilable(String),
311
- phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]),
235
+ phone_numbers: T.nilable(
236
+ T::Array[
237
+ T.nilable(
238
+ T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, FinchAPI::Util::AnyHash)
239
+ )
240
+ ]
241
+ ),
312
242
  preferred_name: T.nilable(String),
313
- residence: T.nilable(FinchAPI::Models::Location),
243
+ residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)),
314
244
  source_id: String,
315
245
  ssn: T.nilable(String),
316
246
  start_date: T.nilable(String),
317
247
  title: T.nilable(String)
318
248
  )
319
- .void
249
+ .returns(T.attached_class)
320
250
  end
321
- def initialize(
251
+ def self.new(
322
252
  class_code: nil,
323
253
  custom_fields: nil,
324
254
  department: nil,
@@ -359,12 +289,12 @@ module FinchAPI
359
289
  dob: T.nilable(String),
360
290
  emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]),
361
291
  employment: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment),
362
- employment_status: T.nilable(Symbol),
292
+ employment_status: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol),
363
293
  encrypted_ssn: T.nilable(String),
364
294
  end_date: T.nilable(String),
365
- ethnicity: T.nilable(Symbol),
295
+ ethnicity: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol),
366
296
  first_name: T.nilable(String),
367
- gender: T.nilable(Symbol),
297
+ gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol),
368
298
  income: T.nilable(FinchAPI::Models::Income),
369
299
  income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]),
370
300
  is_active: T.nilable(T::Boolean),
@@ -388,23 +318,16 @@ module FinchAPI
388
318
 
389
319
  class CustomField < FinchAPI::BaseModel
390
320
  sig { returns(T.nilable(String)) }
391
- def name
392
- end
393
-
394
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
395
- def name=(_)
396
- end
321
+ attr_accessor :name
397
322
 
398
323
  sig { returns(T.nilable(T.anything)) }
399
- def value
400
- end
324
+ attr_reader :value
401
325
 
402
- sig { params(_: T.anything).returns(T.anything) }
403
- def value=(_)
404
- end
326
+ sig { params(value: T.anything).void }
327
+ attr_writer :value
405
328
 
406
- sig { params(name: T.nilable(String), value: T.anything).void }
407
- def initialize(name: nil, value: nil)
329
+ sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) }
330
+ def self.new(name: nil, value: nil)
408
331
  end
409
332
 
410
333
  sig { override.returns({name: T.nilable(String), value: T.anything}) }
@@ -413,16 +336,13 @@ module FinchAPI
413
336
  end
414
337
 
415
338
  class Department < FinchAPI::BaseModel
339
+ # The name of the department associated with the individual.
416
340
  sig { returns(T.nilable(String)) }
417
- def name
418
- end
341
+ attr_accessor :name
419
342
 
420
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
421
- def name=(_)
422
- end
423
-
424
- sig { params(name: T.nilable(String)).void }
425
- def initialize(name: nil)
343
+ # The department object.
344
+ sig { params(name: T.nilable(String)).returns(T.attached_class) }
345
+ def self.new(name: nil)
426
346
  end
427
347
 
428
348
  sig { override.returns({name: T.nilable(String)}) }
@@ -432,153 +352,264 @@ module FinchAPI
432
352
 
433
353
  class Email < FinchAPI::BaseModel
434
354
  sig { returns(T.nilable(String)) }
435
- def data
436
- end
355
+ attr_reader :data
437
356
 
438
- sig { params(_: String).returns(String) }
439
- def data=(_)
440
- end
357
+ sig { params(data: String).void }
358
+ attr_writer :data
441
359
 
442
- sig { returns(T.nilable(Symbol)) }
443
- def type
444
- end
360
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) }
361
+ attr_accessor :type
445
362
 
446
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
447
- def type=(_)
363
+ sig do
364
+ params(
365
+ data: String,
366
+ type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)
367
+ )
368
+ .returns(T.attached_class)
448
369
  end
449
-
450
- sig { params(data: String, type: T.nilable(Symbol)).void }
451
- def initialize(data: nil, type: nil)
370
+ def self.new(data: nil, type: nil)
452
371
  end
453
372
 
454
- sig { override.returns({data: String, type: T.nilable(Symbol)}) }
373
+ sig do
374
+ override
375
+ .returns(
376
+ {data: String, type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)}
377
+ )
378
+ end
455
379
  def to_hash
456
380
  end
457
381
 
458
- class Type < FinchAPI::Enum
459
- abstract!
382
+ module Type
383
+ extend FinchAPI::Enum
384
+
385
+ TaggedSymbol =
386
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type) }
387
+ OrSymbol =
388
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) }
460
389
 
461
- WORK = T.let(:work, T.nilable(Symbol))
462
- PERSONAL = T.let(:personal, T.nilable(Symbol))
390
+ WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol)
391
+ PERSONAL =
392
+ T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol)
463
393
 
464
- sig { override.returns(T::Array[Symbol]) }
394
+ sig do
395
+ override
396
+ .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol])
397
+ end
465
398
  def self.values
466
399
  end
467
400
  end
468
401
  end
469
402
 
470
403
  class Employment < FinchAPI::BaseModel
471
- sig { returns(T.nilable(Symbol)) }
472
- def subtype
473
- end
474
-
475
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
476
- def subtype=(_)
404
+ # The secondary employment type of the individual. Options: `full_time`,
405
+ # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
406
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol)) }
407
+ attr_accessor :subtype
408
+
409
+ # The main employment type of the individual.
410
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) }
411
+ attr_accessor :type
412
+
413
+ # The employment object.
414
+ sig do
415
+ params(
416
+ subtype: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol),
417
+ type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)
418
+ )
419
+ .returns(T.attached_class)
477
420
  end
478
-
479
- sig { returns(T.nilable(Symbol)) }
480
- def type
421
+ def self.new(subtype: nil, type: nil)
481
422
  end
482
423
 
483
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
484
- def type=(_)
424
+ sig do
425
+ override
426
+ .returns(
427
+ {
428
+ subtype: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol),
429
+ type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)
430
+ }
431
+ )
485
432
  end
486
-
487
- sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void }
488
- def initialize(subtype: nil, type: nil)
489
- end
490
-
491
- sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) }
492
433
  def to_hash
493
434
  end
494
435
 
495
- class Subtype < FinchAPI::Enum
496
- abstract!
497
-
498
- FULL_TIME = T.let(:full_time, T.nilable(Symbol))
499
- INTERN = T.let(:intern, T.nilable(Symbol))
500
- PART_TIME = T.let(:part_time, T.nilable(Symbol))
501
- TEMP = T.let(:temp, T.nilable(Symbol))
502
- SEASONAL = T.let(:seasonal, T.nilable(Symbol))
503
- INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol))
504
-
505
- sig { override.returns(T::Array[Symbol]) }
436
+ # The secondary employment type of the individual. Options: `full_time`,
437
+ # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
438
+ module Subtype
439
+ extend FinchAPI::Enum
440
+
441
+ TaggedSymbol =
442
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype) }
443
+ OrSymbol =
444
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) }
445
+
446
+ FULL_TIME =
447
+ T.let(
448
+ :full_time,
449
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol
450
+ )
451
+ INTERN =
452
+ T.let(:intern, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol)
453
+ PART_TIME =
454
+ T.let(
455
+ :part_time,
456
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol
457
+ )
458
+ TEMP =
459
+ T.let(:temp, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol)
460
+ SEASONAL =
461
+ T.let(
462
+ :seasonal,
463
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol
464
+ )
465
+ INDIVIDUAL_CONTRACTOR =
466
+ T.let(
467
+ :individual_contractor,
468
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol
469
+ )
470
+
471
+ sig do
472
+ override
473
+ .returns(
474
+ T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol]
475
+ )
476
+ end
506
477
  def self.values
507
478
  end
508
479
  end
509
480
 
510
- class Type < FinchAPI::Enum
511
- abstract!
481
+ # The main employment type of the individual.
482
+ module Type
483
+ extend FinchAPI::Enum
512
484
 
513
- EMPLOYEE = T.let(:employee, T.nilable(Symbol))
514
- CONTRACTOR = T.let(:contractor, T.nilable(Symbol))
485
+ TaggedSymbol =
486
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type) }
487
+ OrSymbol =
488
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) }
515
489
 
516
- sig { override.returns(T::Array[Symbol]) }
490
+ EMPLOYEE =
491
+ T.let(:employee, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol)
492
+ CONTRACTOR =
493
+ T.let(:contractor, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol)
494
+
495
+ sig do
496
+ override
497
+ .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol])
498
+ end
517
499
  def self.values
518
500
  end
519
501
  end
520
502
  end
521
503
 
522
- class EmploymentStatus < FinchAPI::Enum
523
- abstract!
504
+ # The detailed employment status of the individual.
505
+ module EmploymentStatus
506
+ extend FinchAPI::Enum
524
507
 
525
- ACTIVE = T.let(:active, T.nilable(Symbol))
526
- DECEASED = T.let(:deceased, T.nilable(Symbol))
527
- LEAVE = T.let(:leave, T.nilable(Symbol))
528
- ONBOARDING = T.let(:onboarding, T.nilable(Symbol))
529
- PREHIRE = T.let(:prehire, T.nilable(Symbol))
530
- RETIRED = T.let(:retired, T.nilable(Symbol))
531
- TERMINATED = T.let(:terminated, T.nilable(Symbol))
508
+ TaggedSymbol =
509
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus) }
510
+ OrSymbol =
511
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) }
532
512
 
533
- sig { override.returns(T::Array[Symbol]) }
513
+ ACTIVE =
514
+ T.let(:active, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
515
+ DECEASED =
516
+ T.let(:deceased, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
517
+ LEAVE =
518
+ T.let(:leave, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
519
+ ONBOARDING =
520
+ T.let(:onboarding, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
521
+ PREHIRE =
522
+ T.let(:prehire, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
523
+ RETIRED =
524
+ T.let(:retired, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
525
+ TERMINATED =
526
+ T.let(:terminated, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol)
527
+
528
+ sig do
529
+ override
530
+ .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol])
531
+ end
534
532
  def self.values
535
533
  end
536
534
  end
537
535
 
538
- class Ethnicity < FinchAPI::Enum
539
- abstract!
536
+ # The EEOC-defined ethnicity of the individual.
537
+ module Ethnicity
538
+ extend FinchAPI::Enum
540
539
 
541
- ASIAN = T.let(:asian, T.nilable(Symbol))
542
- WHITE = T.let(:white, T.nilable(Symbol))
543
- BLACK_OR_AFRICAN_AMERICAN = T.let(:black_or_african_american, T.nilable(Symbol))
544
- NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let(
545
- :native_hawaiian_or_pacific_islander,
546
- T.nilable(Symbol)
547
- )
548
- AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let(:american_indian_or_alaska_native, T.nilable(Symbol))
549
- HISPANIC_OR_LATINO = T.let(:hispanic_or_latino, T.nilable(Symbol))
550
- TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol))
551
- DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol))
540
+ TaggedSymbol =
541
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity) }
542
+ OrSymbol =
543
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) }
544
+
545
+ ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol)
546
+ WHITE = T.let(:white, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol)
547
+ BLACK_OR_AFRICAN_AMERICAN =
548
+ T.let(
549
+ :black_or_african_american,
550
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol
551
+ )
552
+ NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER =
553
+ T.let(
554
+ :native_hawaiian_or_pacific_islander,
555
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol
556
+ )
557
+ AMERICAN_INDIAN_OR_ALASKA_NATIVE =
558
+ T.let(
559
+ :american_indian_or_alaska_native,
560
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol
561
+ )
562
+ HISPANIC_OR_LATINO =
563
+ T.let(
564
+ :hispanic_or_latino,
565
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol
566
+ )
567
+ TWO_OR_MORE_RACES =
568
+ T.let(:two_or_more_races, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol)
569
+ DECLINE_TO_SPECIFY =
570
+ T.let(
571
+ :decline_to_specify,
572
+ FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol
573
+ )
552
574
 
553
- sig { override.returns(T::Array[Symbol]) }
575
+ sig do
576
+ override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol])
577
+ end
554
578
  def self.values
555
579
  end
556
580
  end
557
581
 
558
- class Gender < FinchAPI::Enum
559
- abstract!
582
+ # The gender of the individual.
583
+ module Gender
584
+ extend FinchAPI::Enum
585
+
586
+ TaggedSymbol =
587
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender) }
588
+ OrSymbol =
589
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) }
560
590
 
561
- FEMALE = T.let(:female, T.nilable(Symbol))
562
- MALE = T.let(:male, T.nilable(Symbol))
563
- OTHER = T.let(:other, T.nilable(Symbol))
564
- DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol))
591
+ FEMALE = T.let(:female, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol)
592
+ MALE = T.let(:male, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol)
593
+ OTHER = T.let(:other, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol)
594
+ DECLINE_TO_SPECIFY =
595
+ T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol)
565
596
 
566
- sig { override.returns(T::Array[Symbol]) }
597
+ sig { override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol]) }
567
598
  def self.values
568
599
  end
569
600
  end
570
601
 
571
602
  class Manager < FinchAPI::BaseModel
603
+ # A stable Finch `id` (UUID v4) for an individual in the company.
572
604
  sig { returns(T.nilable(String)) }
573
- def id
574
- end
575
-
576
- sig { params(_: String).returns(String) }
577
- def id=(_)
578
- end
605
+ attr_reader :id
579
606
 
580
607
  sig { params(id: String).void }
581
- def initialize(id: nil)
608
+ attr_writer :id
609
+
610
+ # The manager object representing the manager of the individual within the org.
611
+ sig { params(id: String).returns(T.attached_class) }
612
+ def self.new(id: nil)
582
613
  end
583
614
 
584
615
  sig { override.returns({id: String}) }
@@ -588,36 +619,53 @@ module FinchAPI
588
619
 
589
620
  class PhoneNumber < FinchAPI::BaseModel
590
621
  sig { returns(T.nilable(String)) }
591
- def data
592
- end
622
+ attr_reader :data
593
623
 
594
- sig { params(_: String).returns(String) }
595
- def data=(_)
596
- end
624
+ sig { params(data: String).void }
625
+ attr_writer :data
597
626
 
598
- sig { returns(T.nilable(Symbol)) }
599
- def type
600
- end
627
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) }
628
+ attr_accessor :type
601
629
 
602
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
603
- def type=(_)
630
+ sig do
631
+ params(
632
+ data: String,
633
+ type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)
634
+ )
635
+ .returns(T.attached_class)
604
636
  end
605
-
606
- sig { params(data: String, type: T.nilable(Symbol)).void }
607
- def initialize(data: nil, type: nil)
637
+ def self.new(data: nil, type: nil)
608
638
  end
609
639
 
610
- sig { override.returns({data: String, type: T.nilable(Symbol)}) }
640
+ sig do
641
+ override
642
+ .returns(
643
+ {
644
+ data: String,
645
+ type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)
646
+ }
647
+ )
648
+ end
611
649
  def to_hash
612
650
  end
613
651
 
614
- class Type < FinchAPI::Enum
615
- abstract!
652
+ module Type
653
+ extend FinchAPI::Enum
616
654
 
617
- WORK = T.let(:work, T.nilable(Symbol))
618
- PERSONAL = T.let(:personal, T.nilable(Symbol))
655
+ TaggedSymbol =
656
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type) }
657
+ OrSymbol =
658
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) }
619
659
 
620
- sig { override.returns(T::Array[Symbol]) }
660
+ WORK =
661
+ T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol)
662
+ PERSONAL =
663
+ T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol)
664
+
665
+ sig do
666
+ override
667
+ .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol])
668
+ end
621
669
  def self.values
622
670
  end
623
671
  end