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
@@ -13,40 +13,22 @@ module FinchAPI
13
13
  end
14
14
 
15
15
  # Finch id (uuidv4) for the pay group
16
- sig { returns(T.nilable(String)) }
17
- attr_reader :id
18
-
19
- sig { params(id: String).void }
20
- attr_writer :id
16
+ sig { returns(String) }
17
+ attr_accessor :id
21
18
 
22
19
  # Name of the pay group
23
- sig { returns(T.nilable(String)) }
24
- attr_reader :name
25
-
26
- sig { params(name: String).void }
27
- attr_writer :name
20
+ sig { returns(String) }
21
+ attr_accessor :name
28
22
 
29
23
  # List of pay frequencies associated with this pay group
30
24
  sig do
31
25
  returns(
32
- T.nilable(
33
- T::Array[
34
- FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
35
- ]
36
- )
26
+ T::Array[
27
+ FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
28
+ ]
37
29
  )
38
30
  end
39
- attr_reader :pay_frequencies
40
-
41
- sig do
42
- params(
43
- pay_frequencies:
44
- T::Array[
45
- FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol
46
- ]
47
- ).void
48
- end
49
- attr_writer :pay_frequencies
31
+ attr_accessor :pay_frequencies
50
32
 
51
33
  sig do
52
34
  params(
@@ -60,11 +42,11 @@ module FinchAPI
60
42
  end
61
43
  def self.new(
62
44
  # Finch id (uuidv4) for the pay group
63
- id: nil,
45
+ id:,
64
46
  # Name of the pay group
65
- name: nil,
47
+ name:,
66
48
  # List of pay frequencies associated with this pay group
67
- pay_frequencies: nil
49
+ pay_frequencies:
68
50
  )
69
51
  end
70
52
 
@@ -100,14 +82,14 @@ module FinchAPI
100
82
  :annually,
101
83
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
102
84
  )
103
- SEMI_ANNUALLY =
85
+ BI_WEEKLY =
104
86
  T.let(
105
- :semi_annually,
87
+ :bi_weekly,
106
88
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
107
89
  )
108
- QUARTERLY =
90
+ DAILY =
109
91
  T.let(
110
- :quarterly,
92
+ :daily,
111
93
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
112
94
  )
113
95
  MONTHLY =
@@ -115,29 +97,29 @@ module FinchAPI
115
97
  :monthly,
116
98
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
117
99
  )
118
- SEMI_MONTHLY =
100
+ OTHER =
119
101
  T.let(
120
- :semi_monthly,
102
+ :other,
121
103
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
122
104
  )
123
- BI_WEEKLY =
105
+ QUARTERLY =
124
106
  T.let(
125
- :bi_weekly,
107
+ :quarterly,
126
108
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
127
109
  )
128
- WEEKLY =
110
+ SEMI_ANNUALLY =
129
111
  T.let(
130
- :weekly,
112
+ :semi_annually,
131
113
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
132
114
  )
133
- DAILY =
115
+ SEMI_MONTHLY =
134
116
  T.let(
135
- :daily,
117
+ :semi_monthly,
136
118
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
137
119
  )
138
- OTHER =
120
+ WEEKLY =
139
121
  T.let(
140
- :other,
122
+ :weekly,
141
123
  FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol
142
124
  )
143
125
 
@@ -88,14 +88,14 @@ module FinchAPI
88
88
  :annually,
89
89
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
90
90
  )
91
- SEMI_ANNUALLY =
91
+ BI_WEEKLY =
92
92
  T.let(
93
- :semi_annually,
93
+ :bi_weekly,
94
94
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
95
95
  )
96
- QUARTERLY =
96
+ DAILY =
97
97
  T.let(
98
- :quarterly,
98
+ :daily,
99
99
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
100
100
  )
101
101
  MONTHLY =
@@ -103,29 +103,29 @@ module FinchAPI
103
103
  :monthly,
104
104
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
105
105
  )
