finch-api 0.1.0.pre.alpha.13 → 0.1.0.pre.alpha.14

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 (446) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +38 -0
  3. data/README.md +6 -6
  4. data/lib/finch_api/file_part.rb +2 -2
  5. data/lib/finch_api/internal/individuals_page.rb +5 -5
  6. data/lib/finch_api/internal/page.rb +5 -5
  7. data/lib/finch_api/internal/responses_page.rb +2 -2
  8. data/lib/finch_api/internal/transport/base_client.rb +3 -3
  9. data/lib/finch_api/internal/type/base_model.rb +1 -9
  10. data/lib/finch_api/internal/type/enum.rb +4 -4
  11. data/lib/finch_api/internal/type/request_parameters.rb +6 -12
  12. data/lib/finch_api/internal/type/union.rb +2 -2
  13. data/lib/finch_api/internal/util.rb +21 -5
  14. data/lib/finch_api/models/account_update_event.rb +202 -148
  15. data/lib/finch_api/models/base_webhook_event.rb +1 -3
  16. data/lib/finch_api/models/company_event.rb +3 -3
  17. data/lib/finch_api/models/connect/session_new_params.rb +13 -14
  18. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -4
  19. data/lib/finch_api/models/create_access_token_response.rb +9 -12
  20. data/lib/finch_api/models/directory_event.rb +6 -6
  21. data/lib/finch_api/models/employment_event.rb +6 -6
  22. data/lib/finch_api/models/hris/benefit_contribution.rb +4 -4
  23. data/lib/finch_api/models/hris/benefit_create_params.rb +18 -17
  24. data/lib/finch_api/models/hris/benefit_features_and_operations.rb +32 -36
  25. data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +3 -7
  26. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +15 -17
  27. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +42 -33
  28. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +0 -1
  29. data/lib/finch_api/models/hris/benefits_support.rb +36 -36
  30. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +21 -16
  31. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb +0 -1
  32. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb +0 -1
  33. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb +0 -1
  34. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb +0 -1
  35. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +5 -6
  36. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +0 -3
  37. data/lib/finch_api/models/hris/company.rb +35 -33
  38. data/lib/finch_api/models/hris/company_benefit.rb +19 -19
  39. data/lib/finch_api/models/hris/document_list_params.rb +5 -5
  40. data/lib/finch_api/models/hris/document_list_response.rb +6 -6
  41. data/lib/finch_api/models/hris/document_response.rb +5 -7
  42. data/lib/finch_api/models/hris/document_retreive_response.rb +3 -3
  43. data/lib/finch_api/models/hris/employment_data.rb +326 -258
  44. data/lib/finch_api/models/hris/employment_data_response.rb +8 -8
  45. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +6 -6
  46. data/lib/finch_api/models/hris/individual.rb +34 -31
  47. data/lib/finch_api/models/hris/individual_in_directory.rb +8 -8
  48. data/lib/finch_api/models/hris/individual_response.rb +3 -3
  49. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +8 -6
  50. data/lib/finch_api/models/hris/pay_statement.rb +105 -100
  51. data/lib/finch_api/models/hris/pay_statement_response.rb +3 -3
  52. data/lib/finch_api/models/hris/pay_statement_response_body.rb +6 -6
  53. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +5 -3
  54. data/lib/finch_api/models/hris/payment.rb +22 -22
  55. data/lib/finch_api/models/hris/payment_list_params.rb +0 -2
  56. data/lib/finch_api/models/hris/support_per_benefit_type.rb +6 -6
  57. data/lib/finch_api/models/hris/supported_benefit.rb +22 -17
  58. data/lib/finch_api/models/hris/w42005.rb +16 -16
  59. data/lib/finch_api/models/hris/w42020.rb +13 -14
  60. data/lib/finch_api/models/income.rb +10 -11
  61. data/lib/finch_api/models/individual_event.rb +6 -6
  62. data/lib/finch_api/models/introspection.rb +31 -39
  63. data/lib/finch_api/models/job_completion_event.rb +6 -6
  64. data/lib/finch_api/models/jobs/automated_async_job.rb +13 -15
  65. data/lib/finch_api/models/jobs/automated_create_params.rb +6 -6
  66. data/lib/finch_api/models/jobs/automated_list_response.rb +3 -4
  67. data/lib/finch_api/models/jobs/manual_async_job.rb +4 -4
  68. data/lib/finch_api/models/operation_support_matrix.rb +13 -13
  69. data/lib/finch_api/models/pay_statement_event.rb +6 -6
  70. data/lib/finch_api/models/payment_event.rb +6 -6
  71. data/lib/finch_api/models/provider.rb +178 -140
  72. data/lib/finch_api/models/request_forwarding_forward_params.rb +0 -5
  73. data/lib/finch_api/models/request_forwarding_forward_response.rb +0 -8
  74. data/lib/finch_api/models/sandbox/company_update_params.rb +34 -33
  75. data/lib/finch_api/models/sandbox/company_update_response.rb +5 -5
  76. data/lib/finch_api/models/sandbox/connection_create_params.rb +5 -4
  77. data/lib/finch_api/models/sandbox/connections/account_create_params.rb +3 -4
  78. data/lib/finch_api/models/sandbox/connections/account_update_params.rb +3 -3
  79. data/lib/finch_api/models/sandbox/directory_create_params.rb +83 -77
  80. data/lib/finch_api/models/sandbox/employment_update_params.rb +37 -39
  81. data/lib/finch_api/models/sandbox/employment_update_response.rb +9 -12
  82. data/lib/finch_api/models/sandbox/individual_update_params.rb +28 -25
  83. data/lib/finch_api/models/sandbox/individual_update_response.rb +3 -5
  84. data/lib/finch_api/models/sandbox/job_create_params.rb +3 -3
  85. data/lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb +1 -1
  86. data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +8 -8
  87. data/lib/finch_api/models/sandbox/payment_create_params.rb +124 -99
  88. data/lib/finch_api/models/webhook_event.rb +9 -9
  89. data/lib/finch_api/models.rb +65 -0
  90. data/lib/finch_api/resources/access_tokens.rb +3 -3
  91. data/lib/finch_api/resources/account.rb +4 -4
  92. data/lib/finch_api/resources/connect/sessions.rb +6 -8
  93. data/lib/finch_api/resources/hris/benefits/individuals.rb +10 -12
  94. data/lib/finch_api/resources/hris/benefits.rb +13 -14
  95. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +5 -7
  96. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +2 -5
  97. data/lib/finch_api/resources/hris/company.rb +2 -2
  98. data/lib/finch_api/resources/hris/directory.rb +3 -3
  99. data/lib/finch_api/resources/hris/documents.rb +3 -5
  100. data/lib/finch_api/resources/hris/employments.rb +4 -4
  101. data/lib/finch_api/resources/hris/individuals.rb +5 -5
  102. data/lib/finch_api/resources/hris/pay_statements.rb +4 -4
  103. data/lib/finch_api/resources/hris/payments.rb +3 -5
  104. data/lib/finch_api/resources/jobs/automated.rb +6 -6
  105. data/lib/finch_api/resources/jobs/manual.rb +2 -2
  106. data/lib/finch_api/resources/payroll/pay_groups.rb +1 -1
  107. data/lib/finch_api/resources/providers.rb +2 -2
  108. data/lib/finch_api/resources/request_forwarding.rb +1 -6
  109. data/lib/finch_api/resources/sandbox/company.rb +5 -6
  110. data/lib/finch_api/resources/sandbox/connections/accounts.rb +4 -5
  111. data/lib/finch_api/resources/sandbox/connections.rb +2 -3
  112. data/lib/finch_api/resources/sandbox/directory.rb +2 -3
  113. data/lib/finch_api/resources/sandbox/employment.rb +9 -11
  114. data/lib/finch_api/resources/sandbox/individual.rb +6 -8
  115. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +7 -7
  116. data/lib/finch_api/resources/sandbox/jobs.rb +2 -2
  117. data/lib/finch_api/resources/sandbox/payment.rb +2 -2
  118. data/lib/finch_api/version.rb +1 -1
  119. data/lib/finch_api.rb +1 -0
  120. data/rbi/finch_api/client.rbi +9 -6
  121. data/rbi/finch_api/errors.rbi +34 -15
  122. data/rbi/finch_api/file_part.rbi +9 -6
  123. data/rbi/finch_api/internal/individuals_page.rbi +3 -2
  124. data/rbi/finch_api/internal/page.rbi +3 -2
  125. data/rbi/finch_api/internal/responses_page.rbi +2 -1
  126. data/rbi/finch_api/internal/single_page.rbi +8 -4
  127. data/rbi/finch_api/internal/transport/base_client.rbi +140 -75
  128. data/rbi/finch_api/internal/transport/pooled_net_requester.rbi +26 -12
  129. data/rbi/finch_api/internal/type/array_of.rbi +34 -24
  130. data/rbi/finch_api/internal/type/base_model.rbi +129 -69
  131. data/rbi/finch_api/internal/type/base_page.rbi +13 -8
  132. data/rbi/finch_api/internal/type/boolean.rbi +16 -14
  133. data/rbi/finch_api/internal/type/converter.rbi +68 -28
  134. data/rbi/finch_api/internal/type/enum.rbi +27 -15
  135. data/rbi/finch_api/internal/type/file_input.rbi +8 -4
  136. data/rbi/finch_api/internal/type/hash_of.rbi +34 -24
  137. data/rbi/finch_api/internal/type/request_parameters.rbi +12 -4
  138. data/rbi/finch_api/internal/type/union.rbi +54 -19
  139. data/rbi/finch_api/internal/type/unknown.rbi +16 -6
  140. data/rbi/finch_api/internal/util.rbi +215 -86
  141. data/rbi/finch_api/models/access_token_create_params.rbi +23 -15
  142. data/rbi/finch_api/models/account_disconnect_params.rbi +10 -5
  143. data/rbi/finch_api/models/account_introspect_params.rbi +10 -5
  144. data/rbi/finch_api/models/account_update_event.rbi +968 -731
  145. data/rbi/finch_api/models/base_webhook_event.rbi +19 -4
  146. data/rbi/finch_api/models/company_event.rbi +34 -18
  147. data/rbi/finch_api/models/connect/session_new_params.rbi +202 -69
  148. data/rbi/finch_api/models/connect/session_new_response.rbi +14 -4
  149. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +97 -30
  150. data/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +14 -4
  151. data/rbi/finch_api/models/connection_status_type.rbi +19 -9
  152. data/rbi/finch_api/models/create_access_token_response.rbi +86 -34
  153. data/rbi/finch_api/models/directory_event.rbi +53 -26
  154. data/rbi/finch_api/models/disconnect_response.rbi +8 -3
  155. data/rbi/finch_api/models/employment_event.rbi +53 -26
  156. data/rbi/finch_api/models/hris/benefit_contribution.rbi +45 -15
  157. data/rbi/finch_api/models/hris/benefit_create_params.rbi +121 -56
  158. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +145 -99
  159. data/rbi/finch_api/models/hris/benefit_frequency.rbi +15 -6
  160. data/rbi/finch_api/models/hris/benefit_list_params.rbi +11 -5
  161. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +11 -5
  162. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +126 -50
  163. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +11 -5
  164. data/rbi/finch_api/models/hris/benefit_type.rbi +41 -22
  165. data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -9
  166. data/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +8 -3
  167. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +82 -49
  168. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +188 -153
  169. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +13 -5
  170. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +19 -4
  171. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +18 -6
  172. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +16 -6
  173. data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +8 -3
  174. data/rbi/finch_api/models/hris/benefits_support.rbi +106 -82
  175. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +126 -82
  176. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +125 -81
  177. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +13 -5
  178. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +126 -82
  179. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +13 -5
  180. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +125 -81
  181. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -6
  182. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +125 -81
  183. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +60 -29
  184. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +83 -45
  185. data/rbi/finch_api/models/hris/company.rbi +258 -98
  186. data/rbi/finch_api/models/hris/company_benefit.rbi +122 -50
  187. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +11 -5
  188. data/rbi/finch_api/models/hris/create_company_benefits_response.rbi +12 -4
  189. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +19 -6
  190. data/rbi/finch_api/models/hris/directory_list_params.rbi +19 -6
  191. data/rbi/finch_api/models/hris/document_list_params.rbi +54 -23
  192. data/rbi/finch_api/models/hris/document_list_response.rbi +19 -11
  193. data/rbi/finch_api/models/hris/document_response.rbi +48 -22
  194. data/rbi/finch_api/models/hris/document_retreive_params.rbi +11 -5
  195. data/rbi/finch_api/models/hris/document_retreive_response.rbi +10 -2
  196. data/rbi/finch_api/models/hris/employment_data.rbi +616 -278
  197. data/rbi/finch_api/models/hris/employment_data_response.rbi +42 -23
  198. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +35 -17
  199. data/rbi/finch_api/models/hris/individual.rbi +302 -103
  200. data/rbi/finch_api/models/hris/individual_in_directory.rbi +60 -32
  201. data/rbi/finch_api/models/hris/individual_response.rbi +28 -18
  202. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +66 -33
  203. data/rbi/finch_api/models/hris/pay_statement.rbi +632 -252
  204. data/rbi/finch_api/models/hris/pay_statement_response.rbi +20 -9
  205. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +23 -15
  206. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +46 -18
  207. data/rbi/finch_api/models/hris/payment.rbi +122 -61
  208. data/rbi/finch_api/models/hris/payment_list_params.rbi +17 -6
  209. data/rbi/finch_api/models/hris/support_per_benefit_type.rbi +24 -18
  210. data/rbi/finch_api/models/hris/supported_benefit.rbi +173 -40
  211. data/rbi/finch_api/models/hris/update_company_benefit_response.rbi +12 -4
  212. data/rbi/finch_api/models/hris/w42005.rbi +119 -52
  213. data/rbi/finch_api/models/hris/w42020.rbi +84 -47
  214. data/rbi/finch_api/models/income.rbi +36 -31
  215. data/rbi/finch_api/models/individual_event.rbi +53 -26
  216. data/rbi/finch_api/models/introspection.rbi +195 -99
  217. data/rbi/finch_api/models/job_completion_event.rbi +74 -30
  218. data/rbi/finch_api/models/jobs/automated_async_job.rbi +100 -44
  219. data/rbi/finch_api/models/jobs/automated_create_params.rbi +50 -26
  220. data/rbi/finch_api/models/jobs/automated_create_response.rbi +22 -11
  221. data/rbi/finch_api/models/jobs/automated_list_params.rbi +19 -6
  222. data/rbi/finch_api/models/jobs/automated_list_response.rbi +93 -45
  223. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +11 -5
  224. data/rbi/finch_api/models/jobs/manual_async_job.rbi +46 -21
  225. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +11 -5
  226. data/rbi/finch_api/models/location.rbi +20 -17
  227. data/rbi/finch_api/models/money.rbi +13 -4
  228. data/rbi/finch_api/models/operation_support.rbi +15 -7
  229. data/rbi/finch_api/models/operation_support_matrix.rbi +28 -25
  230. data/rbi/finch_api/models/paging.rbi +8 -3
  231. data/rbi/finch_api/models/pay_statement_event.rbi +60 -27
  232. data/rbi/finch_api/models/payment_event.rbi +59 -27
  233. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +20 -13
  234. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +94 -28
  235. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +11 -5
  236. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +83 -27
  237. data/rbi/finch_api/models/provider.rbi +1000 -711
  238. data/rbi/finch_api/models/provider_list_params.rbi +10 -5
  239. data/rbi/finch_api/models/request_forwarding_forward_params.rbi +19 -16
  240. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +43 -32
  241. data/rbi/finch_api/models/sandbox/company_update_params.rbi +283 -110
  242. data/rbi/finch_api/models/sandbox/company_update_response.rbi +296 -112
  243. data/rbi/finch_api/models/sandbox/connection_create_params.rbi +61 -28
  244. data/rbi/finch_api/models/sandbox/connection_create_response.rbi +58 -27
  245. data/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +45 -30
  246. data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +41 -24
  247. data/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +22 -15
  248. data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +40 -23
  249. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +565 -221
  250. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +296 -119
  251. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +304 -121
  252. data/rbi/finch_api/models/sandbox/individual_update_params.rbi +275 -94
  253. data/rbi/finch_api/models/sandbox/individual_update_response.rbi +276 -93
  254. data/rbi/finch_api/models/sandbox/job_create_params.rbi +34 -15
  255. data/rbi/finch_api/models/sandbox/job_create_response.rbi +22 -11
  256. data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +13 -5
  257. data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi +3 -1
  258. data/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +13 -5
  259. data/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +72 -29
  260. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +658 -355
  261. data/rbi/finch_api/models/sandbox/payment_create_response.rbi +12 -4
  262. data/rbi/finch_api/models/webhook_event.rbi +15 -5
  263. data/rbi/finch_api/models.rbi +66 -0
  264. data/rbi/finch_api/request_options.rbi +15 -7
  265. data/rbi/finch_api/resources/access_tokens.rbi +12 -5
  266. data/rbi/finch_api/resources/account.rbi +16 -5
  267. data/rbi/finch_api/resources/connect/sessions.rbi +26 -13
  268. data/rbi/finch_api/resources/connect.rbi +2 -1
  269. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +38 -19
  270. data/rbi/finch_api/resources/hris/benefits.rbi +39 -22
  271. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +40 -26
  272. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +17 -6
  273. data/rbi/finch_api/resources/hris/company.rbi +9 -3
  274. data/rbi/finch_api/resources/hris/directory.rbi +14 -4
  275. data/rbi/finch_api/resources/hris/documents.rbi +15 -9
  276. data/rbi/finch_api/resources/hris/employments.rbi +14 -5
  277. data/rbi/finch_api/resources/hris/individuals.rbi +17 -8
  278. data/rbi/finch_api/resources/hris/pay_statements.rbi +14 -5
  279. data/rbi/finch_api/resources/hris/payments.rbi +10 -4
  280. data/rbi/finch_api/resources/hris.rbi +2 -1
  281. data/rbi/finch_api/resources/jobs/automated.rbi +23 -13
  282. data/rbi/finch_api/resources/jobs/manual.rbi +8 -4
  283. data/rbi/finch_api/resources/jobs.rbi +2 -1
  284. data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -7
  285. data/rbi/finch_api/resources/payroll.rbi +2 -1
  286. data/rbi/finch_api/resources/providers.rbi +7 -4
  287. data/rbi/finch_api/resources/request_forwarding.rbi +7 -5
  288. data/rbi/finch_api/resources/sandbox/company.rbi +25 -13
  289. data/rbi/finch_api/resources/sandbox/connections/accounts.rbi +16 -9
  290. data/rbi/finch_api/resources/sandbox/connections.rbi +9 -6
  291. data/rbi/finch_api/resources/sandbox/directory.rbi +9 -6
  292. data/rbi/finch_api/resources/sandbox/employment.rbi +31 -17
  293. data/rbi/finch_api/resources/sandbox/individual.rbi +30 -18
  294. data/rbi/finch_api/resources/sandbox/jobs/configuration.rbi +15 -10
  295. data/rbi/finch_api/resources/sandbox/jobs.rbi +8 -6
  296. data/rbi/finch_api/resources/sandbox/payment.rbi +15 -6
  297. data/rbi/finch_api/resources/sandbox.rbi +2 -1
  298. data/rbi/finch_api/resources/webhooks.rbi +2 -1
  299. data/sig/finch_api/internal/individuals_page.rbs +1 -1
  300. data/sig/finch_api/internal/page.rbs +1 -1
  301. data/sig/finch_api/internal/type/request_parameters.rbs +3 -1
  302. data/sig/finch_api/internal/util.rbs +2 -0
  303. data/sig/finch_api/models/access_token_create_params.rbs +0 -2
  304. data/sig/finch_api/models/account_disconnect_params.rbs +0 -2
  305. data/sig/finch_api/models/account_introspect_params.rbs +0 -2
  306. data/sig/finch_api/models/account_update_event.rbs +176 -244
  307. data/sig/finch_api/models/base_webhook_event.rbs +0 -2
  308. data/sig/finch_api/models/company_event.rbs +6 -8
  309. data/sig/finch_api/models/connect/session_new_params.rbs +11 -15
  310. data/sig/finch_api/models/connect/session_new_response.rbs +0 -2
  311. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +4 -6
  312. data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +0 -2
  313. data/sig/finch_api/models/create_access_token_response.rbs +8 -10
  314. data/sig/finch_api/models/directory_event.rbs +11 -15
  315. data/sig/finch_api/models/disconnect_response.rbs +0 -2
  316. data/sig/finch_api/models/employment_event.rbs +11 -15
  317. data/sig/finch_api/models/hris/benefit_contribution.rbs +4 -9
  318. data/sig/finch_api/models/hris/benefit_create_params.rbs +14 -20
  319. data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +22 -26
  320. data/sig/finch_api/models/hris/benefit_list_params.rbs +0 -2
  321. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +0 -2
  322. data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -2
  323. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +0 -2
  324. data/sig/finch_api/models/hris/benefit_update_params.rbs +0 -2
  325. data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +0 -2
  326. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +15 -19
  327. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +38 -48
  328. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +0 -2
  329. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +0 -2
  330. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +0 -2
  331. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +0 -2
  332. data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +0 -2
  333. data/sig/finch_api/models/hris/benefits_support.rbs +36 -38
  334. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +16 -22
  335. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +0 -6
  336. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +0 -2
  337. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +0 -6
  338. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +0 -2
  339. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +0 -6
  340. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +0 -2
  341. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +0 -6
  342. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +6 -8
  343. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +0 -4
  344. data/sig/finch_api/models/hris/company.rbs +27 -37
  345. data/sig/finch_api/models/hris/company_benefit.rbs +14 -20
  346. data/sig/finch_api/models/hris/company_retrieve_params.rbs +0 -2
  347. data/sig/finch_api/models/hris/create_company_benefits_response.rbs +0 -2
  348. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +0 -2
  349. data/sig/finch_api/models/hris/directory_list_params.rbs +0 -2
  350. data/sig/finch_api/models/hris/document_list_params.rbs +6 -8
  351. data/sig/finch_api/models/hris/document_list_response.rbs +6 -8
  352. data/sig/finch_api/models/hris/document_response.rbs +6 -8
  353. data/sig/finch_api/models/hris/document_retreive_params.rbs +0 -2
  354. data/sig/finch_api/models/hris/document_retreive_response.rbs +2 -2
  355. data/sig/finch_api/models/hris/employment_data.rbs +177 -144
  356. data/sig/finch_api/models/hris/employment_data_response.rbs +7 -17
  357. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +3 -7
  358. data/sig/finch_api/models/hris/individual.rbs +28 -36
  359. data/sig/finch_api/models/hris/individual_in_directory.rbs +6 -12
  360. data/sig/finch_api/models/hris/individual_response.rbs +0 -2
  361. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +8 -14
  362. data/sig/finch_api/models/hris/pay_statement.rbs +82 -108
  363. data/sig/finch_api/models/hris/pay_statement_response.rbs +5 -7
  364. data/sig/finch_api/models/hris/pay_statement_response_body.rbs +9 -11
  365. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +3 -7
  366. data/sig/finch_api/models/hris/payment.rbs +22 -26
  367. data/sig/finch_api/models/hris/payment_list_params.rbs +0 -2
  368. data/sig/finch_api/models/hris/support_per_benefit_type.rbs +10 -12
  369. data/sig/finch_api/models/hris/supported_benefit.rbs +12 -14
  370. data/sig/finch_api/models/hris/update_company_benefit_response.rbs +0 -2
  371. data/sig/finch_api/models/hris/w42005.rbs +21 -25
  372. data/sig/finch_api/models/hris/w42020.rbs +15 -19
  373. data/sig/finch_api/models/income.rbs +7 -9
  374. data/sig/finch_api/models/individual_event.rbs +11 -15
  375. data/sig/finch_api/models/introspection.rbs +25 -33
  376. data/sig/finch_api/models/job_completion_event.rbs +11 -15
  377. data/sig/finch_api/models/jobs/automated_async_job.rbs +11 -15
  378. data/sig/finch_api/models/jobs/automated_create_params.rbs +3 -7
  379. data/sig/finch_api/models/jobs/automated_create_response.rbs +0 -2
  380. data/sig/finch_api/models/jobs/automated_list_params.rbs +0 -2
  381. data/sig/finch_api/models/jobs/automated_list_response.rbs +3 -11
  382. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +0 -2
  383. data/sig/finch_api/models/jobs/manual_async_job.rbs +4 -6
  384. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +0 -2
  385. data/sig/finch_api/models/location.rbs +0 -2
  386. data/sig/finch_api/models/money.rbs +0 -2
  387. data/sig/finch_api/models/operation_support_matrix.rbs +0 -2
  388. data/sig/finch_api/models/paging.rbs +0 -2
  389. data/sig/finch_api/models/pay_statement_event.rbs +11 -15
  390. data/sig/finch_api/models/payment_event.rbs +11 -15
  391. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +0 -2
  392. data/sig/finch_api/models/payroll/pay_group_list_response.rbs +0 -2
  393. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +0 -2
  394. data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +0 -2
  395. data/sig/finch_api/models/provider.rbs +167 -233
  396. data/sig/finch_api/models/provider_list_params.rbs +0 -2
  397. data/sig/finch_api/models/request_forwarding_forward_params.rbs +0 -2
  398. data/sig/finch_api/models/request_forwarding_forward_response.rbs +0 -4
  399. data/sig/finch_api/models/sandbox/company_update_params.rbs +27 -37
  400. data/sig/finch_api/models/sandbox/company_update_response.rbs +3 -13
  401. data/sig/finch_api/models/sandbox/connection_create_params.rbs +0 -2
  402. data/sig/finch_api/models/sandbox/connection_create_response.rbs +0 -2
  403. data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +0 -2
  404. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +0 -2
  405. data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +0 -2
  406. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +0 -2
  407. data/sig/finch_api/models/sandbox/directory_create_params.rbs +65 -83
  408. data/sig/finch_api/models/sandbox/employment_update_params.rbs +31 -41
  409. data/sig/finch_api/models/sandbox/employment_update_response.rbs +9 -19
  410. data/sig/finch_api/models/sandbox/individual_update_params.rbs +17 -23
  411. data/sig/finch_api/models/sandbox/individual_update_response.rbs +3 -9
  412. data/sig/finch_api/models/sandbox/job_create_params.rbs +0 -2
  413. data/sig/finch_api/models/sandbox/job_create_response.rbs +0 -2
  414. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +0 -2
  415. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs +1 -1
  416. data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +0 -2
  417. data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +8 -10
  418. data/sig/finch_api/models/sandbox/payment_create_params.rbs +87 -115
  419. data/sig/finch_api/models/sandbox/payment_create_response.rbs +0 -2
  420. data/sig/finch_api/models/webhook_event.rbs +9 -9
  421. data/sig/finch_api/models.rbs +63 -0
  422. data/sig/finch_api/request_options.rbs +1 -1
  423. data/sig/finch_api/resources/access_tokens.rbs +1 -1
  424. data/sig/finch_api/resources/account.rbs +2 -2
  425. data/sig/finch_api/resources/connect/sessions.rbs +3 -3
  426. data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -4
  427. data/sig/finch_api/resources/hris/benefits.rbs +5 -5
  428. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +2 -2
  429. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
  430. data/sig/finch_api/resources/hris/company.rbs +1 -1
  431. data/sig/finch_api/resources/hris/directory.rbs +1 -1
  432. data/sig/finch_api/resources/hris/documents.rbs +1 -1
  433. data/sig/finch_api/resources/hris/employments.rbs +2 -2
  434. data/sig/finch_api/resources/hris/individuals.rbs +3 -3
  435. data/sig/finch_api/resources/hris/pay_statements.rbs +2 -2
  436. data/sig/finch_api/resources/hris/payments.rbs +1 -1
  437. data/sig/finch_api/resources/jobs/automated.rbs +2 -2
  438. data/sig/finch_api/resources/jobs/manual.rbs +1 -1
  439. data/sig/finch_api/resources/providers.rbs +1 -1
  440. data/sig/finch_api/resources/sandbox/company.rbs +4 -4
  441. data/sig/finch_api/resources/sandbox/directory.rbs +1 -1
  442. data/sig/finch_api/resources/sandbox/employment.rbs +7 -7
  443. data/sig/finch_api/resources/sandbox/individual.rbs +3 -3
  444. data/sig/finch_api/resources/sandbox/jobs/configuration.rbs +1 -1
  445. data/sig/finch_api/resources/sandbox/payment.rbs +1 -1
  446. metadata +7 -4
