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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +50 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/finch_api/errors.rb +22 -0
  6. data/lib/finch_api/internal/individuals_page.rb +1 -1
  7. data/lib/finch_api/internal/page.rb +1 -1
  8. data/lib/finch_api/internal/type/array_of.rb +14 -1
  9. data/lib/finch_api/internal/type/base_model.rb +84 -25
  10. data/lib/finch_api/internal/type/boolean.rb +15 -1
  11. data/lib/finch_api/internal/type/converter.rb +42 -34
  12. data/lib/finch_api/internal/type/enum.rb +25 -2
  13. data/lib/finch_api/internal/type/file_input.rb +13 -1
  14. data/lib/finch_api/internal/type/hash_of.rb +14 -1
  15. data/lib/finch_api/internal/type/union.rb +27 -7
  16. data/lib/finch_api/internal/type/unknown.rb +15 -1
  17. data/lib/finch_api/internal/util.rb +62 -10
  18. data/lib/finch_api/internal.rb +3 -0
  19. data/lib/finch_api/models/account_update_event.rb +110 -109
  20. data/lib/finch_api/models/base_webhook_event.rb +1 -1
  21. data/lib/finch_api/models/company_event.rb +2 -2
  22. data/lib/finch_api/models/connect/session_new_params.rb +12 -12
  23. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +2 -2
  24. data/lib/finch_api/models/create_access_token_response.rb +7 -7
  25. data/lib/finch_api/models/directory_event.rb +4 -4
  26. data/lib/finch_api/models/employment_event.rb +4 -4
  27. data/lib/finch_api/models/hris/benefit_contribution.rb +3 -3
  28. data/lib/finch_api/models/hris/benefit_create_params.rb +11 -11
  29. data/lib/finch_api/models/hris/benefit_features_and_operations.rb +5 -120
  30. data/lib/finch_api/models/hris/benefit_type.rb +10 -10
  31. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +11 -11
  32. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +23 -23
  33. data/lib/finch_api/models/hris/benefits_support.rb +24 -24
  34. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +11 -11
  35. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +2 -2
  36. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +18 -18
  37. data/lib/finch_api/models/hris/company.rb +23 -23
  38. data/lib/finch_api/models/hris/company_benefit.rb +12 -12
  39. data/lib/finch_api/models/hris/document_list_params.rb +2 -2
  40. data/lib/finch_api/models/hris/document_list_response.rb +4 -4
  41. data/lib/finch_api/models/hris/document_response.rb +4 -4
  42. data/lib/finch_api/models/hris/document_retreive_response.rb +1 -5
  43. data/lib/finch_api/models/hris/employment_data.rb +89 -99
  44. data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
  45. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -3
  46. data/lib/finch_api/models/hris/individual.rb +20 -26
  47. data/lib/finch_api/models/hris/individual_in_directory.rb +6 -6
  48. data/lib/finch_api/models/hris/individual_response.rb +2 -2
  49. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +4 -4
  50. data/lib/finch_api/models/hris/pay_statement.rb +184 -182
  51. data/lib/finch_api/models/hris/pay_statement_data_sync_in_progress.rb +76 -0
  52. data/lib/finch_api/models/hris/pay_statement_response.rb +50 -8
  53. data/lib/finch_api/models/hris/pay_statement_response_body.rb +27 -9
  54. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +2 -2
  55. data/lib/finch_api/models/hris/payment.rb +37 -37
  56. data/lib/finch_api/models/hris/support_per_benefit_type.rb +4 -4
  57. data/lib/finch_api/models/hris/supported_benefit.rb +10 -9
  58. data/lib/finch_api/models/hris/w42005.rb +12 -12
  59. data/lib/finch_api/models/hris/w42020.rb +10 -10
  60. data/lib/finch_api/models/income.rb +8 -8
  61. data/lib/finch_api/models/individual_event.rb +4 -4
  62. data/lib/finch_api/models/introspection.rb +23 -23
  63. data/lib/finch_api/models/job_completion_event.rb +4 -4
  64. data/lib/finch_api/models/jobs/automated_async_job.rb +10 -10
  65. data/lib/finch_api/models/jobs/automated_create_params.rb +4 -4
  66. data/lib/finch_api/models/jobs/automated_list_response.rb +2 -2
  67. data/lib/finch_api/models/jobs/manual_async_job.rb +3 -3
  68. data/lib/finch_api/models/money.rb +4 -4
  69. data/lib/finch_api/models/operation_support_matrix.rb +9 -9
  70. data/lib/finch_api/models/pay_statement_event.rb +4 -4
  71. data/lib/finch_api/models/payment_event.rb +4 -4
  72. data/lib/finch_api/models/payroll/pay_group_list_response.rb +12 -12
  73. data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb +5 -5
  74. data/lib/finch_api/models/provider.rb +104 -104
  75. data/lib/finch_api/models/sandbox/company_update_params.rb +21 -21
  76. data/lib/finch_api/models/sandbox/company_update_response.rb +2 -2
  77. data/lib/finch_api/models/sandbox/connection_create_params.rb +2 -2
  78. data/lib/finch_api/models/sandbox/connections/account_create_params.rb +2 -2
  79. data/lib/finch_api/models/sandbox/connections/account_update_params.rb +2 -2
  80. data/lib/finch_api/models/sandbox/directory_create_params.rb +57 -53
  81. data/lib/finch_api/models/sandbox/employment_update_params.rb +32 -28
  82. data/lib/finch_api/models/sandbox/employment_update_response.rb +17 -14
  83. data/lib/finch_api/models/sandbox/individual_update_params.rb +16 -16
  84. data/lib/finch_api/models/sandbox/individual_update_response.rb +2 -2
  85. data/lib/finch_api/models/sandbox/job_create_params.rb +2 -2
  86. data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -6
  87. data/lib/finch_api/models/sandbox/payment_create_params.rb +160 -367
  88. data/lib/finch_api/models/webhook_event.rb +1 -16
  89. data/lib/finch_api/models.rb +30 -19
  90. data/lib/finch_api/resources/access_tokens.rb +1 -1
  91. data/lib/finch_api/resources/account.rb +2 -2
  92. data/lib/finch_api/resources/connect/sessions.rb +5 -5
  93. data/lib/finch_api/resources/hris/benefits/individuals.rb +4 -4
  94. data/lib/finch_api/resources/hris/benefits.rb +9 -9
  95. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +3 -3
  96. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +1 -1
  97. data/lib/finch_api/resources/hris/company.rb +1 -1
  98. data/lib/finch_api/resources/hris/directory.rb +1 -1
  99. data/lib/finch_api/resources/hris/documents.rb +2 -2
  100. data/lib/finch_api/resources/hris/employments.rb +2 -2
  101. data/lib/finch_api/resources/hris/individuals.rb +3 -3
  102. data/lib/finch_api/resources/hris/pay_statements.rb +2 -2
  103. data/lib/finch_api/resources/hris/payments.rb +1 -1
  104. data/lib/finch_api/resources/jobs/automated.rb +3 -3
  105. data/lib/finch_api/resources/jobs/manual.rb +1 -1
  106. data/lib/finch_api/resources/providers.rb +1 -1
  107. data/lib/finch_api/resources/sandbox/company.rb +4 -4
  108. data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -2
  109. data/lib/finch_api/resources/sandbox/connections.rb +1 -1
  110. data/lib/finch_api/resources/sandbox/directory.rb +1 -1
  111. data/lib/finch_api/resources/sandbox/employment.rb +9 -9
  112. data/lib/finch_api/resources/sandbox/individual.rb +5 -5
  113. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +4 -4
  114. data/lib/finch_api/resources/sandbox/jobs.rb +1 -1
  115. data/lib/finch_api/resources/sandbox/payment.rb +6 -3
  116. data/lib/finch_api/version.rb +1 -1
  117. data/lib/finch_api.rb +4 -2
  118. data/rbi/finch_api/errors.rbi +16 -0
  119. data/rbi/finch_api/internal/type/array_of.rbi +6 -0
  120. data/rbi/finch_api/internal/type/base_model.rbi +5 -0
  121. data/rbi/finch_api/internal/type/boolean.rbi +8 -0
  122. data/rbi/finch_api/internal/type/converter.rbi +15 -15
  123. data/rbi/finch_api/internal/type/enum.rbi +5 -0
  124. data/rbi/finch_api/internal/type/file_input.rbi +5 -0
  125. data/rbi/finch_api/internal/type/hash_of.rbi +6 -0
  126. data/rbi/finch_api/internal/type/union.rbi +10 -0
  127. data/rbi/finch_api/internal/type/unknown.rbi +8 -0
  128. data/rbi/finch_api/internal/util.rbi +36 -0
  129. data/rbi/finch_api/internal.rbi +3 -0
  130. data/rbi/finch_api/models/connect/session_new_params.rbi +4 -4
  131. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +4 -296
  132. data/rbi/finch_api/models/hris/benefit_type.rbi +16 -16
  133. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +18 -33
  134. data/rbi/finch_api/models/hris/employment_data.rbi +123 -140
  135. data/rbi/finch_api/models/hris/employment_data_response.rbi +2 -13
  136. data/rbi/finch_api/models/hris/individual_response.rbi +2 -13
  137. data/rbi/finch_api/models/hris/pay_statement.rbi +275 -307
  138. data/rbi/finch_api/models/hris/pay_statement_data_sync_in_progress.rbi +188 -0
  139. data/rbi/finch_api/models/hris/pay_statement_response.rbi +84 -20
  140. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +45 -17
  141. data/rbi/finch_api/models/hris/payment.rbi +27 -30
  142. data/rbi/finch_api/models/hris/supported_benefit.rbi +12 -8
  143. data/rbi/finch_api/models/income.rbi +3 -3
  144. data/rbi/finch_api/models/money.rbi +4 -7
  145. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +25 -43
  146. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +14 -14
  147. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +20 -26
  148. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +20 -26
  149. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +20 -26
  150. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +463 -727
  151. data/rbi/finch_api/resources/connect/sessions.rbi +2 -2
  152. data/rbi/finch_api/resources/hris/benefits.rbi +1 -3
  153. data/rbi/finch_api/resources/hris/documents.rbi +1 -1
  154. data/rbi/finch_api/resources/sandbox/employment.rbi +8 -5
  155. data/rbi/finch_api/resources/sandbox/payment.rbi +3 -2
  156. data/sig/finch_api/errors.rbs +9 -0
  157. data/sig/finch_api/internal/type/array_of.rbs +3 -0
  158. data/sig/finch_api/internal/type/base_model.rbs +2 -0
  159. data/sig/finch_api/internal/type/boolean.rbs +3 -0
  160. data/sig/finch_api/internal/type/converter.rbs +7 -1
  161. data/sig/finch_api/internal/type/enum.rbs +2 -0
  162. data/sig/finch_api/internal/type/file_input.rbs +2 -0
  163. data/sig/finch_api/internal/type/hash_of.rbs +3 -0
  164. data/sig/finch_api/internal/type/union.rbs +2 -0
  165. data/sig/finch_api/internal/type/unknown.rbs +3 -0
  166. data/sig/finch_api/internal/util.rbs +12 -0
  167. data/sig/finch_api/internal.rbs +2 -0
  168. data/sig/finch_api/models/access_token_create_params.rbs +8 -0
  169. data/sig/finch_api/models/account_disconnect_params.rbs +2 -0
  170. data/sig/finch_api/models/account_introspect_params.rbs +2 -0
  171. data/sig/finch_api/models/account_update_event.rbs +230 -12
  172. data/sig/finch_api/models/base_webhook_event.rbs +6 -0
  173. data/sig/finch_api/models/company_event.rbs +11 -6
  174. data/sig/finch_api/models/connect/session_new_params.rbs +26 -8
  175. data/sig/finch_api/models/connect/session_new_response.rbs +2 -0
  176. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +12 -4
  177. data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +2 -0
  178. data/sig/finch_api/models/create_access_token_response.rbs +21 -8
  179. data/sig/finch_api/models/directory_event.rbs +13 -6
  180. data/sig/finch_api/models/disconnect_response.rbs +2 -0
  181. data/sig/finch_api/models/employment_event.rbs +13 -6
  182. data/sig/finch_api/models/hris/benefit_contribution.rbs +12 -4
  183. data/sig/finch_api/models/hris/benefit_create_params.rbs +21 -6
  184. data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +9 -78
  185. data/sig/finch_api/models/hris/benefit_list_params.rbs +2 -0
  186. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +2 -0
  187. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +2 -0
  188. data/sig/finch_api/models/hris/benefit_type.rbs +21 -21
  189. data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -0
  190. data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +2 -0
  191. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +18 -4
  192. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +47 -18
  193. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +2 -0
  194. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +5 -0
  195. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +5 -0
  196. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +5 -0
  197. data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +2 -0
  198. data/sig/finch_api/models/hris/benefits_support.rbs +15 -0
  199. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +23 -6
  200. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +20 -0
  201. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +2 -0
  202. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +21 -0
  203. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +2 -0
  204. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +20 -0
  205. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +5 -0
  206. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +20 -0
  207. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +15 -6
  208. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +23 -20
  209. data/sig/finch_api/models/hris/company.rbs +44 -12
  210. data/sig/finch_api/models/hris/company_benefit.rbs +21 -6
  211. data/sig/finch_api/models/hris/company_retrieve_params.rbs +2 -0
  212. data/sig/finch_api/models/hris/create_company_benefits_response.rbs +2 -0
  213. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +6 -0
  214. data/sig/finch_api/models/hris/directory_list_params.rbs +6 -0
  215. data/sig/finch_api/models/hris/document_list_params.rbs +14 -6
  216. data/sig/finch_api/models/hris/document_list_response.rbs +5 -0
  217. data/sig/finch_api/models/hris/document_response.rbs +14 -6
  218. data/sig/finch_api/models/hris/document_retreive_params.rbs +2 -0
  219. data/sig/finch_api/models/hris/employment_data.rbs +91 -49
  220. data/sig/finch_api/models/hris/employment_data_response.rbs +6 -0
  221. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +7 -0
  222. data/sig/finch_api/models/hris/individual.rbs +49 -16
  223. data/sig/finch_api/models/hris/individual_in_directory.rbs +14 -0
  224. data/sig/finch_api/models/hris/individual_response.rbs +6 -0
  225. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +10 -0
  226. data/sig/finch_api/models/hris/pay_statement.rbs +179 -133
  227. data/sig/finch_api/models/hris/pay_statement_data_sync_in_progress.rbs +78 -0
  228. data/sig/finch_api/models/hris/pay_statement_response.rbs +51 -13
  229. data/sig/finch_api/models/hris/pay_statement_response_body.rbs +24 -11
  230. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +11 -0
  231. data/sig/finch_api/models/hris/payment.rbs +44 -29
  232. data/sig/finch_api/models/hris/payment_list_params.rbs +6 -0
  233. data/sig/finch_api/models/hris/support_per_benefit_type.rbs +5 -0
  234. data/sig/finch_api/models/hris/supported_benefit.rbs +22 -12
  235. data/sig/finch_api/models/hris/update_company_benefit_response.rbs +2 -0
  236. data/sig/finch_api/models/hris/w42005.rbs +30 -16
  237. data/sig/finch_api/models/hris/w42020.rbs +27 -10
  238. data/sig/finch_api/models/income.rbs +14 -7
  239. data/sig/finch_api/models/individual_event.rbs +13 -6
  240. data/sig/finch_api/models/introspection.rbs +51 -14
  241. data/sig/finch_api/models/job_completion_event.rbs +13 -6
  242. data/sig/finch_api/models/jobs/automated_async_job.rbs +22 -8
  243. data/sig/finch_api/models/jobs/automated_create_params.rbs +8 -0
  244. data/sig/finch_api/models/jobs/automated_create_response.rbs +7 -0
  245. data/sig/finch_api/models/jobs/automated_list_params.rbs +6 -0
  246. data/sig/finch_api/models/jobs/automated_list_response.rbs +18 -0
  247. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +2 -0
  248. data/sig/finch_api/models/jobs/manual_async_job.rbs +10 -4
  249. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +2 -0
  250. data/sig/finch_api/models/location.rbs +11 -0
  251. data/sig/finch_api/models/money.rbs +3 -3
  252. data/sig/finch_api/models/operation_support_matrix.rbs +7 -0
  253. data/sig/finch_api/models/paging.rbs +2 -0
  254. data/sig/finch_api/models/pay_statement_event.rbs +13 -6
  255. data/sig/finch_api/models/payment_event.rbs +13 -6
  256. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +6 -0
  257. data/sig/finch_api/models/payroll/pay_group_list_response.rbs +22 -24
  258. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +2 -0
  259. data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +17 -10
  260. data/sig/finch_api/models/provider.rbs +227 -6
  261. data/sig/finch_api/models/provider_list_params.rbs +2 -0
  262. data/sig/finch_api/models/request_forwarding_forward_params.rbs +9 -0
  263. data/sig/finch_api/models/request_forwarding_forward_response.rbs +15 -0
  264. data/sig/finch_api/models/sandbox/company_update_params.rbs +44 -12
  265. data/sig/finch_api/models/sandbox/company_update_response.rbs +31 -0
  266. data/sig/finch_api/models/sandbox/connection_create_params.rbs +8 -0
  267. data/sig/finch_api/models/sandbox/connection_create_response.rbs +11 -0
  268. data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +8 -0
  269. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +10 -0
  270. data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +5 -0
  271. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +9 -0
  272. data/sig/finch_api/models/sandbox/directory_create_params.rbs +90 -40
  273. data/sig/finch_api/models/sandbox/employment_update_params.rbs +47 -20
  274. data/sig/finch_api/models/sandbox/employment_update_response.rbs +39 -12
  275. data/sig/finch_api/models/sandbox/individual_update_params.rbs +34 -8
  276. data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
  277. data/sig/finch_api/models/sandbox/job_create_params.rbs +5 -0
  278. data/sig/finch_api/models/sandbox/job_create_response.rbs +7 -0
  279. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +2 -0
  280. data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +2 -0
  281. data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +13 -8
  282. data/sig/finch_api/models/sandbox/payment_create_params.rbs +287 -228
  283. data/sig/finch_api/models/sandbox/payment_create_response.rbs +2 -0
  284. data/sig/finch_api/resources/connect/sessions.rbs +2 -2
  285. data/sig/finch_api/resources/hris/benefits.rbs +1 -1
  286. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
  287. data/sig/finch_api/resources/hris/documents.rbs +1 -1
  288. data/sig/finch_api/resources/sandbox/employment.rbs +2 -2
  289. data/sig/finch_api/resources/sandbox/payment.rbs +2 -2
  290. metadata +5 -5
  291. data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +0 -110
  292. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +0 -290
  293. data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -79
