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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +63 -20
  3. data/lib/finch-api/base_client.rb +52 -59
  4. data/lib/finch-api/base_model.rb +453 -415
  5. data/lib/finch-api/base_page.rb +34 -15
  6. data/lib/finch-api/client.rb +3 -7
  7. data/lib/finch-api/errors.rb +12 -17
  8. data/lib/finch-api/extern.rb +1 -4
  9. data/lib/finch-api/individuals_page.rb +28 -34
  10. data/lib/finch-api/models/account_update_event.rb +6 -31
  11. data/lib/finch-api/models/company_event.rb +3 -11
  12. data/lib/finch-api/models/connect/session_new_params.rb +9 -52
  13. data/lib/finch-api/models/connect/session_reauthenticate_params.rb +3 -22
  14. data/lib/finch-api/models/connection_status_type.rb +3 -21
  15. data/lib/finch-api/models/create_access_token_response.rb +6 -30
  16. data/lib/finch-api/models/directory_event.rb +3 -15
  17. data/lib/finch-api/models/employment_event.rb +3 -15
  18. data/lib/finch-api/models/hris/benefit_contribution.rb +3 -14
  19. data/lib/finch-api/models/hris/benefit_features_and_operations.rb +9 -39
  20. data/lib/finch-api/models/hris/benefit_frequency.rb +3 -15
  21. data/lib/finch-api/models/hris/benefit_type.rb +3 -22
  22. data/lib/finch-api/models/hris/benefits/enrolled_individual.rb +3 -18
  23. data/lib/finch-api/models/hris/benefits/individual_benefit.rb +3 -14
  24. data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +9 -40
  25. data/lib/finch-api/models/hris/company.rb +9 -52
  26. data/lib/finch-api/models/hris/document_list_params.rb +3 -13
  27. data/lib/finch-api/models/hris/document_response.rb +3 -14
  28. data/lib/finch-api/models/hris/document_retreive_response.rb +7 -23
  29. data/lib/finch-api/models/hris/employment_data.rb +9 -58
  30. data/lib/finch-api/models/hris/individual.rb +12 -66
  31. data/lib/finch-api/models/hris/pay_statement.rb +12 -70
  32. data/lib/finch-api/models/hris/payment.rb +3 -21
  33. data/lib/finch-api/models/hris/supported_benefit.rb +9 -39
  34. data/lib/finch-api/models/hris/w42005.rb +12 -49
  35. data/lib/finch-api/models/hris/w42020.rb +8 -29
  36. data/lib/finch-api/models/income.rb +3 -22
  37. data/lib/finch-api/models/individual_event.rb +3 -15
  38. data/lib/finch-api/models/introspection.rb +9 -50
  39. data/lib/finch-api/models/job_completion_event.rb +3 -21
  40. data/lib/finch-api/models/jobs/automated_async_job.rb +6 -35
  41. data/lib/finch-api/models/jobs/automated_create_params.rb +3 -12
  42. data/lib/finch-api/models/jobs/automated_list_response.rb +100 -0
  43. data/lib/finch-api/models/jobs/manual_async_job.rb +3 -17
  44. data/lib/finch-api/models/operation_support.rb +3 -18
  45. data/lib/finch-api/models/pay_statement_event.rb +3 -15
  46. data/lib/finch-api/models/payment_event.rb +3 -15
  47. data/lib/finch-api/models/payroll/pay_group_list_response.rb +3 -21
  48. data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +3 -21
  49. data/lib/finch-api/models/provider.rb +3 -20
  50. data/lib/finch-api/models/sandbox/company_update_params.rb +9 -52
  51. data/lib/finch-api/models/sandbox/company_update_response.rb +9 -52
  52. data/lib/finch-api/models/sandbox/connection_create_params.rb +3 -17
  53. data/lib/finch-api/models/sandbox/connection_create_response.rb +3 -17
  54. data/lib/finch-api/models/sandbox/connections/account_create_params.rb +3 -17
  55. data/lib/finch-api/models/sandbox/connections/account_create_response.rb +3 -17
  56. data/lib/finch-api/models/sandbox/connections/account_update_response.rb +3 -17
  57. data/lib/finch-api/models/sandbox/directory_create_params.rb +21 -124
  58. data/lib/finch-api/models/sandbox/employment_update_params.rb +9 -58
  59. data/lib/finch-api/models/sandbox/employment_update_response.rb +9 -58
  60. data/lib/finch-api/models/sandbox/individual_update_params.rb +12 -66
  61. data/lib/finch-api/models/sandbox/individual_update_response.rb +12 -66
  62. data/lib/finch-api/models/sandbox/job_create_params.rb +3 -12
  63. data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +2 -1
  64. data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -28
  65. data/lib/finch-api/models/sandbox/payment_create_params.rb +12 -70
  66. data/lib/finch-api/models/webhook_event.rb +10 -27
  67. data/lib/finch-api/page.rb +28 -34
  68. data/lib/finch-api/pooled_net_requester.rb +51 -46
  69. data/lib/finch-api/request_options.rb +5 -12
  70. data/lib/finch-api/resources/access_tokens.rb +0 -2
  71. data/lib/finch-api/resources/account.rb +0 -3
  72. data/lib/finch-api/resources/connect/sessions.rb +0 -3
  73. data/lib/finch-api/resources/connect.rb +0 -1
  74. data/lib/finch-api/resources/hris/benefits/individuals.rb +2 -6
  75. data/lib/finch-api/resources/hris/benefits.rb +0 -6
  76. data/lib/finch-api/resources/hris/company.rb +0 -2
  77. data/lib/finch-api/resources/hris/directory.rb +1 -24
  78. data/lib/finch-api/resources/hris/documents.rb +4 -7
  79. data/lib/finch-api/resources/hris/employments.rb +0 -2
  80. data/lib/finch-api/resources/hris/individuals.rb +0 -2
  81. data/lib/finch-api/resources/hris/pay_statements.rb +0 -2
  82. data/lib/finch-api/resources/hris/payments.rb +0 -2
  83. data/lib/finch-api/resources/hris.rb +0 -1
  84. data/lib/finch-api/resources/jobs/automated.rb +2 -7
  85. data/lib/finch-api/resources/jobs/manual.rb +0 -2
  86. data/lib/finch-api/resources/jobs.rb +0 -1
  87. data/lib/finch-api/resources/payroll/pay_groups.rb +0 -3
  88. data/lib/finch-api/resources/payroll.rb +0 -1
  89. data/lib/finch-api/resources/providers.rb +0 -2
  90. data/lib/finch-api/resources/request_forwarding.rb +0 -2
  91. data/lib/finch-api/resources/sandbox/company.rb +0 -2
  92. data/lib/finch-api/resources/sandbox/connections/accounts.rb +0 -3
  93. data/lib/finch-api/resources/sandbox/connections.rb +0 -2
  94. data/lib/finch-api/resources/sandbox/directory.rb +0 -2
  95. data/lib/finch-api/resources/sandbox/employment.rb +0 -2
  96. data/lib/finch-api/resources/sandbox/individual.rb +0 -2
  97. data/lib/finch-api/resources/sandbox/jobs/configuration.rb +0 -3
  98. data/lib/finch-api/resources/sandbox/jobs.rb +0 -2
  99. data/lib/finch-api/resources/sandbox/payment.rb +0 -2
  100. data/lib/finch-api/resources/sandbox.rb +0 -1
  101. data/lib/finch-api/resources/webhooks.rb +0 -1
  102. data/lib/finch-api/responses_page.rb +24 -31
  103. data/lib/finch-api/single_page.rb +23 -31
  104. data/lib/finch-api/util.rb +216 -124
  105. data/lib/finch-api/version.rb +1 -1
  106. data/lib/finch-api.rb +17 -0
  107. data/manifest.yaml +1 -0
  108. data/rbi/lib/finch-api/base_client.rbi +89 -66
  109. data/rbi/lib/finch-api/base_model.rbi +403 -236
  110. data/rbi/lib/finch-api/base_page.rbi +3 -6
  111. data/rbi/lib/finch-api/client.rbi +23 -28
  112. data/rbi/lib/finch-api/errors.rbi +20 -22
  113. data/rbi/lib/finch-api/extern.rbi +1 -1
  114. data/rbi/lib/finch-api/individuals_page.rbi +5 -23
  115. data/rbi/lib/finch-api/models/access_token_create_params.rbi +13 -24
  116. data/rbi/lib/finch-api/models/account_disconnect_params.rbi +9 -2
  117. data/rbi/lib/finch-api/models/account_introspect_params.rbi +9 -2
  118. data/rbi/lib/finch-api/models/account_update_event.rbi +871 -983
  119. data/rbi/lib/finch-api/models/base_webhook_event.rbi +13 -19
  120. data/rbi/lib/finch-api/models/company_event.rbi +28 -20
  121. data/rbi/lib/finch-api/models/connect/session_new_params.rbi +90 -104
  122. data/rbi/lib/finch-api/models/connect/session_new_response.rbi +6 -14
  123. data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +37 -47
  124. data/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +6 -14
  125. data/rbi/lib/finch-api/models/connection_status_type.rbi +13 -9
  126. data/rbi/lib/finch-api/models/create_access_token_response.rbi +61 -78
  127. data/rbi/lib/finch-api/models/directory_event.rbi +42 -27
  128. data/rbi/lib/finch-api/models/disconnect_response.rbi +4 -8
  129. data/rbi/lib/finch-api/models/employment_event.rbi +42 -27
  130. data/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +29 -21
  131. data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +18 -26
  132. data/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +199 -86
  133. data/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +9 -6
  134. data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +9 -2
  135. data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +9 -2
  136. data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +9 -2
  137. data/rbi/lib/finch-api/models/hris/benefit_type.rbi +26 -22
  138. data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +7 -11
  139. data/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +43 -49
  140. data/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +74 -63
  141. data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +249 -104
  142. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +9 -2
  143. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +4 -14
  144. data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -8
  145. data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +7 -8
  146. data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +23 -39
  147. data/rbi/lib/finch-api/models/hris/benefits_support.rbi +88 -86
  148. data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +1 -1
  149. data/rbi/lib/finch-api/models/hris/company.rbi +119 -171
  150. data/rbi/lib/finch-api/models/hris/company_benefit.rbi +13 -32
  151. data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +9 -2
  152. data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +3 -8
  153. data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +11 -13
  154. data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +11 -13
  155. data/rbi/lib/finch-api/models/hris/document_list_params.rbi +32 -31
  156. data/rbi/lib/finch-api/models/hris/document_list_response.rbi +10 -17
  157. data/rbi/lib/finch-api/models/hris/document_response.rbi +40 -43
  158. data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +9 -2
  159. data/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +6 -4
  160. data/rbi/lib/finch-api/models/hris/employment_data.rbi +163 -205
  161. data/rbi/lib/finch-api/models/hris/employment_data_response.rbi +18 -17
  162. data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +12 -21
  163. data/rbi/lib/finch-api/models/hris/individual.rbi +126 -151
  164. data/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +42 -68
  165. data/rbi/lib/finch-api/models/hris/individual_response.rbi +18 -17
  166. data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +27 -31
  167. data/rbi/lib/finch-api/models/hris/pay_statement.rbi +290 -341
  168. data/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +18 -20
  169. data/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +13 -16
  170. data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +18 -31
  171. data/rbi/lib/finch-api/models/hris/payment.rbi +63 -103
  172. data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +9 -15
  173. data/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +10 -14
  174. data/rbi/lib/finch-api/models/hris/supported_benefit.rbi +83 -79
  175. data/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +3 -8
  176. data/rbi/lib/finch-api/models/hris/w42005.rbi +86 -70
  177. data/rbi/lib/finch-api/models/hris/w42020.rbi +84 -86
  178. data/rbi/lib/finch-api/models/income.rbi +34 -41
  179. data/rbi/lib/finch-api/models/individual_event.rbi +42 -27
  180. data/rbi/lib/finch-api/models/introspection.rbi +138 -178
  181. data/rbi/lib/finch-api/models/job_completion_event.rbi +48 -37
  182. data/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +66 -94
  183. data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +26 -33
  184. data/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +11 -31
  185. data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +11 -13
  186. data/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +126 -0
  187. data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +9 -2
  188. data/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +32 -27
  189. data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +9 -2
  190. data/rbi/lib/finch-api/models/location.rbi +16 -59
  191. data/rbi/lib/finch-api/models/money.rbi +7 -13
  192. data/rbi/lib/finch-api/models/operation_support.rbi +18 -7
  193. data/rbi/lib/finch-api/models/operation_support_matrix.rbi +65 -27
  194. data/rbi/lib/finch-api/models/paging.rbi +10 -12
  195. data/rbi/lib/finch-api/models/pay_statement_event.rbi +46 -32
  196. data/rbi/lib/finch-api/models/payment_event.rbi +39 -34
  197. data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +9 -13
  198. data/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +55 -30
  199. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +9 -2
  200. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +45 -46
  201. data/rbi/lib/finch-api/models/provider.rbi +873 -964
  202. data/rbi/lib/finch-api/models/provider_list_params.rbi +9 -2
  203. data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +20 -33
  204. data/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +40 -59
  205. data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +144 -166
  206. data/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +145 -174
  207. data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +43 -39
  208. data/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +38 -59
  209. data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +62 -39
  210. data/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +54 -62
  211. data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +17 -11
  212. data/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +55 -54
  213. data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +380 -332
  214. data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +1 -1
  215. data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +190 -194
  216. data/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +195 -198
  217. data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +151 -145
  218. data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +163 -151
  219. data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +22 -19
  220. data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +11 -31
  221. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +9 -2
  222. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +2 -1
  223. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +9 -2
  224. data/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +56 -26
  225. data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +409 -393
  226. data/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +6 -14
  227. data/rbi/lib/finch-api/models/webhook_event.rbi +4 -4
  228. data/rbi/lib/finch-api/page.rbi +5 -23
  229. data/rbi/lib/finch-api/pooled_net_requester.rbi +39 -16
  230. data/rbi/lib/finch-api/request_options.rbi +33 -54
  231. data/rbi/lib/finch-api/resources/access_tokens.rbi +4 -3
  232. data/rbi/lib/finch-api/resources/account.rbi +6 -4
  233. data/rbi/lib/finch-api/resources/connect/sessions.rbi +17 -8
  234. data/rbi/lib/finch-api/resources/connect.rbi +3 -4
  235. data/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +33 -10
  236. data/rbi/lib/finch-api/resources/hris/benefits.rbi +32 -13
  237. data/rbi/lib/finch-api/resources/hris/company.rbi +4 -3
  238. data/rbi/lib/finch-api/resources/hris/directory.rbi +11 -15
  239. data/rbi/lib/finch-api/resources/hris/documents.rbi +27 -7
  240. data/rbi/lib/finch-api/resources/hris/employments.rbi +10 -5
  241. data/rbi/lib/finch-api/resources/hris/individuals.rbi +6 -5
  242. data/rbi/lib/finch-api/resources/hris/pay_statements.rbi +13 -5
  243. data/rbi/lib/finch-api/resources/hris/payments.rbi +13 -4
  244. data/rbi/lib/finch-api/resources/hris.rbi +10 -18
  245. data/rbi/lib/finch-api/resources/jobs/automated.rbi +39 -10
  246. data/rbi/lib/finch-api/resources/jobs/manual.rbi +5 -3
  247. data/rbi/lib/finch-api/resources/jobs.rbi +4 -6
  248. data/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +6 -4
  249. data/rbi/lib/finch-api/resources/payroll.rbi +3 -4
  250. data/rbi/lib/finch-api/resources/providers.rbi +4 -3
  251. data/rbi/lib/finch-api/resources/request_forwarding.rbi +27 -4
  252. data/rbi/lib/finch-api/resources/sandbox/company.rbi +19 -7
  253. data/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +19 -7
  254. data/rbi/lib/finch-api/resources/sandbox/connections.rbi +10 -6
  255. data/rbi/lib/finch-api/resources/sandbox/directory.rbi +12 -6
  256. data/rbi/lib/finch-api/resources/sandbox/employment.rbi +30 -11
  257. data/rbi/lib/finch-api/resources/sandbox/individual.rbi +26 -8
  258. data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +9 -7
  259. data/rbi/lib/finch-api/resources/sandbox/jobs.rbi +11 -7
  260. data/rbi/lib/finch-api/resources/sandbox/payment.rbi +5 -4
  261. data/rbi/lib/finch-api/resources/sandbox.rbi +9 -16
  262. data/rbi/lib/finch-api/resources/webhooks.rbi +2 -2
  263. data/rbi/lib/finch-api/responses_page.rbi +4 -17
  264. data/rbi/lib/finch-api/single_page.rbi +4 -12
  265. data/rbi/lib/finch-api/util.rbi +228 -115
  266. data/rbi/lib/finch-api/version.rbi +1 -1
  267. data/sig/finch-api/base_client.rbs +20 -15
  268. data/sig/finch-api/base_model.rbs +36 -18
  269. data/sig/finch-api/base_page.rbs +1 -1
  270. data/sig/finch-api/client.rbs +8 -8
  271. data/sig/finch-api/errors.rbs +21 -21
  272. data/sig/finch-api/individuals_page.rbs +2 -7
  273. data/sig/finch-api/models/access_token_create_params.rbs +7 -12
  274. data/sig/finch-api/models/account_disconnect_params.rbs +1 -6
  275. data/sig/finch-api/models/account_introspect_params.rbs +1 -6
  276. data/sig/finch-api/models/account_update_event.rbs +204 -361
  277. data/sig/finch-api/models/base_webhook_event.rbs +5 -5
  278. data/sig/finch-api/models/company_event.rbs +13 -11
  279. data/sig/finch-api/models/connect/session_new_params.rbs +28 -32
  280. data/sig/finch-api/models/connect/session_new_response.rbs +1 -6
  281. data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +11 -14
  282. data/sig/finch-api/models/connect/session_reauthenticate_response.rbs +1 -6
  283. data/sig/finch-api/models/connection_status_type.rbs +4 -2
  284. data/sig/finch-api/models/create_access_token_response.rbs +20 -21
  285. data/sig/finch-api/models/directory_event.rbs +13 -19
  286. data/sig/finch-api/models/disconnect_response.rbs +1 -5
  287. data/sig/finch-api/models/employment_event.rbs +13 -19
  288. data/sig/finch-api/models/hris/benefit_contribution.rbs +8 -11
  289. data/sig/finch-api/models/hris/benefit_create_params.rbs +6 -11
  290. data/sig/finch-api/models/hris/benefit_features_and_operations.rbs +25 -29
  291. data/sig/finch-api/models/hris/benefit_frequency.rbs +4 -2
  292. data/sig/finch-api/models/hris/benefit_list_params.rbs +1 -6
  293. data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +1 -6
  294. data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +1 -6
  295. data/sig/finch-api/models/hris/benefit_type.rbs +4 -2
  296. data/sig/finch-api/models/hris/benefit_update_params.rbs +4 -6
  297. data/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +14 -18
  298. data/sig/finch-api/models/hris/benefits/individual_benefit.rbs +16 -25
  299. data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +35 -54
  300. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +1 -6
  301. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +4 -6
  302. data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +4 -9
  303. data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +4 -9
  304. data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +10 -16
  305. data/sig/finch-api/models/hris/benefits_support.rbs +14 -18
  306. data/sig/finch-api/models/hris/benfit_contribution.rbs +0 -1
  307. data/sig/finch-api/models/hris/company.rbs +39 -57
  308. data/sig/finch-api/models/hris/company_benefit.rbs +6 -10
  309. data/sig/finch-api/models/hris/company_retrieve_params.rbs +1 -6
  310. data/sig/finch-api/models/hris/create_company_benefits_response.rbs +1 -6
  311. data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +5 -10
  312. data/sig/finch-api/models/hris/directory_list_params.rbs +5 -10
  313. data/sig/finch-api/models/hris/document_list_params.rbs +11 -14
  314. data/sig/finch-api/models/hris/document_list_response.rbs +4 -9
  315. data/sig/finch-api/models/hris/document_response.rbs +11 -14
  316. data/sig/finch-api/models/hris/document_retreive_params.rbs +1 -6
  317. data/sig/finch-api/models/hris/document_retreive_response.rbs +4 -2
  318. data/sig/finch-api/models/hris/employment_data.rbs +41 -59
  319. data/sig/finch-api/models/hris/employment_data_response.rbs +5 -10
  320. data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +5 -15
  321. data/sig/finch-api/models/hris/individual.rbs +39 -45
  322. data/sig/finch-api/models/hris/individual_in_directory.rbs +11 -26
  323. data/sig/finch-api/models/hris/individual_response.rbs +5 -10
  324. data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +7 -22
  325. data/sig/finch-api/models/hris/pay_statement.rbs +75 -131
  326. data/sig/finch-api/models/hris/pay_statement_response.rbs +5 -10
  327. data/sig/finch-api/models/hris/pay_statement_response_body.rbs +4 -9
  328. data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +9 -15
  329. data/sig/finch-api/models/hris/payment.rbs +19 -26
  330. data/sig/finch-api/models/hris/payment_list_params.rbs +5 -10
  331. data/sig/finch-api/models/hris/support_per_benefit_type.rbs +4 -9
  332. data/sig/finch-api/models/hris/supported_benefit.rbs +22 -21
  333. data/sig/finch-api/models/hris/update_company_benefit_response.rbs +1 -6
  334. data/sig/finch-api/models/hris/w42005.rbs +26 -30
  335. data/sig/finch-api/models/hris/w42020.rbs +23 -25
  336. data/sig/finch-api/models/income.rbs +10 -10
  337. data/sig/finch-api/models/individual_event.rbs +13 -19
  338. data/sig/finch-api/models/introspection.rbs +43 -54
  339. data/sig/finch-api/models/job_completion_event.rbs +13 -20
  340. data/sig/finch-api/models/jobs/automated_async_job.rbs +20 -26
  341. data/sig/finch-api/models/jobs/automated_create_params.rbs +10 -18
  342. data/sig/finch-api/models/jobs/automated_create_response.rbs +6 -11
  343. data/sig/finch-api/models/jobs/automated_list_params.rbs +5 -10
  344. data/sig/finch-api/models/jobs/automated_list_response.rbs +82 -0
  345. data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +1 -6
  346. data/sig/finch-api/models/jobs/manual_async_job.rbs +9 -11
  347. data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +1 -6
  348. data/sig/finch-api/models/location.rbs +10 -12
  349. data/sig/finch-api/models/money.rbs +1 -3
  350. data/sig/finch-api/models/operation_support.rbs +4 -2
  351. data/sig/finch-api/models/operation_support_matrix.rbs +6 -10
  352. data/sig/finch-api/models/paging.rbs +1 -3
  353. data/sig/finch-api/models/pay_statement_event.rbs +13 -20
  354. data/sig/finch-api/models/payment_event.rbs +13 -17
  355. data/sig/finch-api/models/payroll/pay_group_list_params.rbs +5 -10
  356. data/sig/finch-api/models/payroll/pay_group_list_response.rbs +9 -12
  357. data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +1 -6
  358. data/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +10 -13
  359. data/sig/finch-api/models/provider.rbs +200 -347
  360. data/sig/finch-api/models/provider_list_params.rbs +1 -5
  361. data/sig/finch-api/models/request_forwarding_forward_params.rbs +8 -13
  362. data/sig/finch-api/models/request_forwarding_forward_response.rbs +13 -23
  363. data/sig/finch-api/models/sandbox/company_update_params.rbs +39 -58
  364. data/sig/finch-api/models/sandbox/company_update_response.rbs +38 -57
  365. data/sig/finch-api/models/sandbox/connection_create_params.rbs +11 -14
  366. data/sig/finch-api/models/sandbox/connection_create_response.rbs +14 -17
  367. data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +11 -14
  368. data/sig/finch-api/models/sandbox/connections/account_create_response.rbs +13 -16
  369. data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +4 -9
  370. data/sig/finch-api/models/sandbox/connections/account_update_response.rbs +12 -15
  371. data/sig/finch-api/models/sandbox/directory_create_params.rbs +76 -102
  372. data/sig/finch-api/models/sandbox/employment_update_params.rbs +40 -59
  373. data/sig/finch-api/models/sandbox/employment_update_response.rbs +40 -59
  374. data/sig/finch-api/models/sandbox/individual_update_params.rbs +39 -46
  375. data/sig/finch-api/models/sandbox/individual_update_response.rbs +39 -46
  376. data/sig/finch-api/models/sandbox/job_create_params.rbs +8 -11
  377. data/sig/finch-api/models/sandbox/job_create_response.rbs +6 -11
  378. data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +1 -6
  379. data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +1 -6
  380. data/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +12 -13
  381. data/sig/finch-api/models/sandbox/payment_create_params.rbs +81 -143
  382. data/sig/finch-api/models/sandbox/payment_create_response.rbs +1 -6
  383. data/sig/finch-api/models/webhook_event.rbs +5 -3
  384. data/sig/finch-api/page.rbs +2 -7
  385. data/sig/finch-api/pooled_net_requester.rbs +13 -4
  386. data/sig/finch-api/request_options.rbs +6 -2
  387. data/sig/finch-api/resources/access_tokens.rbs +7 -11
  388. data/sig/finch-api/resources/account.rbs +6 -16
  389. data/sig/finch-api/resources/connect/sessions.rbs +19 -29
  390. data/sig/finch-api/resources/hris/benefits/individuals.rbs +19 -43
  391. data/sig/finch-api/resources/hris/benefits.rbs +21 -48
  392. data/sig/finch-api/resources/hris/company.rbs +3 -8
  393. data/sig/finch-api/resources/hris/directory.rbs +6 -20
  394. data/sig/finch-api/resources/hris/documents.rbs +11 -22
  395. data/sig/finch-api/resources/hris/employments.rbs +4 -9
  396. data/sig/finch-api/resources/hris/individuals.rbs +5 -10
  397. data/sig/finch-api/resources/hris/pay_statements.rbs +4 -9
  398. data/sig/finch-api/resources/hris/payments.rbs +5 -10
  399. data/sig/finch-api/resources/jobs/automated.rbs +14 -30
  400. data/sig/finch-api/resources/jobs/manual.rbs +4 -10
  401. data/sig/finch-api/resources/payroll/pay_groups.rbs +9 -20
  402. data/sig/finch-api/resources/providers.rbs +3 -7
  403. data/sig/finch-api/resources/request_forwarding.rbs +8 -13
  404. data/sig/finch-api/resources/sandbox/company.rbs +11 -16
  405. data/sig/finch-api/resources/sandbox/connections/accounts.rbs +11 -21
  406. data/sig/finch-api/resources/sandbox/connections.rbs +7 -12
  407. data/sig/finch-api/resources/sandbox/directory.rbs +4 -9
  408. data/sig/finch-api/resources/sandbox/employment.rbs +22 -28
  409. data/sig/finch-api/resources/sandbox/individual.rbs +16 -22
  410. data/sig/finch-api/resources/sandbox/jobs/configuration.rbs +8 -18
  411. data/sig/finch-api/resources/sandbox/jobs.rbs +4 -9
  412. data/sig/finch-api/resources/sandbox/payment.rbs +6 -11
  413. data/sig/finch-api/responses_page.rbs +2 -7
  414. data/sig/finch-api/single_page.rbs +2 -7
  415. data/sig/finch-api/util.rbs +37 -12
  416. data/sig/finch-api/version.rbs +1 -1
  417. metadata +7 -4