@@ -7,30 +7,36 @@ module FinchAPI
7
7
  # @!attribute earnings
8
8
  # The array of earnings objects associated with this pay statement
9
9
  #
10
- # @return [Array<FinchAPI::Models::HRIS::PayStatement::Earning, nil>, nil]
10
+ # @return [Array<FinchAPI::HRIS::PayStatement::Earning, nil>, nil]
11
11
  optional :earnings,
12
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::Earning, nil?: true] },
12
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Earning, nil?: true] },
13
13
  nil?: true
14
14
 
15
15
  # @!attribute employee_deductions
16
16
  # The array of deductions objects associated with this pay statement.
17
17
  #
18
- # @return [Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil>, nil]
18
+ # @return [Array<FinchAPI::HRIS::PayStatement::EmployeeDeduction, nil>, nil]
19
19
  optional :employee_deductions,
20
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil?: true] },
20
+ -> {
21
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployeeDeduction,
22
+ nil?: true]
23
+ },
21
24
  nil?: true
22
25
 
23
26
  # @!attribute employer_contributions
24
27
  #
25
- # @return [Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil>, nil]
28
+ # @return [Array<FinchAPI::HRIS::PayStatement::EmployerContribution, nil>, nil]
26
29
  optional :employer_contributions,
27
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil?: true] },
30
+ -> {
31
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployerContribution,
32
+ nil?: true]
33
+ },
28
34
  nil?: true
