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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +63 -20
  3. data/lib/finch-api/base_client.rb +52 -59
  4. data/lib/finch-api/base_model.rb +453 -415
  5. data/lib/finch-api/base_page.rb +34 -15
  6. data/lib/finch-api/client.rb +3 -7
  7. data/lib/finch-api/errors.rb +12 -17
  8. data/lib/finch-api/extern.rb +1 -4
  9. data/lib/finch-api/individuals_page.rb +28 -34
  10. data/lib/finch-api/models/account_update_event.rb +6 -31
  11. data/lib/finch-api/models/company_event.rb +3 -11
  12. data/lib/finch-api/models/connect/session_new_params.rb +9 -52
  13. data/lib/finch-api/models/connect/session_reauthenticate_params.rb +3 -22
  14. data/lib/finch-api/models/connection_status_type.rb +3 -21
  15. data/lib/finch-api/models/create_access_token_response.rb +6 -30
  16. data/lib/finch-api/models/directory_event.rb +3 -15
  17. data/lib/finch-api/models/employment_event.rb +3 -15
  18. data/lib/finch-api/models/hris/benefit_contribution.rb +3 -14
  19. data/lib/finch-api/models/hris/benefit_features_and_operations.rb +9 -39
  20. data/lib/finch-api/models/hris/benefit_frequency.rb +3 -15
  21. data/lib/finch-api/models/hris/benefit_type.rb +3 -22
  22. data/lib/finch-api/models/hris/benefits/enrolled_individual.rb +3 -18
  23. data/lib/finch-api/models/hris/benefits/individual_benefit.rb +3 -14
  24. data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +9 -40
  25. data/lib/finch-api/models/hris/company.rb +9 -52
  26. data/lib/finch-api/models/hris/document_list_params.rb +3 -13
  27. data/lib/finch-api/models/hris/document_response.rb +3 -14
  28. data/lib/finch-api/models/hris/document_retreive_response.rb +7 -23
  29. data/lib/finch-api/models/hris/employment_data.rb +9 -58
  30. data/lib/finch-api/models/hris/individual.rb +12 -66
  31. data/lib/finch-api/models/hris/pay_statement.rb +12 -70
  32. data/lib/finch-api/models/hris/payment.rb +3 -21
  33. data/lib/finch-api/models/hris/supported_benefit.rb +9 -39
  34. data/lib/finch-api/models/hris/w42005.rb +12 -49
  35. data/lib/finch-api/models/hris/w42020.rb +8 -29
  36. data/lib/finch-api/models/income.rb +3 -22
  37. data/lib/finch-api/models/individual_event.rb +3 -15
  38. data/lib/finch-api/models/introspection.rb +9 -50
  39. data/lib/finch-api/models/job_completion_event.rb +3 -21
  40. data/lib/finch-api/models/jobs/automated_async_job.rb +6 -35
  41. data/lib/finch-api/models/jobs/automated_create_params.rb +3 -12
  42. data/lib/finch-api/models/jobs/automated_list_response.rb +100 -0
  43. data/lib/finch-api/models/jobs/manual_async_job.rb +3 -17
  44. data/lib/finch-api/models/operation_support.rb +3 -18
  45. data/lib/finch-api/models/pay_statement_event.rb +3 -15
  46. data/lib/finch-api/models/payment_event.rb +3 -15
  47. data/lib/finch-api/models/payroll/pay_group_list_response.rb +3 -21
  48. data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +3 -21
  49. data/lib/finch-api/models/provider.rb +3 -20
  50. data/lib/finch-api/models/sandbox/company_update_params.rb +9 -52
  51. data/lib/finch-api/models/sandbox/company_update_response.rb +9 -52
  52. data/lib/finch-api/models/sandbox/connection_create_params.rb +3 -17
  53. data/lib/finch-api/models/sandbox/connection_create_response.rb +3 -17
  54. data/lib/finch-api/models/sandbox/connections/account_create_params.rb +3 -17
  55. data/lib/finch-api/models/sandbox/connections/account_create_response.rb +3 -17
  56. data/lib/finch-api/models/sandbox/connections/account_update_response.rb +3 -17
  57. data/lib/finch-api/models/sandbox/directory_create_params.rb +21 -124
  58. data/lib/finch-api/models/sandbox/employment_update_params.rb +9 -58
  59. data/lib/finch-api/models/sandbox/employment_update_response.rb +9 -58
  60. data/lib/finch-api/models/sandbox/individual_update_params.rb +12 -66
  61. data/lib/finch-api/models/sandbox/individual_update_response.rb +12 -66
  62. data/lib/finch-api/models/sandbox/job_create_params.rb +3 -12
  63. data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +2 -1
  64. data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -28
  65. data/lib/finch-api/models/sandbox/payment_create_params.rb +12 -70
  66. data/lib/finch-api/models/webhook_event.rb +10 -27
  67. data/lib/finch-api/page.rb +28 -34
  68. data/lib/finch-api/pooled_net_requester.rb +51 -46
  69. data/lib/finch-api/request_options.rb +5 -12
  70. data/lib/finch-api/resources/access_tokens.rb +0 -2
  71. data/lib/finch-api/resources/account.rb +0 -3
  72. data/lib/finch-api/resources/connect/sessions.rb +0 -3
  73. data/lib/finch-api/resources/connect.rb +0 -1
  74. data/lib/finch-api/resources/hris/benefits/individuals.rb +2 -6
  75. data/lib/finch-api/resources/hris/benefits.rb +0 -6
  76. data/lib/finch-api/resources/hris/company.rb +0 -2
  77. data/lib/finch-api/resources/hris/directory.rb +1 -24
  78. data/lib/finch-api/resources/hris/documents.rb +4 -7
  79. data/lib/finch-api/resources/hris/employments.rb +0 -2
  80. data/lib/finch-api/resources/hris/individuals.rb +0 -2
  81. data/lib/finch-api/resources/hris/pay_statements.rb +0 -2
  82. data/lib/finch-api/resources/hris/payments.rb +0 -2
  83. data/lib/finch-api/resources/hris.rb +0 -1
  84. data/lib/finch-api/resources/jobs/automated.rb +2 -7
  85. data/lib/finch-api/resources/jobs/manual.rb +0 -2
  86. data/lib/finch-api/resources/jobs.rb +0 -1
  87. data/lib/finch-api/resources/payroll/pay_groups.rb +0 -3
  88. data/lib/finch-api/resources/payroll.rb +0 -1
  89. data/lib/finch-api/resources/providers.rb +0 -2
  90. data/lib/finch-api/resources/request_forwarding.rb +0 -2
  91. data/lib/finch-api/resources/sandbox/company.rb +0 -2
  92. data/lib/finch-api/resources/sandbox/connections/accounts.rb +0 -3
  93. data/lib/finch-api/resources/sandbox/connections.rb +0 -2
  94. data/lib/finch-api/resources/sandbox/directory.rb +0 -2
  95. data/lib/finch-api/resources/sandbox/employment.rb +0 -2
  96. data/lib/finch-api/resources/sandbox/individual.rb +0 -2
  97. data/lib/finch-api/resources/sandbox/jobs/configuration.rb +0 -3
  98. data/lib/finch-api/resources/sandbox/jobs.rb +0 -2
  99. data/lib/finch-api/resources/sandbox/payment.rb +0 -2
  100. data/lib/finch-api/resources/sandbox.rb +0 -1
  101. data/lib/finch-api/resources/webhooks.rb +0 -1
  102. data/lib/finch-api/responses_page.rb +24 -31
  103. data/lib/finch-api/single_page.rb +23 -31
  104. data/lib/finch-api/util.rb +216 -124
  105. data/lib/finch-api/version.rb +1 -1
  106. data/lib/finch-api.rb +17 -0
  107. data/manifest.yaml +1 -0
  108. data/rbi/lib/finch-api/base_client.rbi +89 -66
  109. data/rbi/lib/finch-api/base_model.rbi +403 -236
  110. data/rbi/lib/finch-api/base_page.rbi +3 -6
  111. data/rbi/lib/finch-api/client.rbi +23 -28
  112. data/rbi/lib/finch-api/errors.rbi +20 -22
  113. data/rbi/lib/finch-api/extern.rbi +1 -1
  114. data/rbi/lib/finch-api/individuals_page.rbi +5 -23
  115. data/rbi/lib/finch-api/models/access_token_create_params.rbi +13 -24
  116. data/rbi/lib/finch-api/models/account_disconnect_params.rbi +9 -2
  117. data/rbi/lib/finch-api/models/account_introspect_params.rbi +9 -2
  118. data/rbi/lib/finch-api/models/account_update_event.rbi +871 -983
  119. data/rbi/lib/finch-api/models/base_webhook_event.rbi +13 -19
  120. data/rbi/lib/finch-api/models/company_event.rbi +28 -20
  121. data/rbi/lib/finch-api/models/connect/session_new_params.rbi +90 -104
  122. data/rbi/lib/finch-api/models/connect/session_new_response.rbi +6 -14
  123. data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +37 -47
  124. data/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +6 -14
  125. data/rbi/lib/finch-api/models/connection_status_type.rbi +13 -9
  126. data/rbi/lib/finch-api/models/create_access_token_response.rbi +61 -78
  127. data/rbi/lib/finch-api/models/directory_event.rbi +42 -27
  128. data/rbi/lib/finch-api/models/disconnect_response.rbi +4 -8
  129. data/rbi/lib/finch-api/models/employment_event.rbi +42 -27
  130. data/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +29 -21
  131. data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +18 -26
  132. data/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +199 -86
  133. data/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +9 -6
  134. data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +9 -2
  135. data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +9 -2
  136. data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +9 -2
  137. data/rbi/lib/finch-api/models/hris/benefit_type.rbi +26 -22
  138. data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +7 -11
  139. data/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +43 -49
  140. data/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +74 -63
  141. data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +249 -104
  142. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +9 -2
  143. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +4 -14
  144. data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -8
  145. data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +7 -8
  146. data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +23 -39
  147. data/rbi/lib/finch-api/models/hris/benefits_support.rbi +88 -86
  148. data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +1 -1
  149. data/rbi/lib/finch-api/models/hris/company.rbi +119 -171
  150. data/rbi/lib/finch-api/models/hris/company_benefit.rbi +13 -32
  151. data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +9 -2
  152. data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +3 -8
  153. data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +11 -13
  154. data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +11 -13
  155. data/rbi/lib/finch-api/models/hris/document_list_params.rbi +32 -31
  156. data/rbi/lib/finch-api/models/hris/document_list_response.rbi +10 -17
  157. data/rbi/lib/finch-api/models/hris/document_response.rbi +40 -43
  158. data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +9 -2
  159. data/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +6 -4
  160. data/rbi/lib/finch-api/models/hris/employment_data.rbi +163 -205
  161. data/rbi/lib/finch-api/models/hris/employment_data_response.rbi +18 -17
  162. data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +12 -21
  163. data/rbi/lib/finch-api/models/hris/individual.rbi +126 -151
  164. data/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +42 -68
  165. data/rbi/lib/finch-api/models/hris/individual_response.rbi +18 -17
  166. data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +27 -31
  167. data/rbi/lib/finch-api/models/hris/pay_statement.rbi +290 -341
  168. data/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +18 -20
  169. data/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +13 -16
  170. data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +18 -31
  171. data/rbi/lib/finch-api/models/hris/payment.rbi +63 -103
  172. data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +9 -15
  173. data/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +10 -14
  174. data/rbi/lib/finch-api/models/hris/supported_benefit.rbi +83 -79
  175. data/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +3 -8
  176. data/rbi/lib/finch-api/models/hris/w42005.rbi +86 -70
  177. data/rbi/lib/finch-api/models/hris/w42020.rbi +84 -86
  178. data/rbi/lib/finch-api/models/income.rbi +34 -41
  179. data/rbi/lib/finch-api/models/individual_event.rbi +42 -27
  180. data/rbi/lib/finch-api/models/introspection.rbi +138 -178
  181. data/rbi/lib/finch-api/models/job_completion_event.rbi +48 -37
  182. data/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +66 -94
  183. data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +26 -33
  184. data/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +11 -31
  185. data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +11 -13
  186. data/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +126 -0
  187. data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +9 -2
  188. data/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +32 -27
  189. data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +9 -2
  190. data/rbi/lib/finch-api/models/location.rbi +16 -59
  191. data/rbi/lib/finch-api/models/money.rbi +7 -13
  192. data/rbi/lib/finch-api/models/operation_support.rbi +18 -7
  193. data/rbi/lib/finch-api/models/operation_support_matrix.rbi +65 -27
  194. data/rbi/lib/finch-api/models/paging.rbi +10 -12
  195. data/rbi/lib/finch-api/models/pay_statement_event.rbi +46 -32
  196. data/rbi/lib/finch-api/models/payment_event.rbi +39 -34
  197. data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +9 -13
  198. data/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +55 -30
  199. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +9 -2
  200. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +45 -46
  201. data/rbi/lib/finch-api/models/provider.rbi +873 -964
  202. data/rbi/lib/finch-api/models/provider_list_params.rbi +9 -2
  203. data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +20 -33
  204. data/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +40 -59
  205. data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +144 -166
  206. data/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +145 -174
  207. data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +43 -39
  208. data/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +38 -59
  209. data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +62 -39
  210. data/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +54 -62
  211. data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +17 -11
  212. data/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +55 -54
  213. data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +380 -332
  214. data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +1 -1
  215. data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +190 -194
  216. data/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +195 -198
  217. data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +151 -145
  218. data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +163 -151
  219. data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +22 -19
  220. data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +11 -31
  221. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +9 -2
  222. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +2 -1
  223. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +9 -2
  224. data/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +56 -26
  225. data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +409 -393
  226. data/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +6 -14
  227. data/rbi/lib/finch-api/models/webhook_event.rbi +4 -4
  228. data/rbi/lib/finch-api/page.rbi +5 -23
  229. data/rbi/lib/finch-api/pooled_net_requester.rbi +39 -16
  230. data/rbi/lib/finch-api/request_options.rbi +33 -54
  231. data/rbi/lib/finch-api/resources/access_tokens.rbi +4 -3
  232. data/rbi/lib/finch-api/resources/account.rbi +6 -4
  233. data/rbi/lib/finch-api/resources/connect/sessions.rbi +17 -8
  234. data/rbi/lib/finch-api/resources/connect.rbi +3 -4
  235. data/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +33 -10
  236. data/rbi/lib/finch-api/resources/hris/benefits.rbi +32 -13
  237. data/rbi/lib/finch-api/resources/hris/company.rbi +4 -3
  238. data/rbi/lib/finch-api/resources/hris/directory.rbi +11 -15
  239. data/rbi/lib/finch-api/resources/hris/documents.rbi +27 -7
  240. data/rbi/lib/finch-api/resources/hris/employments.rbi +10 -5
  241. data/rbi/lib/finch-api/resources/hris/individuals.rbi +6 -5
  242. data/rbi/lib/finch-api/resources/hris/pay_statements.rbi +13 -5
  243. data/rbi/lib/finch-api/resources/hris/payments.rbi +13 -4
  244. data/rbi/lib/finch-api/resources/hris.rbi +10 -18
  245. data/rbi/lib/finch-api/resources/jobs/automated.rbi +39 -10
  246. data/rbi/lib/finch-api/resources/jobs/manual.rbi +5 -3
  247. data/rbi/lib/finch-api/resources/jobs.rbi +4 -6
  248. data/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +6 -4
  249. data/rbi/lib/finch-api/resources/payroll.rbi +3 -4
  250. data/rbi/lib/finch-api/resources/providers.rbi +4 -3
  251. data/rbi/lib/finch-api/resources/request_forwarding.rbi +27 -4
  252. data/rbi/lib/finch-api/resources/sandbox/company.rbi +19 -7
  253. data/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +19 -7
  254. data/rbi/lib/finch-api/resources/sandbox/connections.rbi +10 -6
  255. data/rbi/lib/finch-api/resources/sandbox/directory.rbi +12 -6
  256. data/rbi/lib/finch-api/resources/sandbox/employment.rbi +30 -11
  257. data/rbi/lib/finch-api/resources/sandbox/individual.rbi +26 -8
  258. data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +9 -7
  259. data/rbi/lib/finch-api/resources/sandbox/jobs.rbi +11 -7
  260. data/rbi/lib/finch-api/resources/sandbox/payment.rbi +5 -4
  261. data/rbi/lib/finch-api/resources/sandbox.rbi +9 -16
  262. data/rbi/lib/finch-api/resources/webhooks.rbi +2 -2
  263. data/rbi/lib/finch-api/responses_page.rbi +4 -17
  264. data/rbi/lib/finch-api/single_page.rbi +4 -12
  265. data/rbi/lib/finch-api/util.rbi +228 -115
  266. data/rbi/lib/finch-api/version.rbi +1 -1
  267. data/sig/finch-api/base_client.rbs +20 -15
  268. data/sig/finch-api/base_model.rbs +36 -18
  269. data/sig/finch-api/base_page.rbs +1 -1
  270. data/sig/finch-api/client.rbs +8 -8
  271. data/sig/finch-api/errors.rbs +21 -21
  272. data/sig/finch-api/individuals_page.rbs +2 -7
  273. data/sig/finch-api/models/access_token_create_params.rbs +7 -12
  274. data/sig/finch-api/models/account_disconnect_params.rbs +1 -6
  275. data/sig/finch-api/models/account_introspect_params.rbs +1 -6
  276. data/sig/finch-api/models/account_update_event.rbs +204 -361
  277. data/sig/finch-api/models/base_webhook_event.rbs +5 -5
  278. data/sig/finch-api/models/company_event.rbs +13 -11
  279. data/sig/finch-api/models/connect/session_new_params.rbs +28 -32
  280. data/sig/finch-api/models/connect/session_new_response.rbs +1 -6
  281. data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +11 -14
  282. data/sig/finch-api/models/connect/session_reauthenticate_response.rbs +1 -6
  283. data/sig/finch-api/models/connection_status_type.rbs +4 -2
  284. data/sig/finch-api/models/create_access_token_response.rbs +20 -21
  285. data/sig/finch-api/models/directory_event.rbs +13 -19
  286. data/sig/finch-api/models/disconnect_response.rbs +1 -5
  287. data/sig/finch-api/models/employment_event.rbs +13 -19
  288. data/sig/finch-api/models/hris/benefit_contribution.rbs +8 -11
  289. data/sig/finch-api/models/hris/benefit_create_params.rbs +6 -11
  290. data/sig/finch-api/models/hris/benefit_features_and_operations.rbs +25 -29
  291. data/sig/finch-api/models/hris/benefit_frequency.rbs +4 -2
  292. data/sig/finch-api/models/hris/benefit_list_params.rbs +1 -6
  293. data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +1 -6
  294. data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +1 -6
  295. data/sig/finch-api/models/hris/benefit_type.rbs +4 -2
  296. data/sig/finch-api/models/hris/benefit_update_params.rbs +4 -6
  297. data/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +14 -18
  298. data/sig/finch-api/models/hris/benefits/individual_benefit.rbs +16 -25
  299. data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +35 -54
  300. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +1 -6
  301. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +4 -6
  302. data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +4 -9
  303. data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +4 -9
  304. data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +10 -16
  305. data/sig/finch-api/models/hris/benefits_support.rbs +14 -18
  306. data/sig/finch-api/models/hris/benfit_contribution.rbs +0 -1
  307. data/sig/finch-api/models/hris/company.rbs +39 -57
  308. data/sig/finch-api/models/hris/company_benefit.rbs +6 -10
  309. data/sig/finch-api/models/hris/company_retrieve_params.rbs +1 -6
  310. data/sig/finch-api/models/hris/create_company_benefits_response.rbs +1 -6
  311. data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +5 -10
  312. data/sig/finch-api/models/hris/directory_list_params.rbs +5 -10
  313. data/sig/finch-api/models/hris/document_list_params.rbs +11 -14
  314. data/sig/finch-api/models/hris/document_list_response.rbs +4 -9
  315. data/sig/finch-api/models/hris/document_response.rbs +11 -14
  316. data/sig/finch-api/models/hris/document_retreive_params.rbs +1 -6
  317. data/sig/finch-api/models/hris/document_retreive_response.rbs +4 -2
  318. data/sig/finch-api/models/hris/employment_data.rbs +41 -59
  319. data/sig/finch-api/models/hris/employment_data_response.rbs +5 -10
  320. data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +5 -15
  321. data/sig/finch-api/models/hris/individual.rbs +39 -45
  322. data/sig/finch-api/models/hris/individual_in_directory.rbs +11 -26
  323. data/sig/finch-api/models/hris/individual_response.rbs +5 -10
  324. data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +7 -22
  325. data/sig/finch-api/models/hris/pay_statement.rbs +75 -131
  326. data/sig/finch-api/models/hris/pay_statement_response.rbs +5 -10
  327. data/sig/finch-api/models/hris/pay_statement_response_body.rbs +4 -9
  328. data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +9 -15
  329. data/sig/finch-api/models/hris/payment.rbs +19 -26
  330. data/sig/finch-api/models/hris/payment_list_params.rbs +5 -10
  331. data/sig/finch-api/models/hris/support_per_benefit_type.rbs +4 -9
  332. data/sig/finch-api/models/hris/supported_benefit.rbs +22 -21
  333. data/sig/finch-api/models/hris/update_company_benefit_response.rbs +1 -6
  334. data/sig/finch-api/models/hris/w42005.rbs +26 -30
  335. data/sig/finch-api/models/hris/w42020.rbs +23 -25
  336. data/sig/finch-api/models/income.rbs +10 -10
  337. data/sig/finch-api/models/individual_event.rbs +13 -19
  338. data/sig/finch-api/models/introspection.rbs +43 -54
  339. data/sig/finch-api/models/job_completion_event.rbs +13 -20
  340. data/sig/finch-api/models/jobs/automated_async_job.rbs +20 -26
  341. data/sig/finch-api/models/jobs/automated_create_params.rbs +10 -18
  342. data/sig/finch-api/models/jobs/automated_create_response.rbs +6 -11
  343. data/sig/finch-api/models/jobs/automated_list_params.rbs +5 -10
  344. data/sig/finch-api/models/jobs/automated_list_response.rbs +82 -0
  345. data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +1 -6
  346. data/sig/finch-api/models/jobs/manual_async_job.rbs +9 -11
  347. data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +1 -6
  348. data/sig/finch-api/models/location.rbs +10 -12
  349. data/sig/finch-api/models/money.rbs +1 -3
  350. data/sig/finch-api/models/operation_support.rbs +4 -2
  351. data/sig/finch-api/models/operation_support_matrix.rbs +6 -10
  352. data/sig/finch-api/models/paging.rbs +1 -3
  353. data/sig/finch-api/models/pay_statement_event.rbs +13 -20
  354. data/sig/finch-api/models/payment_event.rbs +13 -17
  355. data/sig/finch-api/models/payroll/pay_group_list_params.rbs +5 -10
  356. data/sig/finch-api/models/payroll/pay_group_list_response.rbs +9 -12
  357. data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +1 -6
  358. data/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +10 -13
  359. data/sig/finch-api/models/provider.rbs +200 -347
  360. data/sig/finch-api/models/provider_list_params.rbs +1 -5
  361. data/sig/finch-api/models/request_forwarding_forward_params.rbs +8 -13
  362. data/sig/finch-api/models/request_forwarding_forward_response.rbs +13 -23
  363. data/sig/finch-api/models/sandbox/company_update_params.rbs +39 -58
  364. data/sig/finch-api/models/sandbox/company_update_response.rbs +38 -57
  365. data/sig/finch-api/models/sandbox/connection_create_params.rbs +11 -14
  366. data/sig/finch-api/models/sandbox/connection_create_response.rbs +14 -17
  367. data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +11 -14
  368. data/sig/finch-api/models/sandbox/connections/account_create_response.rbs +13 -16
  369. data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +4 -9
  370. data/sig/finch-api/models/sandbox/connections/account_update_response.rbs +12 -15
  371. data/sig/finch-api/models/sandbox/directory_create_params.rbs +76 -102
  372. data/sig/finch-api/models/sandbox/employment_update_params.rbs +40 -59
  373. data/sig/finch-api/models/sandbox/employment_update_response.rbs +40 -59
  374. data/sig/finch-api/models/sandbox/individual_update_params.rbs +39 -46
  375. data/sig/finch-api/models/sandbox/individual_update_response.rbs +39 -46
  376. data/sig/finch-api/models/sandbox/job_create_params.rbs +8 -11
  377. data/sig/finch-api/models/sandbox/job_create_response.rbs +6 -11
  378. data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +1 -6
  379. data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +1 -6
  380. data/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +12 -13
  381. data/sig/finch-api/models/sandbox/payment_create_params.rbs +81 -143
  382. data/sig/finch-api/models/sandbox/payment_create_response.rbs +1 -6
  383. data/sig/finch-api/models/webhook_event.rbs +5 -3
  384. data/sig/finch-api/page.rbs +2 -7
  385. data/sig/finch-api/pooled_net_requester.rbs +13 -4
  386. data/sig/finch-api/request_options.rbs +6 -2
  387. data/sig/finch-api/resources/access_tokens.rbs +7 -11
  388. data/sig/finch-api/resources/account.rbs +6 -16
  389. data/sig/finch-api/resources/connect/sessions.rbs +19 -29
  390. data/sig/finch-api/resources/hris/benefits/individuals.rbs +19 -43
  391. data/sig/finch-api/resources/hris/benefits.rbs +21 -48
  392. data/sig/finch-api/resources/hris/company.rbs +3 -8
  393. data/sig/finch-api/resources/hris/directory.rbs +6 -20
  394. data/sig/finch-api/resources/hris/documents.rbs +11 -22
  395. data/sig/finch-api/resources/hris/employments.rbs +4 -9
  396. data/sig/finch-api/resources/hris/individuals.rbs +5 -10
  397. data/sig/finch-api/resources/hris/pay_statements.rbs +4 -9
  398. data/sig/finch-api/resources/hris/payments.rbs +5 -10
  399. data/sig/finch-api/resources/jobs/automated.rbs +14 -30
  400. data/sig/finch-api/resources/jobs/manual.rbs +4 -10
  401. data/sig/finch-api/resources/payroll/pay_groups.rbs +9 -20
  402. data/sig/finch-api/resources/providers.rbs +3 -7
  403. data/sig/finch-api/resources/request_forwarding.rbs +8 -13
  404. data/sig/finch-api/resources/sandbox/company.rbs +11 -16
  405. data/sig/finch-api/resources/sandbox/connections/accounts.rbs +11 -21
  406. data/sig/finch-api/resources/sandbox/connections.rbs +7 -12
  407. data/sig/finch-api/resources/sandbox/directory.rbs +4 -9
  408. data/sig/finch-api/resources/sandbox/employment.rbs +22 -28
  409. data/sig/finch-api/resources/sandbox/individual.rbs +16 -22
  410. data/sig/finch-api/resources/sandbox/jobs/configuration.rbs +8 -18
  411. data/sig/finch-api/resources/sandbox/jobs.rbs +4 -9
  412. data/sig/finch-api/resources/sandbox/payment.rbs +6 -11
  413. data/sig/finch-api/responses_page.rbs +2 -7
  414. data/sig/finch-api/single_page.rbs +2 -7
  415. data/sig/finch-api/util.rbs +37 -12
  416. data/sig/finch-api/version.rbs +1 -1
  417. metadata +7 -4
