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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (288) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +37 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/finch_api/errors.rb +22 -0
  6. data/lib/finch_api/internal/individuals_page.rb +1 -1
  7. data/lib/finch_api/internal/page.rb +1 -1
  8. data/lib/finch_api/internal/type/array_of.rb +14 -1
  9. data/lib/finch_api/internal/type/base_model.rb +84 -25
  10. data/lib/finch_api/internal/type/boolean.rb +15 -1
  11. data/lib/finch_api/internal/type/converter.rb +42 -34
  12. data/lib/finch_api/internal/type/enum.rb +25 -2
  13. data/lib/finch_api/internal/type/file_input.rb +13 -1
  14. data/lib/finch_api/internal/type/hash_of.rb +14 -1
  15. data/lib/finch_api/internal/type/union.rb +27 -7
  16. data/lib/finch_api/internal/type/unknown.rb +15 -1
  17. data/lib/finch_api/internal/util.rb +62 -10
  18. data/lib/finch_api/internal.rb +3 -0
  19. data/lib/finch_api/models/account_update_event.rb +110 -109
  20. data/lib/finch_api/models/base_webhook_event.rb +1 -1
  21. data/lib/finch_api/models/company_event.rb +2 -2
  22. data/lib/finch_api/models/connect/session_new_params.rb +12 -12
  23. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +2 -2
  24. data/lib/finch_api/models/create_access_token_response.rb +7 -7
  25. data/lib/finch_api/models/directory_event.rb +4 -4
  26. data/lib/finch_api/models/employment_event.rb +4 -4
  27. data/lib/finch_api/models/hris/benefit_contribution.rb +3 -3
  28. data/lib/finch_api/models/hris/benefit_create_params.rb +11 -11
  29. data/lib/finch_api/models/hris/benefit_features_and_operations.rb +5 -120
  30. data/lib/finch_api/models/hris/benefit_type.rb +10 -10
  31. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +11 -11
  32. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +23 -23
  33. data/lib/finch_api/models/hris/benefits_support.rb +24 -24
  34. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +11 -11
  35. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +2 -2
  36. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +18 -18
  37. data/lib/finch_api/models/hris/company.rb +23 -23
  38. data/lib/finch_api/models/hris/company_benefit.rb +12 -12
  39. data/lib/finch_api/models/hris/document_list_params.rb +2 -2
  40. data/lib/finch_api/models/hris/document_list_response.rb +4 -4
  41. data/lib/finch_api/models/hris/document_response.rb +4 -4
  42. data/lib/finch_api/models/hris/document_retreive_response.rb +1 -5
  43. data/lib/finch_api/models/hris/employment_data.rb +89 -100
  44. data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
  45. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -3
  46. data/lib/finch_api/models/hris/individual.rb +20 -26
  47. data/lib/finch_api/models/hris/individual_in_directory.rb +6 -6
  48. data/lib/finch_api/models/hris/individual_response.rb +2 -2
  49. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +4 -4
  50. data/lib/finch_api/models/hris/pay_statement.rb +184 -182
  51. data/lib/finch_api/models/hris/pay_statement_data_sync_in_progress.rb +76 -0
  52. data/lib/finch_api/models/hris/pay_statement_response.rb +50 -8
  53. data/lib/finch_api/models/hris/pay_statement_response_body.rb +27 -9
  54. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +2 -2
  55. data/lib/finch_api/models/hris/payment.rb +37 -37
  56. data/lib/finch_api/models/hris/support_per_benefit_type.rb +4 -4
  57. data/lib/finch_api/models/hris/supported_benefit.rb +10 -9
  58. data/lib/finch_api/models/hris/w42005.rb +12 -12
  59. data/lib/finch_api/models/hris/w42020.rb +10 -10
  60. data/lib/finch_api/models/income.rb +8 -8
  61. data/lib/finch_api/models/individual_event.rb +4 -4
  62. data/lib/finch_api/models/introspection.rb +23 -23
  63. data/lib/finch_api/models/job_completion_event.rb +4 -4
  64. data/lib/finch_api/models/jobs/automated_async_job.rb +10 -10
  65. data/lib/finch_api/models/jobs/automated_create_params.rb +4 -4
  66. data/lib/finch_api/models/jobs/automated_list_response.rb +2 -2
  67. data/lib/finch_api/models/jobs/manual_async_job.rb +3 -3
  68. data/lib/finch_api/models/money.rb +4 -4
  69. data/lib/finch_api/models/operation_support_matrix.rb +9 -9
  70. data/lib/finch_api/models/pay_statement_event.rb +4 -4
  71. data/lib/finch_api/models/payment_event.rb +4 -4
  72. data/lib/finch_api/models/payroll/pay_group_list_response.rb +12 -12
  73. data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb +5 -5
  74. data/lib/finch_api/models/provider.rb +104 -104
  75. data/lib/finch_api/models/sandbox/company_update_params.rb +21 -21
  76. data/lib/finch_api/models/sandbox/company_update_response.rb +2 -2
  77. data/lib/finch_api/models/sandbox/connection_create_params.rb +2 -2
  78. data/lib/finch_api/models/sandbox/connections/account_create_params.rb +2 -2
  79. data/lib/finch_api/models/sandbox/connections/account_update_params.rb +2 -2
  80. data/lib/finch_api/models/sandbox/directory_create_params.rb +49 -48
  81. data/lib/finch_api/models/sandbox/employment_update_params.rb +24 -23
  82. data/lib/finch_api/models/sandbox/employment_update_response.rb +6 -6
  83. data/lib/finch_api/models/sandbox/individual_update_params.rb +16 -16
  84. data/lib/finch_api/models/sandbox/individual_update_response.rb +2 -2
  85. data/lib/finch_api/models/sandbox/job_create_params.rb +2 -2
  86. data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -6
  87. data/lib/finch_api/models/sandbox/payment_create_params.rb +160 -367
  88. data/lib/finch_api/models/webhook_event.rb +1 -16
  89. data/lib/finch_api/models.rb +30 -19
  90. data/lib/finch_api/resources/access_tokens.rb +1 -1
  91. data/lib/finch_api/resources/account.rb +2 -2
  92. data/lib/finch_api/resources/connect/sessions.rb +5 -5
  93. data/lib/finch_api/resources/hris/benefits/individuals.rb +4 -4
  94. data/lib/finch_api/resources/hris/benefits.rb +9 -9
  95. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +3 -3
  96. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +1 -1
  97. data/lib/finch_api/resources/hris/company.rb +1 -1
  98. data/lib/finch_api/resources/hris/directory.rb +1 -1
  99. data/lib/finch_api/resources/hris/documents.rb +2 -2
  100. data/lib/finch_api/resources/hris/employments.rb +2 -2
  101. data/lib/finch_api/resources/hris/individuals.rb +3 -3
  102. data/lib/finch_api/resources/hris/pay_statements.rb +2 -2
  103. data/lib/finch_api/resources/hris/payments.rb +1 -1
  104. data/lib/finch_api/resources/jobs/automated.rb +3 -3
  105. data/lib/finch_api/resources/jobs/manual.rb +1 -1
  106. data/lib/finch_api/resources/providers.rb +1 -1
  107. data/lib/finch_api/resources/sandbox/company.rb +4 -4
  108. data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -2
  109. data/lib/finch_api/resources/sandbox/connections.rb +1 -1
  110. data/lib/finch_api/resources/sandbox/directory.rb +1 -1
  111. data/lib/finch_api/resources/sandbox/employment.rb +8 -8
  112. data/lib/finch_api/resources/sandbox/individual.rb +5 -5
  113. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +4 -4
  114. data/lib/finch_api/resources/sandbox/jobs.rb +1 -1
  115. data/lib/finch_api/resources/sandbox/payment.rb +6 -3
  116. data/lib/finch_api/version.rb +1 -1
  117. data/lib/finch_api.rb +4 -2
  118. data/rbi/finch_api/errors.rbi +16 -0
  119. data/rbi/finch_api/internal/type/array_of.rbi +6 -0
  120. data/rbi/finch_api/internal/type/base_model.rbi +5 -0
  121. data/rbi/finch_api/internal/type/boolean.rbi +8 -0
  122. data/rbi/finch_api/internal/type/converter.rbi +15 -15
  123. data/rbi/finch_api/internal/type/enum.rbi +5 -0
  124. data/rbi/finch_api/internal/type/file_input.rbi +5 -0
  125. data/rbi/finch_api/internal/type/hash_of.rbi +6 -0
  126. data/rbi/finch_api/internal/type/union.rbi +10 -0
  127. data/rbi/finch_api/internal/type/unknown.rbi +8 -0
  128. data/rbi/finch_api/internal/util.rbi +36 -0
  129. data/rbi/finch_api/internal.rbi +3 -0
  130. data/rbi/finch_api/models/connect/session_new_params.rbi +4 -4
  131. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +4 -296
  132. data/rbi/finch_api/models/hris/benefit_type.rbi +16 -16
  133. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +18 -33
  134. data/rbi/finch_api/models/hris/employment_data.rbi +123 -141
  135. data/rbi/finch_api/models/hris/employment_data_response.rbi +2 -13
  136. data/rbi/finch_api/models/hris/individual_response.rbi +2 -13
  137. data/rbi/finch_api/models/hris/pay_statement.rbi +275 -307
  138. data/rbi/finch_api/models/hris/pay_statement_data_sync_in_progress.rbi +188 -0
  139. data/rbi/finch_api/models/hris/pay_statement_response.rbi +84 -20
  140. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +45 -17
  141. data/rbi/finch_api/models/hris/payment.rbi +27 -30
  142. data/rbi/finch_api/models/hris/supported_benefit.rbi +12 -8
  143. data/rbi/finch_api/models/income.rbi +3 -3
  144. data/rbi/finch_api/models/money.rbi +4 -7
  145. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +25 -43
  146. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +14 -14
  147. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +463 -727
  148. data/rbi/finch_api/resources/connect/sessions.rbi +2 -2
  149. data/rbi/finch_api/resources/hris/benefits.rbi +1 -3
  150. data/rbi/finch_api/resources/hris/documents.rbi +1 -1
  151. data/rbi/finch_api/resources/sandbox/payment.rbi +3 -2
  152. data/sig/finch_api/errors.rbs +9 -0
  153. data/sig/finch_api/internal/type/array_of.rbs +3 -0
  154. data/sig/finch_api/internal/type/base_model.rbs +2 -0
  155. data/sig/finch_api/internal/type/boolean.rbs +3 -0
  156. data/sig/finch_api/internal/type/converter.rbs +7 -1
  157. data/sig/finch_api/internal/type/enum.rbs +2 -0
  158. data/sig/finch_api/internal/type/file_input.rbs +2 -0
  159. data/sig/finch_api/internal/type/hash_of.rbs +3 -0
  160. data/sig/finch_api/internal/type/union.rbs +2 -0
  161. data/sig/finch_api/internal/type/unknown.rbs +3 -0
  162. data/sig/finch_api/internal/util.rbs +12 -0
  163. data/sig/finch_api/internal.rbs +2 -0
  164. data/sig/finch_api/models/access_token_create_params.rbs +8 -0
  165. data/sig/finch_api/models/account_disconnect_params.rbs +2 -0
  166. data/sig/finch_api/models/account_introspect_params.rbs +2 -0
  167. data/sig/finch_api/models/account_update_event.rbs +230 -12
  168. data/sig/finch_api/models/base_webhook_event.rbs +6 -0
  169. data/sig/finch_api/models/company_event.rbs +11 -6
  170. data/sig/finch_api/models/connect/session_new_params.rbs +26 -8
  171. data/sig/finch_api/models/connect/session_new_response.rbs +2 -0
  172. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +12 -4
  173. data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +2 -0
  174. data/sig/finch_api/models/create_access_token_response.rbs +21 -8
  175. data/sig/finch_api/models/directory_event.rbs +13 -6
  176. data/sig/finch_api/models/disconnect_response.rbs +2 -0
  177. data/sig/finch_api/models/employment_event.rbs +13 -6
  178. data/sig/finch_api/models/hris/benefit_contribution.rbs +12 -4
  179. data/sig/finch_api/models/hris/benefit_create_params.rbs +21 -6
  180. data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +9 -78
  181. data/sig/finch_api/models/hris/benefit_list_params.rbs +2 -0
  182. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +2 -0
  183. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +2 -0
  184. data/sig/finch_api/models/hris/benefit_type.rbs +21 -21
  185. data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -0
  186. data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +2 -0
  187. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +18 -4
  188. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +47 -18
  189. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +2 -0
  190. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +5 -0
  191. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +5 -0
  192. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +5 -0
  193. data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +2 -0
  194. data/sig/finch_api/models/hris/benefits_support.rbs +15 -0
  195. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +23 -6
  196. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +20 -0
  197. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +2 -0
  198. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +21 -0
  199. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +2 -0
  200. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +20 -0
  201. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +5 -0
  202. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +20 -0
  203. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +15 -6
  204. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +23 -20
  205. data/sig/finch_api/models/hris/company.rbs +44 -12
  206. data/sig/finch_api/models/hris/company_benefit.rbs +21 -6
  207. data/sig/finch_api/models/hris/company_retrieve_params.rbs +2 -0
  208. data/sig/finch_api/models/hris/create_company_benefits_response.rbs +2 -0
  209. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +6 -0
  210. data/sig/finch_api/models/hris/directory_list_params.rbs +6 -0
  211. data/sig/finch_api/models/hris/document_list_params.rbs +14 -6
  212. data/sig/finch_api/models/hris/document_list_response.rbs +5 -0
  213. data/sig/finch_api/models/hris/document_response.rbs +14 -6
  214. data/sig/finch_api/models/hris/document_retreive_params.rbs +2 -0
  215. data/sig/finch_api/models/hris/employment_data.rbs +91 -47
  216. data/sig/finch_api/models/hris/employment_data_response.rbs +6 -0
  217. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +7 -0
  218. data/sig/finch_api/models/hris/individual.rbs +49 -16
  219. data/sig/finch_api/models/hris/individual_in_directory.rbs +14 -0
  220. data/sig/finch_api/models/hris/individual_response.rbs +6 -0
  221. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +10 -0
  222. data/sig/finch_api/models/hris/pay_statement.rbs +179 -133
  223. data/sig/finch_api/models/hris/pay_statement_data_sync_in_progress.rbs +78 -0
  224. data/sig/finch_api/models/hris/pay_statement_response.rbs +51 -13
  225. data/sig/finch_api/models/hris/pay_statement_response_body.rbs +24 -11
  226. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +11 -0
  227. data/sig/finch_api/models/hris/payment.rbs +44 -29
  228. data/sig/finch_api/models/hris/payment_list_params.rbs +6 -0
  229. data/sig/finch_api/models/hris/support_per_benefit_type.rbs +5 -0
  230. data/sig/finch_api/models/hris/supported_benefit.rbs +22 -12
  231. data/sig/finch_api/models/hris/update_company_benefit_response.rbs +2 -0
  232. data/sig/finch_api/models/hris/w42005.rbs +30 -16
  233. data/sig/finch_api/models/hris/w42020.rbs +27 -10
  234. data/sig/finch_api/models/income.rbs +14 -7
  235. data/sig/finch_api/models/individual_event.rbs +13 -6
  236. data/sig/finch_api/models/introspection.rbs +51 -14
  237. data/sig/finch_api/models/job_completion_event.rbs +13 -6
  238. data/sig/finch_api/models/jobs/automated_async_job.rbs +22 -8
  239. data/sig/finch_api/models/jobs/automated_create_params.rbs +8 -0
  240. data/sig/finch_api/models/jobs/automated_create_response.rbs +7 -0
  241. data/sig/finch_api/models/jobs/automated_list_params.rbs +6 -0
  242. data/sig/finch_api/models/jobs/automated_list_response.rbs +18 -0
  243. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +2 -0
  244. data/sig/finch_api/models/jobs/manual_async_job.rbs +10 -4
  245. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +2 -0
  246. data/sig/finch_api/models/location.rbs +11 -0
  247. data/sig/finch_api/models/money.rbs +3 -3
  248. data/sig/finch_api/models/operation_support_matrix.rbs +7 -0
  249. data/sig/finch_api/models/paging.rbs +2 -0
  250. data/sig/finch_api/models/pay_statement_event.rbs +13 -6
  251. data/sig/finch_api/models/payment_event.rbs +13 -6
  252. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +6 -0
  253. data/sig/finch_api/models/payroll/pay_group_list_response.rbs +22 -24
  254. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +2 -0
  255. data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +17 -10
  256. data/sig/finch_api/models/provider.rbs +227 -6
  257. data/sig/finch_api/models/provider_list_params.rbs +2 -0
  258. data/sig/finch_api/models/request_forwarding_forward_params.rbs +9 -0
  259. data/sig/finch_api/models/request_forwarding_forward_response.rbs +15 -0
  260. data/sig/finch_api/models/sandbox/company_update_params.rbs +44 -12
  261. data/sig/finch_api/models/sandbox/company_update_response.rbs +31 -0
  262. data/sig/finch_api/models/sandbox/connection_create_params.rbs +8 -0
  263. data/sig/finch_api/models/sandbox/connection_create_response.rbs +11 -0
  264. data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +8 -0
  265. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +10 -0
  266. data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +5 -0
  267. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +9 -0
  268. data/sig/finch_api/models/sandbox/directory_create_params.rbs +84 -28
  269. data/sig/finch_api/models/sandbox/employment_update_params.rbs +41 -8
  270. data/sig/finch_api/models/sandbox/employment_update_response.rbs +33 -0
  271. data/sig/finch_api/models/sandbox/individual_update_params.rbs +34 -8
  272. data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
  273. data/sig/finch_api/models/sandbox/job_create_params.rbs +5 -0
  274. data/sig/finch_api/models/sandbox/job_create_response.rbs +7 -0
  275. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +2 -0
  276. data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +2 -0
  277. data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +13 -8
  278. data/sig/finch_api/models/sandbox/payment_create_params.rbs +287 -228
  279. data/sig/finch_api/models/sandbox/payment_create_response.rbs +2 -0
  280. data/sig/finch_api/resources/connect/sessions.rbs +2 -2
  281. data/sig/finch_api/resources/hris/benefits.rbs +1 -1
  282. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
  283. data/sig/finch_api/resources/hris/documents.rbs +1 -1
  284. data/sig/finch_api/resources/sandbox/payment.rbs +2 -2
  285. metadata +5 -5
  286. data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +0 -110
  287. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +0 -290
  288. data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -79
