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

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 +24 -131
  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 +15 -73
  61. data/lib/finch-api/models/sandbox/individual_update_response.rb +15 -73
  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 +377 -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 +148 -145
  218. data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +160 -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 +78 -106
  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 +41 -50
  375. data/sig/finch-api/models/sandbox/individual_update_response.rbs +41 -50
  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
@@ -4,114 +4,74 @@ module FinchAPI
4
4
  module Models
5
5
  module HRIS
6
6
  class PayStatement < FinchAPI::BaseModel
7
+ # The array of earnings objects associated with this pay statement
7
8
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)])) }
8
- def earnings
9
- end
10
-
11
- sig do
12
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)]))
13
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)]))
14
- end
15
- def earnings=(_)
16
- end
9
+ attr_accessor :earnings
17
10
 
11
+ # The array of deductions objects associated with this pay statement.
18
12
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)])) }
19
- def employee_deductions
20
- end
21
-
22
- sig do
23
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)]))
24
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)]))
25
- end
26
- def employee_deductions=(_)
27
- end
13
+ attr_accessor :employee_deductions
28
14
 
29
15
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)])) }
30
- def employer_contributions
31
- end
32
-
33
- sig do
34
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)]))
35
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)]))
36
- end
37
- def employer_contributions=(_)
38
- end
16
+ attr_accessor :employer_contributions
39
17
 
40
18
  sig { returns(T.nilable(FinchAPI::Models::Money)) }
41
- def gross_pay
42
- end
19
+ attr_reader :gross_pay
43
20
 
44
- sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
45
- def gross_pay=(_)
46
- end
21
+ sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void }
22
+ attr_writer :gross_pay
47
23
 
24
+ # A stable Finch `id` (UUID v4) for an individual in the company
48
25
  sig { returns(T.nilable(String)) }
49
- def individual_id
50
- end
26
+ attr_reader :individual_id
51
27
 
52
- sig { params(_: String).returns(String) }
53
- def individual_id=(_)
54
- end
28
+ sig { params(individual_id: String).void }
29
+ attr_writer :individual_id
55
30
 
56
31
  sig { returns(T.nilable(FinchAPI::Models::Money)) }
57
- def net_pay
58
- end
32
+ attr_reader :net_pay
59
33
 
60
- sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
61
- def net_pay=(_)
62
- end
34
+ sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void }
35
+ attr_writer :net_pay
63
36
 
64
- sig { returns(T.nilable(Symbol)) }
65
- def payment_method
66
- end
67
-
68
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
69
- def payment_method=(_)
70
- end
37
+ # The payment method.
38
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) }
39
+ attr_accessor :payment_method
71
40
 
41
+ # The array of taxes objects associated with this pay statement.
72
42
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)])) }
73
- def taxes
74
- end
75
-
76
- sig do
77
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]))
78
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]))
79
- end
80
- def taxes=(_)
81
- end
43
+ attr_accessor :taxes
82
44
 
45
+ # The number of hours worked for this pay period
83
46
  sig { returns(T.nilable(Float)) }
84
- def total_hours
85
- end
86
-
87
- sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) }
88
- def total_hours=(_)
89
- end
47
+ attr_accessor :total_hours
90
48
 
91
- sig { returns(T.nilable(Symbol)) }
92
- def type
93
- end
94
-
95
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
96
- def type=(_)
97
- end
49
+ # The type of the payment associated with the pay statement.
50
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) }
51
+ attr_accessor :type
98
52
 
99
53
  sig do
100
54
  params(
101
- earnings: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)]),
102
- employee_deductions: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)]),
103
- employer_contributions: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)]),
104
- gross_pay: T.nilable(FinchAPI::Models::Money),
55
+ earnings: T.nilable(
56
+ T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning, FinchAPI::Util::AnyHash))]
57
+ ),
58
+ employee_deductions: T.nilable(
59
+ T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, FinchAPI::Util::AnyHash))]
60
+ ),
61
+ employer_contributions: T.nilable(
62
+ T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution, FinchAPI::Util::AnyHash))]
63
+ ),
64
+ gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)),
105
65
  individual_id: String,
106
- net_pay: T.nilable(FinchAPI::Models::Money),
107
- payment_method: T.nilable(Symbol),
108
- taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]),
66
+ net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)),
67
+ payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::OrSymbol),
68
+ taxes: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax, FinchAPI::Util::AnyHash))]),
109
69
  total_hours: T.nilable(Float),