29
35
 
30
36
  # @!attribute gross_pay
31
37
  #
32
- # @return [FinchAPI::Models::Money, nil]
33
- optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true
38
+ # @return [FinchAPI::Money, nil]
39
+ optional :gross_pay, -> { FinchAPI::Money }, nil?: true
34
40
 
35
41
  # @!attribute individual_id
36
42
  # A stable Finch `id` (UUID v4) for an individual in the company
@@ -40,21 +46,21 @@ module FinchAPI
40
46
 
41
47
  # @!attribute net_pay
42
48
  #
43
- # @return [FinchAPI::Models::Money, nil]
44
- optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true
49
+ # @return [FinchAPI::Money, nil]
50
+ optional :net_pay, -> { FinchAPI::Money }, nil?: true
45
51
 
46
52
  # @!attribute payment_method
47
53
  # The payment method.
48
54
  #
49
- # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod, nil]
50
- optional :payment_method, enum: -> { FinchAPI::Models::HRIS::PayStatement::PaymentMethod }, nil?: true
55
+ # @return [Symbol, FinchAPI::HRIS::PayStatement::PaymentMethod, nil]
56
+ optional :payment_method, enum: -> { FinchAPI::HRIS::PayStatement::PaymentMethod }, nil?: true
51
57
 