@@ -6,8 +6,15 @@ module FinchAPI
6
6
  extend FinchAPI::RequestParameters::Converter
7
7
  include FinchAPI::RequestParameters
8
8
 
9
- sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void }
10
- def initialize(request_options: {})
9
+ sig do
10
+ params(
11
+ request_options: T.any(
12
+ FinchAPI::RequestOptions,
13
+ FinchAPI::Util::AnyHash
14
+ )
15
+ ).returns(T.attached_class)
16
+ end
17
+ def self.new(request_options: {})
11
18
  end
12
19
 
13
20
  sig { override.returns({request_options: FinchAPI::RequestOptions}) }
@@ -6,45 +6,32 @@ module FinchAPI
6
6
  extend FinchAPI::RequestParameters::Converter
7
7
  include FinchAPI::RequestParameters
8
8
 
9
+ # The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
10
+ # , `PUT` , `DELETE` , and `PATCH`.
9
11
  sig { returns(String) }
10
- def method_
11
- end
12
-
13
- sig { params(_: String).returns(String) }
14
- def method_=(_)
15
- end
12
+ attr_accessor :method_
16
13
 
14
+ # The URL route path for the forwarded request. This value must begin with a
15
+ # forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
16
+ # underscores.
17
17
  sig { returns(String) }