110
- type: T.nilable(Symbol)
70
+ type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::OrSymbol)
111
71
  )
112
- .void
72
+ .returns(T.attached_class)
113
73
  end
114
- def initialize(
74
+ def self.new(
115
75
  earnings: nil,
116
76
  employee_deductions: nil,
117
77
  employer_contributions: nil,
@@ -135,10 +95,10 @@ module FinchAPI
135
95
  gross_pay: T.nilable(FinchAPI::Models::Money),
136
96
  individual_id: String,
137
97
  net_pay: T.nilable(FinchAPI::Models::Money),
138
- payment_method: T.nilable(Symbol),
98
+ payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol),
139
99
  taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]),
140
100
  total_hours: T.nilable(Float),
141
- type: T.nilable(Symbol)
101
+ type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)
142
102
  }
143
103
  )
144
104
  end
@@ -146,69 +106,50 @@ module FinchAPI
146
106
  end
147
107
 
148
108
  class Earning < FinchAPI::BaseModel
109
+ # The earnings amount in cents.
149
110
  sig { returns(T.nilable(Integer)) }
150
- def amount
151
- end
152
-
153
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
154
- def amount=(_)
155
- end
111
+ attr_accessor :amount
156
112
 
157
113
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes)) }
158
- def attributes
159
- end
114
+ attr_reader :attributes
160
115
 
161
116
  sig do
162
- params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes))
163
- .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes))
164
- end
165
- def attributes=(_)
117
+ params(
118
+ attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash))
119
+ )
120
+ .void
166
121
  end
122
+ attr_writer :attributes
167
123
 
124
+ # The earnings currency code.
168
125
  sig { returns(T.nilable(String)) }
169
- def currency
170
- end
171
-
172
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
173
- def currency=(_)
174
- end
126
+ attr_accessor :currency
175
127
 
128
+ # The number of hours associated with this earning. (For salaried employees, this
129
+ # could be hours per pay period, `0` or `null`, depending on the provider).
176
130
  sig { returns(T.nilable(Float)) }
177
- def hours
178
- end
179
-
180
- sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) }
181
- def hours=(_)
182
- end
131
+ attr_accessor :hours
183
132
 
133
+ # The exact name of the deduction from the pay statement.
184
134
  sig { returns(T.nilable(String)) }
185
- def name
186
- end
187
-
188
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
189
- def name=(_)
190
- end
135
+ attr_accessor :name
191
136
 
192
- sig { returns(T.nilable(Symbol)) }
193
- def type
194
- end
195
-
196
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
197
- def type=(_)
198
- end
137
+ # The type of earning.
138
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) }
139
+ attr_accessor :type
199
140
 
200
141
  sig do
201
142
  params(
202
143
  amount: T.nilable(Integer),
203
- attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes),
144
+ attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)),
204
145
  currency: T.nilable(String),
205
146
  hours: T.nilable(Float),
206
147
  name: T.nilable(String),
207
- type: T.nilable(Symbol)
148
+ type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::OrSymbol)
208
149
  )
209
- .void
150
+ .returns(T.attached_class)
210
151
  end
211
- def initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
152
+ def self.new(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
212
153
  end
213
154
 
214
155
  sig do
@@ -220,7 +161,7 @@ module FinchAPI
220
161
  currency: T.nilable(String),
221
162
  hours: T.nilable(Float),
222
163
  name: T.nilable(String),
223
- type: T.nilable(Symbol)
164
+ type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
224
165
  }
225
166
  )
226
167
  end
@@ -229,18 +170,23 @@ module FinchAPI
229
170
 
230
171
  class Attributes < FinchAPI::BaseModel
231
172
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata)) }
232
- def metadata
233
- end
173
+ attr_reader :metadata
234
174
 
235
175
  sig do
236
- params(_: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata)
237
- .returns(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata)
238
- end
239
- def metadata=(_)
176
+ params(
177
+ metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash)
178
+ )
179
+ .void
240
180
  end
181
+ attr_writer :metadata
241
182
 
242
- sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata).void }
243
- def initialize(metadata: nil)
183
+ sig do
184
+ params(
185
+ metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash)
186
+ )
187
+ .returns(T.attached_class)
188
+ end
189
+ def self.new(metadata: nil)
244
190
  end
245
191
 
246
192
  sig { override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata}) }
@@ -248,16 +194,17 @@ module FinchAPI
248
194
  end
249
195
 
250
196
  class Metadata < FinchAPI::BaseModel