52
58
  # @!attribute taxes
53
59
  # The array of taxes objects associated with this pay statement.
54
60
  #
55
- # @return [Array<FinchAPI::Models::HRIS::PayStatement::Tax, nil>, nil]
61
+ # @return [Array<FinchAPI::HRIS::PayStatement::Tax, nil>, nil]
56
62
  optional :taxes,
57
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::Tax, nil?: true] },
63
+ -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Tax, nil?: true] },
58
64
  nil?: true
59
65
 
60
66
  # @!attribute total_hours
@@ -66,29 +72,29 @@ module FinchAPI
66
72
  # @!attribute type
67
73
  # The type of the payment associated with the pay statement.
68
74
  #
69
- # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::Type, nil]
70
- optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Type }, nil?: true
75
+ # @return [Symbol, FinchAPI::HRIS::PayStatement::Type, nil]
76
+ optional :type, enum: -> { FinchAPI::HRIS::PayStatement::Type }, nil?: true
71
77
 
72
78
  # @!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)
73
- # @param earnings [Array<FinchAPI::Models::HRIS::PayStatement::Earning, nil>, nil] The array of earnings objects associated with this pay statement
79
+ # @param earnings [Array<FinchAPI::HRIS::PayStatement::Earning, nil>, nil] The array of earnings objects associated with this pay statement
74
80
  #
