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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (446) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +38 -0
  3. data/README.md +6 -6
  4. data/lib/finch_api/file_part.rb +2 -2
  5. data/lib/finch_api/internal/individuals_page.rb +5 -5
  6. data/lib/finch_api/internal/page.rb +5 -5
  7. data/lib/finch_api/internal/responses_page.rb +2 -2
  8. data/lib/finch_api/internal/transport/base_client.rb +3 -3
  9. data/lib/finch_api/internal/type/base_model.rb +1 -9
  10. data/lib/finch_api/internal/type/enum.rb +4 -4
  11. data/lib/finch_api/internal/type/request_parameters.rb +6 -12
  12. data/lib/finch_api/internal/type/union.rb +2 -2
  13. data/lib/finch_api/internal/util.rb +21 -5
  14. data/lib/finch_api/models/account_update_event.rb +202 -148
  15. data/lib/finch_api/models/base_webhook_event.rb +1 -3
  16. data/lib/finch_api/models/company_event.rb +3 -3
  17. data/lib/finch_api/models/connect/session_new_params.rb +13 -14
  18. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -4
  19. data/lib/finch_api/models/create_access_token_response.rb +9 -12
  20. data/lib/finch_api/models/directory_event.rb +6 -6
  21. data/lib/finch_api/models/employment_event.rb +6 -6
  22. data/lib/finch_api/models/hris/benefit_contribution.rb +4 -4
  23. data/lib/finch_api/models/hris/benefit_create_params.rb +18 -17
  24. data/lib/finch_api/models/hris/benefit_features_and_operations.rb +32 -36
  25. data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +3 -7
  26. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +15 -17
  27. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +42 -33
  28. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +0 -1
  29. data/lib/finch_api/models/hris/benefits_support.rb +36 -36
  30. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +21 -16
  31. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb +0 -1
  32. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb +0 -1
  33. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb +0 -1
  34. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb +0 -1
  35. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +5 -6
  36. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +0 -3
  37. data/lib/finch_api/models/hris/company.rb +35 -33
  38. data/lib/finch_api/models/hris/company_benefit.rb +19 -19
  39. data/lib/finch_api/models/hris/document_list_params.rb +5 -5
  40. data/lib/finch_api/models/hris/document_list_response.rb +6 -6
  41. data/lib/finch_api/models/hris/document_response.rb +5 -7
  42. data/lib/finch_api/models/hris/document_retreive_response.rb +3 -3
  43. data/lib/finch_api/models/hris/employment_data.rb +326 -258
  44. data/lib/finch_api/models/hris/employment_data_response.rb +8 -8
  45. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +6 -6
  46. data/lib/finch_api/models/hris/individual.rb +34 -31
  47. data/lib/finch_api/models/hris/individual_in_directory.rb +8 -8
  48. data/lib/finch_api/models/hris/individual_response.rb +3 -3
  49. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +8 -6
  50. data/lib/finch_api/models/hris/pay_statement.rb +105 -100
  51. data/lib/finch_api/models/hris/pay_statement_response.rb +3 -3
  52. data/lib/finch_api/models/hris/pay_statement_response_body.rb +6 -6
  53. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +5 -3
  54. data/lib/finch_api/models/hris/payment.rb +22 -22
  55. data/lib/finch_api/models/hris/payment_list_params.rb +0 -2
  56. data/lib/finch_api/models/hris/support_per_benefit_type.rb +6 -6
  57. data/lib/finch_api/models/hris/supported_benefit.rb +22 -17
  58. data/lib/finch_api/models/hris/w42005.rb +16 -16
  59. data/lib/finch_api/models/hris/w42020.rb +13 -14
  60. data/lib/finch_api/models/income.rb +10 -11
  61. data/lib/finch_api/models/individual_event.rb +6 -6
  62. data/lib/finch_api/models/introspection.rb +31 -39
  63. data/lib/finch_api/models/job_completion_event.rb +6 -6
  64. data/lib/finch_api/models/jobs/automated_async_job.rb +13 -15
  65. data/lib/finch_api/models/jobs/automated_create_params.rb +6 -6
  66. data/lib/finch_api/models/jobs/automated_list_response.rb +3 -4
  67. data/lib/finch_api/models/jobs/manual_async_job.rb +4 -4
  68. data/lib/finch_api/models/operation_support_matrix.rb +13 -13
  69. data/lib/finch_api/models/pay_statement_event.rb +6 -6
  70. data/lib/finch_api/models/payment_event.rb +6 -6
  71. data/lib/finch_api/models/provider.rb +178 -140
  72. data/lib/finch_api/models/request_forwarding_forward_params.rb +0 -5
  73. data/lib/finch_api/models/request_forwarding_forward_response.rb +0 -8
  74. data/lib/finch_api/models/sandbox/company_update_params.rb +34 -33
  75. data/lib/finch_api/models/sandbox/company_update_response.rb +5 -5
  76. data/lib/finch_api/models/sandbox/connection_create_params.rb +5 -4
  77. data/lib/finch_api/models/sandbox/connections/account_create_params.rb +3 -4
  78. data/lib/finch_api/models/sandbox/connections/account_update_params.rb +3 -3
  79. data/lib/finch_api/models/sandbox/directory_create_params.rb +83 -77
  80. data/lib/finch_api/models/sandbox/employment_update_params.rb +37 -39
  81. data/lib/finch_api/models/sandbox/employment_update_response.rb +9 -12
  82. data/lib/finch_api/models/sandbox/individual_update_params.rb +28 -25
  83. data/lib/finch_api/models/sandbox/individual_update_response.rb +3 -5
  84. data/lib/finch_api/models/sandbox/job_create_params.rb +3 -3
  85. data/lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb +1 -1
  86. data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +8 -8
  87. data/lib/finch_api/models/sandbox/payment_create_params.rb +124 -99
  88. data/lib/finch_api/models/webhook_event.rb +9 -9
  89. data/lib/finch_api/models.rb +65 -0
  90. data/lib/finch_api/resources/access_tokens.rb +3 -3
  91. data/lib/finch_api/resources/account.rb +4 -4
  92. data/lib/finch_api/resources/connect/sessions.rb +6 -8
  93. data/lib/finch_api/resources/hris/benefits/individuals.rb +10 -12
  94. data/lib/finch_api/resources/hris/benefits.rb +13 -14
  95. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +5 -7
  96. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +2 -5
  97. data/lib/finch_api/resources/hris/company.rb +2 -2
  98. data/lib/finch_api/resources/hris/directory.rb +3 -3
  99. data/lib/finch_api/resources/hris/documents.rb +3 -5
  100. data/lib/finch_api/resources/hris/employments.rb +4 -4
  101. data/lib/finch_api/resources/hris/individuals.rb +5 -5
  102. data/lib/finch_api/resources/hris/pay_statements.rb +4 -4
  103. data/lib/finch_api/resources/hris/payments.rb +3 -5
  104. data/lib/finch_api/resources/jobs/automated.rb +6 -6
  105. data/lib/finch_api/resources/jobs/manual.rb +2 -2
  106. data/lib/finch_api/resources/payroll/pay_groups.rb +1 -1
  107. data/lib/finch_api/resources/providers.rb +2 -2
  108. data/lib/finch_api/resources/request_forwarding.rb +1 -6
  109. data/lib/finch_api/resources/sandbox/company.rb +5 -6
  110. data/lib/finch_api/resources/sandbox/connections/accounts.rb +4 -5
  111. data/lib/finch_api/resources/sandbox/connections.rb +2 -3
  112. data/lib/finch_api/resources/sandbox/directory.rb +2 -3
  113. data/lib/finch_api/resources/sandbox/employment.rb +9 -11
  114. data/lib/finch_api/resources/sandbox/individual.rb +6 -8
  115. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +7 -7
  116. data/lib/finch_api/resources/sandbox/jobs.rb +2 -2
  117. data/lib/finch_api/resources/sandbox/payment.rb +2 -2
  118. data/lib/finch_api/version.rb +1 -1
  119. data/lib/finch_api.rb +1 -0
  120. data/rbi/finch_api/client.rbi +9 -6
  121. data/rbi/finch_api/errors.rbi +34 -15
  122. data/rbi/finch_api/file_part.rbi +9 -6
  123. data/rbi/finch_api/internal/individuals_page.rbi +3 -2
  124. data/rbi/finch_api/internal/page.rbi +3 -2
  125. data/rbi/finch_api/internal/responses_page.rbi +2 -1
  126. data/rbi/finch_api/internal/single_page.rbi +8 -4
  127. data/rbi/finch_api/internal/transport/base_client.rbi +140 -75
  128. data/rbi/finch_api/internal/transport/pooled_net_requester.rbi +26 -12
  129. data/rbi/finch_api/internal/type/array_of.rbi +34 -24
  130. data/rbi/finch_api/internal/type/base_model.rbi +129 -69
  131. data/rbi/finch_api/internal/type/base_page.rbi +13 -8
  132. data/rbi/finch_api/internal/type/boolean.rbi +16 -14
  133. data/rbi/finch_api/internal/type/converter.rbi +68 -28
  134. data/rbi/finch_api/internal/type/enum.rbi +27 -15
  135. data/rbi/finch_api/internal/type/file_input.rbi +8 -4
  136. data/rbi/finch_api/internal/type/hash_of.rbi +34 -24
  137. data/rbi/finch_api/internal/type/request_parameters.rbi +12 -4
  138. data/rbi/finch_api/internal/type/union.rbi +54 -19
  139. data/rbi/finch_api/internal/type/unknown.rbi +16 -6
  140. data/rbi/finch_api/internal/util.rbi +215 -86
  141. data/rbi/finch_api/models/access_token_create_params.rbi +23 -15
  142. data/rbi/finch_api/models/account_disconnect_params.rbi +10 -5
  143. data/rbi/finch_api/models/account_introspect_params.rbi +10 -5
  144. data/rbi/finch_api/models/account_update_event.rbi +968 -731
  145. data/rbi/finch_api/models/base_webhook_event.rbi +19 -4
  146. data/rbi/finch_api/models/company_event.rbi +34 -18
  147. data/rbi/finch_api/models/connect/session_new_params.rbi +202 -69
  148. data/rbi/finch_api/models/connect/session_new_response.rbi +14 -4
  149. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +97 -30
  150. data/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +14 -4
  151. data/rbi/finch_api/models/connection_status_type.rbi +19 -9
  152. data/rbi/finch_api/models/create_access_token_response.rbi +86 -34
  153. data/rbi/finch_api/models/directory_event.rbi +53 -26
  154. data/rbi/finch_api/models/disconnect_response.rbi +8 -3
  155. data/rbi/finch_api/models/employment_event.rbi +53 -26
  156. data/rbi/finch_api/models/hris/benefit_contribution.rbi +45 -15
  157. data/rbi/finch_api/models/hris/benefit_create_params.rbi +121 -56
  158. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +145 -99
  159. data/rbi/finch_api/models/hris/benefit_frequency.rbi +15 -6
  160. data/rbi/finch_api/models/hris/benefit_list_params.rbi +11 -5
  161. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +11 -5
  162. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +126 -50
  163. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +11 -5
  164. data/rbi/finch_api/models/hris/benefit_type.rbi +41 -22
  165. data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -9
  166. data/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +8 -3
  167. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +82 -49
  168. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +188 -153
  169. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +13 -5
  170. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +19 -4
  171. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +18 -6
  172. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +16 -6
  173. data/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +8 -3
  174. data/rbi/finch_api/models/hris/benefits_support.rbi +106 -82
  175. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +126 -82
  176. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +125 -81
  177. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +13 -5
  178. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +126 -82
  179. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +13 -5
  180. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +125 -81
  181. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -6
  182. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +125 -81
  183. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +60 -29
  184. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +83 -45
  185. data/rbi/finch_api/models/hris/company.rbi +258 -98
  186. data/rbi/finch_api/models/hris/company_benefit.rbi +122 -50
  187. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +11 -5
  188. data/rbi/finch_api/models/hris/create_company_benefits_response.rbi +12 -4
  189. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +19 -6
  190. data/rbi/finch_api/models/hris/directory_list_params.rbi +19 -6
  191. data/rbi/finch_api/models/hris/document_list_params.rbi +54 -23
  192. data/rbi/finch_api/models/hris/document_list_response.rbi +19 -11
  193. data/rbi/finch_api/models/hris/document_response.rbi +48 -22
  194. data/rbi/finch_api/models/hris/document_retreive_params.rbi +11 -5
  195. data/rbi/finch_api/models/hris/document_retreive_response.rbi +10 -2
  196. data/rbi/finch_api/models/hris/employment_data.rbi +616 -278
  197. data/rbi/finch_api/models/hris/employment_data_response.rbi +42 -23
  198. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +35 -17
  199. data/rbi/finch_api/models/hris/individual.rbi +302 -103
  200. data/rbi/finch_api/models/hris/individual_in_directory.rbi +60 -32
  201. data/rbi/finch_api/models/hris/individual_response.rbi +28 -18
  202. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +66 -33
  203. data/rbi/finch_api/models/hris/pay_statement.rbi +632 -252
  204. data/rbi/finch_api/models/hris/pay_statement_response.rbi +20 -9
  205. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +23 -15
  206. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +46 -18
  207. data/rbi/finch_api/models/hris/payment.rbi +122 -61
  208. data/rbi/finch_api/models/hris/payment_list_params.rbi +17 -6
  209. data/rbi/finch_api/models/hris/support_per_benefit_type.rbi +24 -18
  210. data/rbi/finch_api/models/hris/supported_benefit.rbi +173 -40
  211. data/rbi/finch_api/models/hris/update_company_benefit_response.rbi +12 -4
  212. data/rbi/finch_api/models/hris/w42005.rbi +119 -52
  213. data/rbi/finch_api/models/hris/w42020.rbi +84 -47
  214. data/rbi/finch_api/models/income.rbi +36 -31
  215. data/rbi/finch_api/models/individual_event.rbi +53 -26
  216. data/rbi/finch_api/models/introspection.rbi +195 -99
  217. data/rbi/finch_api/models/job_completion_event.rbi +74 -30
  218. data/rbi/finch_api/models/jobs/automated_async_job.rbi +100 -44
  219. data/rbi/finch_api/models/jobs/automated_create_params.rbi +50 -26
  220. data/rbi/finch_api/models/jobs/automated_create_response.rbi +22 -11
  221. data/rbi/finch_api/models/jobs/automated_list_params.rbi +19 -6
  222. data/rbi/finch_api/models/jobs/automated_list_response.rbi +93 -45
  223. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +11 -5
  224. data/rbi/finch_api/models/jobs/manual_async_job.rbi +46 -21
  225. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +11 -5
  226. data/rbi/finch_api/models/location.rbi +20 -17
  227. data/rbi/finch_api/models/money.rbi +13 -4
  228. data/rbi/finch_api/models/operation_support.rbi +15 -7
  229. data/rbi/finch_api/models/operation_support_matrix.rbi +28 -25
  230. data/rbi/finch_api/models/paging.rbi +8 -3
  231. data/rbi/finch_api/models/pay_statement_event.rbi +60 -27
  232. data/rbi/finch_api/models/payment_event.rbi +59 -27
  233. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +20 -13
  234. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +94 -28
  235. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +11 -5
  236. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +83 -27
  237. data/rbi/finch_api/models/provider.rbi +1000 -711
  238. data/rbi/finch_api/models/provider_list_params.rbi +10 -5
  239. data/rbi/finch_api/models/request_forwarding_forward_params.rbi +19 -16
  240. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +43 -32
  241. data/rbi/finch_api/models/sandbox/company_update_params.rbi +283 -110
  242. data/rbi/finch_api/models/sandbox/company_update_response.rbi +296 -112
  243. data/rbi/finch_api/models/sandbox/connection_create_params.rbi +61 -28
  244. data/rbi/finch_api/models/sandbox/connection_create_response.rbi +58 -27
  245. data/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +45 -30
  246. data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +41 -24
  247. data/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +22 -15
  248. data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +40 -23
  249. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +565 -221
  250. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +296 -119
  251. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +304 -121
  252. data/rbi/finch_api/models/sandbox/individual_update_params.rbi +275 -94
  253. data/rbi/finch_api/models/sandbox/individual_update_response.rbi +276 -93
  254. data/rbi/finch_api/models/sandbox/job_create_params.rbi +34 -15
  255. data/rbi/finch_api/models/sandbox/job_create_response.rbi +22 -11
  256. data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +13 -5
  257. data/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi +3 -1
  258. data/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +13 -5
  259. data/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +72 -29
  260. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +658 -355
  261. data/rbi/finch_api/models/sandbox/payment_create_response.rbi +12 -4
  262. data/rbi/finch_api/models/webhook_event.rbi +15 -5
  263. data/rbi/finch_api/models.rbi +66 -0
  264. data/rbi/finch_api/request_options.rbi +15 -7
  265. data/rbi/finch_api/resources/access_tokens.rbi +12 -5
  266. data/rbi/finch_api/resources/account.rbi +16 -5
  267. data/rbi/finch_api/resources/connect/sessions.rbi +26 -13
  268. data/rbi/finch_api/resources/connect.rbi +2 -1
  269. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +38 -19
  270. data/rbi/finch_api/resources/hris/benefits.rbi +39 -22
  271. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +40 -26
  272. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +17 -6
  273. data/rbi/finch_api/resources/hris/company.rbi +9 -3
  274. data/rbi/finch_api/resources/hris/directory.rbi +14 -4
  275. data/rbi/finch_api/resources/hris/documents.rbi +15 -9
  276. data/rbi/finch_api/resources/hris/employments.rbi +14 -5
  277. data/rbi/finch_api/resources/hris/individuals.rbi +17 -8
  278. data/rbi/finch_api/resources/hris/pay_statements.rbi +14 -5
  279. data/rbi/finch_api/resources/hris/payments.rbi +10 -4
  280. data/rbi/finch_api/resources/hris.rbi +2 -1
  281. data/rbi/finch_api/resources/jobs/automated.rbi +23 -13
  282. data/rbi/finch_api/resources/jobs/manual.rbi +8 -4
  283. data/rbi/finch_api/resources/jobs.rbi +2 -1
  284. data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -7
  285. data/rbi/finch_api/resources/payroll.rbi +2 -1
  286. data/rbi/finch_api/resources/providers.rbi +7 -4
  287. data/rbi/finch_api/resources/request_forwarding.rbi +7 -5
  288. data/rbi/finch_api/resources/sandbox/company.rbi +25 -13
  289. data/rbi/finch_api/resources/sandbox/connections/accounts.rbi +16 -9
  290. data/rbi/finch_api/resources/sandbox/connections.rbi +9 -6
  291. data/rbi/finch_api/resources/sandbox/directory.rbi +9 -6
  292. data/rbi/finch_api/resources/sandbox/employment.rbi +31 -17
  293. data/rbi/finch_api/resources/sandbox/individual.rbi +30 -18
  294. data/rbi/finch_api/resources/sandbox/jobs/configuration.rbi +15 -10
  295. data/rbi/finch_api/resources/sandbox/jobs.rbi +8 -6
  296. data/rbi/finch_api/resources/sandbox/payment.rbi +15 -6
  297. data/rbi/finch_api/resources/sandbox.rbi +2 -1
  298. data/rbi/finch_api/resources/webhooks.rbi +2 -1
  299. data/sig/finch_api/internal/individuals_page.rbs +1 -1
  300. data/sig/finch_api/internal/page.rbs +1 -1
  301. data/sig/finch_api/internal/type/request_parameters.rbs +3 -1
  302. data/sig/finch_api/internal/util.rbs +2 -0
  303. data/sig/finch_api/models/access_token_create_params.rbs +0 -2
  304. data/sig/finch_api/models/account_disconnect_params.rbs +0 -2
  305. data/sig/finch_api/models/account_introspect_params.rbs +0 -2
  306. data/sig/finch_api/models/account_update_event.rbs +176 -244
  307. data/sig/finch_api/models/base_webhook_event.rbs +0 -2
  308. data/sig/finch_api/models/company_event.rbs +6 -8
  309. data/sig/finch_api/models/connect/session_new_params.rbs +11 -15
  310. data/sig/finch_api/models/connect/session_new_response.rbs +0 -2
  311. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +4 -6
  312. data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +0 -2
  313. data/sig/finch_api/models/create_access_token_response.rbs +8 -10
  314. data/sig/finch_api/models/directory_event.rbs +11 -15
  315. data/sig/finch_api/models/disconnect_response.rbs +0 -2
  316. data/sig/finch_api/models/employment_event.rbs +11 -15
  317. data/sig/finch_api/models/hris/benefit_contribution.rbs +4 -9
  318. data/sig/finch_api/models/hris/benefit_create_params.rbs +14 -20
  319. data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +22 -26
  320. data/sig/finch_api/models/hris/benefit_list_params.rbs +0 -2
  321. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +0 -2
  322. data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -2
  323. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +0 -2
  324. data/sig/finch_api/models/hris/benefit_update_params.rbs +0 -2
  325. data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +0 -2
  326. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +15 -19
  327. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +38 -48
  328. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +0 -2
  329. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +0 -2
  330. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +0 -2
  331. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +0 -2
  332. data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +0 -2
  333. data/sig/finch_api/models/hris/benefits_support.rbs +36 -38
  334. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +16 -22
  335. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +0 -6
  336. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +0 -2
  337. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +0 -6
  338. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +0 -2
  339. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +0 -6
  340. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +0 -2
  341. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +0 -6
  342. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +6 -8
  343. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +0 -4
  344. data/sig/finch_api/models/hris/company.rbs +27 -37
  345. data/sig/finch_api/models/hris/company_benefit.rbs +14 -20
  346. data/sig/finch_api/models/hris/company_retrieve_params.rbs +0 -2
  347. data/sig/finch_api/models/hris/create_company_benefits_response.rbs +0 -2
  348. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +0 -2
  349. data/sig/finch_api/models/hris/directory_list_params.rbs +0 -2
  350. data/sig/finch_api/models/hris/document_list_params.rbs +6 -8
  351. data/sig/finch_api/models/hris/document_list_response.rbs +6 -8
  352. data/sig/finch_api/models/hris/document_response.rbs +6 -8
  353. data/sig/finch_api/models/hris/document_retreive_params.rbs +0 -2
  354. data/sig/finch_api/models/hris/document_retreive_response.rbs +2 -2
  355. data/sig/finch_api/models/hris/employment_data.rbs +177 -144
  356. data/sig/finch_api/models/hris/employment_data_response.rbs +7 -17
  357. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +3 -7
  358. data/sig/finch_api/models/hris/individual.rbs +28 -36
  359. data/sig/finch_api/models/hris/individual_in_directory.rbs +6 -12
  360. data/sig/finch_api/models/hris/individual_response.rbs +0 -2
  361. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +8 -14
  362. data/sig/finch_api/models/hris/pay_statement.rbs +82 -108
  363. data/sig/finch_api/models/hris/pay_statement_response.rbs +5 -7
  364. data/sig/finch_api/models/hris/pay_statement_response_body.rbs +9 -11
  365. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +3 -7
  366. data/sig/finch_api/models/hris/payment.rbs +22 -26
  367. data/sig/finch_api/models/hris/payment_list_params.rbs +0 -2
  368. data/sig/finch_api/models/hris/support_per_benefit_type.rbs +10 -12
  369. data/sig/finch_api/models/hris/supported_benefit.rbs +12 -14
  370. data/sig/finch_api/models/hris/update_company_benefit_response.rbs +0 -2
  371. data/sig/finch_api/models/hris/w42005.rbs +21 -25
  372. data/sig/finch_api/models/hris/w42020.rbs +15 -19
  373. data/sig/finch_api/models/income.rbs +7 -9
  374. data/sig/finch_api/models/individual_event.rbs +11 -15
  375. data/sig/finch_api/models/introspection.rbs +25 -33
  376. data/sig/finch_api/models/job_completion_event.rbs +11 -15
  377. data/sig/finch_api/models/jobs/automated_async_job.rbs +11 -15
  378. data/sig/finch_api/models/jobs/automated_create_params.rbs +3 -7
  379. data/sig/finch_api/models/jobs/automated_create_response.rbs +0 -2
  380. data/sig/finch_api/models/jobs/automated_list_params.rbs +0 -2
  381. data/sig/finch_api/models/jobs/automated_list_response.rbs +3 -11
  382. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +0 -2
  383. data/sig/finch_api/models/jobs/manual_async_job.rbs +4 -6
  384. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +0 -2
  385. data/sig/finch_api/models/location.rbs +0 -2
  386. data/sig/finch_api/models/money.rbs +0 -2
  387. data/sig/finch_api/models/operation_support_matrix.rbs +0 -2
  388. data/sig/finch_api/models/paging.rbs +0 -2
  389. data/sig/finch_api/models/pay_statement_event.rbs +11 -15
  390. data/sig/finch_api/models/payment_event.rbs +11 -15
  391. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +0 -2
  392. data/sig/finch_api/models/payroll/pay_group_list_response.rbs +0 -2
  393. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +0 -2
  394. data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +0 -2
  395. data/sig/finch_api/models/provider.rbs +167 -233
  396. data/sig/finch_api/models/provider_list_params.rbs +0 -2
  397. data/sig/finch_api/models/request_forwarding_forward_params.rbs +0 -2
  398. data/sig/finch_api/models/request_forwarding_forward_response.rbs +0 -4
  399. data/sig/finch_api/models/sandbox/company_update_params.rbs +27 -37
  400. data/sig/finch_api/models/sandbox/company_update_response.rbs +3 -13
  401. data/sig/finch_api/models/sandbox/connection_create_params.rbs +0 -2
  402. data/sig/finch_api/models/sandbox/connection_create_response.rbs +0 -2
  403. data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +0 -2
  404. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +0 -2
  405. data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +0 -2
  406. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +0 -2
  407. data/sig/finch_api/models/sandbox/directory_create_params.rbs +65 -83
  408. data/sig/finch_api/models/sandbox/employment_update_params.rbs +31 -41
  409. data/sig/finch_api/models/sandbox/employment_update_response.rbs +9 -19
  410. data/sig/finch_api/models/sandbox/individual_update_params.rbs +17 -23
  411. data/sig/finch_api/models/sandbox/individual_update_response.rbs +3 -9
  412. data/sig/finch_api/models/sandbox/job_create_params.rbs +0 -2
  413. data/sig/finch_api/models/sandbox/job_create_response.rbs +0 -2
  414. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +0 -2
  415. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs +1 -1
  416. data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +0 -2
  417. data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +8 -10
  418. data/sig/finch_api/models/sandbox/payment_create_params.rbs +87 -115
  419. data/sig/finch_api/models/sandbox/payment_create_response.rbs +0 -2
  420. data/sig/finch_api/models/webhook_event.rbs +9 -9
  421. data/sig/finch_api/models.rbs +63 -0
  422. data/sig/finch_api/request_options.rbs +1 -1
  423. data/sig/finch_api/resources/access_tokens.rbs +1 -1
  424. data/sig/finch_api/resources/account.rbs +2 -2
  425. data/sig/finch_api/resources/connect/sessions.rbs +3 -3
  426. data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -4
  427. data/sig/finch_api/resources/hris/benefits.rbs +5 -5
  428. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +2 -2
  429. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
  430. data/sig/finch_api/resources/hris/company.rbs +1 -1
  431. data/sig/finch_api/resources/hris/directory.rbs +1 -1
  432. data/sig/finch_api/resources/hris/documents.rbs +1 -1
  433. data/sig/finch_api/resources/hris/employments.rbs +2 -2
  434. data/sig/finch_api/resources/hris/individuals.rbs +3 -3
  435. data/sig/finch_api/resources/hris/pay_statements.rbs +2 -2
  436. data/sig/finch_api/resources/hris/payments.rbs +1 -1
  437. data/sig/finch_api/resources/jobs/automated.rbs +2 -2
  438. data/sig/finch_api/resources/jobs/manual.rbs +1 -1
  439. data/sig/finch_api/resources/providers.rbs +1 -1
  440. data/sig/finch_api/resources/sandbox/company.rbs +4 -4
  441. data/sig/finch_api/resources/sandbox/directory.rbs +1 -1
  442. data/sig/finch_api/resources/sandbox/employment.rbs +7 -7
  443. data/sig/finch_api/resources/sandbox/individual.rbs +3 -3
  444. data/sig/finch_api/resources/sandbox/jobs/configuration.rbs +1 -1
  445. data/sig/finch_api/resources/sandbox/payment.rbs +1 -1
  446. metadata +7 -4