@@ -8,42 +8,38 @@ module FinchAPI
8
8
  include FinchAPI::RequestParameters
9
9
 
10
10
  sig { returns(T.nilable(String)) }
11
- def end_date
12
- end
11
+ attr_reader :end_date
13
12
 
14
- sig { params(_: String).returns(String) }
15
- def end_date=(_)
16
- end
13
+ sig { params(end_date: String).void }
14
+ attr_writer :end_date
17
15
 
18
16
  sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement])) }
19
- def pay_statements
20
- end
17
+ attr_reader :pay_statements
21
18
 
22
19
  sig do
23
- params(_: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement])
24
- .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement])
25
- end
26
- def pay_statements=(_)
20
+ params(
21
+ pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)]
22
+ )
23
+ .void
27
24
  end
25
+ attr_writer :pay_statements
28
26
 
29
27
  sig { returns(T.nilable(String)) }
30
- def start_date
31
- end
28
+ attr_reader :start_date
32
29
 
33
- sig { params(_: String).returns(String) }
34
- def start_date=(_)
35
- end
30
+ sig { params(start_date: String).void }
31
+ attr_writer :start_date
36
32
 
37
33
  sig do
38
34
  params(
39
35
  end_date: String,
40
- pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement],
36
+ pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)],
41
37
  start_date: String,