75
- # @param employee_deductions [Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil>, nil] The array of deductions objects associated with this pay statement.
81
+ # @param employee_deductions [Array<FinchAPI::HRIS::PayStatement::EmployeeDeduction, nil>, nil] The array of deductions objects associated with this pay statement.
76
82
  #
77
- # @param employer_contributions [Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil>, nil]
83
+ # @param employer_contributions [Array<FinchAPI::HRIS::PayStatement::EmployerContribution, nil>, nil]
78
84
  #
79
- # @param gross_pay [FinchAPI::Models::Money, nil]
85
+ # @param gross_pay [FinchAPI::Money, nil]
80
86
  #
81
87
  # @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company
82
88
  #
83
- # @param net_pay [FinchAPI::Models::Money, nil]
89
+ # @param net_pay [FinchAPI::Money, nil]
84
90
  #
85
- # @param payment_method [Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod, nil] The payment method.
91
+ # @param payment_method [Symbol, FinchAPI::HRIS::PayStatement::PaymentMethod, nil] The payment method.
86
92
  #
87
- # @param taxes [Array<FinchAPI::Models::HRIS::PayStatement::Tax, nil>, nil] The array of taxes objects associated with this pay statement.
93
+ # @param taxes [Array<FinchAPI::HRIS::PayStatement::Tax, nil>, nil] The array of taxes objects associated with this pay statement.
88
94
  #
89
95
  # @param total_hours [Float, nil] The number of hours worked for this pay period
90
96
  #
91
- # @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Type, nil] The type of the payment associated with the pay statement.
97
+ # @param type [Symbol, FinchAPI::HRIS::PayStatement::Type, nil] The type of the payment associated with the pay statement.
92
98
 
93
99
  class Earning < FinchAPI::Internal::Type::BaseModel
94
100
  # @!attribute amount
@@ -99,8 +105,8 @@ module FinchAPI
99
105
 
100
106
  # @!attribute attributes
101
107
  #
102
- # @return [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, nil]
103
- optional :attributes, -> { FinchAPI::Models::HRIS::PayStatement::Earning::Attributes }, nil?: true
108
+ # @return [FinchAPI::HRIS::PayStatement::Earning::Attributes, nil]
109
+ optional :attributes, -> { FinchAPI::HRIS::PayStatement::Earning::Attributes }, nil?: true
104
110
 
105
111
  # @!attribute currency
106
112
  # The earnings currency code.
@@ -124,59 +130,57 @@ module FinchAPI
124
130
  # @!attribute type
125
131
  # The type of earning.
126
132
  #