@@ -7,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
  # The ID of the existing connection to reauthenticate
11
14
  sig { returns(String) }
12
15
  attr_accessor :connection_id
@@ -17,7 +20,15 @@ module FinchAPI
17
20
  attr_accessor :minutes_to_expire
18
21
 
19
22
  # The products to request access to (optional for reauthentication)
20
- sig { returns(T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) }
23
+ sig do
24
+ returns(
25
+ T.nilable(
26
+ T::Array[
27
+ FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol
28
+ ]
29
+ )
30
+ )
31
+ end
21
32
  attr_accessor :products
22
33
 
23
34
  # The URI to redirect to after the Connect flow is completed
@@ -28,11 +39,15 @@ module FinchAPI
28
39
  params(
29
40
  connection_id: String,
30
41
  minutes_to_expire: T.nilable(Integer),
31
- products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]),
42
+ products:
43
+ T.nilable(
44
+ T::Array[
45
+ FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol
46
+ ]
47
+ ),
32
48
  redirect_uri: T.nilable(String),
33
- request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)
34
- )
35
- .returns(T.attached_class)
49
+ request_options: FinchAPI::RequestOptions::OrHash
50
+ ).returns(T.attached_class)
36
51
  end
37
52
  def self.new(
38
53
  # The ID of the existing connection to reauthenticate
@@ -45,49 +60,101 @@ module FinchAPI
45
60
  # The URI to redirect to after the Connect flow is completed
46
61
  redirect_uri: nil,
47
62
  request_options: {}
48
- ); end
63
+ )
64
+ end
65
+
49
66
  sig do