197
+ # The metadata to be attached to the entity by existing rules. It is a key-value
198
+ # pairs where the values can be of any type (string, number, boolean, object,
199
+ # array, etc.).
251
200
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
252
- def metadata
253
- end
254
-
255
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
256
- def metadata=(_)
257
- end
201
+ attr_reader :metadata
258
202
 
259
203
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
260
- def initialize(metadata: nil)
204
+ attr_writer :metadata
205
+
206
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
207
+ def self.new(metadata: nil)
261
208
  end
262
209
 
263
210
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -266,93 +213,83 @@ module FinchAPI
266
213
  end
267
214
  end
268
215
 
269
- class Type < FinchAPI::Enum
270
- abstract!
271
-
272
- SALARY = T.let(:salary, T.nilable(Symbol))
273
- WAGE = T.let(:wage, T.nilable(Symbol))
274
- REIMBURSEMENT = T.let(:reimbursement, T.nilable(Symbol))
275
- OVERTIME = T.let(:overtime, T.nilable(Symbol))
276
- SEVERANCE = T.let(:severance, T.nilable(Symbol))
277
- DOUBLE_OVERTIME = T.let(:double_overtime, T.nilable(Symbol))
278
- PTO = T.let(:pto, T.nilable(Symbol))
279
- SICK = T.let(:sick, T.nilable(Symbol))
280
- BONUS = T.let(:bonus, T.nilable(Symbol))
281
- COMMISSION = T.let(:commission, T.nilable(Symbol))
282
- TIPS = T.let(:tips, T.nilable(Symbol))
283
- NUMBER_1099 = T.let(:"1099", T.nilable(Symbol))
284
- OTHER = T.let(:other, T.nilable(Symbol))
285
-
286
- sig { override.returns(T::Array[Symbol]) }
216
+ # The type of earning.
217
+ module Type
218
+ extend FinchAPI::Enum
219
+
220
+ TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type) }
221
+ OrSymbol =
222
+ T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) }
223
+
224
+ SALARY = T.let(:salary, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
225
+ WAGE = T.let(:wage, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
226
+ REIMBURSEMENT = T.let(:reimbursement, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
227
+ OVERTIME = T.let(:overtime, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
228
+ SEVERANCE = T.let(:severance, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
229
+ DOUBLE_OVERTIME =
230
+ T.let(:double_overtime, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
231
+ PTO = T.let(:pto, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
232
+ SICK = T.let(:sick, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
233
+ BONUS = T.let(:bonus, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
234
+ COMMISSION = T.let(:commission, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
235
+ TIPS = T.let(:tips, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
236
+ NUMBER_1099 = T.let(:"1099", FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
237
+ OTHER = T.let(:other, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)
238
+
239
+ sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol]) }
287
240
  def self.values
288
241
  end
289
242
  end
290
243
  end
291
244
 
292
245
  class EmployeeDeduction < FinchAPI::BaseModel
246
+ # The deduction amount in cents.
293
247
  sig { returns(T.nilable(Integer)) }
294
- def amount
295
- end
296
-
297
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
298
- def amount=(_)
299
- end
248
+ attr_accessor :amount
300
249
 
301
250
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes)) }
302
- def attributes
303
- end
251
+ attr_reader :attributes
304
252
 
305
253
  sig do
306
- params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes))
307
- .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes))
308
- end
309
- def attributes=(_)
254
+ params(
255
+ attributes: T.nilable(
256
+ T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash)
257
+ )
258
+ )
259
+ .void
310
260
  end
261
+ attr_writer :attributes
311
262
 
263
+ # The deduction currency.
312
264
  sig { returns(T.nilable(String)) }
313
- def currency
314
- end
315
-
316
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
317
- def currency=(_)
318
- end
265
+ attr_accessor :currency
319
266
 
267
+ # The deduction name from the pay statement.
320
268
  sig { returns(T.nilable(String)) }
321
- def name
322
- end
323
-
324
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
325
- def name=(_)
326
- end
269
+ attr_accessor :name
327
270
 
271
+ # Boolean indicating if the deduction is pre-tax.
328
272
  sig { returns(T.nilable(T::Boolean)) }
329
- def pre_tax
330
- end
331
-
332
- sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
333
- def pre_tax=(_)
334
- end
335
-
336
- sig { returns(T.nilable(Symbol)) }
337
- def type
338
- end
273
+ attr_accessor :pre_tax
339
274
 
340
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
341
- def type=(_)
342
- end
275
+ # Type of benefit.
276
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) }
277
+ attr_accessor :type
343
278
 