127
- # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type, nil]
128
- optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Earning::Type }, nil?: true
133
+ # @return [Symbol, FinchAPI::HRIS::PayStatement::Earning::Type, nil]
134
+ optional :type, enum: -> { FinchAPI::HRIS::PayStatement::Earning::Type }, nil?: true
129
135
 
130
136
  # @!method initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil)
131
137
  # Some parameter documentations has been truncated, see
132
- # {FinchAPI::Models::HRIS::PayStatement::Earning} for more details.
138
+ # {FinchAPI::HRIS::PayStatement::Earning} for more details.
133
139
  #
134
140
  # @param amount [Integer, nil] The earnings amount in cents.
135
141
  #
136
- # @param attributes [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, nil]
142
+ # @param attributes [FinchAPI::HRIS::PayStatement::Earning::Attributes, nil]
137
143
  #
138
144
  # @param currency [String, nil] The earnings currency code.
139
145
  #
140
146
  # @param hours [Float, nil] The number of hours associated with this earning. (For salaried employees, this
141
- # ...
142
147
  #
143
148
  # @param name [String, nil] The exact name of the deduction from the pay statement.
144
149
  #
145
- # @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type, nil] The type of earning.
150
+ # @param type [Symbol, FinchAPI::HRIS::PayStatement::Earning::Type, nil] The type of earning.
146
151
 
147
- # @see FinchAPI::Models::HRIS::PayStatement::Earning#attributes
152
+ # @see FinchAPI::HRIS::PayStatement::Earning#attributes
148
153
  class Attributes < FinchAPI::Internal::Type::BaseModel
149
154
  # @!attribute metadata
150
155
  #
151
- # @return [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, nil]
152
- optional :metadata, -> { FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata }
156
+ # @return [FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata, nil]
157
+ optional :metadata, -> { FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata }
153
158
 
154
159
  # @!method initialize(metadata: nil)
155
- # @param metadata [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata]
160
+ # @param metadata [FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata]
156
161
 
157
- # @see FinchAPI::Models::HRIS::PayStatement::Earning::Attributes#metadata
162
+ # @see FinchAPI::HRIS::PayStatement::Earning::Attributes#metadata
158
163
  class Metadata < FinchAPI::Internal::Type::BaseModel
159
164
  # @!attribute metadata
160
165
  # The metadata to be attached to the entity by existing rules. It is a key-value
161
166
  # pairs where the values can be of any type (string, number, boolean, object,
162
167
  # array, etc.).
163
168
  #
164
- # @return [Hash{Symbol=>Object}, nil]
165
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
169
+ # @return [Hash{Symbol=>Object, nil}, nil]
170
+ optional :metadata,
171
+ FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
166
172
 
167
173
  # @!method initialize(metadata: nil)
168
174
  # Some parameter documentations has been truncated, see
169
- # {FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata} for more
170
- # details.
175
+ # {FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata} for more details.
171
176
  #
172
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
173
- # ...
177
+ # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
174
178
  end
175
179
  end
176
180
 
177
181
  # The type of earning.
178
182
  #
179
- # @see FinchAPI::Models::HRIS::PayStatement::Earning#type
183
+ # @see FinchAPI::HRIS::PayStatement::Earning#type
180
184
  module Type
181
185
  extend FinchAPI::Internal::Type::Enum
182
186
 
@@ -208,10 +212,8 @@ module FinchAPI
208
212
 
209
213
  # @!attribute attributes
210
214
  #
211
- # @return [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, nil]
212
- optional :attributes,
213
- -> { FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes },
214
- nil?: true
215
+ # @return [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes, nil]
216
+ optional :attributes, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes }, nil?: true
215
217
 
216
218
  # @!attribute currency
217
219
  # The deduction currency.
@@ -234,13 +236,13 @@ module FinchAPI
234
236
  # @!attribute type
235
237
  # Type of benefit.
236
238
  #
237
- # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
238
- optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
239
+ # @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
240
+ optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
239
241
 
240
242
  # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
241
243
  # @param amount [Integer, nil] The deduction amount in cents.
242
244
  #
243
- # @param attributes [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, nil]
245
+ # @param attributes [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes, nil]
244
246
  #
245
247
  # @param currency [String, nil] The deduction currency.
246
248
  #
@@ -248,35 +250,35 @@ module FinchAPI
248
250
  #
249
251
  # @param pre_tax [Boolean, nil] Boolean indicating if the deduction is pre-tax.
250
252
  #
251
- # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
253
+ # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
252
254
 
253
- # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction#attributes
255
+ # @see FinchAPI::HRIS::PayStatement::EmployeeDeduction#attributes
254
256
  class Attributes < FinchAPI::Internal::Type::BaseModel
255
257
  # @!attribute metadata
256
258
  #
257
- # @return [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, nil]
258
- optional :metadata, -> { FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata }
259
+ # @return [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, nil]
260
+ optional :metadata, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata }
259
261
 
260
262
  # @!method initialize(metadata: nil)
261
- # @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata]
263
+ # @param metadata [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata]
262
264
 
263
- # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes#metadata
265
+ # @see FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes#metadata
264
266
  class Metadata < FinchAPI::Internal::Type::BaseModel
265
267
  # @!attribute metadata
266
268
  # The metadata to be attached to the entity by existing rules. It is a key-value
267
269
  # pairs where the values can be of any type (string, number, boolean, object,
268
270
  # array, etc.).
269
271
  #
270
- # @return [Hash{Symbol=>Object}, nil]
271
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
272
+ # @return [Hash{Symbol=>Object, nil}, nil]
273
+ optional :metadata,
274
+ FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
272
275
 
273
276
  # @!method initialize(metadata: nil)
274
277
  # Some parameter documentations has been truncated, see
275
- # {FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata}
276
- # for more details.
278
+ # {FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata} for more
279
+ # details.
277
280
  #
278
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
279
- # ...
281
+ # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
280
282
  end
281
283
  end
282
284
  end
@@ -290,9 +292,11 @@ module FinchAPI
290
292
 
291
293
  # @!attribute attributes
292
294
  #
293
- # @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, nil]
295
+ # @return [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes, nil]
294
296
  optional :attributes,
295
- -> { FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes },
297
+ -> {
298
+ FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes
299
+ },
296
300
  nil?: true
297
301
 
298
302
  # @!attribute currency
@@ -310,55 +314,57 @@ module FinchAPI
310
314
  # @!attribute type
311
315
  # Type of benefit.
312
316
  #
313
- # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
314
- optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
317
+ # @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
318
+ optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
315
319
 
316
320
  # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil)
317
321
  # @param amount [Integer, nil] The contribution amount in cents.
318
322
  #
319
- # @param attributes [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, nil]
323
+ # @param attributes [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes, nil]
320
324
  #
321
325
  # @param currency [String, nil] The contribution currency.
322
326
  #
323
327
  # @param name [String, nil] The contribution name from the pay statement.
324
328
  #
325
- # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
329
+ # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
326
330
 
327
- # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution#attributes
331
+ # @see FinchAPI::HRIS::PayStatement::EmployerContribution#attributes
328
332
  class Attributes < FinchAPI::Internal::Type::BaseModel
329
333
  # @!attribute metadata
330
334
  #
331
- # @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, nil]
335
+ # @return [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, nil]
332
336
  optional :metadata,