50
- override
51
- .returns(
52
- {
53
- connection_id: String,
54
- minutes_to_expire: T.nilable(Integer),
55
- products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]),
56
- redirect_uri: T.nilable(String),
57
- request_options: FinchAPI::RequestOptions
58
- }
59
- )
67
+ override.returns(
68
+ {
69
+ connection_id: String,
70
+ minutes_to_expire: T.nilable(Integer),
71
+ products:
72
+ T.nilable(
73
+ T::Array[
74
+ FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol
75
+ ]
76
+ ),
77
+ redirect_uri: T.nilable(String),
78
+ request_options: FinchAPI::RequestOptions
79
+ }
80
+ )
81
+ end
82
+ def to_hash
60
83
  end
61
- def to_hash; end
62
84
 
63
85
  # The Finch products that can be requested during the Connect flow.
64
86
  module Product
65
87
  extend FinchAPI::Internal::Type::Enum
66
88
 
67
89
  TaggedSymbol =
68
- T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product) }
90
+ T.type_alias do
91
+ T.all(
92
+ Symbol,
93
+ FinchAPI::Connect::SessionReauthenticateParams::Product
94
+ )
95
+ end
69
96
  OrSymbol = T.type_alias { T.any(Symbol, String) }
70
97
 
71
- COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
98
+ COMPANY =
99
+ T.let(
100
+ :company,
101
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
102
+ )
72
103
  DIRECTORY =