344
279
  sig do
345
280
  params(
346
281
  amount: T.nilable(Integer),
347
- attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes),
282
+ attributes: T.nilable(
283
+ T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash)
284
+ ),
348
285
  currency: T.nilable(String),
349
286
  name: T.nilable(String),
350
287
  pre_tax: T.nilable(T::Boolean),
351
- type: T.nilable(Symbol)
288
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
352
289
  )
353
- .void
290
+ .returns(T.attached_class)
354
291
  end
355
- def initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
292
+ def self.new(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
356
293
  end
357
294
 
358
295
  sig do
@@ -364,7 +301,7 @@ module FinchAPI
364
301
  currency: T.nilable(String),
365
302
  name: T.nilable(String),
366
303
  pre_tax: T.nilable(T::Boolean),
367
- type: T.nilable(Symbol)
304
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)
368
305
  }
369
306
  )
370
307
  end
@@ -373,18 +310,29 @@ module FinchAPI
373
310
 
374
311
  class Attributes < FinchAPI::BaseModel
375
312
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata)) }
376
- def metadata
377
- end
313
+ attr_reader :metadata
378
314
 
379
315
  sig do
380
- params(_: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata)
381
- .returns(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata)
382
- end
383
- def metadata=(_)
316
+ params(
317
+ metadata: T.any(
318
+ FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata,
319
+ FinchAPI::Util::AnyHash
320
+ )
321
+ )
322
+ .void
384
323
  end
324
+ attr_writer :metadata
385
325
 
386
- sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata).void }
387
- def initialize(metadata: nil)
326
+ sig do
327
+ params(
328
+ metadata: T.any(
329
+ FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata,
330
+ FinchAPI::Util::AnyHash
331
+ )
332
+ )
333
+ .returns(T.attached_class)
334
+ end
335
+ def self.new(metadata: nil)
388
336
  end
389
337
 
390
338
  sig do
@@ -394,16 +342,17 @@ module FinchAPI
394
342
  end
395
343
 
396
344
  class Metadata < FinchAPI::BaseModel
345
+ # The metadata to be attached to the entity by existing rules. It is a key-value
346
+ # pairs where the values can be of any type (string, number, boolean, object,
347
+ # array, etc.).
397
348
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
398
- def metadata
399
- end
400
-
401
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
402
- def metadata=(_)
403
- end
349
+ attr_reader :metadata
404
350
 
405
351
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
406
- def initialize(metadata: nil)
352
+ attr_writer :metadata
353
+
354
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
355
+ def self.new(metadata: nil)
407
356
  end
408
357
 
409
358
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -414,60 +363,48 @@ module FinchAPI
414
363
  end
415
364
 
416
365
  class EmployerContribution < FinchAPI::BaseModel
366
+ # The contribution amount in cents.
417
367
  sig { returns(T.nilable(Integer)) }
418
- def amount
419
- end
420
-
421
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
422
- def amount=(_)
423
- end
368
+ attr_accessor :amount
424
369
 
425
370
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes)) }
426
- def attributes
427
- end
371
+ attr_reader :attributes
428
372
 
429
373
  sig do
430
- params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes))
431
- .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes))
432
- end
433
- def attributes=(_)
374
+ params(
375
+ attributes: T.nilable(
376
+ T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash)
377
+ )
378
+ )
379
+ .void
434
380
  end
381
+ attr_writer :attributes
435
382
 
383
+ # The contribution currency.
436
384
  sig { returns(T.nilable(String)) }
437
- def currency
438
- end
439
-
440
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
441
- def currency=(_)
442
- end
385
+ attr_accessor :currency
443
386
 
387
+ # The contribution name from the pay statement.
444
388
  sig { returns(T.nilable(String)) }
445
- def name
446
- end
389
+ attr_accessor :name
447
390
 
448
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
449
- def name=(_)
450
- end
451
-
452
- sig { returns(T.nilable(Symbol)) }
453
- def type
454
- end
455
-
456
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
457
- def type=(_)
458
- end
391
+ # Type of benefit.
392
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) }
393
+ attr_accessor :type
459
394
 
460
395
  sig do
461
396
  params(
462
397
  amount: T.nilable(Integer),
463
- attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes),
398
+ attributes: T.nilable(
399
+ T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash)
400
+ ),
464
401
  currency: T.nilable(String),
465
402
  name: T.nilable(String),