333
- -> { FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata }
337
+ -> {
338
+ FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
339
+ }
334
340
 
335
341
  # @!method initialize(metadata: nil)
336
- # @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
342
+ # @param metadata [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
337
343
 
338
- # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes#metadata
344
+ # @see FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes#metadata
339
345
  class Metadata < FinchAPI::Internal::Type::BaseModel
340
346
  # @!attribute metadata
341
347
  # The metadata to be attached to the entity by existing rules. It is a key-value
342
348
  # pairs where the values can be of any type (string, number, boolean, object,
343
349
  # array, etc.).
344
350
  #
345
- # @return [Hash{Symbol=>Object}, nil]
346
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
351
+ # @return [Hash{Symbol=>Object, nil}, nil]
352
+ optional :metadata,
353
+ FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
347
354
 
348
355
  # @!method initialize(metadata: nil)
349
356
  # Some parameter documentations has been truncated, see
350
- # {FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata}
351
- # for more details.
357
+ # {FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata} for
358
+ # more details.
352
359
  #
353
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
354
- # ...
360
+ # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
355
361
  end
356
362
  end
357
363
  end
358
364
 
359
365
  # The payment method.
360
366
  #
361
- # @see FinchAPI::Models::HRIS::PayStatement#payment_method
367
+ # @see FinchAPI::HRIS::PayStatement#payment_method
362
368
  module PaymentMethod
363
369
  extend FinchAPI::Internal::Type::Enum
364
370
 
@@ -378,8 +384,8 @@ module FinchAPI
378
384
 
379
385
  # @!attribute attributes
380
386
  #
381
- # @return [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, nil]
382
- optional :attributes, -> { FinchAPI::Models::HRIS::PayStatement::Tax::Attributes }, nil?: true
387
+ # @return [FinchAPI::HRIS::PayStatement::Tax::Attributes, nil]
388
+ optional :attributes, -> { FinchAPI::HRIS::PayStatement::Tax::Attributes }, nil?: true
383
389
 
384
390
  # @!attribute currency
385
391
  # The currency code.
@@ -402,13 +408,13 @@ module FinchAPI
402
408
  # @!attribute type
403
409
  # The type of taxes.
404
410
  #
405
- # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type, nil]
406
- optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Tax::Type }, nil?: true
411
+ # @return [Symbol, FinchAPI::HRIS::PayStatement::Tax::Type, nil]
412
+ optional :type, enum: -> { FinchAPI::HRIS::PayStatement::Tax::Type }, nil?: true
407
413
 
408
414
  # @!method initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil)
409
415
  # @param amount [Integer, nil] The tax amount in cents.
410
416
  #
411
- # @param attributes [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, nil]
417
+ # @param attributes [FinchAPI::HRIS::PayStatement::Tax::Attributes, nil]
412
418
  #
413
419
  # @param currency [String, nil] The currency code.
414
420
  #
@@ -416,41 +422,40 @@ module FinchAPI
416
422
  #
417
423
  # @param name [String, nil] The exact name of tax from the pay statement.
418
424
  #
419
- # @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type, nil] The type of taxes.
425
+ # @param type [Symbol, FinchAPI::HRIS::PayStatement::Tax::Type, nil] The type of taxes.
420
426
 
421
- # @see FinchAPI::Models::HRIS::PayStatement::Tax#attributes
427
+ # @see FinchAPI::HRIS::PayStatement::Tax#attributes
422
428
  class Attributes < FinchAPI::Internal::Type::BaseModel
423
429
  # @!attribute metadata
424
430
  #
425
- # @return [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, nil]
426
- optional :metadata, -> { FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata }
431
+ # @return [FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata, nil]
432
+ optional :metadata, -> { FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata }
427
433
 
428
434
  # @!method initialize(metadata: nil)
429
- # @param metadata [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata]
435
+ # @param metadata [FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata]
430
436
 
431
- # @see FinchAPI::Models::HRIS::PayStatement::Tax::Attributes#metadata
437
+ # @see FinchAPI::HRIS::PayStatement::Tax::Attributes#metadata
432
438
  class Metadata < FinchAPI::Internal::Type::BaseModel
433
439
  # @!attribute metadata
434
440
  # The metadata to be attached to the entity by existing rules. It is a key-value
435
441
  # pairs where the values can be of any type (string, number, boolean, object,
436
442
  # array, etc.).
437
443
  #
438
- # @return [Hash{Symbol=>Object}, nil]
439
- optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
444
+ # @return [Hash{Symbol=>Object, nil}, nil]
445
+ optional :metadata,
446
+ FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
440
447
 
441
448
  # @!method initialize(metadata: nil)
442
449
  # Some parameter documentations has been truncated, see
443
- # {FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata} for more
444
- # details.
450
+ # {FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata} for more details.
445
451
  #
446
- # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p
447
- # ...
452
+ # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
448
453
  end
449
454
  end
450
455
 
451
456
  # The type of taxes.
452
457
  #
453
- # @see FinchAPI::Models::HRIS::PayStatement::Tax#type
458
+ # @see FinchAPI::HRIS::PayStatement::Tax#type
454
459
  module Type
455
460
  extend FinchAPI::Internal::Type::Enum
456
461
 
@@ -466,7 +471,7 @@ module FinchAPI
466
471
 
467
472
  # The type of the payment associated with the pay statement.
468
473
  #
469
- # @see FinchAPI::Models::HRIS::PayStatement#type
474
+ # @see FinchAPI::HRIS::PayStatement#type
470
475
  module Type
471
476
  extend FinchAPI::Internal::Type::Enum
472
477
 
@@ -7,8 +7,8 @@ module FinchAPI
7
7
  class PayStatementResponse < FinchAPI::Internal::Type::BaseModel
8
8
  # @!attribute body
9
9
  #
10
- # @return [FinchAPI::Models::HRIS::PayStatementResponseBody, nil]
11
- optional :body, -> { FinchAPI::Models::HRIS::PayStatementResponseBody }
10
+ # @return [FinchAPI::HRIS::PayStatementResponseBody, nil]
11
+ optional :body, -> { FinchAPI::HRIS::PayStatementResponseBody }
12
12
 
13
13
  # @!attribute code
14
14
  #
@@ -21,7 +21,7 @@ module FinchAPI
21
21
  optional :payment_id, String
22
22
 
23
23
  # @!method initialize(body: nil, code: nil, payment_id: nil)
24
- # @param body [FinchAPI::Models::HRIS::PayStatementResponseBody]
24
+ # @param body [FinchAPI::HRIS::PayStatementResponseBody]
25
25
  # @param code [Integer]
26
26
  # @param payment_id [String]
27
27
  end
@@ -6,19 +6,19 @@ module FinchAPI
6
6
  class PayStatementResponseBody < FinchAPI::Internal::Type::BaseModel
7
7
  # @!attribute paging
8
8
  #
9
- # @return [FinchAPI::Models::Paging, nil]
10
- optional :paging, -> { FinchAPI::Models::Paging }
9
+ # @return [FinchAPI::Paging, nil]
10
+ optional :paging, -> { FinchAPI::Paging }
11
11
 