73
- T.let(:directory, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
104
+ T.let(
105
+ :directory,
106
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
107
+ )
74
108
  INDIVIDUAL =
75
- T.let(:individual, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
109
+ T.let(
110
+ :individual,
111
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
112
+ )
76
113
  EMPLOYMENT =
77
- T.let(:employment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
78
- PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
114
+ T.let(
115
+ :employment,
116
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
117
+ )
118
+ PAYMENT =
119
+ T.let(
120
+ :payment,
121
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
122
+ )
79
123
  PAY_STATEMENT =
80
- T.let(:pay_statement, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
124
+ T.let(
125
+ :pay_statement,
126
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
127
+ )
81
128
  BENEFITS =
82
- T.let(:benefits, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
83
- SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
129
+ T.let(
130
+ :benefits,
131
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
132
+ )
133
+ SSN =
134
+ T.let(
135
+ :ssn,
136
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
137
+ )
84
138
  DEDUCTION =
85
- T.let(:deduction, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
139
+ T.let(
140
+ :deduction,
141
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
142
+ )
86
143
  DOCUMENTS =
87
- T.let(:documents, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol)
144
+ T.let(
145
+ :documents,
146
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
147
+ )
88
148
 
89
- sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol]) }
90
- def self.values; end
149
+ sig do
150
+ override.returns(
151
+ T::Array[
152
+ FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
153
+ ]
154
+ )
155
+ end
156
+ def self.values
157
+ end
91
158
  end
92
159
  end
93
160
  end
@@ -4,6 +4,9 @@ module FinchAPI
4
4
  module Models
5
5
  module Connect
6
6
  class SessionReauthenticateResponse < FinchAPI::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
9
+
7
10
  # The Connect URL to redirect the user to for reauthentication
8
11
  sig { returns(String) }
9
12
  attr_accessor :connect_url
@@ -12,15 +15,22 @@ module FinchAPI
12
15
  sig { returns(String) }
13
16
  attr_accessor :session_id
14
17
 
15
- sig { params(connect_url: String, session_id: String).returns(T.attached_class) }
18
+ sig do
19
+ params(connect_url: String, session_id: String).returns(
20
+ T.attached_class
21
+ )
22
+ end
16
23
  def self.new(
17
24
  # The Connect URL to redirect the user to for reauthentication
18
25
  connect_url:,
19
26
  # The unique identifier for the created connect session
20
27
  session_id:
21
- ); end
22
- sig { override.returns({connect_url: String, session_id: String}) }
23
- def to_hash; end
28
+ )
29
+ end
30
+
31
+ sig { override.returns({ connect_url: String, session_id: String }) }
32
+ def to_hash
33
+ end
24
34
  end
25
35
  end
26
36
  end
@@ -5,19 +5,29 @@ module FinchAPI
5
5
  module ConnectionStatusType
6
6
  extend FinchAPI::Internal::Type::Enum
7
7
 
8
- TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::ConnectionStatusType) }
8
+ TaggedSymbol =
9
+ T.type_alias { T.all(Symbol, FinchAPI::ConnectionStatusType) }
9
10
  OrSymbol = T.type_alias { T.any(Symbol, String) }