@@ -10,12 +10,13 @@ module FinchAPI
10
10
 
11
11
  # @!attribute end_date
12
12
  #
13
- # @return [String, nil]
14
- optional :end_date, String
13
+ # @return [Date, nil]
14
+ optional :end_date, Date
15
15
 
16
16
  # @!attribute pay_statements
17
+ # Array of pay statements to include in the payment.
17
18
  #
18
- # @return [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement>, nil]
19
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>, nil]
19
20
  optional :pay_statements,
20
21
  -> {
21
22
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement]
@@ -23,226 +24,139 @@ module FinchAPI
23
24
 
24
25
  # @!attribute start_date
25
26
  #
26
- # @return [String, nil]
27
- optional :start_date, String
27
+ # @return [Date, nil]
28
+ optional :start_date, Date
28
29
 
29
30
  # @!method initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
30
- # @param end_date [String]
31
- # @param pay_statements [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement>]
32
- # @param start_date [String]
31
+ # @param end_date [Date]
32
+ #
33
+ # @param pay_statements [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>] Array of pay statements to include in the payment.
34
+ #
35
+ # @param start_date [Date]
36
+ #
33
37
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
34
38
 
35
39
  class PayStatement < FinchAPI::Internal::Type::BaseModel
40
+ # @!attribute individual_id
41
+ #
42
+ # @return [String]
43
+ required :individual_id, String
44
+
36
45
  # @!attribute earnings