42
- request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
38
+ request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
43
39
  )
44
- .void
40
+ .returns(T.attached_class)
45
41
  end
46
- def initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
42
+ def self.new(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
47
43
  end
48
44
 
49
45
  sig do
@@ -61,25 +57,15 @@ module FinchAPI
61
57
  end
62
58
 
63
59
  class PayStatement < FinchAPI::BaseModel
60
+ # The array of earnings objects associated with this pay statement
64
61
  sig do
65
62
  returns(
66
63
  T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)])
67
64
  )
68
65
  end
69
- def earnings
70
- end
71
-
72
- sig do
73
- params(
74
- _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)])
75
- )
76
- .returns(
77
- T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)])
78
- )
79
- end
80
- def earnings=(_)
81
- end
66
+ attr_accessor :earnings
82
67
 
68
+ # The array of deductions objects associated with this pay statement.
83
69
  sig do
84
70
  returns(
85
71
  T.nilable(
@@ -87,23 +73,7 @@ module FinchAPI
87
73
  )
88
74
  )
89
75
  end
90
- def employee_deductions
91
- end
92
-
93
- sig do
94
- params(
95
- _: T.nilable(
96
- T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)]
97
- )
98
- )
99
- .returns(
100
- T.nilable(
101
- T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)]
102
- )
103
- )
104
- end
105
- def employee_deductions=(_)
106
- end
76
+ attr_accessor :employee_deductions
107
77
 