10
11
 
11
- PENDING = T.let(:pending, FinchAPI::Models::ConnectionStatusType::TaggedSymbol)
12
- PROCESSING = T.let(:processing, FinchAPI::Models::ConnectionStatusType::TaggedSymbol)
13
- CONNECTED = T.let(:connected, FinchAPI::Models::ConnectionStatusType::TaggedSymbol)
12
+ PENDING = T.let(:pending, FinchAPI::ConnectionStatusType::TaggedSymbol)
13
+ PROCESSING =
14
+ T.let(:processing, FinchAPI::ConnectionStatusType::TaggedSymbol)
15
+ CONNECTED =
16
+ T.let(:connected, FinchAPI::ConnectionStatusType::TaggedSymbol)
14
17
  ERROR_NO_ACCOUNT_SETUP =
15
- T.let(:error_no_account_setup, FinchAPI::Models::ConnectionStatusType::TaggedSymbol)
16
- ERROR_PERMISSIONS = T.let(:error_permissions, FinchAPI::Models::ConnectionStatusType::TaggedSymbol)
17
- REAUTH = T.let(:reauth, FinchAPI::Models::ConnectionStatusType::TaggedSymbol)
18
+ T.let(
19
+ :error_no_account_setup,
20
+ FinchAPI::ConnectionStatusType::TaggedSymbol
21
+ )
22
+ ERROR_PERMISSIONS =
23
+ T.let(:error_permissions, FinchAPI::ConnectionStatusType::TaggedSymbol)
24
+ REAUTH = T.let(:reauth, FinchAPI::ConnectionStatusType::TaggedSymbol)
18
25
 