@@ -15,12 +15,13 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- sig { returns(T.nilable(String)) }
18
+ sig { returns(T.nilable(Date)) }
19
19
  attr_reader :end_date
20
20
 
21
- sig { params(end_date: String).void }
21
+ sig { params(end_date: Date).void }
22
22
  attr_writer :end_date
23
23
 
24
+ # Array of pay statements to include in the payment.
24
25
  sig do
25
26
  returns(
26
27
  T.nilable(
@@ -40,25 +41,26 @@ module FinchAPI
40
41
  end
41
42
  attr_writer :pay_statements
42
43
 
43
- sig { returns(T.nilable(String)) }
44
+ sig { returns(T.nilable(Date)) }
44
45
  attr_reader :start_date
45
46
 
46
- sig { params(start_date: String).void }
47
+ sig { params(start_date: Date).void }
47
48
  attr_writer :start_date
48
49
 
49
50
  sig do
50
51
  params(
51
- end_date: String,
52
+ end_date: Date,
52
53
  pay_statements:
53
54
  T::Array[
54
55
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::OrHash
55
56
  ],
56
- start_date: String,
57
+ start_date: Date,
57
58
  request_options: FinchAPI::RequestOptions::OrHash
58
59
  ).returns(T.attached_class)
59
60
  end
60
61
  def self.new(
61
62
  end_date: nil,
63
+ # Array of pay statements to include in the payment.
62
64
  pay_statements: nil,
63
65
  start_date: nil,
64
66
  request_options: {}
@@ -68,10 +70,10 @@ module FinchAPI
68
70
  sig do
69
71
  override.returns(
70
72
  {
71
- end_date: String,
73
+ end_date: Date,
72
74
  pay_statements:
73
75
  T::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement],
74
- start_date: String,
76
+ start_date: Date,
75
77
  request_options: FinchAPI::RequestOptions
76
78
  }
77
79
  )
@@ -88,67 +90,84 @@ module FinchAPI
88
90
  )
89
91
  end
90
92
 
91
- # The array of earnings objects associated with this pay statement
93
+ sig { returns(String) }
94
+ attr_accessor :individual_id
95
+
92
96
  sig do
93
97
  returns(
94
98
  T.nilable(
95
99
  T::Array[
96
- T.nilable(
97
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning
98
- )
100
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning
99
101
  ]
100
102
  )
101
103
  )
102
104
  end
103
- attr_accessor :earnings
105
+ attr_reader :earnings
106
+
107
+ sig do
108
+ params(
109
+ earnings:
110
+ T::Array[
111
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::OrHash
112
+ ]
113
+ ).void
114
+ end
115
+ attr_writer :earnings
104
116
 
105
- # The array of deductions objects associated with this pay statement.
106
117
  sig do
107
118
  returns(
108
119
  T.nilable(
109
120
  T::Array[
110
- T.nilable(
111
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction
112
- )
121
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction
113
122
  ]
114
123
  )
115
124
  )
116
125
  end
117
- attr_accessor :employee_deductions
126
+ attr_reader :employee_deductions
127
+
128
+ sig do
129
+ params(
130
+ employee_deductions:
131
+ T::Array[
132
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::OrHash
133
+ ]
134
+ ).void
135
+ end
136
+ attr_writer :employee_deductions
118
137
 
119
138
  sig do
120
139
  returns(
121
140
  T.nilable(
122
141
  T::Array[
123
- T.nilable(
124
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution
125
- )
142
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution
126
143
  ]
127
144
  )
128
145
  )
129
146
  end
130
- attr_accessor :employer_contributions
147
+ attr_reader :employer_contributions
148
+
149
+ sig do
150
+ params(
151
+ employer_contributions:
152
+ T::Array[
153
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::OrHash
154
+ ]
155
+ ).void
156
+ end
157
+ attr_writer :employer_contributions
131
158
 
132
- sig { returns(T.nilable(FinchAPI::Money)) }
159
+ sig { returns(T.nilable(Integer)) }
133
160
  attr_reader :gross_pay
134
161
 
135
- sig { params(gross_pay: T.nilable(FinchAPI::Money::OrHash)).void }
162
+ sig { params(gross_pay: Integer).void }
136
163
  attr_writer :gross_pay
137
164
 
138
- # A stable Finch `id` (UUID v4) for an individual in the company
139
- sig { returns(T.nilable(String)) }
140
- attr_reader :individual_id
141
-
142
- sig { params(individual_id: String).void }
143
- attr_writer :individual_id
144
-
145
- sig { returns(T.nilable(FinchAPI::Money)) }
165
+ sig { returns(T.nilable(Integer)) }
146
166
  attr_reader :net_pay
147
167
 
148
- sig { params(net_pay: T.nilable(FinchAPI::Money::OrHash)).void }
168
+ sig { params(net_pay: Integer).void }
149
169
  attr_writer :net_pay
150
170
 
151
- # The payment method.
152
171
  sig do
153
172
  returns(
154
173
  T.nilable(
@@ -158,25 +177,33 @@ module FinchAPI
158
177
  end
159
178
  attr_accessor :payment_method
160
179
 
161
- # The array of taxes objects associated with this pay statement.
162
180
  sig do
163
181
  returns(
164
182
  T.nilable(
165
183
  T::Array[
166
- T.nilable(
167
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax
168
- )
184
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax
169
185
  ]
170
186
  )
171
187
  )
172
188
  end
173
- attr_accessor :taxes
189
+ attr_reader :taxes
190
+
191
+ sig do
192
+ params(
193
+ taxes:
194
+ T::Array[
195
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::OrHash
196
+ ]
197
+ ).void
198
+ end
199
+ attr_writer :taxes
174
200
 
175
- # The number of hours worked for this pay period
176
201
  sig { returns(T.nilable(Float)) }
177
- attr_accessor :total_hours
202
+ attr_reader :total_hours
203
+
204
+ sig { params(total_hours: Float).void }
205
+ attr_writer :total_hours
178
206
 
179
- # The type of the payment associated with the pay statement.
180
207
  sig do
181
208
  returns(
182
209
  T.nilable(
@@ -188,46 +215,30 @@ module FinchAPI
188
215
 
189
216
  sig do
190
217
  params(
218
+ individual_id: String,
191
219
  earnings:
192
- T.nilable(
193
- T::Array[
194
- T.nilable(
195
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::OrHash
196
- )
197
- ]
198
- ),
220
+ T::Array[
221
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::OrHash
222
+ ],
199
223
  employee_deductions:
200
- T.nilable(
201
- T::Array[
202
- T.nilable(
203
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::OrHash
204
- )
205
- ]
206
- ),
224
+ T::Array[
225
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::OrHash
226
+ ],
207
227
  employer_contributions:
208
- T.nilable(
209
- T::Array[
210
- T.nilable(
211
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::OrHash
212
- )
213
- ]
214
- ),
215
- gross_pay: T.nilable(FinchAPI::Money::OrHash),
216
- individual_id: String,
217
- net_pay: T.nilable(FinchAPI::Money::OrHash),
228
+ T::Array[
229
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::OrHash
230
+ ],
231
+ gross_pay: Integer,
232
+ net_pay: Integer,
218
233
  payment_method:
219
234
  T.nilable(
220
235
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol
221
236
  ),
222
237
  taxes:
223
- T.nilable(
224
- T::Array[
225
- T.nilable(
226
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::OrHash
227
- )
228
- ]
229
- ),
230
- total_hours: T.nilable(Float),
238
+ T::Array[
239
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::OrHash
240
+ ],
241
+ total_hours: Float,
231
242
  type:
232
243
  T.nilable(
233
244
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol
@@ -235,22 +246,15 @@ module FinchAPI
235
246
  ).returns(T.attached_class)
236
247
  end
237
248
  def self.new(
238
- # The array of earnings objects associated with this pay statement
249
+ individual_id:,
239
250
  earnings: nil,
240
- # The array of deductions objects associated with this pay statement.
241
251
  employee_deductions: nil,
242
252
  employer_contributions: nil,
243
253
  gross_pay: nil,
244
- # A stable Finch `id` (UUID v4) for an individual in the company
245
- individual_id: nil,
246
254
  net_pay: nil,
247
- # The payment method.
248
255
  payment_method: nil,
249
- # The array of taxes objects associated with this pay statement.
250
256
  taxes: nil,
251
- # The number of hours worked for this pay period
252
257
  total_hours: nil,
253
- # The type of the payment associated with the pay statement.
254
258
  type: nil
255
259
  )
256
260
  end
@@ -258,46 +262,30 @@ module FinchAPI
258
262
  sig do
259
263
  override.returns(
260
264
  {
265
+ individual_id: String,
261
266
  earnings:
262
- T.nilable(
263
- T::Array[
264
- T.nilable(
265
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning
266
- )
267
- ]
268
- ),
267
+ T::Array[
268
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning
269
+ ],
269
270
  employee_deductions:
270
- T.nilable(
271
- T::Array[
272
- T.nilable(
273
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction
274
- )
275
- ]
276
- ),
271
+ T::Array[
272
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction
273
+ ],
277
274
  employer_contributions:
278
- T.nilable(
279
- T::Array[
280
- T.nilable(
281
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution
282
- )
283
- ]
284
- ),
285
- gross_pay: T.nilable(FinchAPI::Money),
286
- individual_id: String,
287
- net_pay: T.nilable(FinchAPI::Money),
275
+ T::Array[
276
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution
277
+ ],
278
+ gross_pay: Integer,
279
+ net_pay: Integer,
288
280
  payment_method:
289
281
  T.nilable(
290
282
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol
291
283
  ),
292
284
  taxes:
293
- T.nilable(
294
- T::Array[
295
- T.nilable(
296
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax
297
- )
298
- ]
299
- ),
300
- total_hours: T.nilable(Float),
285
+ T::Array[
286
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax
287
+ ],
288
+ total_hours: Float,
301
289
  type:
302
290
  T.nilable(
303
291
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol
@@ -317,43 +305,24 @@ module FinchAPI
317
305
  )
318
306
  end
319
307
 
320
- # The earnings amount in cents.
321
308
  sig { returns(T.nilable(Integer)) }
322
- attr_accessor :amount
309
+ attr_reader :amount
323
310
 
324
- sig do
325
- returns(
326
- T.nilable(
327
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes
328
- )
329
- )
330
- end
331
- attr_reader :attributes
311
+ sig { params(amount: Integer).void }
312
+ attr_writer :amount
332
313
 
333
- sig do
334
- params(
335
- attributes:
336
- T.nilable(
337
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::OrHash
338
- )
339
- ).void
340
- end
341
- attr_writer :attributes
342
-
343
- # The earnings currency code.
344
- sig { returns(T.nilable(String)) }
345
- attr_accessor :currency
346
-
347
- # The number of hours associated with this earning. (For salaried employees, this
348
- # could be hours per pay period, `0` or `null`, depending on the provider).
349
314
  sig { returns(T.nilable(Float)) }
350
- attr_accessor :hours
315
+ attr_reader :hours
316
+
317
+ sig { params(hours: Float).void }
318
+ attr_writer :hours
351
319
 
352
- # The exact name of the deduction from the pay statement.
353
320
  sig { returns(T.nilable(String)) }
354
- attr_accessor :name
321
+ attr_reader :name
322
+
323
+ sig { params(name: String).void }
324
+ attr_writer :name
355
325
 
356
- # The type of earning.
357
326
  sig do
358
327
  returns(
359
328
  T.nilable(
@@ -361,153 +330,42 @@ module FinchAPI
361
330
  )
362
331
  )
363
332
  end
364
- attr_accessor :type
333
+ attr_reader :type
365
334
 
366
335
  sig do
367
336
  params(
368
- amount: T.nilable(Integer),
369
- attributes:
370
- T.nilable(
371
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::OrHash
372
- ),
373
- currency: T.nilable(String),
374
- hours: T.nilable(Float),
375
- name: T.nilable(String),
376
337
  type:
377
- T.nilable(
378
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol
379
- )
338
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol
339
+ ).void
340
+ end
341
+ attr_writer :type
342
+
343
+ sig do
344
+ params(
345
+ amount: Integer,
346
+ hours: Float,
347
+ name: String,
348
+ type:
349
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol
380
350
  ).returns(T.attached_class)
381
351
  end
382
- def self.new(
383
- # The earnings amount in cents.
384
- amount: nil,
385
- attributes: nil,
386
- # The earnings currency code.
387
- currency: nil,
388
- # The number of hours associated with this earning. (For salaried employees, this
389
- # could be hours per pay period, `0` or `null`, depending on the provider).
390
- hours: nil,
391
- # The exact name of the deduction from the pay statement.
392
- name: nil,
393
- # The type of earning.
394
- type: nil
395
- )
352
+ def self.new(amount: nil, hours: nil, name: nil, type: nil)
396
353
  end
397
354
 
398
355
  sig do
399
356
  override.returns(
400
357
  {
401
- amount: T.nilable(Integer),
402
- attributes:
403
- T.nilable(
404
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes
405
- ),
406
- currency: T.nilable(String),
407
- hours: T.nilable(Float),
408
- name: T.nilable(String),
358
+ amount: Integer,
359
+ hours: Float,
360
+ name: String,
409
361
  type:
410
- T.nilable(
411
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol
412
- )
362
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol
413
363
  }
414
364
  )
415
365
  end
416
366
  def to_hash
417
367
  end
418
368
 
419
- class Attributes < FinchAPI::Internal::Type::BaseModel
420
- OrHash =
421
- T.type_alias do
422
- T.any(
423
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes,
424
- FinchAPI::Internal::AnyHash
425
- )
426
- end
427
-
428
- sig do
429
- returns(
430
- T.nilable(
431
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata
432
- )
433
- )
434
- end
435
- attr_reader :metadata
436
-
437
- sig do
438
- params(
439
- metadata:
440
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata::OrHash
441
- ).void
442
- end
443
- attr_writer :metadata
444
-
445
- sig do
446
- params(
447
- metadata:
448
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata::OrHash
449
- ).returns(T.attached_class)
450
- end
451
- def self.new(metadata: nil)
452
- end
453
-
454
- sig do
455
- override.returns(
456
- {
457
- metadata:
458
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata
459
- }
460
- )
461
- end
462
- def to_hash
463
- end
464
-
465
- class Metadata < FinchAPI::Internal::Type::BaseModel
466
- OrHash =
467
- T.type_alias do
468
- T.any(
469
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata,
470
- FinchAPI::Internal::AnyHash
471
- )
472
- end
473
-
474
- # The metadata to be attached to the entity by existing rules. It is a key-value
475
- # pairs where the values can be of any type (string, number, boolean, object,
476
- # array, etc.).
477
- sig do
478
- returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)]))
479
- end
480
- attr_reader :metadata
481
-
482
- sig do
483
- params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
484
- end
485
- attr_writer :metadata
486
-
487
- sig do
488
- params(
489
- metadata: T::Hash[Symbol, T.nilable(T.anything)]
490
- ).returns(T.attached_class)
491
- end
492
- def self.new(
493
- # The metadata to be attached to the entity by existing rules. It is a key-value
494
- # pairs where the values can be of any type (string, number, boolean, object,
495
- # array, etc.).
496
- metadata: nil
497
- )
498
- end
499
-
500
- sig do
501
- override.returns(
502
- { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
503
- )
504
- end
505
- def to_hash
506
- end
507
- end
508
- end
509
-
510
- # The type of earning.
511
369
  module Type
512
370
  extend FinchAPI::Internal::Type::Enum
513
371
 
@@ -520,54 +378,54 @@ module FinchAPI
520
378
  end
521
379
  OrSymbol = T.type_alias { T.any(Symbol, String) }
522
380
 
523
- SALARY =
381
+ BONUS =
524
382
  T.let(
525
- :salary,
383
+ :bonus,
526
384
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
527
385
  )
528
- WAGE =
386
+ COMMISSION =
529
387
  T.let(
530
- :wage,
388
+ :commission,
531
389
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
532
390
  )
533
- REIMBURSEMENT =
391
+ DOUBLE_OVERTIME =
534
392
  T.let(
535
- :reimbursement,
393
+ :double_overtime,
536
394
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
537
395
  )
538
- OVERTIME =
396
+ OTHER =
539
397
  T.let(
540
- :overtime,
398
+ :other,
541
399
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
542
400
  )
543
- SEVERANCE =
401
+ OVERTIME =
544
402
  T.let(
545
- :severance,
403
+ :overtime,
546
404
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
547
405
  )
548
- DOUBLE_OVERTIME =
406
+ PTO =
549
407
  T.let(
550
- :double_overtime,
408
+ :pto,
551
409
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
552
410
  )
553
- PTO =
411
+ REIMBURSEMENT =
554
412
  T.let(
555
- :pto,
413
+ :reimbursement,
556
414
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
557
415
  )
558
- SICK =
416
+ SALARY =
559
417
  T.let(
560
- :sick,
418
+ :salary,
561
419
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
562
420
  )
563
- BONUS =
421
+ SEVERANCE =
564
422
  T.let(
565
- :bonus,
423
+ :severance,
566
424
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
567
425
  )
568
- COMMISSION =
426
+ SICK =
569
427
  T.let(
570
- :commission,
428
+ :sick,
571
429
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
572
430
  )
573
431
  TIPS =
@@ -575,14 +433,14 @@ module FinchAPI
575
433
  :tips,
576
434
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
577
435
  )
578
- TYPE_1099 =
436
+ WAGE =
579
437
  T.let(
580
- :"1099",
438
+ :wage,
581
439
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
582
440
  )
583
- OTHER =
441
+ TYPE_1099 =
584
442
  T.let(
585
- :other,
443
+ :"1099",
586
444
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol
587
445
  )
588
446
 
@@ -607,179 +465,183 @@ module FinchAPI
607
465
  )
608
466
  end
609
467
 
610
- # The deduction amount in cents.
611
468
  sig { returns(T.nilable(Integer)) }
612
- attr_accessor :amount
469
+ attr_reader :amount
470
+
471
+ sig { params(amount: Integer).void }
472
+ attr_writer :amount
473
+
474
+ sig { returns(T.nilable(String)) }
475
+ attr_reader :name
476
+
477
+ sig { params(name: String).void }
478
+ attr_writer :name
479
+
480
+ sig { returns(T.nilable(T::Boolean)) }
481
+ attr_reader :pre_tax
482
+
483
+ sig { params(pre_tax: T::Boolean).void }
484
+ attr_writer :pre_tax
613
485
 
614
486
  sig do
615
487
  returns(
616
488
  T.nilable(
617
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes
489
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::OrSymbol
618
490
  )
619
491
  )
620
492
  end
621
- attr_reader :attributes
493
+ attr_reader :type
622
494
 
623
495
  sig do
624
496
  params(
625
- attributes:
626
- T.nilable(
627
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::OrHash
628
- )
497
+ type:
498
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::OrSymbol
629
499
  ).void
630
500
  end
631
- attr_writer :attributes
632
-
633
- # The deduction currency.
634
- sig { returns(T.nilable(String)) }
635
- attr_accessor :currency
636
-
637
- # The deduction name from the pay statement.
638
- sig { returns(T.nilable(String)) }
639
- attr_accessor :name
640
-
641
- # Boolean indicating if the deduction is pre-tax.
642
- sig { returns(T.nilable(T::Boolean)) }
643
- attr_accessor :pre_tax
644
-
645
- # Type of benefit.
646
- sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)) }
647
- attr_accessor :type
501
+ attr_writer :type
648
502
 