37
- # The array of earnings objects associated with this pay statement
38
46
  #
39
- # @return [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning, nil>, nil]
47
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning>, nil]
40
48
  optional :earnings,
41
49
  -> {
42
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning,
43
- nil?: true]
44
- },
45
- nil?: true
50
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning]
51
+ }
46
52
 
47
53
  # @!attribute employee_deductions
48
- # The array of deductions objects associated with this pay statement.
49
54
  #
50
- # @return [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil>, nil]
55
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction>, nil]
51
56
  optional :employee_deductions,
52
57
  -> {
53
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction,
54
- nil?: true]
55
- },
56
- nil?: true
58
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction]
59
+ }
57
60
 
58
61
  # @!attribute employer_contributions
59
62
  #
60
- # @return [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil>, nil]
63
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution>, nil]
61
64
  optional :employer_contributions,
62
65
  -> {
63
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution,
64
- nil?: true]
65
- },
66
- nil?: true
66
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution]
67
+ }
67
68
 
68
69
  # @!attribute gross_pay
69
70
  #
70
- # @return [FinchAPI::Money, nil]
71
- optional :gross_pay, -> { FinchAPI::Money }, nil?: true
72
-
73
- # @!attribute individual_id
74
- # A stable Finch `id` (UUID v4) for an individual in the company
75
- #
76
- # @return [String, nil]
77
- optional :individual_id, String
71
+ # @return [Integer, nil]
72
+ optional :gross_pay, Integer
78
73
 