19
- sig { override.returns(T::Array[FinchAPI::Models::ConnectionStatusType::TaggedSymbol]) }
20
- def self.values; end
26
+ sig do
27
+ override.returns(T::Array[FinchAPI::ConnectionStatusType::TaggedSymbol])
28
+ end
29
+ def self.values
30
+ end
21
31
  end
22
32
  end
23
33
  end
@@ -3,6 +3,8 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
6
+ OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
7
+
6
8
  # The access token for the connection.
7
9
  sig { returns(String) }
8
10
  attr_accessor :access_token
@@ -13,7 +15,9 @@ module FinchAPI
13
15
  attr_accessor :account_id
14
16
 
15
17
  # The type of application associated with a token.
16
- sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) }
18
+ sig do
19
+ returns(FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol)
20
+ end
17
21
  attr_accessor :client_type
18
22
 
19
23
  # [DEPRECATED] Use `connection_id` to identify the connection instead of this
@@ -29,7 +33,11 @@ module FinchAPI
29
33
  #
30
34
  # - `provider` - connection to an external provider
31
35
  # - `finch` - finch-generated data.
32
- sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) }
36
+ sig do
37
+ returns(
38
+ FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
39
+ )
40
+ end
33
41
  attr_accessor :connection_type
34
42
 