18
- def route
19
- end
20
-
21
- sig { params(_: String).returns(String) }
22
- def route=(_)
23
- end
18
+ attr_accessor :route
24
19
 
20
+ # The body for the forwarded request. This value must be specified as either a
21
+ # string or a valid JSON object.
25
22
  sig { returns(T.nilable(String)) }
26
- def data
27
- end
28
-
29
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
30
- def data=(_)
31
- end
23
+ attr_accessor :data
32
24
 
25
+ # The HTTP headers to include on the forwarded request. This value must be
26
+ # specified as an object of key-value pairs. Example:
27
+ # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
33
28
  sig { returns(T.nilable(T.anything)) }
34
- def headers
35
- end
36
-
37
- sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
38
- def headers=(_)
39
- end
29
+ attr_accessor :headers
40
30
 
31
+ # The query parameters for the forwarded request. This value must be specified as
32
+ # a valid JSON object rather than a query string.
41
33
  sig { returns(T.nilable(T.anything)) }
42
- def params
43
- end
44
-
45
- sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
46
- def params=(_)
47
- end
34
+ attr_accessor :params
48
35
 
49
36
  sig do
50
37
  params(
@@ -53,11 +40,11 @@ module FinchAPI
53
40
  data: T.nilable(String),
54
41
  headers: T.nilable(T.anything),
55
42
  params: T.nilable(T.anything),
56
- request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
43
+ request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
57
44
  )