79
74
  # @!attribute net_pay
80
75
  #
81
- # @return [FinchAPI::Money, nil]
82
- optional :net_pay, -> { FinchAPI::Money }, nil?: true
76
+ # @return [Integer, nil]
77
+ optional :net_pay, Integer
83
78
 
84
79
  # @!attribute payment_method
85
- # The payment method.
86
80
  #
87
- # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
81
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
88
82
  optional :payment_method,
89
83
  enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod },
90
84
  nil?: true
91
85
 
92
86
  # @!attribute taxes
93
- # The array of taxes objects associated with this pay statement.
94
87
  #
95
- # @return [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax, nil>, nil]
88
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax>, nil]
96
89
  optional :taxes,
97
90
  -> {
98
- FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax,
99
- nil?: true]
100
- },
101
- nil?: true
91
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax]
92
+ }
102
93
 
103
94
  # @!attribute total_hours
104
- # The number of hours worked for this pay period
105
95
  #
106
96
  # @return [Float, nil]
107
- optional :total_hours, Float, nil?: true
97
+ optional :total_hours, Float
108
98
 
109
99
  # @!attribute type
110
- # The type of the payment associated with the pay statement.
111
100
  #
112
- # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
101
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
113
102
  optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type }, nil?: true
114
103
 