35
43
  # An array of the authorized products associated with the `access_token`.
@@ -56,16 +64,17 @@ module FinchAPI
56
64
  params(
57
65
  access_token: String,
58
66
  account_id: String,
59
- client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::OrSymbol,
67
+ client_type:
68
+ FinchAPI::CreateAccessTokenResponse::ClientType::OrSymbol,
60
69
  company_id: String,
61
70
  connection_id: String,
62
- connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::OrSymbol,
71
+ connection_type:
72
+ FinchAPI::CreateAccessTokenResponse::ConnectionType::OrSymbol,
63
73
  products: T::Array[String],
64
74
  provider_id: String,
65
75
  customer_id: T.nilable(String),
66
76
  token_type: String
67
- )
68
- .returns(T.attached_class)
77
+ ).returns(T.attached_class)
69
78
  end
70
79
  def self.new(
71
80
  # The access token for the connection.
@@ -94,39 +103,65 @@ module FinchAPI
94
103
  customer_id: nil,
95
104
  # The RFC 8693 token type (Finch uses `bearer` tokens)
96
105
  token_type: nil
97
- ); end
106
+ )
107
+ end
108
+
98
109
  sig do
99
- override
100
- .returns(
101
- {
102
- access_token: String,
103
- account_id: String,
104
- client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol,
105
- company_id: String,
106
- connection_id: String,
107
- connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol,
108
- products: T::Array[String],
109
- provider_id: String,
110
- customer_id: T.nilable(String),
111
- token_type: String
112
- }
113
- )
110
+ override.returns(
111
+ {
112
+ access_token: String,
113
+ account_id: String,
114
+ client_type:
115
+ FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol,
116
+ company_id: String,
117
+ connection_id: String,
118
+ connection_type:
119
+ FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol,
120
+ products: T::Array[String],
121
+ provider_id: String,
122
+ customer_id: T.nilable(String),
123
+ token_type: String
124
+ }
125
+ )
126
+ end
127
+ def to_hash
114
128
  end
115
- def to_hash; end
116
129
 
117
130
  # The type of application associated with a token.
118
131
  module ClientType
119
132
  extend FinchAPI::Internal::Type::Enum
120
133
 
121
- TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType) }
134
+ TaggedSymbol =
135
+ T.type_alias do
136
+ T.all(Symbol, FinchAPI::CreateAccessTokenResponse::ClientType)
137
+ end
122
138
  OrSymbol = T.type_alias { T.any(Symbol, String) }
123
139
 
124
- PRODUCTION = T.let(:production, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol)
125
- DEVELOPMENT = T.let(:development, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol)
126
- SANDBOX = T.let(:sandbox, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol)
140
+ PRODUCTION =
141
+ T.let(
142
+ :production,
143
+ FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
144
+ )
145
+ DEVELOPMENT =
146
+ T.let(
147
+ :development,
148
+ FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
149
+ )
150
+ SANDBOX =
151
+ T.let(
152
+ :sandbox,
153
+ FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
154
+ )
127
155
 
128
- sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol]) }
129
- def self.values; end
156
+ sig do
157
+ override.returns(
158
+ T::Array[
159
+ FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
160
+ ]
161
+ )
162
+ end
163
+ def self.values
164
+ end
130
165
  end
131
166
 
132
167
  # The type of the connection associated with the token.