58
- .void
45
+ .returns(T.attached_class)
59
46
  end
60
- def initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
47
+ def self.new(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
61
48
  end
62
49
 
63
50
  sig do
@@ -3,51 +3,45 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class RequestForwardingForwardResponse < FinchAPI::BaseModel
6
+ # A string representation of the HTTP response body of the forwarded request’s
7
+ # response received from the underlying integration’s API. This field may be null
8
+ # in the case where the upstream system’s response is empty.
6
9
  sig { returns(T.nilable(String)) }
7
- def data
8
- end
9
-
10
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
11
- def data=(_)
12
- end
10
+ attr_accessor :data
13
11
 
12
+ # The HTTP headers of the forwarded request’s response, exactly as received from
13
+ # the underlying integration’s API.
14
14
  sig { returns(T.nilable(T.anything)) }
15
- def headers
16
- end
17
-
18
- sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
19
- def headers=(_)
20
- end
15
+ attr_accessor :headers
21
16
 
17
+ # An object containing details of your original forwarded request, for your ease
18
+ # of reference.
22
19
  sig { returns(FinchAPI::Models::RequestForwardingForwardResponse::Request) }
23
- def request
24
- end
20
+ attr_reader :request
25
21
 
26
22
  sig do
27
- params(_: FinchAPI::Models::RequestForwardingForwardResponse::Request)
28
- .returns(FinchAPI::Models::RequestForwardingForwardResponse::Request)
29
- end
30
- def request=(_)
23
+ params(
24
+ request: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash)
25
+ )
26
+ .void
31
27
  end