108
78
  sig do
109
79
  returns(
@@ -112,105 +82,89 @@ module FinchAPI
112
82
  )
113
83
  )
114
84
  end
115
- def employer_contributions
116
- end
117
-
118
- sig do
119
- params(
120
- _: T.nilable(
121
- T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)]
122
- )
123
- )
124
- .returns(
125
- T.nilable(
126
- T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)]
127
- )
128
- )
129
- end
130
- def employer_contributions=(_)
131
- end
85
+ attr_accessor :employer_contributions
132
86
 
133
87
  sig { returns(T.nilable(FinchAPI::Models::Money)) }
134
- def gross_pay
135
- end
88
+ attr_reader :gross_pay
136
89
 
137
- sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
138
- def gross_pay=(_)
139
- end
90
+ sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void }
91
+ attr_writer :gross_pay
140
92
 
93
+ # A stable Finch `id` (UUID v4) for an individual in the company
141
94
  sig { returns(T.nilable(String)) }
142
- def individual_id
143
- end
95
+ attr_reader :individual_id
144
96
 
145
- sig { params(_: String).returns(String) }
146
- def individual_id=(_)
147
- end
97
+ sig { params(individual_id: String).void }
98
+ attr_writer :individual_id
148
99
 
149
100
  sig { returns(T.nilable(FinchAPI::Models::Money)) }