466
- type: T.nilable(Symbol)
403
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
467
404
  )
468
- .void
405
+ .returns(T.attached_class)
469
406
  end
470
- def initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
407
+ def self.new(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
471
408
  end
472
409
 
473
410
  sig do
@@ -478,7 +415,7 @@ module FinchAPI
478
415
  attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes),
479
416
  currency: T.nilable(String),
480
417
  name: T.nilable(String),
481
- type: T.nilable(Symbol)
418
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)
482
419
  }
483
420
  )
484
421
  end
@@ -487,18 +424,29 @@ module FinchAPI
487
424
 
488
425
  class Attributes < FinchAPI::BaseModel
489
426
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata)) }
490
- def metadata
491
- end
427
+ attr_reader :metadata
492
428
 
493
429
  sig do
494
- params(_: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata)
495
- .returns(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata)
496
- end
497
- def metadata=(_)
430
+ params(
431
+ metadata: T.any(
432
+ FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata,
433
+ FinchAPI::Util::AnyHash
434
+ )
435
+ )
436
+ .void
498
437
  end
438
+ attr_writer :metadata
499
439
 
500
- sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata).void }
501
- def initialize(metadata: nil)
440
+ sig do
441
+ params(
442
+ metadata: T.any(
443
+ FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata,
444
+ FinchAPI::Util::AnyHash
445
+ )
446
+ )
447
+ .returns(T.attached_class)
448
+ end
449
+ def self.new(metadata: nil)
502
450
  end
503
451
 
504
452
  sig do
@@ -509,16 +457,17 @@ module FinchAPI
509
457
  end
510
458
 
511
459
  class Metadata < FinchAPI::BaseModel
460
+ # The metadata to be attached to the entity by existing rules. It is a key-value
461
+ # pairs where the values can be of any type (string, number, boolean, object,
462
+ # array, etc.).
512
463
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
513
- def metadata
514
- end
515
-
516
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
517
- def metadata=(_)
518
- end
464
+ attr_reader :metadata
519
465
 
520
466
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
521
- def initialize(metadata: nil)
467
+ attr_writer :metadata
468
+
469
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
470
+ def self.new(metadata: nil)
522
471
  end
523
472
 
524
473
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -528,81 +477,67 @@ module FinchAPI
528
477
  end
529
478
  end
530
479
 
531
- class PaymentMethod < FinchAPI::Enum
532
- abstract!
480
+ # The payment method.
481
+ module PaymentMethod
482
+ extend FinchAPI::Enum
483
+
484
+ TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod) }
485
+ OrSymbol =
486
+ T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) }
533
487
 
534
- CHECK = T.let(:check, T.nilable(Symbol))
535
- DIRECT_DEPOSIT = T.let(:direct_deposit, T.nilable(Symbol))
488
+ CHECK = T.let(:check, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)
489
+ DIRECT_DEPOSIT =
490
+ T.let(:direct_deposit, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)
536
491
 
537
- sig { override.returns(T::Array[Symbol]) }
492
+ sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol]) }
538
493
  def self.values
539
494
  end
540
495
  end
541
496
 
542
497
  class Tax < FinchAPI::BaseModel
498
+ # The tax amount in cents.
543
499
  sig { returns(T.nilable(Integer)) }
544
- def amount
545
- end
546
-
547
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
548
- def amount=(_)
549
- end
500
+ attr_accessor :amount
550
501
 
551
502
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes)) }
552
- def attributes
553
- end
503
+ attr_reader :attributes
554
504
 
555
505
  sig do
556
- params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes))
557
- .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes))
558
- end
559
- def attributes=(_)
506
+ params(
507
+ attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash))
508
+ )
509
+ .void
560
510
  end
511
+ attr_writer :attributes
561
512
 
513
+ # The currency code.
562
514
  sig { returns(T.nilable(String)) }
563
- def currency
564
- end
565
-
566
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
567
- def currency=(_)
568
- end
515
+ attr_accessor :currency
569
516
 
517
+ # `true` if the amount is paid by the employers.
570
518
  sig { returns(T.nilable(T::Boolean)) }
571
- def employer
572
- end
573
-
574
- sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
575
- def employer=(_)
576
- end
519
+ attr_accessor :employer
577
520
 
521
+ # The exact name of tax from the pay statement.
578
522
  sig { returns(T.nilable(String)) }
579
- def name
580
- end
581
-
582
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
583
- def name=(_)
584
- end
585
-
586
- sig { returns(T.nilable(Symbol)) }
587
- def type
588
- end
523
+ attr_accessor :name
589
524
 