28
+ attr_writer :request
32
29
 
30
+ # The HTTP status code of the forwarded request’s response, exactly received from
31
+ # the underlying integration’s API. This value will be returned as an integer.
33
32
  sig { returns(Integer) }
34
- def status_code
35
- end
36
-
37
- sig { params(_: Integer).returns(Integer) }
38
- def status_code=(_)
39
- end
33
+ attr_accessor :status_code
40
34
 
41
35
  sig do
42
36
  params(
43
37
  data: T.nilable(String),
44
38
  headers: T.nilable(T.anything),
45
- request: FinchAPI::Models::RequestForwardingForwardResponse::Request,
39
+ request: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash),
46
40
  status_code: Integer
47
41
  )
48
- .void
42
+ .returns(T.attached_class)
49
43
  end
50
- def initialize(data:, headers:, request:, status_code:)
44
+ def self.new(data:, headers:, request:, status_code:)
51
45
  end
52
46
 
53
47
  sig do
@@ -65,46 +59,33 @@ module FinchAPI
65
59
  end
66
60
 
67
61
  class Request < FinchAPI::BaseModel
62
+ # The body that was specified for the forwarded request. If a value was not
63
+ # specified in the original request, this value will be returned as null ;
64
+ # otherwise, this value will always be returned as a string.
68
65
  sig { returns(T.nilable(String)) }