115
- # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
116
- # @param earnings [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning, nil>, nil] The array of earnings objects associated with this pay statement
117
- #
118
- # @param employee_deductions [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil>, nil] The array of deductions objects associated with this pay statement.
119
- #
120
- # @param employer_contributions [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil>, nil]
121
- #
122
- # @param gross_pay [FinchAPI::Money, nil]
123
- #
124
- # @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company
125
- #
126
- # @param net_pay [FinchAPI::Money, nil]
127
- #
128
- # @param payment_method [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil] The payment method.
129
- #
130
- # @param taxes [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax, nil>, nil] The array of taxes objects associated with this pay statement.
131
- #
132
- # @param total_hours [Float, nil] The number of hours worked for this pay period
133
- #
134
- # @param type [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type, nil] The type of the payment associated with the pay statement.
104
+ # @!method initialize(individual_id:, earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
105
+ # @param individual_id [String]
106
+ # @param earnings [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning>]
107
+ # @param employee_deductions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction>]
108
+ # @param employer_contributions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution>]
109
+ # @param gross_pay [Integer]
110
+ # @param net_pay [Integer]
111
+ # @param payment_method [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
112
+ # @param taxes [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax>]
113
+ # @param total_hours [Float]
114
+ # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
135
115
 
136
116
  class Earning < FinchAPI::Internal::Type::BaseModel
137
117
  # @!attribute amount
138
- # The earnings amount in cents.
139
118
  #
140
119
  # @return [Integer, nil]
141
- optional :amount, Integer, nil?: true
142
-
143
- # @!attribute attributes
144
- #
145
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil]
146
- optional :attributes,
147
- -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes },
148
- nil?: true
149
-
150
- # @!attribute currency
151
- # The earnings currency code.
152
- #
153
- # @return [String, nil]
154
- optional :currency, String, nil?: true
120
+ optional :amount, Integer
155
121
 
156
122
  # @!attribute hours
157
- # The number of hours associated with this earning. (For salaried employees, this
158
- # could be hours per pay period, `0` or `null`, depending on the provider).
159
123
  #
160
124
  # @return [Float, nil]
161
- optional :hours, Float, nil?: true
125
+ optional :hours, Float
162
126
 
163
127
  # @!attribute name
164
- # The exact name of the deduction from the pay statement.
165
128
  #
166
129
  # @return [String, nil]
167
- optional :name, String, nil?: true
130
+ optional :name, String
168
131
 
