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
@@ -4,6 +4,9 @@ module FinchAPI
4
4
  module Models
5
5
  module Jobs
6
6
  class AutomatedAsyncJob < FinchAPI::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
9
+
7
10
  # The datetime the job completed.
8
11
  sig { returns(T.nilable(Time)) }
9
12
  attr_accessor :completed_at
@@ -23,14 +26,13 @@ module FinchAPI
23
26
  attr_accessor :job_url
24
27
 
25
28
  # The input parameters for the job.
26
- sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params)) }
29
+ sig { returns(T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params)) }
27
30
  attr_reader :params
28
31
 
29
32
  sig do
30
33
  params(
31
- params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Internal::AnyHash))
32
- )
33
- .void
34
+ params: T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params::OrHash)
35
+ ).void
34
36
  end
35
37
  attr_writer :params
36
38
 
@@ -44,11 +46,11 @@ module FinchAPI
44
46
  sig { returns(T.nilable(Time)) }
45
47
  attr_accessor :started_at
46
48
 
47
- sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) }
49
+ sig { returns(FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) }
48
50
  attr_accessor :status
49
51
 
50
52
  # The type of automated job
51
- sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) }
53
+ sig { returns(FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) }
52
54
  attr_accessor :type
53
55
 
54
56
  sig do
@@ -57,13 +59,13 @@ module FinchAPI
57
59
  created_at: Time,
58
60
  job_id: String,
59
61
  job_url: String,
60
- params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Internal::AnyHash)),
62
+ params:
63
+ T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params::OrHash),
61
64
  scheduled_at: T.nilable(Time),
62
65
  started_at: T.nilable(Time),
63
- status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::OrSymbol,
64
- type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::OrSymbol
65
- )
66
- .returns(T.attached_class)
66
+ status: FinchAPI::Jobs::AutomatedAsyncJob::Status::OrSymbol,
67
+ type: FinchAPI::Jobs::AutomatedAsyncJob::Type::OrSymbol
68
+ ).returns(T.attached_class)
67
69
  end
68
70
  def self.new(
69
71
  # The datetime the job completed.
@@ -87,26 +89,31 @@ module FinchAPI
87
89
  status:,
88
90
  # The type of automated job
89
91
  type:
90
- ); end
92
+ )
93
+ end
94
+
91
95
  sig do
92
- override
93
- .returns(
94
- {
95
- completed_at: T.nilable(Time),
96
- created_at: Time,
97
- job_id: String,
98
- job_url: String,
99
- params: T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params),
100
- scheduled_at: T.nilable(Time),
101
- started_at: T.nilable(Time),
102
- status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol,
103
- type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol
104
- }
105
- )
96
+ override.returns(
97
+ {
98
+ completed_at: T.nilable(Time),
99
+ created_at: Time,
100
+ job_id: String,
101
+ job_url: String,
102
+ params: T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params),
103
+ scheduled_at: T.nilable(Time),
104
+ started_at: T.nilable(Time),
105
+ status: FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol,
106
+ type: FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol
107
+ }
108
+ )
109
+ end
110
+ def to_hash
106
111
  end
107
- def to_hash; end
108
112
 
109
113
  class Params < FinchAPI::Internal::Type::BaseModel
114
+ OrHash =
115
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
116
+
110
117
  # The ID of the individual that the job was completed for.
111
118
  sig { returns(T.nilable(String)) }
112
119
  attr_reader :individual_id
@@ -119,42 +126,91 @@ module FinchAPI
119
126
  def self.new(
120
127
  # The ID of the individual that the job was completed for.
121
128
  individual_id: nil
122
- ); end
123
- sig { override.returns({individual_id: String}) }
124
- def to_hash; end
129
+ )
130
+ end
131
+
132
+ sig { override.returns({ individual_id: String }) }
133
+ def to_hash
134
+ end
125
135
  end
126
136
 
127
137
  module Status
128
138
  extend FinchAPI::Internal::Type::Enum
129
139
 