649
503
  sig do
650
504
  params(
651
- amount: T.nilable(Integer),
652
- attributes:
653
- T.nilable(
654
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::OrHash
655
- ),
656
- currency: T.nilable(String),
657
- name: T.nilable(String),
658
- pre_tax: T.nilable(T::Boolean),
659
- type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)
505
+ amount: Integer,
506
+ name: String,
507
+ pre_tax: T::Boolean,
508
+ type:
509
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::OrSymbol
660
510
  ).returns(T.attached_class)
661
511
  end
662
- def self.new(
663
- # The deduction amount in cents.
664
- amount: nil,
665
- attributes: nil,
666
- # The deduction currency.
667
- currency: nil,
668
- # The deduction name from the pay statement.
669
- name: nil,
670
- # Boolean indicating if the deduction is pre-tax.
671
- pre_tax: nil,
672
- # Type of benefit.
673
- type: nil
674
- )
512
+ def self.new(amount: nil, name: nil, pre_tax: nil, type: nil)
675
513
  end
676
514
 
677
515
  sig do
678
516
  override.returns(
679
517
  {
680
- amount: T.nilable(Integer),
681
- attributes:
682
- T.nilable(
683
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes
684
- ),
685
- currency: T.nilable(String),
686
- name: T.nilable(String),
687
- pre_tax: T.nilable(T::Boolean),
688
- type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)
518
+ amount: Integer,
519
+ name: String,
520
+ pre_tax: T::Boolean,
521
+ type:
522
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::OrSymbol
689
523
  }