150
- def net_pay
151
- end
152
-
153
- sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) }
154
- def net_pay=(_)
155
- end
101
+ attr_reader :net_pay
156
102
 
157
- sig { returns(T.nilable(Symbol)) }
158
- def payment_method
159
- end
103
+ sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void }
104
+ attr_writer :net_pay
160
105
 
161
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
162
- def payment_method=(_)
163
- end
106
+ # The payment method.
107
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) }
108
+ attr_accessor :payment_method
164
109
 
110
+ # The array of taxes objects associated with this pay statement.
165
111
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])) }
166
- def taxes
167
- end
168
-
169
- sig do
170
- params(
171
- _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])
172
- )
173
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]))
174
- end
175
- def taxes=(_)
176
- end
112
+ attr_accessor :taxes
177
113
 
114
+ # The number of hours worked for this pay period
178
115
  sig { returns(T.nilable(Float)) }
179
- def total_hours
180
- end
116
+ attr_accessor :total_hours
181
117
 
182
- sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) }
183
- def total_hours=(_)
184
- end
185
-
186
- sig { returns(T.nilable(Symbol)) }
187
- def type
188
- end
189
-
190
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
191
- def type=(_)
192
- end
118
+ # The type of the payment associated with the pay statement.
119
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) }
120
+ attr_accessor :type
193
121
 
194
122
  sig do
195
123
  params(
196
- earnings: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]),
124
+ earnings: T.nilable(
125
+ T::Array[
126
+ T.nilable(
127
+ T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, FinchAPI::Util::AnyHash)
128
+ )
129
+ ]
130
+ ),
197
131
  employee_deductions: T.nilable(
198
- T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)]
132
+ T::Array[
133
+ T.nilable(
134
+ T.any(
135
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction,
136
+ FinchAPI::Util::AnyHash
137
+ )
138
+ )
139
+ ]
199
140
  ),
200
141
  employer_contributions: T.nilable(
201
- T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)]
142
+ T::Array[
143
+ T.nilable(
144
+ T.any(
145
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution,
146
+ FinchAPI::Util::AnyHash
147
+ )
148
+ )
149
+ ]
202
150
  ),
203
- gross_pay: T.nilable(FinchAPI::Models::Money),
151
+ gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)),
204
152
  individual_id: String,
205
- net_pay: T.nilable(FinchAPI::Models::Money),
206
- payment_method: T.nilable(Symbol),
207
- taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]),
153
+ net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)),
154
+ payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol),
155
+ taxes: T.nilable(
156
+ T::Array[
157
+ T.nilable(
158
+ T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, FinchAPI::Util::AnyHash)
159
+ )
160
+ ]
161
+ ),
208
162
  total_hours: T.nilable(Float),
209
- type: T.nilable(Symbol)
163
+ type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)
210
164
  )
211
- .void
165
+ .returns(T.attached_class)
212
166
  end
213
- def initialize(
167
+ def self.new(
214
168
  earnings: nil,
215
169
  employee_deductions: nil,
216
170
  employer_contributions: nil,
@@ -238,10 +192,10 @@ module FinchAPI
238
192
  gross_pay: T.nilable(FinchAPI::Models::Money),
239
193
  individual_id: String,
240
194
  net_pay: T.nilable(FinchAPI::Models::Money),
241
- payment_method: T.nilable(Symbol),
195
+ payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol),
242
196
  taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]),
243
197
  total_hours: T.nilable(Float),
244
- type: T.nilable(Symbol)
198
+ type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)
245
199
  }
246
200
  )
247
201
  end
@@ -249,69 +203,60 @@ module FinchAPI
249
203
  end
250
204
 
251
205
  class Earning < FinchAPI::BaseModel
206
+ # The earnings amount in cents.
252
207
  sig { returns(T.nilable(Integer)) }
253
- def amount
254
- end
255
-
256
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
257
- def amount=(_)
258
- end
208
+ attr_accessor :amount
259
209
 
260
210
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes)) }
261
- def attributes
262
- end
211
+ attr_reader :attributes
263
212
 
264
213
  sig do
265
- params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes))
266
- .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes))
267
- end
268
- def attributes=(_)
214
+ params(
215
+ attributes: T.nilable(
216
+ T.any(
217
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes,
218
+ FinchAPI::Util::AnyHash
219
+ )
220
+ )
221
+ )
222
+ .void
269
223
  end
224
+ attr_writer :attributes
270
225
 
226
+ # The earnings currency code.
271
227
  sig { returns(T.nilable(String)) }
272
- def currency
273
- end
274
-
275
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
276
- def currency=(_)
277
- end
228
+ attr_accessor :currency
278
229
 
230
+ # The number of hours associated with this earning. (For salaried employees, this
231
+ # could be hours per pay period, `0` or `null`, depending on the provider).
279
232
  sig { returns(T.nilable(Float)) }
280
- def hours
281
- end
282
-
283
- sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) }
284
- def hours=(_)
285
- end
233
+ attr_accessor :hours
286
234
 