130
- TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status) }
140
+ TaggedSymbol =
141
+ T.type_alias do
142
+ T.all(Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status)
143
+ end
131
144
  OrSymbol = T.type_alias { T.any(Symbol, String) }
132
145
 
133
- PENDING = T.let(:pending, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol)
134
- IN_PROGRESS = T.let(:in_progress, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol)
135
- COMPLETE = T.let(:complete, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol)
136
- ERROR = T.let(:error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol)
137
- REAUTH_ERROR = T.let(:reauth_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol)
146
+ PENDING =
147
+ T.let(
148
+ :pending,
149
+ FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol
150
+ )
151
+ IN_PROGRESS =
152
+ T.let(
153
+ :in_progress,
154
+ FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol
155
+ )
156
+ COMPLETE =
157
+ T.let(
158
+ :complete,
159
+ FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol
160
+ )
161
+ ERROR =
162
+ T.let(
163
+ :error,
164
+ FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol
165
+ )
166
+ REAUTH_ERROR =
167
+ T.let(
168
+ :reauth_error,
169
+ FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol
170
+ )
138
171
  PERMISSIONS_ERROR =
139
- T.let(:permissions_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol)
172
+ T.let(
173
+ :permissions_error,
174
+ FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol
175
+ )
140
176
 
141
- sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol]) }
142
- def self.values; end
177
+ sig do
178
+ override.returns(
179
+ T::Array[FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol]
180
+ )
181
+ end
182
+ def self.values
183
+ end
143
184
  end
144
185
 
145
186
  # The type of automated job
146
187
  module Type
147
188
  extend FinchAPI::Internal::Type::Enum
148
189
 
149
- TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type) }
190
+ TaggedSymbol =
191
+ T.type_alias do
192
+ T.all(Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type)
193
+ end
150
194
  OrSymbol = T.type_alias { T.any(Symbol, String) }
151
195
 
152
- DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol)
196
+ DATA_SYNC_ALL =
197
+ T.let(
198
+ :data_sync_all,
199
+ FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol
200
+ )
153
201
  W4_FORM_EMPLOYEE_SYNC =
154
- T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol)
202
+ T.let(
203
+ :w4_form_employee_sync,
204
+ FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol
205
+ )
155
206
 
156
- sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol]) }
157
- def self.values; end
207
+ sig do
208
+ override.returns(
209
+ T::Array[FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol]
210
+ )
211
+ end
212
+ def self.values
213
+ end
158
214
  end
159
215
  end
160
216
  end
@@ -7,60 +7,81 @@ module FinchAPI
7
7
  extend FinchAPI::Internal::Type::RequestParameters::Converter
8
8
  include FinchAPI::Internal::Type::RequestParameters
9
9
 
10
+ OrHash =
11
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
12
+
10
13
  # The type of job to start.
11
- sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) }
14
+ sig { returns(FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol) }
12
15
  attr_accessor :type
13
16
 
14
- sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Params) }
17
+ sig { returns(FinchAPI::Jobs::AutomatedCreateParams::Params) }
15
18
  attr_reader :params
16
19
 
17
20
  sig do
18
- params(params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Internal::AnyHash))
19
- .void
21
+ params(
22
+ params: FinchAPI::Jobs::AutomatedCreateParams::Params::OrHash
23
+ ).void
20
24
  end
21
25
  attr_writer :params
22
26
 
23
27
  sig do
24
28
  params(
25
- type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol,
26
- params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Internal::AnyHash),
27
- request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)
28
- )
29
- .returns(T.attached_class)
29
+ type: FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol,
30
+ params: FinchAPI::Jobs::AutomatedCreateParams::Params::OrHash,
31
+ request_options: FinchAPI::RequestOptions::OrHash
32
+ ).returns(T.attached_class)
30
33
  end
31
34
  def self.new(
32
35
  # The type of job to start.
33
36
  type:,
34
37
  params:,
35
38
  request_options: {}
36
- ); end
39
+ )
40
+ end
41
+
37
42
  sig do