69
- def data
70
- end
71
-
72
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
73
- def data=(_)
74
- end
66
+ attr_accessor :data
75
67
 
68
+ # The specified HTTP headers that were included in the forwarded request. If no
69
+ # headers were specified, this will be returned as `null`.
76
70
  sig { returns(T.nilable(T.anything)) }
77
- def headers
78
- end
79
-
80
- sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
81
- def headers=(_)
82
- end
71
+ attr_accessor :headers
83
72
 
73
+ # The HTTP method that was specified for the forwarded request. Valid values
74
+ # include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
84
75
  sig { returns(String) }
85
- def method_
86
- end
87
-
88
- sig { params(_: String).returns(String) }
89
- def method_=(_)
90
- end
76
+ attr_accessor :method_
91
77
 
78
+ # The query parameters that were included in the forwarded request. If no query
79
+ # parameters were specified, this will be returned as `null`.
92
80
  sig { returns(T.nilable(T.anything)) }
93
- def params
94
- end
95
-
96
- sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
97
- def params=(_)
98
- end
81
+ attr_accessor :params
99
82
 
83
+ # The URL route path that was specified for the forwarded request.
100
84
  sig { returns(String) }
101
- def route
102
- end
103
-
104
- sig { params(_: String).returns(String) }
105
- def route=(_)
106
- end
85
+ attr_accessor :route
107
86
 
87
+ # An object containing details of your original forwarded request, for your ease
88
+ # of reference.
108
89
  sig do
109
90
  params(
110
91
  data: T.nilable(String),
@@ -113,9 +94,9 @@ module FinchAPI
113
94
  params: T.nilable(T.anything),
114
95
  route: String
115
96
  )
116
- .void
97
+ .returns(T.attached_class)
117
98
  end
118
- def initialize(data:, headers:, method_:, params:, route:)
99
+ def self.new(data:, headers:, method_:, params:, route:)
119
100
  end
120
101
 
121
102
  sig do