235
+ # The exact name of the deduction from the pay statement.
287
236
  sig { returns(T.nilable(String)) }
288
- def name
289
- end
290
-
291
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
292
- def name=(_)
293
- end
237
+ attr_accessor :name
294
238
 
295
- sig { returns(T.nilable(Symbol)) }
296
- def type
297
- end
298
-
299
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
300
- def type=(_)
301
- end
239
+ # The type of earning.
240
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) }
241
+ attr_accessor :type
302
242
 
303
243
  sig do
304
244
  params(
305
245
  amount: T.nilable(Integer),
306
- attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes),
246
+ attributes: T.nilable(
247
+ T.any(
248
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes,
249
+ FinchAPI::Util::AnyHash
250
+ )
251
+ ),
307
252
  currency: T.nilable(String),
308
253
  hours: T.nilable(Float),
309
254
  name: T.nilable(String),
310
- type: T.nilable(Symbol)
255
+ type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)
311
256
  )
312
- .void
257
+ .returns(T.attached_class)
313
258
  end
314
- def initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
259
+ def self.new(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
315
260
  end
316
261
 
317
262
  sig do
@@ -323,7 +268,7 @@ module FinchAPI
323
268
  currency: T.nilable(String),
324
269
  hours: T.nilable(Float),
325
270
  name: T.nilable(String),
326
- type: T.nilable(Symbol)
271
+ type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)
327
272
  }
328
273
  )
329
274
  end
@@ -336,23 +281,29 @@ module FinchAPI
336
281
  T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata)
337
282
  )
338
283
  end
339
- def metadata
340
- end
284
+ attr_reader :metadata
341
285
 
342
286
  sig do
343
- params(_: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata)
344
- .returns(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata)
345
- end
346
- def metadata=(_)
287
+ params(
288
+ metadata: T.any(
289
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata,
290
+ FinchAPI::Util::AnyHash
291
+ )
292
+ )
293
+ .void
347
294
  end
295
+ attr_writer :metadata
348
296
 
349
297
  sig do
350
298
  params(
351
- metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata
299
+ metadata: T.any(
300
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata,
301
+ FinchAPI::Util::AnyHash
302
+ )
352
303
  )
353
- .void
304
+ .returns(T.attached_class)
354
305
  end
355
- def initialize(metadata: nil)
306
+ def self.new(metadata: nil)
356
307
  end
357
308
 
358
309
  sig do
@@ -365,16 +316,17 @@ module FinchAPI
365
316
  end
366
317
 
367
318
  class Metadata < FinchAPI::BaseModel
319
+ # The metadata to be attached to the entity by existing rules. It is a key-value
320
+ # pairs where the values can be of any type (string, number, boolean, object,
321
+ # array, etc.).
368
322
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
369
- def metadata
370
- end
371
-
372
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
373
- def metadata=(_)
374
- end
323
+ attr_reader :metadata
375
324
 
376
325
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
377
- def initialize(metadata: nil)
326
+ attr_writer :metadata
327
+
328
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
329
+ def self.new(metadata: nil)
378
330
  end
379
331
 
380
332
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -383,101 +335,126 @@ module FinchAPI
383
335
  end
384
336
  end
385
337
 
386
- class Type < FinchAPI::Enum
387
- abstract!
338
+ # The type of earning.
339
+ module Type
340
+ extend FinchAPI::Enum
388
341
 
389
- SALARY = T.let(:salary, T.nilable(Symbol))
390
- WAGE = T.let(:wage, T.nilable(Symbol))
391
- REIMBURSEMENT = T.let(:reimbursement, T.nilable(Symbol))
392
- OVERTIME = T.let(:overtime, T.nilable(Symbol))
393
- SEVERANCE = T.let(:severance, T.nilable(Symbol))
394
- DOUBLE_OVERTIME = T.let(:double_overtime, T.nilable(Symbol))
395
- PTO = T.let(:pto, T.nilable(Symbol))
396
- SICK = T.let(:sick, T.nilable(Symbol))
397
- BONUS = T.let(:bonus, T.nilable(Symbol))
398
- COMMISSION = T.let(:commission, T.nilable(Symbol))
399
- TIPS = T.let(:tips, T.nilable(Symbol))
400
- NUMBER_1099 = T.let(:"1099", T.nilable(Symbol))
401
- OTHER = T.let(:other, T.nilable(Symbol))
342
+ TaggedSymbol =
343
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type) }
344
+ OrSymbol =
345
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) }
402
346
 
403
- sig { override.returns(T::Array[Symbol]) }
347
+ SALARY =
348
+ T.let(:salary, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
349
+ WAGE =
350
+ T.let(:wage, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
351
+ REIMBURSEMENT =
352
+ T.let(
353
+ :reimbursement,
354
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
355
+ )
356
+ OVERTIME =
357
+ T.let(
358
+ :overtime,
359
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
360
+ )
361
+ SEVERANCE =
362
+ T.let(
363
+ :severance,
364
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
365
+ )
366
+ DOUBLE_OVERTIME =
367
+ T.let(
368
+ :double_overtime,
369
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
370
+ )
371
+ PTO =
372
+ T.let(:pto, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
373
+ SICK =
374
+ T.let(:sick, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
375
+ BONUS =
376
+ T.let(:bonus, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
377
+ COMMISSION =
378
+ T.let(
379
+ :commission,
380
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
381
+ )
382
+ TIPS =
383
+ T.let(:tips, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
384
+ NUMBER_1099 =
385
+ T.let(:"1099", FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
386
+ OTHER =
387
+ T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol)
388
+
389
+ sig do
390
+ override
391
+ .returns(
392
+ T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol]
393
+ )
394
+ end
404
395
  def self.values
405
396
  end
406
397
  end
407
398
  end
408
399
 
409
400
  class EmployeeDeduction < FinchAPI::BaseModel
401
+ # The deduction amount in cents.
410
402
  sig { returns(T.nilable(Integer)) }
411
- def amount
412
- end
413
-
414
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
415
- def amount=(_)
416
- end
403
+ attr_accessor :amount
417
404
 
418
405
  sig do
419
406
  returns(
420
407
  T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes)
421
408
  )
422
409
  end
423
- def attributes
424
- end
410
+ attr_reader :attributes
425
411
 
426
412
  sig do
427
413
  params(
428
- _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes)
429
- )
430
- .returns(
431
- T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes)
414
+ attributes: T.nilable(
415
+ T.any(
416
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes,
417
+ FinchAPI::Util::AnyHash
418
+ )
432
419
  )
420
+ )
421
+ .void
433
422
  end
434
- def attributes=(_)
435
- end
423
+ attr_writer :attributes
436
424
 
425
+ # The deduction currency.
437
426
  sig { returns(T.nilable(String)) }
438
- def currency
439
- end
440
-
441
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
442
- def currency=(_)
443
- end
427
+ attr_accessor :currency
444
428
 
429
+ # The deduction name from the pay statement.
445
430
  sig { returns(T.nilable(String)) }
446
- def name
447
- end
448
-
449
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
450
- def name=(_)
451
- end
431
+ attr_accessor :name
452
432
 
433
+ # Boolean indicating if the deduction is pre-tax.
453
434
  sig { returns(T.nilable(T::Boolean)) }
454
- def pre_tax
455
- end
456
-
457
- sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
458
- def pre_tax=(_)
459
- end
435
+ attr_accessor :pre_tax
460
436
 
461
- sig { returns(T.nilable(Symbol)) }
462
- def type
463
- end
464
-
465
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
466
- def type=(_)
467
- end
437
+ # Type of benefit.
438
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) }
439
+ attr_accessor :type
468
440
 