169
132
  # @!attribute type
170
- # The type of earning.
171
133
  #
172
- # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil]
173
- optional :type,
174
- enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type },
175
- nil?: true
134
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil]
135
+ optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type }
176
136
 
177
- # @!method initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
178
- # Some parameter documentations has been truncated, see
179
- # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning} for more
180
- # details.
181
- #
182
- # @param amount [Integer, nil] The earnings amount in cents.
183
- #
184
- # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil]
185
- #
186
- # @param currency [String, nil] The earnings currency code.
187
- #
188
- # @param hours [Float, nil] The number of hours associated with this earning. (For salaried employees, this
189
- #
190
- # @param name [String, nil] The exact name of the deduction from the pay statement.
191
- #
192
- # @param type [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil] The type of earning.
193
-
194
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning#attributes
195
- class Attributes < FinchAPI::Internal::Type::BaseModel
196
- # @!attribute metadata
197
- #
198
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, nil]
199
- optional :metadata,
200
- -> {
201
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata
202
- }
203
-
204
- # @!method initialize(metadata: nil)
205
- # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata]
206
-
207
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes#metadata
208
- class Metadata < FinchAPI::Internal::Type::BaseModel
209
- # @!attribute metadata
210
- # The metadata to be attached to the entity by existing rules. It is a key-value
211
- # pairs where the values can be of any type (string, number, boolean, object,
212
- # array, etc.).
213
- #
214
- # @return [Hash{Symbol=>Object, nil}, nil]
215
- optional :metadata,
216
- FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
217
-
218
- # @!method initialize(metadata: nil)
219
- # Some parameter documentations has been truncated, see
220
- # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata}
221
- # for more details.
222
- #
223
- # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
224
- end
225
- end
137
+ # @!method initialize(amount: nil, hours: nil, name: nil, type: nil)
138
+ # @param amount [Integer]
139
+ # @param hours [Float]
140
+ # @param name [String]
141
+ # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type]
226
142
 
227
- # The type of earning.
228
- #
229
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning#type
143
+ # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning#type
230
144
  module Type
231
145
  extend FinchAPI::Internal::Type::Enum
232
146
 
233
- SALARY = :salary
234
- WAGE = :wage
235
- REIMBURSEMENT = :reimbursement
236
- OVERTIME = :overtime
237
- SEVERANCE = :severance
147
+ BONUS = :bonus
148
+ COMMISSION = :commission
238
149
  DOUBLE_OVERTIME = :double_overtime
150
+ OTHER = :other
151
+ OVERTIME = :overtime
239
152
  PTO = :pto
153
+ REIMBURSEMENT = :reimbursement
154
+ SALARY = :salary
155
+ SEVERANCE = :severance
240
156
  SICK = :sick
241
- BONUS = :bonus
242
- COMMISSION = :commission
243
157
  TIPS = :tips
158
+ WAGE = :wage
244
159
  TYPE_1099 = :"1099"
245
- OTHER = :other
246
160
 
247
161
  # @!method self.values
248
162
  # @return [Array<Symbol>]
@@ -251,173 +165,117 @@ module FinchAPI
251
165
 
252
166
  class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
253
167
  # @!attribute amount
254
- # The deduction amount in cents.
255
168
  #
256
169
  # @return [Integer, nil]
257
- optional :amount, Integer, nil?: true
258
-
259
- # @!attribute attributes
260
- #
261
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil]
262
- optional :attributes,
263
- -> {
264
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes
265
- },
266
- nil?: true
267
-
268
- # @!attribute currency
269
- # The deduction currency.
270
- #
271
- # @return [String, nil]
272
- optional :currency, String, nil?: true
170
+ optional :amount, Integer
273
171
 
274
172
  # @!attribute name
275
- # The deduction name from the pay statement.
276
173
  #
277
174
  # @return [String, nil]
278
- optional :name, String, nil?: true
175
+ optional :name, String
279
176
 
280
177
  # @!attribute pre_tax
281
- # Boolean indicating if the deduction is pre-tax.
282
178
  #
283
179
  # @return [Boolean, nil]
284
- optional :pre_tax, FinchAPI::Internal::Type::Boolean, nil?: true
180
+ optional :pre_tax, FinchAPI::Internal::Type::Boolean
285
181
 
286
182
  # @!attribute type
287
- # Type of benefit.
288
183
  #
289
- # @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
290
- optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
184
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type, nil]
185
+ optional :type,
186
+ enum: -> {
187
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type
188
+ }
291
189
 