38
- override
39
- .returns(
40
- {
41
- type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol,
42
- params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params,
43
- request_options: FinchAPI::RequestOptions
44
- }
45
- )
43
+ override.returns(
44
+ {
45
+ type: FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol,
46
+ params: FinchAPI::Jobs::AutomatedCreateParams::Params,
47
+ request_options: FinchAPI::RequestOptions
48
+ }
49
+ )
50
+ end
51
+ def to_hash
46
52
  end
47
- def to_hash; end
48
53
 
49
54
  # The type of job to start.
50
55
  module Type
51
56
  extend FinchAPI::Internal::Type::Enum
52
57
 
53
- TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type) }
58
+ TaggedSymbol =
59
+ T.type_alias do
60
+ T.all(Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type)
61
+ end
54
62
  OrSymbol = T.type_alias { T.any(Symbol, String) }
55
63
 
56
64
  W4_FORM_EMPLOYEE_SYNC =
57
- T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol)
65
+ T.let(
66
+ :w4_form_employee_sync,
67
+ FinchAPI::Jobs::AutomatedCreateParams::Type::TaggedSymbol
68
+ )
58
69
 
59
- sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol]) }
60
- def self.values; end
70
+ sig do
71
+ override.returns(
72
+ T::Array[
73
+ FinchAPI::Jobs::AutomatedCreateParams::Type::TaggedSymbol
74
+ ]
75
+ )
76
+ end
77
+ def self.values
78
+ end
61
79
  end
62
80
 
63
81
  class Params < FinchAPI::Internal::Type::BaseModel
82
+ OrHash =
83
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
84
+
64
85
  # The unique ID of the individual for W-4 data sync.
65
86
  sig { returns(String) }
66
87
  attr_accessor :individual_id
@@ -69,9 +90,12 @@ module FinchAPI
69
90
  def self.new(
70
91
  # The unique ID of the individual for W-4 data sync.
71
92
  individual_id:
72
- ); end
73
- sig { override.returns({individual_id: String}) }
74
- def to_hash; end
93
+ )
94
+ end
95
+
96
+ sig { override.returns({ individual_id: String }) }
97
+ def to_hash
98
+ end
75
99
  end
76
100
  end
77
101
  end
@@ -4,6 +4,9 @@ module FinchAPI
4
4
  module Models
5
5
  module Jobs
6
6
  class AutomatedCreateResponse < FinchAPI::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
9
+
7
10
  # The number of allowed refreshes per hour (per hour, fixed window)
8
11
  sig { returns(Integer) }
9
12
  attr_accessor :allowed_refreshes
@@ -21,8 +24,12 @@ module FinchAPI
21
24
  attr_accessor :remaining_refreshes
22
25
 
23
26
  sig do
24
- params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer)
25
- .returns(T.attached_class)
27
+ params(
28
+ allowed_refreshes: Integer,
29
+ job_id: String,
30
+ job_url: String,
31
+ remaining_refreshes: Integer
32
+ ).returns(T.attached_class)
26
33
  end
27
34
  def self.new(
28
35
  # The number of allowed refreshes per hour (per hour, fixed window)
@@ -33,17 +40,21 @@ module FinchAPI
33
40
  job_url:,
34
41
  # The number of remaining refreshes available (per hour, fixed window)
35
42
  remaining_refreshes:
36
- ); end
43
+ )
44
+ end
45
+
37
46
  sig do
38
- override
39
- .returns({
40
- allowed_refreshes: Integer,
41
- job_id: String,
42
- job_url: String,
43
- remaining_refreshes: Integer
44
- })
47
+ override.returns(
48
+ {
49
+ allowed_refreshes: Integer,
50
+ job_id: String,
51
+ job_url: String,
52
+ remaining_refreshes: Integer
53
+ }
54
+ )
55
+ end
56
+ def to_hash
45
57
  end
46
- def to_hash; end
47
58
  end
48
59
  end
49
60
  end
@@ -7,6 +7,9 @@ module FinchAPI
7
7
  extend FinchAPI::Internal::Type::RequestParameters::Converter
8
8
  include FinchAPI::Internal::Type::RequestParameters
9
9
 