690
524
  )
691
525
  end
692
526
  def to_hash
693
527
  end
694
528
 
695
- class Attributes < FinchAPI::Internal::Type::BaseModel
696
- OrHash =
529
+ module Type
530
+ extend FinchAPI::Internal::Type::Enum
531
+
532
+ TaggedSymbol =
697
533
  T.type_alias do
698
- T.any(
699
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes,
700
- FinchAPI::Internal::AnyHash
534
+ T.all(
535
+ Symbol,
536
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type
701
537
  )
702
538
  end
539
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
703
540
 
704
- sig do
705
- returns(
706
- T.nilable(
707
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
708
- )
541
+ TYPE_457 =
542
+ T.let(
543
+ :"457",
544
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
545
+ )
546
+ TYPE_401K =
547
+ T.let(
548
+ :"401k",
549
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
550
+ )
551
+ TYPE_401K_ROTH =
552
+ T.let(
553
+ :"401k_roth",
554
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
555
+ )
556
+ TYPE_401K_LOAN =
557
+ T.let(
558
+ :"401k_loan",
559
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
560
+ )
561
+ TYPE_403B =
562
+ T.let(
563
+ :"403b",
564
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
565
+ )
566
+ TYPE_403B_ROTH =
567
+ T.let(
568
+ :"403b_roth",
569
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
570
+ )
571
+ TYPE_457_ROTH =
572
+ T.let(
573
+ :"457_roth",
574
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
575
+ )
576
+ COMMUTER =
577
+ T.let(
578
+ :commuter,
579
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
580
+ )
581
+ CUSTOM_POST_TAX =
582
+ T.let(
583
+ :custom_post_tax,
584
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
585
+ )
586
+ CUSTOM_PRE_TAX =
587
+ T.let(
588
+ :custom_pre_tax,
589
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
590
+ )
591
+ FSA_DEPENDENT_CARE =
592
+ T.let(
593
+ :fsa_dependent_care,
594
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
595
+ )
596
+ FSA_MEDICAL =
597
+ T.let(
598
+ :fsa_medical,
599
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
600
+ )
601
+ HSA_POST =
602
+ T.let(
603
+ :hsa_post,
604
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
605
+ )
606
+ HSA_PRE =
607
+ T.let(
608
+ :hsa_pre,
609
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
610
+ )
611
+ S125_DENTAL =
612
+ T.let(
613
+ :s125_dental,
614
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
615
+ )
616
+ S125_MEDICAL =
617
+ T.let(
618
+ :s125_medical,
619
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
620
+ )
621
+ S125_VISION =
622
+ T.let(
623
+ :s125_vision,
624
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
625
+ )
626
+ SIMPLE =
627
+ T.let(
628
+ :simple,
629
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
630
+ )
631
+ SIMPLE_IRA =
632
+ T.let(
633
+ :simple_ira,
634
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
709
635
  )
710
- end
711
- attr_reader :metadata
712
-
713
- sig do
714
- params(
715
- metadata:
716
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash
717
- ).void
718
- end
719
- attr_writer :metadata
720
-
721
- sig do
722
- params(
723
- metadata:
724
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash
725
- ).returns(T.attached_class)
726
- end
727
- def self.new(metadata: nil)
728
- end
729
636
 
730
637
  sig do
731
638
  override.returns(
732
- {
733
- metadata:
734
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
735
- }
639
+ T::Array[
640
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::TaggedSymbol
641
+ ]
736
642
  )
737
643
  end
738
- def to_hash
739
- end
740
-
741
- class Metadata < FinchAPI::Internal::Type::BaseModel
742
- OrHash =
743
- T.type_alias do
744
- T.any(
745
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata,
746
- FinchAPI::Internal::AnyHash
747
- )
748
- end
749
-
750
- # The metadata to be attached to the entity by existing rules. It is a key-value
751
- # pairs where the values can be of any type (string, number, boolean, object,
752
- # array, etc.).
753
- sig do
754
- returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)]))
755
- end
756
- attr_reader :metadata
757
-
758
- sig do
759
- params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
760
- end
761
- attr_writer :metadata
762
-
763
- sig do
764
- params(
765
- metadata: T::Hash[Symbol, T.nilable(T.anything)]
766
- ).returns(T.attached_class)
767
- end
768
- def self.new(
769
- # The metadata to be attached to the entity by existing rules. It is a key-value
770
- # pairs where the values can be of any type (string, number, boolean, object,
771
- # array, etc.).
772
- metadata: nil
773
- )
774
- end
775
-
776
- sig do
777
- override.returns(
778
- { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
779
- )
780
- end
781
- def to_hash
782
- end
644
+ def self.values
783
645
  end
784
646
  end
785
647
  end
@@ -793,176 +655,179 @@ module FinchAPI
793
655
  )