12
12
  # @!attribute pay_statements
13
13
  # The array of pay statements for the current payment.
14
14
  #
15
- # @return [Array<FinchAPI::Models::HRIS::PayStatement>, nil]
16
- optional :pay_statements, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement] }
15
+ # @return [Array<FinchAPI::HRIS::PayStatement>, nil]
16
+ optional :pay_statements, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement] }
17
17
 
18
18
  # @!method initialize(paging: nil, pay_statements: nil)
19
- # @param paging [FinchAPI::Models::Paging]
19
+ # @param paging [FinchAPI::Paging]
20
20
  #
21
- # @param pay_statements [Array<FinchAPI::Models::HRIS::PayStatement>] The array of pay statements for the current payment.
21
+ # @param pay_statements [Array<FinchAPI::HRIS::PayStatement>] The array of pay statements for the current payment.
22
22
  end
23
23
  end
24
24
  end
@@ -11,12 +11,14 @@ module FinchAPI
11
11
  # @!attribute requests
12
12
  # The array of batch requests.
13
13
  #
14
- # @return [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
14
+ # @return [Array<FinchAPI::HRIS::PayStatementRetrieveManyParams::Request>]
15
15
  required :requests,
16
- -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request] }
16
+ -> {
17
+ FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
18
+ }
17
19
 
18
20
  # @!method initialize(requests:, request_options: {})
19
- # @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
21
+ # @param requests [Array<FinchAPI::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
20
22
  #
21
23
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
22
24
 
@@ -13,8 +13,8 @@ module FinchAPI
13
13
 
14
14
  # @!attribute company_debit
15
15
  #
16
- # @return [FinchAPI::Models::Money, nil]
17
- optional :company_debit, -> { FinchAPI::Models::Money }, nil?: true
16
+ # @return [FinchAPI::Money, nil]
17
+ optional :company_debit, -> { FinchAPI::Money }, nil?: true
18
18
 
19
19
  # @!attribute debit_date
20
20
  #
@@ -23,18 +23,18 @@ module FinchAPI
23
23
 
24
24
  # @!attribute employee_taxes
25
25
  #
26
- # @return [FinchAPI::Models::Money, nil]
27
- optional :employee_taxes, -> { FinchAPI::Models::Money }, nil?: true
26
+ # @return [FinchAPI::Money, nil]
27
+ optional :employee_taxes, -> { FinchAPI::Money }, nil?: true
28
28
 
29
29
  # @!attribute employer_taxes
30
30
  #
31
- # @return [FinchAPI::Models::Money, nil]
32
- optional :employer_taxes, -> { FinchAPI::Models::Money }, nil?: true
31
+ # @return [FinchAPI::Money, nil]
32
+ optional :employer_taxes, -> { FinchAPI::Money }, nil?: true
33
33
 
34
34
  # @!attribute gross_pay
35
35
  #
36
- # @return [FinchAPI::Models::Money, nil]
37
- optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true
36
+ # @return [FinchAPI::Money, nil]
37
+ optional :gross_pay, -> { FinchAPI::Money }, nil?: true
38
38
 
39
39
  # @!attribute individual_ids
40
40
  # Array of every individual on this payment.
@@ -44,8 +44,8 @@ module FinchAPI
44
44
 
45
45
  # @!attribute net_pay
46
46
  #
47
- # @return [FinchAPI::Models::Money, nil]
48
- optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true
47
+ # @return [FinchAPI::Money, nil]
48
+ optional :net_pay, -> { FinchAPI::Money }, nil?: true
49
49
 
50
50
  # @!attribute pay_date
51
51
  #
@@ -55,9 +55,9 @@ module FinchAPI
55
55
  # @!attribute pay_frequencies
56
56
  # List of pay frequencies associated with this payment.
57
57
  #
58
- # @return [Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>, nil]
58
+ # @return [Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil]
59
59
  optional :pay_frequencies,
60
- -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::Payment::PayFrequency] },
60
+ -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Payment::PayFrequency] },
61
61
  nil?: true
62
62
 
63
63
  # @!attribute pay_group_ids
@@ -69,33 +69,33 @@ module FinchAPI
69
69
  # @!attribute pay_period
70
70
  # The pay period object.
71
71
  #
72
- # @return [FinchAPI::Models::HRIS::Payment::PayPeriod, nil]
73
- optional :pay_period, -> { FinchAPI::Models::HRIS::Payment::PayPeriod }, nil?: true
72
+ # @return [FinchAPI::HRIS::Payment::PayPeriod, nil]
73
+ optional :pay_period, -> { FinchAPI::HRIS::Payment::PayPeriod }, nil?: true
74
74
 
75
75
  # @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
76
76
  # @param id [String] The unique id for the payment.
77
77
  #
78
- # @param company_debit [FinchAPI::Models::Money, nil]
78
+ # @param company_debit [FinchAPI::Money, nil]
79
79
  #
80
80
  # @param debit_date [String, nil]
81
81
  #
82
- # @param employee_taxes [FinchAPI::Models::Money, nil]
82
+ # @param employee_taxes [FinchAPI::Money, nil]
83
83
  #
84
- # @param employer_taxes [FinchAPI::Models::Money, nil]
84
+ # @param employer_taxes [FinchAPI::Money, nil]
85
85
  #
86
- # @param gross_pay [FinchAPI::Models::Money, nil]
86
+ # @param gross_pay [FinchAPI::Money, nil]
87
87
  #
88
88
  # @param individual_ids [Array<String>, nil] Array of every individual on this payment.
89
89
  #
90
- # @param net_pay [FinchAPI::Models::Money, nil]
90
+ # @param net_pay [FinchAPI::Money, nil]
91
91
  #
92
92
  # @param pay_date [String, nil]
93
93
  #
94
- # @param pay_frequencies [Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>, nil] List of pay frequencies associated with this payment.
94
+ # @param pay_frequencies [Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil] List of pay frequencies associated with this payment.
95
95
  #
96
96
  # @param pay_group_ids [Array<String>, nil] Array of the Finch id (uuidv4) of every pay group associated with this payment.
97
97
  #
98
- # @param pay_period [FinchAPI::Models::HRIS::Payment::PayPeriod, nil] The pay period object.
98
+ # @param pay_period [FinchAPI::HRIS::Payment::PayPeriod, nil] The pay period object.
99
99
 
100
100
  module PayFrequency
101
101
  extend FinchAPI::Internal::Type::Enum
@@ -114,7 +114,7 @@ module FinchAPI
114
114
  # @return [Array<Symbol>]
115
115
  end
116
116
 
117
- # @see FinchAPI::Models::HRIS::Payment#pay_period
117
+ # @see FinchAPI::HRIS::Payment#pay_period
118
118
  class PayPeriod < FinchAPI::Internal::Type::BaseModel
119
119
  # @!attribute end_date
120
120
  #
@@ -27,10 +27,8 @@ module FinchAPI
27
27
  # {FinchAPI::Models::HRIS::PaymentListParams} for more details.
28
28
  #
29
29
  # @param end_date [Date] The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` forma
30
- # ...
31
30
  #
32
31
  # @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for
33
- # ...
34
32
  #
35
33
  # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
36
34
  end