10
+ OrHash =
11
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
12
+
10
13
  # Number of items to return
11
14
  sig { returns(T.nilable(Integer)) }
12
15
  attr_reader :limit
@@ -25,9 +28,8 @@ module FinchAPI
25
28
  params(
26
29
  limit: Integer,
27
30
  offset: Integer,
28
- request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)
29
- )
30
- .returns(T.attached_class)
31
+ request_options: FinchAPI::RequestOptions::OrHash
32
+ ).returns(T.attached_class)
31
33
  end
32
34
  def self.new(
33
35
  # Number of items to return
@@ -35,9 +37,20 @@ module FinchAPI
35
37
  # Index to start from (defaults to 0)
36
38
  offset: nil,
37
39
  request_options: {}
38
- ); end
39
- sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) }
40
- def to_hash; end
40
+ )
41
+ end
42
+
43
+ sig do
44
+ override.returns(
45
+ {
46
+ limit: Integer,
47
+ offset: Integer,
48
+ request_options: FinchAPI::RequestOptions
49
+ }
50
+ )
51
+ end
52
+ def to_hash
53
+ end
41
54
  end
42
55
  end
43
56
  end
@@ -4,56 +4,72 @@ module FinchAPI
4
4
  module Models
5
5
  module Jobs
6
6
  class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel
7
- sig { returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) }
7
+ OrHash =
8
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
9
+
10
+ sig { returns(T::Array[FinchAPI::Jobs::AutomatedAsyncJob]) }
8
11
  attr_accessor :data
9
12
 
10
13
  sig { returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta) }
11
14
  attr_reader :meta
12
15
 
13
- sig { params(meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Internal::AnyHash)).void }
16
+ sig do
17
+ params(
18
+ meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::OrHash
19
+ ).void
20
+ end
14
21
  attr_writer :meta
15
22
 
16
23
  sig do
17
24
  params(
18
- data: T::Array[T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob, FinchAPI::Internal::AnyHash)],
19
- meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Internal::AnyHash)
20
- )
21
- .returns(T.attached_class)
25
+ data: T::Array[FinchAPI::Jobs::AutomatedAsyncJob::OrHash],
26
+ meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::OrHash
27
+ ).returns(T.attached_class)
28
+ end
29
+ def self.new(data:, meta:)
22
30
  end
23
- def self.new(data:, meta:); end
24
31
 
25
32
  sig do
26
- override
27
- .returns(
28
- {
29
- data: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob],
30
- meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta
31
- }
32
- )
33
+ override.returns(
34
+ {
35
+ data: T::Array[FinchAPI::Jobs::AutomatedAsyncJob],
36
+ meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta
37
+ }
38
+ )
39
+ end
40
+ def to_hash
33
41
  end
34
- def to_hash; end
35
42
 
36
43
  class Meta < FinchAPI::Internal::Type::BaseModel
44
+ OrHash =
45
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
46
+
37
47
  # Information about remaining quotas for this connection. Only applicable for
38
48
  # customers opted in to use Finch's Data Sync Refresh endpoint
39
49
  # (`POST /jobs/automated`). Please contact a Finch representative for more
40
50
  # details.
41
- sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas)) }
51
+ sig do
52
+ returns(
53
+ T.nilable(
54
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas
55
+ )
56
+ )
57
+ end
42
58
  attr_reader :quotas
43
59
 
44
60
  sig do
45
61
  params(
46
- quotas: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Internal::AnyHash)
47
- )
48
- .void
62
+ quotas:
63
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::OrHash
64
+ ).void
49
65
  end
50
66
  attr_writer :quotas
51
67
 
52
68
  sig do
53
69
  params(
54
- quotas: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Internal::AnyHash)
55
- )
56
- .returns(T.attached_class)
70
+ quotas:
71
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::OrHash
72
+ ).returns(T.attached_class)
57
73
  end