292
- # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
293
- # @param amount [Integer, nil] The deduction amount in cents.
294
- #
295
- # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil]
296
- #
297
- # @param currency [String, nil] The deduction currency.
298
- #
299
- # @param name [String, nil] The deduction name from the pay statement.
300
- #
301
- # @param pre_tax [Boolean, nil] Boolean indicating if the deduction is pre-tax.
302
- #
303
- # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
304
-
305
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#attributes
306
- class Attributes < FinchAPI::Internal::Type::BaseModel
307
- # @!attribute metadata
308
- #
309
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, nil]
310
- optional :metadata,
311
- -> {
312
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata
313
- }
314
-
315
- # @!method initialize(metadata: nil)
316
- # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata]
317
-
318
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes#metadata
319
- class Metadata < FinchAPI::Internal::Type::BaseModel
320
- # @!attribute metadata
321
- # The metadata to be attached to the entity by existing rules. It is a key-value
322
- # pairs where the values can be of any type (string, number, boolean, object,
323
- # array, etc.).
324
- #
325
- # @return [Hash{Symbol=>Object, nil}, nil]
326
- optional :metadata,
327
- FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
328
-
329
- # @!method initialize(metadata: nil)
330
- # Some parameter documentations has been truncated, see
331
- # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata}
332
- # for more details.
333
- #
334
- # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
335
- end
190
+ # @!method initialize(amount: nil, name: nil, pre_tax: nil, type: nil)
191
+ # @param amount [Integer]
192
+ # @param name [String]
193
+ # @param pre_tax [Boolean]
194
+ # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type]
195
+
196
+ # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#type
197
+ module Type
198
+ extend FinchAPI::Internal::Type::Enum
199
+
200
+ TYPE_457 = :"457"
201
+ TYPE_401K = :"401k"
202
+ TYPE_401K_ROTH = :"401k_roth"
203
+ TYPE_401K_LOAN = :"401k_loan"
204
+ TYPE_403B = :"403b"
205
+ TYPE_403B_ROTH = :"403b_roth"
206
+ TYPE_457_ROTH = :"457_roth"
207
+ COMMUTER = :commuter
208
+ CUSTOM_POST_TAX = :custom_post_tax
209
+ CUSTOM_PRE_TAX = :custom_pre_tax
210
+ FSA_DEPENDENT_CARE = :fsa_dependent_care
211
+ FSA_MEDICAL = :fsa_medical
212
+ HSA_POST = :hsa_post
213
+ HSA_PRE = :hsa_pre
214
+ S125_DENTAL = :s125_dental
215
+ S125_MEDICAL = :s125_medical
216
+ S125_VISION = :s125_vision
217
+ SIMPLE = :simple
218
+ SIMPLE_IRA = :simple_ira
219
+
220
+ # @!method self.values
221
+ # @return [Array<Symbol>]
336
222
  end
337
223
  end
338
224
 
339
225
  class EmployerContribution < FinchAPI::Internal::Type::BaseModel
340
226
  # @!attribute amount
341
- # The contribution amount in cents.
342
227
  #
343
228
  # @return [Integer, nil]
344
- optional :amount, Integer, nil?: true
345
-
346
- # @!attribute attributes
347
- #
348
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil]
349
- optional :attributes,
350
- -> {
351
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes
352
- },
353
- nil?: true
354
-
355
- # @!attribute currency
356
- # The contribution currency.
357
- #
358
- # @return [String, nil]
359
- optional :currency, String, nil?: true
229
+ optional :amount, Integer
360
230
 
361
231
  # @!attribute name
362
- # The contribution name from the pay statement.
363
232
  #
364
233
  # @return [String, nil]
365
- optional :name, String, nil?: true
234
+ optional :name, String
366
235
 
367
236
  # @!attribute type
368
- # Type of benefit.
369
237
  #
370
- # @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
371
- optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
238
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type, nil]
239
+ optional :type,
240
+ enum: -> {
241
+ FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type
242
+ }
372
243
 
373
- # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
374
- # @param amount [Integer, nil] The contribution amount in cents.
375
- #
376
- # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil]
377
- #
378
- # @param currency [String, nil] The contribution currency.
379
- #
380
- # @param name [String, nil] The contribution name from the pay statement.
381
- #
382
- # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
383
-
384
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#attributes
385
- class Attributes < FinchAPI::Internal::Type::BaseModel
386
- # @!attribute metadata
387
- #
388
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, nil]
389
- optional :metadata,
390
- -> {
391
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata
392
- }
393
-
394
- # @!method initialize(metadata: nil)
395
- # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata]
396
-
397
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes#metadata
398
- class Metadata < FinchAPI::Internal::Type::BaseModel
399
- # @!attribute metadata
400
- # The metadata to be attached to the entity by existing rules. It is a key-value
401
- # pairs where the values can be of any type (string, number, boolean, object,
402
- # array, etc.).
403
- #
404
- # @return [Hash{Symbol=>Object, nil}, nil]
405
- optional :metadata,
406
- FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
407
-
408
- # @!method initialize(metadata: nil)
409
- # Some parameter documentations has been truncated, see
410
- # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata}
411
- # for more details.
412
- #
413
- # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
414
- end
244
+ # @!method initialize(amount: nil, name: nil, type: nil)
245
+ # @param amount [Integer]
246
+ # @param name [String]
247
+ # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type]
248
+
249
+ # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#type
250
+ module Type
251
+ extend FinchAPI::Internal::Type::Enum
252
+
253
+ TYPE_457 = :"457"
254
+ TYPE_401K = :"401k"
255
+ TYPE_401K_ROTH = :"401k_roth"
256
+ TYPE_401K_LOAN = :"401k_loan"
257
+ TYPE_403B = :"403b"
258
+ TYPE_403B_ROTH = :"403b_roth"
259
+ TYPE_457_ROTH = :"457_roth"
260
+ COMMUTER = :commuter
261
+ CUSTOM_POST_TAX = :custom_post_tax
262
+ CUSTOM_PRE_TAX = :custom_pre_tax
263
+ FSA_DEPENDENT_CARE = :fsa_dependent_care
264
+ FSA_MEDICAL = :fsa_medical
265
+ HSA_POST = :hsa_post
266
+ HSA_PRE = :hsa_pre
267
+ S125_DENTAL = :s125_dental
268
+ S125_MEDICAL = :s125_medical
269
+ S125_VISION = :s125_vision
270
+ SIMPLE = :simple
271
+ SIMPLE_IRA = :simple_ira
272
+
273
+ # @!method self.values
274
+ # @return [Array<Symbol>]
415
275
  end