794
656
  end
795
657
 
796
- # The contribution amount in cents.
797
658
  sig { returns(T.nilable(Integer)) }
798
- attr_accessor :amount
659
+ attr_reader :amount
660
+
661
+ sig { params(amount: Integer).void }
662
+ attr_writer :amount
663
+
664
+ sig { returns(T.nilable(String)) }
665
+ attr_reader :name
666
+
667
+ sig { params(name: String).void }
668
+ attr_writer :name
799
669
 
800
670
  sig do
801
671
  returns(
802
672
  T.nilable(
803
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes
673
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::OrSymbol
804
674
  )
805
675
  )
806
676
  end
807
- attr_reader :attributes
677
+ attr_reader :type
808
678
 
809
679
  sig do
810
680
  params(
811
- attributes:
812
- T.nilable(
813
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::OrHash
814
- )
681
+ type:
682
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::OrSymbol
815
683
  ).void
816
684
  end
817
- attr_writer :attributes
818
-
819
- # The contribution currency.
820
- sig { returns(T.nilable(String)) }
821
- attr_accessor :currency
822
-
823
- # The contribution name from the pay statement.
824
- sig { returns(T.nilable(String)) }
825
- attr_accessor :name
826
-
827
- # Type of benefit.
828
- sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)) }
829
- attr_accessor :type
685
+ attr_writer :type
830
686
 