@@ -7,97 +7,64 @@ module FinchAPI
7
7
  extend FinchAPI::RequestParameters::Converter
8
8
  include FinchAPI::RequestParameters
9
9
 
10
+ # An array of bank account objects associated with the payroll/HRIS system.
10
11
  sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account])) }
11
- def accounts
12
- end
13
-
14
- sig do
15
- params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]))
16
- .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]))
17
- end
18
- def accounts=(_)
19
- end
12
+ attr_accessor :accounts
20
13
 
14
+ # The array of company departments.
21
15
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)])) }
22
- def departments
23
- end
24
-
25
- sig do
26
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)]))
27
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)]))
28
- end
29
- def departments=(_)
30
- end
16
+ attr_accessor :departments
31
17
 
18
+ # The employer identification number.
32
19
  sig { returns(T.nilable(String)) }
33
- def ein
34
- end
35
-
36
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
37
- def ein=(_)
38
- end
20
+ attr_accessor :ein
39
21
 
22
+ # The entity type object.
40
23
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity)) }
41
- def entity
42
- end
24
+ attr_reader :entity
43
25
 
44
26
  sig do
45
- params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity))
46
- .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity))
47
- end
48
- def entity=(_)
27
+ params(
28
+ entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash))
29
+ )
30
+ .void
49
31
  end
32
+ attr_writer :entity
50
33
 
34
+ # The legal name of the company.
51
35
  sig { returns(T.nilable(String)) }
52
- def legal_name
53
- end
54
-
55
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
56
- def legal_name=(_)
57
- end
36
+ attr_accessor :legal_name
58
37
 
59
38
  sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) }
60
- def locations
61
- end
62
-
63
- sig do
64
- params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]))
65
- .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]))
66
- end
67
- def locations=(_)
68
- end
39
+ attr_accessor :locations
69
40
 
41
+ # The email of the main administrator on the account.
70
42
  sig { returns(T.nilable(String)) }
71
- def primary_email
72
- end
73
-
74
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
75
- def primary_email=(_)
76
- end
43
+ attr_accessor :primary_email
77
44
 
45
+ # The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
78
46
  sig { returns(T.nilable(String)) }
79
- def primary_phone_number
80
- end
81
-
82
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
83
- def primary_phone_number=(_)
84
- end
47
+ attr_accessor :primary_phone_number
85
48
 
86
49
  sig do
87
50
  params(
88
- accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]),
89
- departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)]),
51
+ accounts: T.nilable(
52
+ T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account, FinchAPI::Util::AnyHash)]
53
+ ),
54
+ departments: T.nilable(
55
+ T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, FinchAPI::Util::AnyHash))]
56
+ ),
90
57
  ein: T.nilable(String),
91
- entity: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity),
58
+ entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)),
92
59
  legal_name: T.nilable(String),
93
- locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]),
60
+ locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))]),
94
61
  primary_email: T.nilable(String),
95
62
  primary_phone_number: T.nilable(String),
96
- request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
63
+ request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
97
64
  )
98
- .void
65
+ .returns(T.attached_class)
99
66
  end
100
- def initialize(
67
+ def self.new(
101
68
  accounts:,
102
69
  departments:,
103
70
  ein:,
@@ -130,63 +97,38 @@ module FinchAPI
130
97
  end
131
98
 
132
99
  class Account < FinchAPI::BaseModel
100
+ # The name of the bank associated in the payroll/HRIS system.
133
101
  sig { returns(T.nilable(String)) }
134
- def account_name
135
- end
136
-
137
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
138
- def account_name=(_)
139
- end
102
+ attr_accessor :account_name
140
103
 
104
+ # 10-12 digit number to specify the bank account
141
105
  sig { returns(T.nilable(String)) }
142
- def account_number
143
- end
144
-
145
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
146
- def account_number=(_)
147
- end
148
-
149
- sig { returns(T.nilable(Symbol)) }
150
- def account_type
151
- end
106
+ attr_accessor :account_number
152
107
 
153
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
154
- def account_type=(_)
155
- end
108
+ # The type of bank account.
109
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) }
110
+ attr_accessor :account_type
156
111
 
112
+ # Name of the banking institution.
157
113
  sig { returns(T.nilable(String)) }
158
- def institution_name
159
- end
160
-
161
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
162
- def institution_name=(_)
163
- end
114
+ attr_accessor :institution_name
164
115
 
116
+ # A nine-digit code that's based on the U.S. Bank location where your account was
117
+ # opened.
165
118
  sig { returns(T.nilable(String)) }
166
- def routing_number
167
- end
168
-
169
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
170
- def routing_number=(_)
171
- end
119
+ attr_accessor :routing_number
172
120
 
173
121
  sig do
174
122
  params(
175
123
  account_name: T.nilable(String),
176
124
  account_number: T.nilable(String),
177
- account_type: T.nilable(Symbol),
125
+ account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol),
178
126
  institution_name: T.nilable(String),
179
127
  routing_number: T.nilable(String)
180
128
  )
181
- .void
129
+ .returns(T.attached_class)
182
130
  end
183
- def initialize(
184
- account_name: nil,
185
- account_number: nil,
186
- account_type: nil,
187
- institution_name: nil,
188
- routing_number: nil
189
- )
131
+ def self.new(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
190
132
  end
191
133
 
192
134
  sig do
@@ -195,7 +137,7 @@ module FinchAPI
195
137
  {
196
138
  account_name: T.nilable(String),
197
139
  account_number: T.nilable(String),
198
- account_type: T.nilable(Symbol),
140
+ account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol),
199
141
  institution_name: T.nilable(String),
200
142
  routing_number: T.nilable(String)
201
143
  }
@@ -204,46 +146,58 @@ module FinchAPI
204
146
  def to_hash
205
147
  end
206
148
 
207
- class AccountType < FinchAPI::Enum
208
- abstract!
149
+ # The type of bank account.
150
+ module AccountType
151
+ extend FinchAPI::Enum
209
152
 