106
- SEMI_MONTHLY =
106
+ OTHER =
107
107
  T.let(
108
- :semi_monthly,
108
+ :other,
109
109
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
110
110
  )
111
- BI_WEEKLY =
111
+ QUARTERLY =
112
112
  T.let(
113
- :bi_weekly,
113
+ :quarterly,
114
114
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
115
115
  )
116
- WEEKLY =
116
+ SEMI_ANNUALLY =
117
117
  T.let(
118
- :weekly,
118
+ :semi_annually,
119
119
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
120
120
  )
121
- DAILY =
121
+ SEMI_MONTHLY =
122
122
  T.let(
123
- :daily,
123
+ :semi_monthly,
124
124
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
125
125
  )
126
- OTHER =
126
+ WEEKLY =
127
127
  T.let(
128
- :other,
128
+ :weekly,
129
129
  FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol
130
130
  )
131
131
 
@@ -83,17 +83,7 @@ module FinchAPI
83
83
  )
84
84
  )
85
85
  end
86
- attr_reader :custom_fields
87
-
88
- sig do
89
- params(
90
- custom_fields:
91
- T::Array[
92
- FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash
93
- ]
94
- ).void
95
- end
96
- attr_writer :custom_fields
86
+ attr_accessor :custom_fields
97
87
 
98
88
  # The department object.
99
89
  sig do
@@ -147,7 +137,8 @@ module FinchAPI
147
137
  end
148
138
  attr_writer :employment
149
139
 
150
- # The detailed employment status of the individual.
140
+ # The detailed employment status of the individual. Available options: `active`,
141
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
151
142
  sig do