831
687
  sig do
832
688
  params(
833
- amount: T.nilable(Integer),
834
- attributes:
835
- T.nilable(
836
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::OrHash
837
- ),
838
- currency: T.nilable(String),
839
- name: T.nilable(String),
840
- type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)
689
+ amount: Integer,
690
+ name: String,
691
+ type:
692
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::OrSymbol
841
693
  ).returns(T.attached_class)
842
694
  end
843
- def self.new(
844
- # The contribution amount in cents.
845
- amount: nil,
846
- attributes: nil,
847
- # The contribution currency.
848
- currency: nil,
849
- # The contribution name from the pay statement.
850
- name: nil,
851
- # Type of benefit.
852
- type: nil
853
- )
695
+ def self.new(amount: nil, name: nil, type: nil)
854
696
  end
855
697
 
856
698
  sig do
857
699
  override.returns(
858
700
  {
859
- amount: T.nilable(Integer),
860
- attributes:
861
- T.nilable(
862
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes
863
- ),
864
- currency: T.nilable(String),
865
- name: T.nilable(String),
866
- type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)
701
+ amount: Integer,
702
+ name: String,
703
+ type:
704
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::OrSymbol
867
705
  }
868
706
  )
869
707
  end
870
708
  def to_hash
871
709
  end
872
710
 