469
441
  sig do
470
442
  params(
471
443
  amount: T.nilable(Integer),
472
- attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes),
444
+ attributes: T.nilable(
445
+ T.any(
446
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes,
447
+ FinchAPI::Util::AnyHash
448
+ )
449
+ ),
473
450
  currency: T.nilable(String),
474
451
  name: T.nilable(String),
475
452
  pre_tax: T.nilable(T::Boolean),
476
- type: T.nilable(Symbol)
453
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
477
454
  )
478
- .void
455
+ .returns(T.attached_class)
479
456
  end
480
- def initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
457
+ def self.new(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
481
458
  end
482
459
 
483
460
  sig do
@@ -489,7 +466,7 @@ module FinchAPI
489
466
  currency: T.nilable(String),
490
467
  name: T.nilable(String),
491
468
  pre_tax: T.nilable(T::Boolean),
492
- type: T.nilable(Symbol)
469
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
493
470
  }
494
471
  )
495
472
  end
@@ -504,27 +481,29 @@ module FinchAPI
504
481
  )
505
482
  )
506
483
  end
507
- def metadata
508
- end
484
+ attr_reader :metadata
509
485
 
510
486
  sig do
511
487
  params(
512
- _: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
513
- )
514
- .returns(
515
- FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
488
+ metadata: T.any(
489
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata,
490
+ FinchAPI::Util::AnyHash
516
491
  )
492
+ )
493
+ .void
517
494
  end
518
- def metadata=(_)
519
- end
495
+ attr_writer :metadata
520
496
 
521
497
  sig do
522
498
  params(
523
- metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
499
+ metadata: T.any(
500
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata,
501
+ FinchAPI::Util::AnyHash
502
+ )
524
503
  )
525
- .void
504
+ .returns(T.attached_class)
526
505
  end
527
- def initialize(metadata: nil)
506
+ def self.new(metadata: nil)
528
507
  end
529
508
 
530
509
  sig do
@@ -539,16 +518,17 @@ module FinchAPI
539
518
  end
540
519
 
541
520
  class Metadata < FinchAPI::BaseModel
521
+ # The metadata to be attached to the entity by existing rules. It is a key-value
522
+ # pairs where the values can be of any type (string, number, boolean, object,
523
+ # array, etc.).
542
524
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
543
- def metadata
544
- end
545
-
546
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
547
- def metadata=(_)
548
- end
525
+ attr_reader :metadata
549
526
 
550
527
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
551
- def initialize(metadata: nil)
528
+ attr_writer :metadata
529
+
530
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
531
+ def self.new(metadata: nil)
552
532
  end
553
533
 
554
534
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -559,68 +539,58 @@ module FinchAPI
559
539
  end
560
540
 
561
541
  class EmployerContribution < FinchAPI::BaseModel
542
+ # The contribution amount in cents.
562
543
  sig { returns(T.nilable(Integer)) }
563
- def amount
564
- end
565
-
566
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
567
- def amount=(_)
568
- end
544
+ attr_accessor :amount
569
545
 
570
546
  sig do
571
547
  returns(
572
548
  T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes)
573
549
  )
574
550
  end
575
- def attributes
576
- end
551
+ attr_reader :attributes
577
552
 
578
553
  sig do
579
554
  params(
580
- _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes)
581
- )
582
- .returns(
583
- T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes)
555
+ attributes: T.nilable(
556
+ T.any(
557
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes,
558
+ FinchAPI::Util::AnyHash
559
+ )
584
560
  )
561
+ )
562
+ .void
585
563
  end
586
- def attributes=(_)
587
- end
564
+ attr_writer :attributes
588
565
 
566
+ # The contribution currency.
589
567
  sig { returns(T.nilable(String)) }
590
- def currency
591
- end
592
-
593
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
594
- def currency=(_)
595
- end
568
+ attr_accessor :currency
596
569
 
570
+ # The contribution name from the pay statement.
597
571
  sig { returns(T.nilable(String)) }
598
- def name
599
- end
572
+ attr_accessor :name
600
573
 
601
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
602
- def name=(_)
603
- end
604
-
605
- sig { returns(T.nilable(Symbol)) }
606
- def type
607
- end
608
-
609
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
610
- def type=(_)
611
- end
574
+ # Type of benefit.
575
+ sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) }
576
+ attr_accessor :type
612
577
 
613
578
  sig do
614
579
  params(
615
580
  amount: T.nilable(Integer),
616
- attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes),
581
+ attributes: T.nilable(
582
+ T.any(
583
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes,
584
+ FinchAPI::Util::AnyHash
585
+ )
586
+ ),
617
587
  currency: T.nilable(String),
618
588
  name: T.nilable(String),
619
- type: T.nilable(Symbol)
589
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
620
590
  )
621
- .void
591
+ .returns(T.attached_class)
622
592
  end
623
- def initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
593
+ def self.new(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
624
594
  end
625
595
 
626
596
  sig do
@@ -631,7 +601,7 @@ module FinchAPI
631
601
  attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes),
632
602
  currency: T.nilable(String),
633
603
  name: T.nilable(String),
634
- type: T.nilable(Symbol)
604
+ type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
635
605
  }
636
606
  )
637
607
  end
@@ -646,27 +616,29 @@ module FinchAPI
646
616
  )
647
617
  )
648
618
  end
649
- def metadata
650
- end
619
+ attr_reader :metadata
651
620
 
652
621
  sig do
653
622
  params(
654
- _: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
655
- )
656
- .returns(
657
- FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
623
+ metadata: T.any(
624
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata,
625
+ FinchAPI::Util::AnyHash
658
626
  )
627
+ )
628
+ .void
659
629
  end
660
- def metadata=(_)
661
- end
630
+ attr_writer :metadata
662
631
 
663
632
  sig do
664
633
  params(
665
- metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
634
+ metadata: T.any(
635
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata,
636
+ FinchAPI::Util::AnyHash
637
+ )
666
638
  )
667
- .void
639
+ .returns(T.attached_class)
668
640
  end
669
- def initialize(metadata: nil)
641
+ def self.new(metadata: nil)
670
642
  end
671
643
 
672
644
  sig do
@@ -681,16 +653,17 @@ module FinchAPI
681
653
  end
682
654
 
683
655
  class Metadata < FinchAPI::BaseModel
656
+ # The metadata to be attached to the entity by existing rules. It is a key-value
657
+ # pairs where the values can be of any type (string, number, boolean, object,
658
+ # array, etc.).
684
659
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
685
- def metadata
686
- end
687
-
688
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
689
- def metadata=(_)
690
- end
660
+ attr_reader :metadata
691
661
 
692
662
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
693
- def initialize(metadata: nil)
663
+ attr_writer :metadata
664
+
665
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
666
+ def self.new(metadata: nil)
694
667
  end
695
668
 
696
669
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -700,81 +673,87 @@ module FinchAPI
700
673
  end
701
674
  end
702
675
 
703
- class PaymentMethod < FinchAPI::Enum
704
- abstract!
676
+ # The payment method.
677
+ module PaymentMethod
678
+ extend FinchAPI::Enum
679
+
680
+ TaggedSymbol =
681
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod) }
682
+ OrSymbol =
683
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol) }
705
684
 