152
143
  returns(
153
144
  T.nilable(
@@ -267,10 +258,7 @@ module FinchAPI
267
258
 
268
259
  # The source system's unique employment identifier for this individual
269
260
  sig { returns(T.nilable(String)) }
270
- attr_reader :source_id
271
-
272
- sig { params(source_id: String).void }
273
- attr_writer :source_id
261
+ attr_accessor :source_id
274
262
 
275
263
  # Social Security Number of the individual. This field is only available with the
276
264
  # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
@@ -290,9 +278,11 @@ module FinchAPI
290
278
  params(
291
279
  class_code: T.nilable(String),
292
280
  custom_fields:
293
- T::Array[
294
- FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash
295
- ],
281
+ T.nilable(
282
+ T::Array[
283
+ FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash
284
+ ]
285
+ ),
296
286
  department:
297
287
  T.nilable(
298
288
  FinchAPI::Sandbox::DirectoryCreateParams::Body::Department::OrHash
@@ -345,7 +335,7 @@ module FinchAPI
345
335
  ),
346
336
  preferred_name: T.nilable(String),
347
337
  residence: T.nilable(FinchAPI::Location::OrHash),
348
- source_id: String,
338
+ source_id: T.nilable(String),
349
339
  ssn: T.nilable(String),
350
340
  start_date: T.nilable(String),
351
341
  title: T.nilable(String)
@@ -364,7 +354,8 @@ module FinchAPI
364
354
  emails: nil,
365
355
  # The employment object.
366
356
  employment: nil,
367
- # The detailed employment status of the individual.
357
+ # The detailed employment status of the individual. Available options: `active`,
358
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
368
359
  employment_status: nil,
369
360
  # Social Security Number of the individual in **encrypted** format. This field is
370
361
  # only available with the `ssn` scope enabled and the
@@ -415,9 +406,11 @@ module FinchAPI
415
406
  {
416
407
  class_code: T.nilable(String),
417
408
  custom_fields:
418
- T::Array[
419
- FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField
420
- ],
409
+ T.nilable(
410
+ T::Array[
411
+ FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField
412
+ ]
413
+ ),
421
414
  department:
422
415
  T.nilable(
423
416
  FinchAPI::Sandbox::DirectoryCreateParams::Body::Department
@@ -470,7 +463,7 @@ module FinchAPI
470
463
  ),
471
464
  preferred_name: T.nilable(String),
472
465
  residence: T.nilable(FinchAPI::Location),
473
- source_id: String,
466
+ source_id: T.nilable(String),
474
467
  ssn: T.nilable(String),
475
468
  start_date: T.nilable(String),
476
469
  title: T.nilable(String)
@@ -785,7 +778,8 @@ module FinchAPI
785
778
  end
786
779
  end
787
780
 
788
- # The detailed employment status of the individual.
781
+ # The detailed employment status of the individual. Available options: `active`,
782
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
789
783
  module EmploymentStatus
790
784
  extend FinchAPI::Internal::Type::Enum
791
785
 
@@ -29,17 +29,7 @@ module FinchAPI
29
29
  )
30
30
  )
31
31
  end
32
- attr_reader :custom_fields
33
-
34
- sig do
35
- params(
36
- custom_fields:
37
- T::Array[
38
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
39
- ]
40
- ).void
41
- end
42
- attr_writer :custom_fields
32
+ attr_accessor :custom_fields
43
33
 
44
34
  # The department object.
45
35
  sig do
@@ -77,7 +67,8 @@ module FinchAPI
77
67
  end
78
68
  attr_writer :employment
79
69
 
80
- # The detailed employment status of the individual.
70
+ # The detailed employment status of the individual. Available options: `active`,
71
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
81
72
  sig do
82
73
  returns(
83
74
  T.nilable(
@@ -146,10 +137,7 @@ module FinchAPI
146
137
 
147
138
  # The source system's unique employment identifier for this individual
148
139
  sig { returns(T.nilable(String)) }
149
- attr_reader :source_id
150
-
151
- sig { params(source_id: String).void }
152
- attr_writer :source_id
140
+ attr_accessor :source_id
153
141
 
154
142
  sig { returns(T.nilable(String)) }
155
143
  attr_accessor :start_date
@@ -162,9 +150,11 @@ module FinchAPI
162
150
  params(
163
151
  class_code: T.nilable(String),
164
152
  custom_fields:
165
- T::Array[
166
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
167
- ],
153
+ T.nilable(
154
+ T::Array[
155
+ FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
156
+ ]
157
+ ),
168
158
  department:
169
159
  T.nilable(
170
160
  FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash
@@ -191,7 +181,7 @@ module FinchAPI
191
181
  FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash
192
182
  ),
193
183
  middle_name: T.nilable(String),
194
- source_id: String,
184
+ source_id: T.nilable(String),
195
185
  start_date: T.nilable(String),
196
186
  title: T.nilable(String),
197
187
  request_options: FinchAPI::RequestOptions::OrHash
@@ -208,7 +198,8 @@ module FinchAPI
208
198
  department: nil,
209
199
  # The employment object.
210
200
  employment: nil,
211
- # The detailed employment status of the individual.
201
+ # The detailed employment status of the individual. Available options: `active`,
202
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
212
203
  employment_status: nil,
213
204
  end_date: nil,
214
205
  # The legal first name of the individual.
@@ -243,9 +234,11 @@ module FinchAPI
243
234
  {
244
235
  class_code: T.nilable(String),
245
236
  custom_fields:
246
- T::Array[
247
- FinchAPI::Sandbox::EmploymentUpdateParams::CustomField
248
- ],
237
+ T.nilable(
238
+ T::Array[
239
+ FinchAPI::Sandbox::EmploymentUpdateParams::CustomField
240
+ ]
241
+ ),
249
242
  department:
250
243
  T.nilable(
251
244
  FinchAPI::Sandbox::EmploymentUpdateParams::Department
@@ -269,7 +262,7 @@ module FinchAPI
269
262
  manager:
270
263
  T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Manager),
271
264
  middle_name: T.nilable(String),
272
- source_id: String,
265
+ source_id: T.nilable(String),
273
266
  start_date: T.nilable(String),
274
267
  title: T.nilable(String),
275
268
  request_options: FinchAPI::RequestOptions
@@ -499,7 +492,8 @@ module FinchAPI
499
492
  end
500
493
  end
501
494
 
502
- # The detailed employment status of the individual.
495
+ # The detailed employment status of the individual. Available options: `active`,
496
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
503
497
  module EmploymentStatus
504
498
  extend FinchAPI::Internal::Type::Enum
505
499
 
@@ -35,17 +35,7 @@ module FinchAPI
35
35
  )
36
36
  )
37
37
  end
38
- attr_reader :custom_fields
39
-
40
- sig do
41
- params(
42
- custom_fields:
43
- T::Array[
44
- FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash
45
- ]
46
- ).void
47
- end
48
- attr_writer :custom_fields
38
+ attr_accessor :custom_fields
49
39
 
50
40
  # The department object.
51
41
  sig do
@@ -87,7 +77,8 @@ module FinchAPI
87
77
  end
88
78
  attr_writer :employment
89
79
 
90
- # The detailed employment status of the individual.
80
+ # The detailed employment status of the individual. Available options: `active`,
81
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
91
82
  sig do
92
83
  returns(
93
84
  T.nilable(
@@ -160,10 +151,7 @@ module FinchAPI
160
151
 
161
152
  # The source system's unique employment identifier for this individual
162
153
  sig { returns(T.nilable(String)) }
163
- attr_reader :source_id
164
-
165
- sig { params(source_id: String).void }
166
- attr_writer :source_id
154
+ attr_accessor :source_id
167
155
 
168
156
  sig { returns(T.nilable(String)) }
169
157
  attr_accessor :start_date
@@ -177,9 +165,11 @@ module FinchAPI
177
165
  id: String,
178
166
  class_code: T.nilable(String),
179
167
  custom_fields:
180
- T::Array[
181
- FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash
182
- ],
168
+ T.nilable(
169
+ T::Array[
170
+ FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash
171
+ ]
172
+ ),
183
173
  department:
184
174
  T.nilable(
185
175
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department::OrHash
@@ -206,7 +196,7 @@ module FinchAPI
206
196
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager::OrHash
207
197
  ),
208
198
  middle_name: T.nilable(String),
209
- source_id: String,
199
+ source_id: T.nilable(String),
210
200
  start_date: T.nilable(String),
211
201
  title: T.nilable(String)
212
202
  ).returns(T.attached_class)
@@ -224,7 +214,8 @@ module FinchAPI
224
214
  department: nil,
225
215
  # The employment object.
226
216
  employment: nil,
227
- # The detailed employment status of the individual.
217
+ # The detailed employment status of the individual. Available options: `active`,
218
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
228
219
  employment_status: nil,
229
220
  end_date: nil,
230
221
  # The legal first name of the individual.
@@ -259,9 +250,11 @@ module FinchAPI
259
250
  id: String,
260
251
  class_code: T.nilable(String),
261
252
  custom_fields:
262
- T::Array[
263
- FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField
264
- ],
253
+ T.nilable(
254
+ T::Array[
255
+ FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField
256
+ ]
257
+ ),
265
258
  department:
266
259
  T.nilable(
267
260
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department
@@ -287,7 +280,7 @@ module FinchAPI
287
280
  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager
288
281
  ),
289
282
  middle_name: T.nilable(String),
290
- source_id: String,
283
+ source_id: T.nilable(String),
291
284
  start_date: T.nilable(String),
292
285
  title: T.nilable(String)
293
286
  }
@@ -516,7 +509,8 @@ module FinchAPI
516
509
  end
517
510
  end
518
511
 
519
- # The detailed employment status of the individual.
512
+ # The detailed employment status of the individual. Available options: `active`,
513
+ # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
520
514
  module EmploymentStatus
521
515
  extend FinchAPI::Internal::Type::Enum
522
516