873
- class Attributes < FinchAPI::Internal::Type::BaseModel
874
- OrHash =
711
+ module Type
712
+ extend FinchAPI::Internal::Type::Enum
713
+
714
+ TaggedSymbol =
875
715
  T.type_alias do
876
- T.any(
877
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes,
878
- FinchAPI::Internal::AnyHash
716
+ T.all(
717
+ Symbol,
718
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type
879
719
  )
880
720
  end
721
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
881
722
 
882
- sig do
883
- returns(
884
- T.nilable(
885
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
886
- )
723
+ TYPE_457 =
724
+ T.let(
725
+ :"457",
726
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
727
+ )
728
+ TYPE_401K =
729
+ T.let(
730
+ :"401k",
731
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
732
+ )
733
+ TYPE_401K_ROTH =
734
+ T.let(
735
+ :"401k_roth",
736
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
737
+ )
738
+ TYPE_401K_LOAN =
739
+ T.let(
740
+ :"401k_loan",
741
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
742
+ )
743
+ TYPE_403B =
744
+ T.let(
745
+ :"403b",
746
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
747
+ )
748
+ TYPE_403B_ROTH =
749
+ T.let(
750
+ :"403b_roth",
751
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
752
+ )
753
+ TYPE_457_ROTH =
754
+ T.let(
755
+ :"457_roth",
756
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
757
+ )
758
+ COMMUTER =
759
+ T.let(
760
+ :commuter,
761
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
762
+ )
763
+ CUSTOM_POST_TAX =
764
+ T.let(
765
+ :custom_post_tax,
766
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
767
+ )
768
+ CUSTOM_PRE_TAX =
769
+ T.let(
770
+ :custom_pre_tax,
771
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
772
+ )
773
+ FSA_DEPENDENT_CARE =
774
+ T.let(
775
+ :fsa_dependent_care,
776
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
777
+ )
778
+ FSA_MEDICAL =
779
+ T.let(
780
+ :fsa_medical,
781
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
782
+ )
783
+ HSA_POST =
784
+ T.let(
785
+ :hsa_post,
786
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
787
+ )
788
+ HSA_PRE =
789
+ T.let(
790
+ :hsa_pre,
791
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
792
+ )
793
+ S125_DENTAL =
794
+ T.let(
795
+ :s125_dental,
796
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
797
+ )
798
+ S125_MEDICAL =
799
+ T.let(
800
+ :s125_medical,
801
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
802
+ )
803
+ S125_VISION =
804
+ T.let(
805
+ :s125_vision,
806
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
807
+ )
808
+ SIMPLE =
809
+ T.let(
810
+ :simple,
811
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
812
+ )
813
+ SIMPLE_IRA =
814
+ T.let(
815
+ :simple_ira,
816
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
887
817
  )
888
- end
889
- attr_reader :metadata
890
-
891
- sig do
892
- params(
893
- metadata:
894
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata::OrHash
895
- ).void
896
- end
897
- attr_writer :metadata
898
-
899
- sig do
900
- params(
901
- metadata:
902
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata::OrHash
903
- ).returns(T.attached_class)
904
- end
905
- def self.new(metadata: nil)
906
- end
907
818
 
908
819
  sig do
909
820
  override.returns(
910
- {
911
- metadata:
912
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
913
- }
821
+ T::Array[
822
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::TaggedSymbol
823
+ ]
914
824
  )
915
825
  end
916
- def to_hash
917
- end
918
-
919
- class Metadata < FinchAPI::Internal::Type::BaseModel
920
- OrHash =
921
- T.type_alias do
922
- T.any(
923
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata,
924
- FinchAPI::Internal::AnyHash
925
- )
926
- end
927
-
928
- # The metadata to be attached to the entity by existing rules. It is a key-value
929
- # pairs where the values can be of any type (string, number, boolean, object,
930
- # array, etc.).
931
- sig do
932
- returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)]))
933
- end
934
- attr_reader :metadata
935
-
936
- sig do
937
- params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
938
- end
939
- attr_writer :metadata
940
-
941
- sig do
942
- params(
943
- metadata: T::Hash[Symbol, T.nilable(T.anything)]
944
- ).returns(T.attached_class)
945
- end
946
- def self.new(
947
- # The metadata to be attached to the entity by existing rules. It is a key-value
948
- # pairs where the values can be of any type (string, number, boolean, object,
949
- # array, etc.).
950
- metadata: nil
951
- )
952
- end
953
-
954
- sig do
955
- override.returns(
956
- { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
957
- )
958
- end
959
- def to_hash
960
- end
826
+ def self.values
961
827
  end
962
828
  end
963
829
  end
964
830
 
965
- # The payment method.
966
831
  module PaymentMethod
967
832
  extend FinchAPI::Internal::Type::Enum
968
833
 
@@ -1011,42 +876,24 @@ module FinchAPI
1011
876
  )
1012
877
  end
1013
878
 
1014
- # The tax amount in cents.
1015
879
  sig { returns(T.nilable(Integer)) }
1016
- attr_accessor :amount
880
+ attr_reader :amount
1017
881
 
1018
- sig do
1019
- returns(
1020
- T.nilable(
1021
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes
1022
- )
1023
- )
1024
- end
1025
- attr_reader :attributes
882
+ sig { params(amount: Integer).void }
883
+ attr_writer :amount
1026
884
 