416
276
  end
417
277
 
418
- # The payment method.
419
- #
420
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement#payment_method
278
+ # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#payment_method
421
279
  module PaymentMethod
422
280
  extend FinchAPI::Internal::Type::Enum
423
281
 
@@ -431,117 +289,52 @@ module FinchAPI
431
289
 
432
290
  class Tax < FinchAPI::Internal::Type::BaseModel
433
291
  # @!attribute amount
434
- # The tax amount in cents.
435
292
  #
436
293
  # @return [Integer, nil]
437
- optional :amount, Integer, nil?: true
438
-
439
- # @!attribute attributes
440
- #
441
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil]
442
- optional :attributes,
443
- -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes },
444
- nil?: true
445
-
446
- # @!attribute currency
447
- # The currency code.
448
- #
449
- # @return [String, nil]
450
- optional :currency, String, nil?: true
294
+ optional :amount, Integer
451
295
 
452
296
  # @!attribute employer
453
- # `true` if the amount is paid by the employers.
454
297
  #
455
298
  # @return [Boolean, nil]
456
- optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
299
+ optional :employer, FinchAPI::Internal::Type::Boolean
457
300
 
458
301
  # @!attribute name
459
- # The exact name of tax from the pay statement.
460
302
  #
461
303
  # @return [String, nil]
462
- optional :name, String, nil?: true
304
+ optional :name, String
463
305
 
464
306
  # @!attribute type
465
- # The type of taxes.
466
307
  #
467
- # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil]
468
- optional :type,
469
- enum: -> {
470
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type
471
- },
472
- nil?: true
308
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil]
309
+ optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type }
473
310
 
474
- # @!method initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
475
- # @param amount [Integer, nil] The tax amount in cents.
476
- #
477
- # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil]
478
- #
479
- # @param currency [String, nil] The currency code.
480
- #
481
- # @param employer [Boolean, nil] `true` if the amount is paid by the employers.
482
- #
483
- # @param name [String, nil] The exact name of tax from the pay statement.
484
- #
485
- # @param type [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil] The type of taxes.
486
-
487
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax#attributes
488
- class Attributes < FinchAPI::Internal::Type::BaseModel
489
- # @!attribute metadata
490
- #
491
- # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, nil]
492
- optional :metadata,
493
- -> {
494
- FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata
495
- }
496
-
497
- # @!method initialize(metadata: nil)
498
- # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata]
499
-
500
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes#metadata
501
- class Metadata < FinchAPI::Internal::Type::BaseModel
502
- # @!attribute metadata
503
- # The metadata to be attached to the entity by existing rules. It is a key-value
504
- # pairs where the values can be of any type (string, number, boolean, object,
505
- # array, etc.).
506
- #
507
- # @return [Hash{Symbol=>Object, nil}, nil]
508
- optional :metadata,
509
- FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
510
-
511
- # @!method initialize(metadata: nil)
512
- # Some parameter documentations has been truncated, see
513
- # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata}
514
- # for more details.
515
- #
516
- # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
517
- end
518
- end
311
+ # @!method initialize(amount: nil, employer: nil, name: nil, type: nil)
312
+ # @param amount [Integer]
313
+ # @param employer [Boolean]
314
+ # @param name [String]
315
+ # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type]
519
316
 
520
- # The type of taxes.
521
- #
522
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax#type
317
+ # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax#type
523
318
  module Type
524
319
  extend FinchAPI::Internal::Type::Enum
525
320
 
526
- STATE = :state
527
321
  FEDERAL = :federal
528
- LOCAL = :local
529
322
  FICA = :fica
323
+ LOCAL = :local
324
+ STATE = :state
530
325
 
531
326
  # @!method self.values
532
327
  # @return [Array<Symbol>]
533
328
  end
534
329
  end
535
330
 
536
- # The type of the payment associated with the pay statement.
537
- #
538
- # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement#type
331
+ # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#type
539
332
  module Type
540
333
  extend FinchAPI::Internal::Type::Enum
541
334
 
542
- REGULAR_PAYROLL = :regular_payroll
543
335
  OFF_CYCLE_PAYROLL = :off_cycle_payroll
544
336
  ONE_TIME_PAYMENT = :one_time_payment
337
+ REGULAR_PAYROLL = :regular_payroll
545
338
 
546
339
  # @!method self.values
547
340
  # @return [Array<Symbol>]