58
74
  def self.new(
59
75
  # Information about remaining quotas for this connection. Only applicable for
@@ -61,22 +77,38 @@ module FinchAPI
61
77
  # (`POST /jobs/automated`). Please contact a Finch representative for more
62
78
  # details.
63
79
  quotas: nil
64
- ); end
65
- sig { override.returns({quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas}) }
66
- def to_hash; end
80
+ )
81
+ end
82
+
83
+ sig do
84
+ override.returns(
85
+ {
86
+ quotas:
87
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas
88
+ }
89
+ )
90
+ end
91
+ def to_hash
92
+ end
67
93
 
68
94
  class Quotas < FinchAPI::Internal::Type::BaseModel
69
- sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll)) }
70
- attr_reader :data_sync_all
95
+ OrHash =
96
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
71
97
 
72
98
  sig do
73
- params(
74
- data_sync_all: T.any(
75
- FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll,
76
- FinchAPI::Internal::AnyHash
99
+ returns(
100
+ T.nilable(
101
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll
77
102
  )
78
103
  )
79
- .void
104
+ end
105
+ attr_reader :data_sync_all
106
+
107
+ sig do
108
+ params(
109
+ data_sync_all:
110
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll::OrHash
111
+ ).void
80
112
  end
81
113
  attr_writer :data_sync_all
82
114
 
@@ -86,21 +118,28 @@ module FinchAPI
86
118
  # details.
87
119
  sig do
88
120
  params(
89
- data_sync_all: T.any(
90
- FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll,
91
- FinchAPI::Internal::AnyHash
92
- )
93
- )
94
- .returns(T.attached_class)
121
+ data_sync_all:
122
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll::OrHash
123
+ ).returns(T.attached_class)
124
+ end
125
+ def self.new(data_sync_all: nil)
95
126
  end
96
- def self.new(data_sync_all: nil); end
97
127
 
98
128
  sig do
99
- override.returns({data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll})
129
+ override.returns(
130
+ {
131
+ data_sync_all:
132
+ FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll
133
+ }
134
+ )
135
+ end
136
+ def to_hash
100
137
  end
101
- def to_hash; end
102
138
 
103
139
  class DataSyncAll < FinchAPI::Internal::Type::BaseModel
140
+ OrHash =
141
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
142
+
104
143
  sig { returns(T.nilable(Integer)) }
105
144
  attr_reader :allowed_refreshes
106
145
 
@@ -114,12 +153,21 @@ module FinchAPI
114
153
  attr_writer :remaining_refreshes
115
154
 
116
155
  sig do
117
- params(allowed_refreshes: Integer, remaining_refreshes: Integer).returns(T.attached_class)
156
+ params(
157
+ allowed_refreshes: Integer,
158
+ remaining_refreshes: Integer
159
+ ).returns(T.attached_class)
160
+ end
161
+ def self.new(allowed_refreshes: nil, remaining_refreshes: nil)
118
162
  end
119
- def self.new(allowed_refreshes: nil, remaining_refreshes: nil); end
120
163
 
121
- sig { override.returns({allowed_refreshes: Integer, remaining_refreshes: Integer}) }
122
- def to_hash; end
164
+ sig do
165
+ override.returns(
166
+ { allowed_refreshes: Integer, remaining_refreshes: Integer }
167
+ )
168
+ end
169
+ def to_hash
170
+ end
123
171
  end
124
172
  end
125
173
  end
@@ -7,14 +7,20 @@ module FinchAPI
7
7
  extend FinchAPI::Internal::Type::RequestParameters::Converter
8
8
  include FinchAPI::Internal::Type::RequestParameters
9
9
 
10
+ OrHash =
11
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
12
+
10
13
  sig do
11
- params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
12
- .returns(T.attached_class)
14
+ params(request_options: FinchAPI::RequestOptions::OrHash).returns(
15
+ T.attached_class
16
+ )
17
+ end
18
+ def self.new(request_options: {})
13
19
  end
14
- def self.new(request_options: {}); end
15
20
 
16
- sig { override.returns({request_options: FinchAPI::RequestOptions}) }
17
- def to_hash; end
21
+ sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
22
+ def to_hash
23
+ end
18
24
  end
19
25
  end
20
26
  end