@@ -137,14 +172,31 @@ module FinchAPI
137
172
  extend FinchAPI::Internal::Type::Enum
138
173
 
139
174
  TaggedSymbol =
140
- T.type_alias { T.all(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType) }
175
+ T.type_alias do
176
+ T.all(Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType)
177
+ end
141
178
  OrSymbol = T.type_alias { T.any(Symbol, String) }
142
179
 
143
- PROVIDER = T.let(:provider, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol)
144
- FINCH = T.let(:finch, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol)
180
+ PROVIDER =
181
+ T.let(
182
+ :provider,
183
+ FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
184
+ )
185
+ FINCH =
186
+ T.let(
187
+ :finch,
188
+ FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
189
+ )
145
190
 
146
- sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol]) }
147
- def self.values; end
191
+ sig do
192
+ override.returns(
193
+ T::Array[
194
+ FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
195
+ ]
196
+ )
197
+ end
198
+ def self.values
199
+ end
148
200
  end
149
201
  end
150
202
  end
@@ -3,39 +3,48 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent
6
- sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::Data)) }
6
+ OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
7
+
8
+ sig { returns(T.nilable(FinchAPI::DirectoryEvent::Data)) }
7
9
  attr_reader :data
8
10
 
9
- sig { params(data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Internal::AnyHash)).void }
11
+ sig { params(data: FinchAPI::DirectoryEvent::Data::OrHash).void }
10
12
  attr_writer :data
11
13
 
12
- sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)) }
14
+ sig do
15
+ returns(T.nilable(FinchAPI::DirectoryEvent::EventType::TaggedSymbol))
16
+ end
13
17
  attr_reader :event_type
14
18
 
15
- sig { params(event_type: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol).void }
19
+ sig do
20
+ params(event_type: FinchAPI::DirectoryEvent::EventType::OrSymbol).void
21
+ end
16
22
  attr_writer :event_type
17
23
 
18
24
  sig do
19
25
  params(
20
- data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Internal::AnyHash),
21
- event_type: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol
22
- )
23
- .returns(T.attached_class)
26
+ data: FinchAPI::DirectoryEvent::Data::OrHash,
27
+ event_type: FinchAPI::DirectoryEvent::EventType::OrSymbol
28
+ ).returns(T.attached_class)
29
+ end
30
+ def self.new(data: nil, event_type: nil)
24
31
  end
25
- def self.new(data: nil, event_type: nil); end
26
32
 
27
33
  sig do
28
- override
29
- .returns(
30
- {
31
- data: FinchAPI::Models::DirectoryEvent::Data,
32
- event_type: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol
33
- }
34
- )
34
+ override.returns(
35
+ {
36
+ data: FinchAPI::DirectoryEvent::Data,
37
+ event_type: FinchAPI::DirectoryEvent::EventType::TaggedSymbol
38
+ }
39
+ )
40
+ end
41
+ def to_hash
35
42
  end
36
- def to_hash; end
37
43
 
38
44
  class Data < FinchAPI::Internal::Type::BaseModel
45
+ OrHash =
46
+ T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
47
+
39
48
  # The ID of the individual related to the event.
40
49
  sig { returns(T.nilable(String)) }
41
50
  attr_reader :individual_id
@@ -47,26 +56,44 @@ module FinchAPI
47
56
  def self.new(
48
57
  # The ID of the individual related to the event.
49
58
  individual_id: nil
50
- ); end
51
- sig { override.returns({individual_id: String}) }
52
- def to_hash; end
59
+ )
60
+ end
61
+
62
+ sig { override.returns({ individual_id: String }) }
63
+ def to_hash
64
+ end
53
65
  end
54
66
 
55
67
  module EventType
56
68
  extend FinchAPI::Internal::Type::Enum
57
69
 
58
- TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::DirectoryEvent::EventType) }
70
+ TaggedSymbol =
71
+ T.type_alias { T.all(Symbol, FinchAPI::DirectoryEvent::EventType) }
59
72
  OrSymbol = T.type_alias { T.any(Symbol, String) }
60
73
 
61
74
  DIRECTORY_CREATED =
62
- T.let(:"directory.created", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)
75
+ T.let(
76
+ :"directory.created",
77
+ FinchAPI::DirectoryEvent::EventType::TaggedSymbol
78
+ )
63
79
  DIRECTORY_UPDATED =
64
- T.let(:"directory.updated", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)
80
+ T.let(
81
+ :"directory.updated",
82
+ FinchAPI::DirectoryEvent::EventType::TaggedSymbol
83
+ )
65
84
  DIRECTORY_DELETED =
66
- T.let(:"directory.deleted", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)
85
+ T.let(
86
+ :"directory.deleted",
87
+ FinchAPI::DirectoryEvent::EventType::TaggedSymbol
88
+ )
67
89
 
68
- sig { override.returns(T::Array[FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol]) }
69
- def self.values; end
90
+ sig do
91
+ override.returns(
92
+ T::Array[FinchAPI::DirectoryEvent::EventType::TaggedSymbol]
93
+ )
94
+ end
95
+ def self.values
96
+ end
70
97
  end
71
98
  end
72
99
  end
@@ -3,6 +3,8 @@
3
3
  module FinchAPI
4
4
  module Models
5
5
  class DisconnectResponse < FinchAPI::Internal::Type::BaseModel
6
+ OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
7
+
6
8
  # If the request is successful, Finch will return “success” (HTTP 200 status).
7
9
  sig { returns(String) }
8
10
  attr_accessor :status
@@ -11,9 +13,12 @@ module FinchAPI
11
13
  def self.new(
12
14
  # If the request is successful, Finch will return “success” (HTTP 200 status).
13
15
  status:
14
- ); end
15
- sig { override.returns({status: String}) }
16
- def to_hash; end
16
+ )
17
+ end
18
+
19
+ sig { override.returns({ status: String }) }
20
+ def to_hash
21
+ end
17
22
  end
18
23
  end
19
24
  end