590
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
591
- def type=(_)
592
- end
525
+ # The type of taxes.
526
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) }
527
+ attr_accessor :type
593
528
 
594
529
  sig do
595
530
  params(
596
531
  amount: T.nilable(Integer),
597
- attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes),
532
+ attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash)),
598
533
  currency: T.nilable(String),
599
534
  employer: T.nilable(T::Boolean),
600
535
  name: T.nilable(String),
601
- type: T.nilable(Symbol)
536
+ type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::OrSymbol)
602
537
  )
603
- .void
538
+ .returns(T.attached_class)
604
539
  end
605
- def initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
540
+ def self.new(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
606
541
  end
607
542
 
608
543
  sig do
@@ -614,7 +549,7 @@ module FinchAPI
614
549
  currency: T.nilable(String),
615
550
  employer: T.nilable(T::Boolean),
616
551
  name: T.nilable(String),
617
- type: T.nilable(Symbol)
552
+ type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)
618
553
  }
619
554
  )
620
555
  end
@@ -623,18 +558,23 @@ module FinchAPI
623
558
 
624
559
  class Attributes < FinchAPI::BaseModel
625
560
  sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata)) }
626
- def metadata
627
- end
561
+ attr_reader :metadata
628
562
 
629
563
  sig do
630
- params(_: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata)
631
- .returns(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata)
632
- end
633
- def metadata=(_)
564
+ params(
565
+ metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash)
566
+ )
567
+ .void
634
568
  end
569
+ attr_writer :metadata
635
570
 
636
- sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata).void }
637
- def initialize(metadata: nil)
571
+ sig do
572
+ params(
573
+ metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash)
574
+ )
575
+ .returns(T.attached_class)
576
+ end
577
+ def self.new(metadata: nil)
638
578
  end
639
579
 
640
580
  sig { override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata}) }
@@ -642,16 +582,17 @@ module FinchAPI
642
582
  end
643
583
 
644
584
  class Metadata < FinchAPI::BaseModel
585
+ # The metadata to be attached to the entity by existing rules. It is a key-value
586
+ # pairs where the values can be of any type (string, number, boolean, object,
587
+ # array, etc.).
645
588
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
646
- def metadata
647
- end
648
-
649
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
650
- def metadata=(_)
651
- end
589
+ attr_reader :metadata
652
590
 
653
591
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
654
- def initialize(metadata: nil)
592
+ attr_writer :metadata
593
+
594
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
595
+ def self.new(metadata: nil)
655
596
  end
656
597
 
657
598
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -660,28 +601,36 @@ module FinchAPI
660
601
  end
661
602
  end
662
603
 
663
- class Type < FinchAPI::Enum
664
- abstract!
604
+ # The type of taxes.
605
+ module Type
606
+ extend FinchAPI::Enum
665
607
 
666
- STATE = T.let(:state, T.nilable(Symbol))
667
- FEDERAL = T.let(:federal, T.nilable(Symbol))
668
- LOCAL = T.let(:local, T.nilable(Symbol))
669
- FICA = T.let(:fica, T.nilable(Symbol))
608
+ TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type) }
609
+ OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) }
670
610
 
671
- sig { override.returns(T::Array[Symbol]) }
611
+ STATE = T.let(:state, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)
612
+ FEDERAL = T.let(:federal, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)
613
+ LOCAL = T.let(:local, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)
614
+ FICA = T.let(:fica, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)
615
+
616
+ sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol]) }
672
617
  def self.values
673
618
  end
674
619
  end
675
620
  end
676
621
 
677
- class Type < FinchAPI::Enum
678
- abstract!
622
+ # The type of the payment associated with the pay statement.
623
+ module Type
624
+ extend FinchAPI::Enum
625
+
626
+ TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Type) }
627
+ OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) }
679
628
 
680
- REGULAR_PAYROLL = T.let(:regular_payroll, T.nilable(Symbol))
681
- OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, T.nilable(Symbol))
682
- ONE_TIME_PAYMENT = T.let(:one_time_payment, T.nilable(Symbol))
629
+ REGULAR_PAYROLL = T.let(:regular_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)
630
+ OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)
631
+ ONE_TIME_PAYMENT = T.let(:one_time_payment, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)
683
632
 
684
- sig { override.returns(T::Array[Symbol]) }
633
+ sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol]) }
685
634
  def self.values
686
635
  end
687
636
  end