210
- CHECKING = T.let(:checking, T.nilable(Symbol))
211
- SAVINGS = T.let(:savings, T.nilable(Symbol))
153
+ TaggedSymbol =
154
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType) }
155
+ OrSymbol =
156
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) }
212
157
 
213
- sig { override.returns(T::Array[Symbol]) }
158
+ CHECKING =
159
+ T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol)
160
+ SAVINGS =
161
+ T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol)
162
+
163
+ sig do
164
+ override
165
+ .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol])
166
+ end
214
167
  def self.values
215
168
  end
216
169
  end
217
170
  end
218
171
 
219
172
  class Department < FinchAPI::BaseModel
173
+ # The department name.
220
174
  sig { returns(T.nilable(String)) }
221
- def name
222
- end
223
-
224
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
225
- def name=(_)
226
- end
175
+ attr_accessor :name
227
176
 
177
+ # The parent department, if present.
228
178
  sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)) }
229
- def parent
230
- end
179
+ attr_reader :parent
231
180
 
232
181
  sig do
233
- params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent))
234
- .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent))
235
- end
236
- def parent=(_)
182
+ params(
183
+ parent: T.nilable(
184
+ T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash)
185
+ )
186
+ )
187
+ .void
237
188
  end
189
+ attr_writer :parent
238
190
 
239
191
  sig do
240
192
  params(
241
193
  name: T.nilable(String),
242
- parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)
194
+ parent: T.nilable(
195
+ T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash)
196
+ )
243
197
  )
244
- .void
198
+ .returns(T.attached_class)
245
199
  end
246
- def initialize(name: nil, parent: nil)
200
+ def self.new(name: nil, parent: nil)
247
201
  end
248
202
 
249
203
  sig do
@@ -259,16 +213,13 @@ module FinchAPI
259
213
  end
260
214
 
261
215
  class Parent < FinchAPI::BaseModel
216
+ # The parent department's name.
262
217
  sig { returns(T.nilable(String)) }
263
- def name
264
- end
218
+ attr_accessor :name
265
219
 
266
- sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
267
- def name=(_)
268
- end
269
-
270
- sig { params(name: T.nilable(String)).void }
271
- def initialize(name: nil)
220
+ # The parent department, if present.
221
+ sig { params(name: T.nilable(String)).returns(T.attached_class) }
222
+ def self.new(name: nil)
272
223
  end
273
224
 
274
225
  sig { override.returns({name: T.nilable(String)}) }
@@ -278,54 +229,81 @@ module FinchAPI
278
229
  end
279
230
 
280
231
  class Entity < FinchAPI::BaseModel
281
- sig { returns(T.nilable(Symbol)) }
282
- def subtype
283
- end
232
+ # The tax payer subtype of the company.
233
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) }
234
+ attr_accessor :subtype
284
235
 
285
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
286
- def subtype=(_)
287
- end
236
+ # The tax payer type of the company.
237
+ sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) }
238
+ attr_accessor :type
288
239
 
289
- sig { returns(T.nilable(Symbol)) }
290
- def type
240
+ # The entity type object.
241
+ sig do
242
+ params(
243
+ subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol),
244
+ type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)
245
+ )
246
+ .returns(T.attached_class)
291
247
  end
292
-
293
- sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
294
- def type=(_)
248
+ def self.new(subtype: nil, type: nil)
295
249
  end
296
250
 
297
- sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void }
298
- def initialize(subtype: nil, type: nil)
251
+ sig do
252
+ override
253
+ .returns(
254
+ {
255
+ subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol),
256
+ type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)
257
+ }
258
+ )
299
259
  end
300
-
301
- sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) }
302
260
  def to_hash
303
261
  end
304
262
 
305
- class Subtype < FinchAPI::Enum
306
- abstract!
263
+ # The tax payer subtype of the company.
264
+ module Subtype
265
+ extend FinchAPI::Enum
266
+
267
+ TaggedSymbol =
268
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype) }
269
+ OrSymbol =
270
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) }
307
271
 
308
- S_CORPORATION = T.let(:s_corporation, T.nilable(Symbol))
309
- C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol))
310
- B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol))
272
+ S_CORPORATION =
273
+ T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol)
274
+ C_CORPORATION =
275
+ T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol)
276
+ B_CORPORATION =
277
+ T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol)
311
278
 
312
- sig { override.returns(T::Array[Symbol]) }
279
+ sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol]) }
313
280
  def self.values
314
281
  end
315
282
  end
316
283
 
317
- class Type < FinchAPI::Enum
318
- abstract!
319
-
320
- LLC = T.let(:llc, T.nilable(Symbol))
321
- LP = T.let(:lp, T.nilable(Symbol))
322
- CORPORATION = T.let(:corporation, T.nilable(Symbol))
323
- SOLE_PROPRIETOR = T.let(:sole_proprietor, T.nilable(Symbol))
324
- NON_PROFIT = T.let(:non_profit, T.nilable(Symbol))
325
- PARTNERSHIP = T.let(:partnership, T.nilable(Symbol))
326
- COOPERATIVE = T.let(:cooperative, T.nilable(Symbol))
327
-
328
- sig { override.returns(T::Array[Symbol]) }
284
+ # The tax payer type of the company.
285
+ module Type
286
+ extend FinchAPI::Enum
287
+
288
+ TaggedSymbol =
289
+ T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type) }
290
+ OrSymbol =
291
+ T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) }
292
+
293
+ LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
294
+ LP = T.let(:lp, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
295
+ CORPORATION =
296
+ T.let(:corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
297
+ SOLE_PROPRIETOR =
298
+ T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
299
+ NON_PROFIT =
300
+ T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
301
+ PARTNERSHIP =
302
+ T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
303
+ COOPERATIVE =
304
+ T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol)
305
+
306
+ sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol]) }
329
307
  def self.values
330
308
  end
331
309
  end