1027
- sig do
1028
- params(
1029
- attributes:
1030
- T.nilable(
1031
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::OrHash
1032
- )
1033
- ).void
1034
- end
1035
- attr_writer :attributes
1036
-
1037
- # The currency code.
1038
- sig { returns(T.nilable(String)) }
1039
- attr_accessor :currency
1040
-
1041
- # `true` if the amount is paid by the employers.
1042
885
  sig { returns(T.nilable(T::Boolean)) }
1043
- attr_accessor :employer
886
+ attr_reader :employer
887
+
888
+ sig { params(employer: T::Boolean).void }
889
+ attr_writer :employer
1044
890
 
1045
- # The exact name of tax from the pay statement.
1046
891
  sig { returns(T.nilable(String)) }
1047
- attr_accessor :name
892
+ attr_reader :name
893
+
894
+ sig { params(name: String).void }
895
+ attr_writer :name
1048
896
 
1049
- # The type of taxes.
1050
897
  sig do
1051
898
  returns(
1052
899
  T.nilable(
@@ -1054,152 +901,42 @@ module FinchAPI
1054
901
  )
1055
902
  )
1056
903
  end
1057
- attr_accessor :type
904
+ attr_reader :type
1058
905
 
1059
906
  sig do
1060
907
  params(
1061
- amount: T.nilable(Integer),
1062
- attributes:
1063
- T.nilable(
1064
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::OrHash
1065
- ),
1066
- currency: T.nilable(String),
1067
- employer: T.nilable(T::Boolean),
1068
- name: T.nilable(String),
1069
908
  type:
1070
- T.nilable(
1071
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol
1072
- )
909
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol
910
+ ).void
911
+ end
912
+ attr_writer :type
913
+
914
+ sig do
915
+ params(
916
+ amount: Integer,
917
+ employer: T::Boolean,
918
+ name: String,
919
+ type:
920
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol
1073
921
  ).returns(T.attached_class)
1074
922
  end
1075
- def self.new(
1076
- # The tax amount in cents.
1077
- amount: nil,
1078
- attributes: nil,
1079
- # The currency code.
1080
- currency: nil,
1081
- # `true` if the amount is paid by the employers.
1082
- employer: nil,
1083
- # The exact name of tax from the pay statement.
1084
- name: nil,
1085
- # The type of taxes.
1086
- type: nil
1087
- )
923
+ def self.new(amount: nil, employer: nil, name: nil, type: nil)
1088
924
  end
1089
925
 
1090
926
  sig do
1091
927
  override.returns(
1092
928
  {
1093
- amount: T.nilable(Integer),
1094
- attributes:
1095
- T.nilable(
1096
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes
1097
- ),
1098
- currency: T.nilable(String),
1099
- employer: T.nilable(T::Boolean),
1100
- name: T.nilable(String),
929
+ amount: Integer,
930
+ employer: T::Boolean,
931
+ name: String,
1101
932
  type:
1102
- T.nilable(
1103
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol
1104
- )
933
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol
1105
934
  }
1106
935
  )
1107
936
  end
1108
937
  def to_hash
1109
938
  end
1110
939
 
1111
- class Attributes < FinchAPI::Internal::Type::BaseModel
1112
- OrHash =
1113
- T.type_alias do
1114
- T.any(
1115
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes,
1116
- FinchAPI::Internal::AnyHash
1117
- )
1118
- end
1119
-
1120
- sig do
1121
- returns(
1122
- T.nilable(
1123
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata
1124
- )
1125
- )
1126
- end
1127
- attr_reader :metadata
1128
-
1129
- sig do
1130
- params(
1131
- metadata:
1132
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata::OrHash
1133
- ).void
1134
- end
1135
- attr_writer :metadata
1136
-
1137
- sig do
1138
- params(
1139
- metadata:
1140
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata::OrHash
1141
- ).returns(T.attached_class)
1142
- end
1143
- def self.new(metadata: nil)
1144
- end
1145
-
1146
- sig do
1147
- override.returns(
1148
- {
1149
- metadata:
1150
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata
1151
- }
1152
- )
1153
- end
1154
- def to_hash
1155
- end
1156
-
1157
- class Metadata < FinchAPI::Internal::Type::BaseModel
1158
- OrHash =
1159
- T.type_alias do
1160
- T.any(
1161
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata,
1162
- FinchAPI::Internal::AnyHash
1163
- )
1164
- end
1165
-
1166
- # The metadata to be attached to the entity by existing rules. It is a key-value
1167
- # pairs where the values can be of any type (string, number, boolean, object,
1168
- # array, etc.).
1169
- sig do
1170
- returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)]))
1171
- end
1172
- attr_reader :metadata
1173
-
1174
- sig do
1175
- params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void
1176
- end
1177
- attr_writer :metadata
1178
-
1179
- sig do
1180
- params(
1181
- metadata: T::Hash[Symbol, T.nilable(T.anything)]
1182
- ).returns(T.attached_class)
1183
- end
1184
- def self.new(
1185
- # The metadata to be attached to the entity by existing rules. It is a key-value
1186
- # pairs where the values can be of any type (string, number, boolean, object,
1187
- # array, etc.).
1188
- metadata: nil
1189
- )
1190
- end
1191
-
1192
- sig do
1193
- override.returns(
1194
- { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
1195
- )
1196
- end
1197
- def to_hash
1198
- end
1199
- end
1200
- end
1201
-
1202
- # The type of taxes.
1203
940
  module Type
1204
941
  extend FinchAPI::Internal::Type::Enum
1205
942
 
@@ -1212,14 +949,14 @@ module FinchAPI
1212
949
  end
1213
950
  OrSymbol = T.type_alias { T.any(Symbol, String) }
1214
951
 
1215
- STATE =
952
+ FEDERAL =
1216
953
  T.let(
1217
- :state,
954
+ :federal,
1218
955
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol
1219
956
  )
1220
- FEDERAL =
957
+ FICA =
1221
958
  T.let(
1222
- :federal,
959
+ :fica,
1223
960
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol
1224
961
  )
1225
962
  LOCAL =
@@ -1227,9 +964,9 @@ module FinchAPI
1227
964
  :local,
1228
965
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol
1229
966
  )
1230
- FICA =
967
+ STATE =
1231
968
  T.let(
1232
- :fica,
969
+ :state,
1233
970
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol
1234
971
  )
1235
972
 
@@ -1245,7 +982,6 @@ module FinchAPI
1245
982
  end
1246
983
  end
1247
984
 
1248
- # The type of the payment associated with the pay statement.
1249
985
  module Type
1250
986
  extend FinchAPI::Internal::Type::Enum
1251
987
 
@@ -1258,11 +994,6 @@ module FinchAPI
1258
994
  end
1259
995
  OrSymbol = T.type_alias { T.any(Symbol, String) }
1260
996
 
1261
- REGULAR_PAYROLL =
1262
- T.let(
1263
- :regular_payroll,
1264
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol
1265
- )
1266
997
  OFF_CYCLE_PAYROLL =
1267
998
  T.let(
1268
999
  :off_cycle_payroll,
@@ -1273,6 +1004,11 @@ module FinchAPI
1273
1004
  :one_time_payment,
1274
1005
  FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol
1275
1006
  )
1007
+ REGULAR_PAYROLL =
1008
+ T.let(
1009
+ :regular_payroll,
1010
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol
1011
+ )
1276
1012
 
1277
1013
  sig do
1278
1014
  override.returns(