706
- CHECK = T.let(:check, T.nilable(Symbol))
707
- DIRECT_DEPOSIT = T.let(:direct_deposit, T.nilable(Symbol))
685
+ CHECK =
686
+ T.let(:check, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol)
687
+ DIRECT_DEPOSIT =
688
+ T.let(
689
+ :direct_deposit,
690
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol
691
+ )
708
692
 
709
- sig { override.returns(T::Array[Symbol]) }
693
+ sig do
694
+ override
695
+ .returns(
696
+ T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol]
697
+ )
698
+ end
710
699
  def self.values
711
700
  end
712
701
  end
713
702
 
714
703
  class Tax < FinchAPI::BaseModel
704
+ # The tax amount in cents.
715
705
  sig { returns(T.nilable(Integer)) }
716
- def amount
717
- end
718
-
719
- sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
720
- def amount=(_)
721
- end
706
+ attr_accessor :amount
722
707
 
723
708
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes)) }
724
- def attributes
725
- end
709
+ attr_reader :attributes
726
710
 
727
711
  sig do
728
- params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes))
729
- .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes))
730
- end
731
- def attributes=(_)
712
+ params(
713
+ attributes: T.nilable(
714
+ T.any(
715
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes,
716
+ FinchAPI::Util::AnyHash
717
+ )
718
+ )
719
+ )
720
+ .void
732
721
  end
722
+ attr_writer :attributes
733
723
 
724
+ # The currency code.
734
725
  sig { returns(T.nilable(String)) }
735
- def currency
736
- end
737
-
738
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
739
- def currency=(_)
740
- end
726
+ attr_accessor :currency
741
727
 
728
+ # `true` if the amount is paid by the employers.
742
729
  sig { returns(T.nilable(T::Boolean)) }
743
- def employer
744
- end
745
-
746
- sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
747
- def employer=(_)
748
- end
730
+ attr_accessor :employer
749
731
 
732
+ # The exact name of tax from the pay statement.
750
733
  sig { returns(T.nilable(String)) }
751
- def name
752
- end
753
-
754
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
755
- def name=(_)
756
- end
757
-
758
- sig { returns(T.nilable(Symbol)) }
759
- def type
760
- end
734
+ attr_accessor :name
761
735
 
762
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
763
- def type=(_)
764
- end
736
+ # The type of taxes.
737
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) }
738
+ attr_accessor :type
765
739
 
766
740
  sig do
767
741
  params(
768
742
  amount: T.nilable(Integer),
769
- attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes),
743
+ attributes: T.nilable(
744
+ T.any(
745
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes,
746
+ FinchAPI::Util::AnyHash
747
+ )
748
+ ),
770
749
  currency: T.nilable(String),
771
750
  employer: T.nilable(T::Boolean),
772
751
  name: T.nilable(String),
773
- type: T.nilable(Symbol)
752
+ type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)
774
753
  )
775
- .void
754
+ .returns(T.attached_class)
776
755
  end
777
- def initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
756
+ def self.new(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
778
757
  end
779
758
 
780
759
  sig do
@@ -786,7 +765,7 @@ module FinchAPI
786
765
  currency: T.nilable(String),
787
766
  employer: T.nilable(T::Boolean),
788
767
  name: T.nilable(String),
789
- type: T.nilable(Symbol)
768
+ type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)
790
769
  }
791
770
  )
792
771
  end
@@ -799,21 +778,29 @@ module FinchAPI
799
778
  T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata)
800
779
  )
801
780
  end
802
- def metadata
803
- end
781
+ attr_reader :metadata
804
782
 
805
783
  sig do
806
- params(_: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata)
807
- .returns(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata)
808
- end
809
- def metadata=(_)
784
+ params(
785
+ metadata: T.any(
786
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata,
787
+ FinchAPI::Util::AnyHash
788
+ )
789
+ )
790
+ .void
810
791
  end
792
+ attr_writer :metadata
811
793
 
812
794
  sig do
813
- params(metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata)
814
- .void
795
+ params(
796
+ metadata: T.any(
797
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata,
798
+ FinchAPI::Util::AnyHash
799
+ )
800
+ )
801
+ .returns(T.attached_class)
815
802
  end
816
- def initialize(metadata: nil)
803
+ def self.new(metadata: nil)
817
804
  end
818
805
 
819
806
  sig do
@@ -826,16 +813,17 @@ module FinchAPI
826
813
  end
827
814
 
828
815
  class Metadata < FinchAPI::BaseModel
816
+ # The metadata to be attached to the entity by existing rules. It is a key-value
817
+ # pairs where the values can be of any type (string, number, boolean, object,
818
+ # array, etc.).
829
819
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
830
- def metadata
831
- end
832
-
833
- sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) }
834
- def metadata=(_)
835
- end
820
+ attr_reader :metadata
836
821
 
837
822
  sig { params(metadata: T::Hash[Symbol, T.anything]).void }
838
- def initialize(metadata: nil)
823
+ attr_writer :metadata
824
+
825
+ sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) }
826
+ def self.new(metadata: nil)
839
827
  end
840
828
 
841
829
  sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) }
@@ -844,28 +832,56 @@ module FinchAPI
844
832
  end
845
833
  end
846
834
 
847
- class Type < FinchAPI::Enum
848
- abstract!
835
+ # The type of taxes.
836
+ module Type
837
+ extend FinchAPI::Enum
849
838
 
850
- STATE = T.let(:state, T.nilable(Symbol))
851
- FEDERAL = T.let(:federal, T.nilable(Symbol))
852
- LOCAL = T.let(:local, T.nilable(Symbol))
853
- FICA = T.let(:fica, T.nilable(Symbol))
839
+ TaggedSymbol =
840
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type) }
841
+ OrSymbol =
842
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) }
854
843
 
855
- sig { override.returns(T::Array[Symbol]) }
844
+ STATE =
845
+ T.let(:state, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
846
+ FEDERAL =
847
+ T.let(:federal, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
848
+ LOCAL =
849
+ T.let(:local, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
850
+ FICA =
851
+ T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol)
852
+
853
+ sig do
854
+ override
855
+ .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol])
856
+ end
856
857
  def self.values
857
858
  end
858
859
  end
859
860
  end
860
861
 
861
- class Type < FinchAPI::Enum
862
- abstract!
862
+ # The type of the payment associated with the pay statement.
863
+ module Type
864
+ extend FinchAPI::Enum
863
865
 
864
- REGULAR_PAYROLL = T.let(:regular_payroll, T.nilable(Symbol))
865
- OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, T.nilable(Symbol))
866
- ONE_TIME_PAYMENT = T.let(:one_time_payment, T.nilable(Symbol))
866
+ TaggedSymbol =
867
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type) }
868
+ OrSymbol =
869
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) }
870
+
871
+ REGULAR_PAYROLL =
872
+ T.let(:regular_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol)
873
+ OFF_CYCLE_PAYROLL =
874
+ T.let(
875
+ :off_cycle_payroll,
876
+ FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol
877
+ )
878
+ ONE_TIME_PAYMENT =
879
+ T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol)
867
880
 
868
- sig { override.returns(T::Array[Symbol]) }
881
+ sig do
882
+ override
883
+ .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol])
884
+ end
869
885
  def self.values
870
886
  end
871
887
  end