finch-api 0.1.0.pre.alpha.1

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 (479) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +124 -0
  3. data/lib/finch-api/base_client.rb +464 -0
  4. data/lib/finch-api/base_model.rb +1188 -0
  5. data/lib/finch-api/base_page.rb +40 -0
  6. data/lib/finch-api/client.rb +145 -0
  7. data/lib/finch-api/errors.rb +188 -0
  8. data/lib/finch-api/extern.rb +10 -0
  9. data/lib/finch-api/individuals_page.rb +98 -0
  10. data/lib/finch-api/models/access_token_create_params.rb +54 -0
  11. data/lib/finch-api/models/account_disconnect_params.rb +18 -0
  12. data/lib/finch-api/models/account_introspect_params.rb +18 -0
  13. data/lib/finch-api/models/account_update_event.rb +1978 -0
  14. data/lib/finch-api/models/base_webhook_event.rb +41 -0
  15. data/lib/finch-api/models/company_event.rb +49 -0
  16. data/lib/finch-api/models/connect/session_new_params.rb +203 -0
  17. data/lib/finch-api/models/connect/session_new_response.rb +29 -0
  18. data/lib/finch-api/models/connect/session_reauthenticate_params.rb +90 -0
  19. data/lib/finch-api/models/connect/session_reauthenticate_response.rb +29 -0
  20. data/lib/finch-api/models/connection_status_type.rb +40 -0
  21. data/lib/finch-api/models/create_access_token_response.rb +163 -0
  22. data/lib/finch-api/models/directory_event.rb +78 -0
  23. data/lib/finch-api/models/disconnect_response.rb +20 -0
  24. data/lib/finch-api/models/employment_event.rb +78 -0
  25. data/lib/finch-api/models/hris/benefit_contribution.rb +54 -0
  26. data/lib/finch-api/models/hris/benefit_create_params.rb +46 -0
  27. data/lib/finch-api/models/hris/benefit_features_and_operations.rb +199 -0
  28. data/lib/finch-api/models/hris/benefit_frequency.rb +33 -0
  29. data/lib/finch-api/models/hris/benefit_list_params.rb +20 -0
  30. data/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rb +20 -0
  31. data/lib/finch-api/models/hris/benefit_retrieve_params.rb +20 -0
  32. data/lib/finch-api/models/hris/benefit_type.rb +57 -0
  33. data/lib/finch-api/models/hris/benefit_update_params.rb +31 -0
  34. data/lib/finch-api/models/hris/benefits/enrolled_individual.rb +108 -0
  35. data/lib/finch-api/models/hris/benefits/individual_benefit.rb +127 -0
  36. data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +268 -0
  37. data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rb +22 -0
  38. data/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rb +29 -0
  39. data/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +34 -0
  40. data/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rb +33 -0
  41. data/lib/finch-api/models/hris/benefits/unenrolled_individual.rb +77 -0
  42. data/lib/finch-api/models/hris/benefits_support.rb +106 -0
  43. data/lib/finch-api/models/hris/benfit_contribution.rb +9 -0
  44. data/lib/finch-api/models/hris/company.rb +290 -0
  45. data/lib/finch-api/models/hris/company_benefit.rb +40 -0
  46. data/lib/finch-api/models/hris/company_retrieve_params.rb +20 -0
  47. data/lib/finch-api/models/hris/create_company_benefits_response.rb +21 -0
  48. data/lib/finch-api/models/hris/directory_list_individuals_params.rb +42 -0
  49. data/lib/finch-api/models/hris/directory_list_params.rb +42 -0
  50. data/lib/finch-api/models/hris/document_list_params.rb +89 -0
  51. data/lib/finch-api/models/hris/document_list_response.rb +27 -0
  52. data/lib/finch-api/models/hris/document_response.rb +89 -0
  53. data/lib/finch-api/models/hris/document_retreive_params.rb +20 -0
  54. data/lib/finch-api/models/hris/document_retreive_response.rb +41 -0
  55. data/lib/finch-api/models/hris/employment_data.rb +380 -0
  56. data/lib/finch-api/models/hris/employment_data_response.rb +45 -0
  57. data/lib/finch-api/models/hris/employment_retrieve_many_params.rb +45 -0
  58. data/lib/finch-api/models/hris/individual.rb +290 -0
  59. data/lib/finch-api/models/hris/individual_in_directory.rb +117 -0
  60. data/lib/finch-api/models/hris/individual_response.rb +45 -0
  61. data/lib/finch-api/models/hris/individual_retrieve_many_params.rb +73 -0
  62. data/lib/finch-api/models/hris/pay_statement.rb +587 -0
  63. data/lib/finch-api/models/hris/pay_statement_response.rb +45 -0
  64. data/lib/finch-api/models/hris/pay_statement_response_body.rb +36 -0
  65. data/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rb +65 -0
  66. data/lib/finch-api/models/hris/payment.rb +174 -0
  67. data/lib/finch-api/models/hris/payment_list_params.rb +36 -0
  68. data/lib/finch-api/models/hris/support_per_benefit_type.rb +35 -0
  69. data/lib/finch-api/models/hris/supported_benefit.rb +166 -0
  70. data/lib/finch-api/models/hris/update_company_benefit_response.rb +21 -0
  71. data/lib/finch-api/models/hris/w42005.rb +188 -0
  72. data/lib/finch-api/models/hris/w42020.rb +180 -0
  73. data/lib/finch-api/models/income.rb +87 -0
  74. data/lib/finch-api/models/individual_event.rb +78 -0
  75. data/lib/finch-api/models/introspection.rb +342 -0
  76. data/lib/finch-api/models/job_completion_event.rb +90 -0
  77. data/lib/finch-api/models/jobs/automated_async_job.rb +162 -0
  78. data/lib/finch-api/models/jobs/automated_create_params.rb +70 -0
  79. data/lib/finch-api/models/jobs/automated_create_response.rb +43 -0
  80. data/lib/finch-api/models/jobs/automated_list_params.rb +42 -0
  81. data/lib/finch-api/models/jobs/automated_retrieve_params.rb +20 -0
  82. data/lib/finch-api/models/jobs/manual_async_job.rb +63 -0
  83. data/lib/finch-api/models/jobs/manual_retrieve_params.rb +20 -0
  84. data/lib/finch-api/models/location.rb +79 -0
  85. data/lib/finch-api/models/money.rb +30 -0
  86. data/lib/finch-api/models/operation_support.rb +42 -0
  87. data/lib/finch-api/models/operation_support_matrix.rb +81 -0
  88. data/lib/finch-api/models/paging.rb +35 -0
  89. data/lib/finch-api/models/pay_statement_event.rb +89 -0
  90. data/lib/finch-api/models/payment_event.rb +81 -0
  91. data/lib/finch-api/models/payroll/pay_group_list_params.rb +40 -0
  92. data/lib/finch-api/models/payroll/pay_group_list_response.rb +87 -0
  93. data/lib/finch-api/models/payroll/pay_group_retrieve_params.rb +20 -0
  94. data/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +81 -0
  95. data/lib/finch-api/models/provider.rb +2039 -0
  96. data/lib/finch-api/models/provider_list_params.rb +18 -0
  97. data/lib/finch-api/models/request_forwarding_forward_params.rb +60 -0
  98. data/lib/finch-api/models/request_forwarding_forward_response.rb +97 -0
  99. data/lib/finch-api/models/sandbox/company_update_params.rb +294 -0
  100. data/lib/finch-api/models/sandbox/company_update_response.rb +276 -0
  101. data/lib/finch-api/models/sandbox/connection_create_params.rb +90 -0
  102. data/lib/finch-api/models/sandbox/connection_create_response.rb +113 -0
  103. data/lib/finch-api/models/sandbox/connections/account_create_params.rb +87 -0
  104. data/lib/finch-api/models/sandbox/connections/account_create_response.rb +93 -0
  105. data/lib/finch-api/models/sandbox/connections/account_update_params.rb +32 -0
  106. data/lib/finch-api/models/sandbox/connections/account_update_response.rb +91 -0
  107. data/lib/finch-api/models/sandbox/directory_create_params.rb +642 -0
  108. data/lib/finch-api/models/sandbox/directory_create_response.rb +9 -0
  109. data/lib/finch-api/models/sandbox/employment_update_params.rb +372 -0
  110. data/lib/finch-api/models/sandbox/employment_update_response.rb +378 -0
  111. data/lib/finch-api/models/sandbox/individual_update_params.rb +292 -0
  112. data/lib/finch-api/models/sandbox/individual_update_response.rb +300 -0
  113. data/lib/finch-api/models/sandbox/job_create_params.rb +49 -0
  114. data/lib/finch-api/models/sandbox/job_create_response.rb +43 -0
  115. data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rb +22 -0
  116. data/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +11 -0
  117. data/lib/finch-api/models/sandbox/jobs/configuration_update_params.rb +22 -0
  118. data/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +79 -0
  119. data/lib/finch-api/models/sandbox/payment_create_params.rb +646 -0
  120. data/lib/finch-api/models/sandbox/payment_create_response.rb +29 -0
  121. data/lib/finch-api/models/webhook_event.rb +48 -0
  122. data/lib/finch-api/page.rb +98 -0
  123. data/lib/finch-api/pooled_net_requester.rb +175 -0
  124. data/lib/finch-api/request_options.rb +115 -0
  125. data/lib/finch-api/resources/access_tokens.rb +40 -0
  126. data/lib/finch-api/resources/account.rb +47 -0
  127. data/lib/finch-api/resources/connect/sessions.rb +81 -0
  128. data/lib/finch-api/resources/connect.rb +17 -0
  129. data/lib/finch-api/resources/hris/benefits/individuals.rb +112 -0
  130. data/lib/finch-api/resources/hris/benefits.rb +125 -0
  131. data/lib/finch-api/resources/hris/company.rb +32 -0
  132. data/lib/finch-api/resources/hris/directory.rb +65 -0
  133. data/lib/finch-api/resources/hris/documents.rb +65 -0
  134. data/lib/finch-api/resources/hris/employments.rb +37 -0
  135. data/lib/finch-api/resources/hris/individuals.rb +39 -0
  136. data/lib/finch-api/resources/hris/pay_statements.rb +40 -0
  137. data/lib/finch-api/resources/hris/payments.rb +41 -0
  138. data/lib/finch-api/resources/hris.rb +45 -0
  139. data/lib/finch-api/resources/jobs/automated.rb +96 -0
  140. data/lib/finch-api/resources/jobs/manual.rb +35 -0
  141. data/lib/finch-api/resources/jobs.rb +21 -0
  142. data/lib/finch-api/resources/payroll/pay_groups.rb +58 -0
  143. data/lib/finch-api/resources/payroll.rb +17 -0
  144. data/lib/finch-api/resources/providers.rb +31 -0
  145. data/lib/finch-api/resources/request_forwarding.rb +52 -0
  146. data/lib/finch-api/resources/sandbox/company.rb +50 -0
  147. data/lib/finch-api/resources/sandbox/connections/accounts.rb +67 -0
  148. data/lib/finch-api/resources/sandbox/connections.rb +48 -0
  149. data/lib/finch-api/resources/sandbox/directory.rb +37 -0
  150. data/lib/finch-api/resources/sandbox/employment.rb +76 -0
  151. data/lib/finch-api/resources/sandbox/individual.rb +65 -0
  152. data/lib/finch-api/resources/sandbox/jobs/configuration.rb +57 -0
  153. data/lib/finch-api/resources/sandbox/jobs.rb +40 -0
  154. data/lib/finch-api/resources/sandbox/payment.rb +40 -0
  155. data/lib/finch-api/resources/sandbox.rb +41 -0
  156. data/lib/finch-api/resources/webhooks.rb +13 -0
  157. data/lib/finch-api/responses_page.rb +84 -0
  158. data/lib/finch-api/single_page.rb +82 -0
  159. data/lib/finch-api/util.rb +636 -0
  160. data/lib/finch-api/version.rb +5 -0
  161. data/lib/finch-api.rb +178 -0
  162. data/manifest.yaml +13 -0
  163. data/rbi/lib/finch-api/base_client.rbi +173 -0
  164. data/rbi/lib/finch-api/base_model.rbi +476 -0
  165. data/rbi/lib/finch-api/base_page.rbi +39 -0
  166. data/rbi/lib/finch-api/client.rbi +102 -0
  167. data/rbi/lib/finch-api/errors.rbi +146 -0
  168. data/rbi/lib/finch-api/extern.rbi +7 -0
  169. data/rbi/lib/finch-api/individuals_page.rbi +37 -0
  170. data/rbi/lib/finch-api/models/access_token_create_params.rbi +70 -0
  171. data/rbi/lib/finch-api/models/account_disconnect_params.rbi +18 -0
  172. data/rbi/lib/finch-api/models/account_introspect_params.rbi +18 -0
  173. data/rbi/lib/finch-api/models/account_update_event.rbi +2479 -0
  174. data/rbi/lib/finch-api/models/base_webhook_event.rbi +39 -0
  175. data/rbi/lib/finch-api/models/company_event.rbi +43 -0
  176. data/rbi/lib/finch-api/models/connect/session_new_params.rbi +203 -0
  177. data/rbi/lib/finch-api/models/connect/session_new_response.rbi +33 -0
  178. data/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +95 -0
  179. data/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +33 -0
  180. data/rbi/lib/finch-api/models/connection_status_type.rbi +20 -0
  181. data/rbi/lib/finch-api/models/create_access_token_response.rbi +159 -0
  182. data/rbi/lib/finch-api/models/directory_event.rbi +61 -0
  183. data/rbi/lib/finch-api/models/disconnect_response.rbi +23 -0
  184. data/rbi/lib/finch-api/models/employment_event.rbi +61 -0
  185. data/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +44 -0
  186. data/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +62 -0
  187. data/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +190 -0
  188. data/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +19 -0
  189. data/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +20 -0
  190. data/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +20 -0
  191. data/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +20 -0
  192. data/rbi/lib/finch-api/models/hris/benefit_type.rbi +35 -0
  193. data/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +37 -0
  194. data/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +115 -0
  195. data/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +153 -0
  196. data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +281 -0
  197. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +22 -0
  198. data/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +35 -0
  199. data/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +36 -0
  200. data/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +38 -0
  201. data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +102 -0
  202. data/rbi/lib/finch-api/models/hris/benefits_support.rbi +196 -0
  203. data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +9 -0
  204. data/rbi/lib/finch-api/models/hris/company.rbi +338 -0
  205. data/rbi/lib/finch-api/models/hris/company_benefit.rbi +67 -0
  206. data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +20 -0
  207. data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +25 -0
  208. data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +43 -0
  209. data/rbi/lib/finch-api/models/hris/directory_list_params.rbi +43 -0
  210. data/rbi/lib/finch-api/models/hris/document_list_params.rbi +83 -0
  211. data/rbi/lib/finch-api/models/hris/document_list_response.rbi +42 -0
  212. data/rbi/lib/finch-api/models/hris/document_response.rbi +86 -0
  213. data/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +20 -0
  214. data/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +15 -0
  215. data/rbi/lib/finch-api/models/hris/employment_data.rbi +393 -0
  216. data/rbi/lib/finch-api/models/hris/employment_data_response.rbi +41 -0
  217. data/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +63 -0
  218. data/rbi/lib/finch-api/models/hris/individual.rbi +281 -0
  219. data/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +147 -0
  220. data/rbi/lib/finch-api/models/hris/individual_response.rbi +41 -0
  221. data/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +94 -0
  222. data/rbi/lib/finch-api/models/hris/pay_statement.rbi +691 -0
  223. data/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +47 -0
  224. data/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +44 -0
  225. data/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +79 -0
  226. data/rbi/lib/finch-api/models/hris/payment.rbi +207 -0
  227. data/rbi/lib/finch-api/models/hris/payment_list_params.rbi +45 -0
  228. data/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +47 -0
  229. data/rbi/lib/finch-api/models/hris/supported_benefit.rbi +155 -0
  230. data/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +25 -0
  231. data/rbi/lib/finch-api/models/hris/w42005.rbi +150 -0
  232. data/rbi/lib/finch-api/models/hris/w42020.rbi +177 -0
  233. data/rbi/lib/finch-api/models/income.rbi +83 -0
  234. data/rbi/lib/finch-api/models/individual_event.rbi +61 -0
  235. data/rbi/lib/finch-api/models/introspection.rbi +350 -0
  236. data/rbi/lib/finch-api/models/job_completion_event.rbi +72 -0
  237. data/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +174 -0
  238. data/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +83 -0
  239. data/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +64 -0
  240. data/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +43 -0
  241. data/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +20 -0
  242. data/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +54 -0
  243. data/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +20 -0
  244. data/rbi/lib/finch-api/models/location.rbi +114 -0
  245. data/rbi/lib/finch-api/models/money.rbi +31 -0
  246. data/rbi/lib/finch-api/models/operation_support.rbi +18 -0
  247. data/rbi/lib/finch-api/models/operation_support_matrix.rbi +47 -0
  248. data/rbi/lib/finch-api/models/paging.rbi +31 -0
  249. data/rbi/lib/finch-api/models/pay_statement_event.rbi +69 -0
  250. data/rbi/lib/finch-api/models/payment_event.rbi +69 -0
  251. data/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +52 -0
  252. data/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +59 -0
  253. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +20 -0
  254. data/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +82 -0
  255. data/rbi/lib/finch-api/models/provider.rbi +2369 -0
  256. data/rbi/lib/finch-api/models/provider_list_params.rbi +18 -0
  257. data/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +80 -0
  258. data/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +138 -0
  259. data/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +336 -0
  260. data/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +330 -0
  261. data/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +91 -0
  262. data/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +129 -0
  263. data/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +93 -0
  264. data/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +120 -0
  265. data/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +36 -0
  266. data/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +109 -0
  267. data/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +629 -0
  268. data/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +9 -0
  269. data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +377 -0
  270. data/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +382 -0
  271. data/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +276 -0
  272. data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +283 -0
  273. data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +46 -0
  274. data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +64 -0
  275. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +22 -0
  276. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +11 -0
  277. data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +22 -0
  278. data/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +58 -0
  279. data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +876 -0
  280. data/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +33 -0
  281. data/rbi/lib/finch-api/models/webhook_event.rbi +18 -0
  282. data/rbi/lib/finch-api/page.rbi +37 -0
  283. data/rbi/lib/finch-api/pooled_net_requester.rbi +36 -0
  284. data/rbi/lib/finch-api/request_options.rbi +84 -0
  285. data/rbi/lib/finch-api/resources/access_tokens.rbi +24 -0
  286. data/rbi/lib/finch-api/resources/account.rbi +25 -0
  287. data/rbi/lib/finch-api/resources/connect/sessions.rbi +61 -0
  288. data/rbi/lib/finch-api/resources/connect.rbi +15 -0
  289. data/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +58 -0
  290. data/rbi/lib/finch-api/resources/hris/benefits.rbi +64 -0
  291. data/rbi/lib/finch-api/resources/hris/company.rbi +20 -0
  292. data/rbi/lib/finch-api/resources/hris/directory.rbi +35 -0
  293. data/rbi/lib/finch-api/resources/hris/documents.rbi +36 -0
  294. data/rbi/lib/finch-api/resources/hris/employments.rbi +23 -0
  295. data/rbi/lib/finch-api/resources/hris/individuals.rbi +24 -0
  296. data/rbi/lib/finch-api/resources/hris/pay_statements.rbi +23 -0
  297. data/rbi/lib/finch-api/resources/hris/payments.rbi +24 -0
  298. data/rbi/lib/finch-api/resources/hris.rbi +43 -0
  299. data/rbi/lib/finch-api/resources/jobs/automated.rbi +45 -0
  300. data/rbi/lib/finch-api/resources/jobs/manual.rbi +23 -0
  301. data/rbi/lib/finch-api/resources/jobs.rbi +19 -0
  302. data/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +34 -0
  303. data/rbi/lib/finch-api/resources/payroll.rbi +15 -0
  304. data/rbi/lib/finch-api/resources/providers.rbi +18 -0
  305. data/rbi/lib/finch-api/resources/request_forwarding.rbi +25 -0
  306. data/rbi/lib/finch-api/resources/sandbox/company.rbi +40 -0
  307. data/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +38 -0
  308. data/rbi/lib/finch-api/resources/sandbox/connections.rbi +36 -0
  309. data/rbi/lib/finch-api/resources/sandbox/directory.rbi +23 -0
  310. data/rbi/lib/finch-api/resources/sandbox/employment.rbi +62 -0
  311. data/rbi/lib/finch-api/resources/sandbox/individual.rbi +50 -0
  312. data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +33 -0
  313. data/rbi/lib/finch-api/resources/sandbox/jobs.rbi +27 -0
  314. data/rbi/lib/finch-api/resources/sandbox/payment.rbi +25 -0
  315. data/rbi/lib/finch-api/resources/sandbox.rbi +39 -0
  316. data/rbi/lib/finch-api/resources/webhooks.rbi +11 -0
  317. data/rbi/lib/finch-api/responses_page.rbi +29 -0
  318. data/rbi/lib/finch-api/single_page.rbi +33 -0
  319. data/rbi/lib/finch-api/util.rbi +167 -0
  320. data/rbi/lib/finch-api/version.rbi +5 -0
  321. data/sig/finch-api/base_client.rbs +101 -0
  322. data/sig/finch-api/base_model.rbs +242 -0
  323. data/sig/finch-api/base_page.rbs +20 -0
  324. data/sig/finch-api/client.rbs +54 -0
  325. data/sig/finch-api/errors.rbs +99 -0
  326. data/sig/finch-api/extern.rbs +4 -0
  327. data/sig/finch-api/individuals_page.rbs +16 -0
  328. data/sig/finch-api/models/access_token_create_params.rbs +46 -0
  329. data/sig/finch-api/models/account_disconnect_params.rbs +19 -0
  330. data/sig/finch-api/models/account_introspect_params.rbs +19 -0
  331. data/sig/finch-api/models/account_update_event.rbs +1448 -0
  332. data/sig/finch-api/models/base_webhook_event.rbs +24 -0
  333. data/sig/finch-api/models/company_event.rbs +36 -0
  334. data/sig/finch-api/models/connect/session_new_params.rbs +129 -0
  335. data/sig/finch-api/models/connect/session_new_response.rbs +22 -0
  336. data/sig/finch-api/models/connect/session_reauthenticate_params.rbs +65 -0
  337. data/sig/finch-api/models/connect/session_reauthenticate_response.rbs +23 -0
  338. data/sig/finch-api/models/connection_status_type.rbs +22 -0
  339. data/sig/finch-api/models/create_access_token_response.rbs +80 -0
  340. data/sig/finch-api/models/directory_event.rbs +61 -0
  341. data/sig/finch-api/models/disconnect_response.rbs +17 -0
  342. data/sig/finch-api/models/employment_event.rbs +61 -0
  343. data/sig/finch-api/models/hris/benefit_contribution.rbs +38 -0
  344. data/sig/finch-api/models/hris/benefit_create_params.rbs +40 -0
  345. data/sig/finch-api/models/hris/benefit_features_and_operations.rbs +112 -0
  346. data/sig/finch-api/models/hris/benefit_frequency.rbs +15 -0
  347. data/sig/finch-api/models/hris/benefit_list_params.rbs +21 -0
  348. data/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +22 -0
  349. data/sig/finch-api/models/hris/benefit_retrieve_params.rbs +21 -0
  350. data/sig/finch-api/models/hris/benefit_type.rbs +50 -0
  351. data/sig/finch-api/models/hris/benefit_update_params.rbs +26 -0
  352. data/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +75 -0
  353. data/sig/finch-api/models/hris/benefits/individual_benefit.rbs +91 -0
  354. data/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +203 -0
  355. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +24 -0
  356. data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +25 -0
  357. data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +31 -0
  358. data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +31 -0
  359. data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +62 -0
  360. data/sig/finch-api/models/hris/benefits_support.rbs +68 -0
  361. data/sig/finch-api/models/hris/benfit_contribution.rbs +8 -0
  362. data/sig/finch-api/models/hris/company.rbs +195 -0
  363. data/sig/finch-api/models/hris/company_benefit.rbs +36 -0
  364. data/sig/finch-api/models/hris/company_retrieve_params.rbs +21 -0
  365. data/sig/finch-api/models/hris/create_company_benefits_response.rbs +20 -0
  366. data/sig/finch-api/models/hris/directory_list_individuals_params.rbs +34 -0
  367. data/sig/finch-api/models/hris/directory_list_params.rbs +34 -0
  368. data/sig/finch-api/models/hris/document_list_params.rbs +61 -0
  369. data/sig/finch-api/models/hris/document_list_response.rbs +29 -0
  370. data/sig/finch-api/models/hris/document_response.rbs +58 -0
  371. data/sig/finch-api/models/hris/document_retreive_params.rbs +21 -0
  372. data/sig/finch-api/models/hris/document_retreive_response.rbs +12 -0
  373. data/sig/finch-api/models/hris/employment_data.rbs +228 -0
  374. data/sig/finch-api/models/hris/employment_data_response.rbs +41 -0
  375. data/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +45 -0
  376. data/sig/finch-api/models/hris/individual.rbs +176 -0
  377. data/sig/finch-api/models/hris/individual_in_directory.rbs +83 -0
  378. data/sig/finch-api/models/hris/individual_response.rbs +41 -0
  379. data/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +72 -0
  380. data/sig/finch-api/models/hris/pay_statement.rbs +445 -0
  381. data/sig/finch-api/models/hris/pay_statement_response.rbs +41 -0
  382. data/sig/finch-api/models/hris/pay_statement_response_body.rbs +35 -0
  383. data/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +53 -0
  384. data/sig/finch-api/models/hris/payment.rbs +112 -0
  385. data/sig/finch-api/models/hris/payment_list_params.rbs +30 -0
  386. data/sig/finch-api/models/hris/support_per_benefit_type.rbs +37 -0
  387. data/sig/finch-api/models/hris/supported_benefit.rbs +84 -0
  388. data/sig/finch-api/models/hris/update_company_benefit_response.rbs +20 -0
  389. data/sig/finch-api/models/hris/w42005.rbs +111 -0
  390. data/sig/finch-api/models/hris/w42020.rbs +108 -0
  391. data/sig/finch-api/models/income.rbs +57 -0
  392. data/sig/finch-api/models/individual_event.rbs +61 -0
  393. data/sig/finch-api/models/introspection.rbs +204 -0
  394. data/sig/finch-api/models/job_completion_event.rbs +70 -0
  395. data/sig/finch-api/models/jobs/automated_async_job.rbs +102 -0
  396. data/sig/finch-api/models/jobs/automated_create_params.rbs +57 -0
  397. data/sig/finch-api/models/jobs/automated_create_response.rbs +37 -0
  398. data/sig/finch-api/models/jobs/automated_list_params.rbs +34 -0
  399. data/sig/finch-api/models/jobs/automated_retrieve_params.rbs +21 -0
  400. data/sig/finch-api/models/jobs/manual_async_job.rbs +43 -0
  401. data/sig/finch-api/models/jobs/manual_retrieve_params.rbs +21 -0
  402. data/sig/finch-api/models/location.rbs +48 -0
  403. data/sig/finch-api/models/money.rbs +19 -0
  404. data/sig/finch-api/models/operation_support.rbs +18 -0
  405. data/sig/finch-api/models/operation_support_matrix.rbs +50 -0
  406. data/sig/finch-api/models/paging.rbs +21 -0
  407. data/sig/finch-api/models/pay_statement_event.rbs +68 -0
  408. data/sig/finch-api/models/payment_event.rbs +59 -0
  409. data/sig/finch-api/models/payroll/pay_group_list_params.rbs +35 -0
  410. data/sig/finch-api/models/payroll/pay_group_list_response.rbs +66 -0
  411. data/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +21 -0
  412. data/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +62 -0
  413. data/sig/finch-api/models/provider.rbs +1455 -0
  414. data/sig/finch-api/models/provider_list_params.rbs +18 -0
  415. data/sig/finch-api/models/request_forwarding_forward_params.rbs +44 -0
  416. data/sig/finch-api/models/request_forwarding_forward_response.rbs +71 -0
  417. data/sig/finch-api/models/sandbox/company_update_params.rbs +197 -0
  418. data/sig/finch-api/models/sandbox/company_update_response.rbs +192 -0
  419. data/sig/finch-api/models/sandbox/connection_create_params.rbs +61 -0
  420. data/sig/finch-api/models/sandbox/connection_create_response.rbs +66 -0
  421. data/sig/finch-api/models/sandbox/connections/account_create_params.rbs +62 -0
  422. data/sig/finch-api/models/sandbox/connections/account_create_response.rbs +63 -0
  423. data/sig/finch-api/models/sandbox/connections/account_update_params.rbs +34 -0
  424. data/sig/finch-api/models/sandbox/connections/account_update_response.rbs +61 -0
  425. data/sig/finch-api/models/sandbox/directory_create_params.rbs +392 -0
  426. data/sig/finch-api/models/sandbox/directory_create_response.rbs +9 -0
  427. data/sig/finch-api/models/sandbox/employment_update_params.rbs +228 -0
  428. data/sig/finch-api/models/sandbox/employment_update_response.rbs +229 -0
  429. data/sig/finch-api/models/sandbox/individual_update_params.rbs +178 -0
  430. data/sig/finch-api/models/sandbox/individual_update_response.rbs +179 -0
  431. data/sig/finch-api/models/sandbox/job_create_params.rbs +36 -0
  432. data/sig/finch-api/models/sandbox/job_create_response.rbs +37 -0
  433. data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +23 -0
  434. data/sig/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbs +12 -0
  435. data/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +23 -0
  436. data/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +51 -0
  437. data/sig/finch-api/models/sandbox/payment_create_params.rbs +487 -0
  438. data/sig/finch-api/models/sandbox/payment_create_response.rbs +22 -0
  439. data/sig/finch-api/models/webhook_event.rbs +17 -0
  440. data/sig/finch-api/page.rbs +16 -0
  441. data/sig/finch-api/pooled_net_requester.rbs +28 -0
  442. data/sig/finch-api/request_options.rbs +40 -0
  443. data/sig/finch-api/resources/access_tokens.rbs +19 -0
  444. data/sig/finch-api/resources/account.rbs +25 -0
  445. data/sig/finch-api/resources/connect/sessions.rbs +40 -0
  446. data/sig/finch-api/resources/connect.rbs +9 -0
  447. data/sig/finch-api/resources/hris/benefits/individuals.rbs +58 -0
  448. data/sig/finch-api/resources/hris/benefits.rbs +64 -0
  449. data/sig/finch-api/resources/hris/company.rbs +18 -0
  450. data/sig/finch-api/resources/hris/directory.rbs +31 -0
  451. data/sig/finch-api/resources/hris/documents.rbs +33 -0
  452. data/sig/finch-api/resources/hris/employments.rbs +19 -0
  453. data/sig/finch-api/resources/hris/individuals.rbs +20 -0
  454. data/sig/finch-api/resources/hris/pay_statements.rbs +19 -0
  455. data/sig/finch-api/resources/hris/payments.rbs +20 -0
  456. data/sig/finch-api/resources/hris.rbs +23 -0
  457. data/sig/finch-api/resources/jobs/automated.rbs +42 -0
  458. data/sig/finch-api/resources/jobs/manual.rbs +20 -0
  459. data/sig/finch-api/resources/jobs.rbs +11 -0
  460. data/sig/finch-api/resources/payroll/pay_groups.rbs +31 -0
  461. data/sig/finch-api/resources/payroll.rbs +9 -0
  462. data/sig/finch-api/resources/providers.rbs +15 -0
  463. data/sig/finch-api/resources/request_forwarding.rbs +21 -0
  464. data/sig/finch-api/resources/sandbox/company.rbs +26 -0
  465. data/sig/finch-api/resources/sandbox/connections/accounts.rbs +34 -0
  466. data/sig/finch-api/resources/sandbox/connections.rbs +24 -0
  467. data/sig/finch-api/resources/sandbox/directory.rbs +19 -0
  468. data/sig/finch-api/resources/sandbox/employment.rbs +38 -0
  469. data/sig/finch-api/resources/sandbox/individual.rbs +32 -0
  470. data/sig/finch-api/resources/sandbox/jobs/configuration.rbs +31 -0
  471. data/sig/finch-api/resources/sandbox/jobs.rbs +21 -0
  472. data/sig/finch-api/resources/sandbox/payment.rbs +21 -0
  473. data/sig/finch-api/resources/sandbox.rbs +21 -0
  474. data/sig/finch-api/resources/webhooks.rbs +7 -0
  475. data/sig/finch-api/responses_page.rbs +14 -0
  476. data/sig/finch-api/single_page.rbs +18 -0
  477. data/sig/finch-api/util.rbs +109 -0
  478. data/sig/finch-api/version.rbs +3 -0
  479. metadata +536 -0
@@ -0,0 +1,228 @@
1
+ module FinchAPI
2
+ module Models
3
+ module Sandbox
4
+ type employment_update_params =
5
+ {
6
+ class_code: String?,
7
+ custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField],
8
+ department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?,
9
+ employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?,
10
+ employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
11
+ end_date: String?,
12
+ first_name: String?,
13
+ income: FinchAPI::Models::Income?,
14
+ income_history: ::Array[FinchAPI::Models::Income?]?,
15
+ is_active: bool?,
16
+ last_name: String?,
17
+ latest_rehire_date: String?,
18
+ location: FinchAPI::Models::Location?,
19
+ manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?,
20
+ middle_name: String?,
21
+ source_id: String,
22
+ start_date: String?,
23
+ title: String?
24
+ }
25
+ & FinchAPI::request_parameters
26
+
27
+ class EmploymentUpdateParams < FinchAPI::BaseModel
28
+ extend FinchAPI::RequestParameters::Converter
29
+ include FinchAPI::RequestParameters
30
+
31
+ attr_accessor class_code: String?
32
+
33
+ attr_reader custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField]?
34
+
35
+ def custom_fields=: (
36
+ ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField]
37
+ ) -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField]
38
+
39
+ attr_accessor department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?
40
+
41
+ attr_accessor employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?
42
+
43
+ attr_accessor employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?
44
+
45
+ attr_accessor end_date: String?
46
+
47
+ attr_accessor first_name: String?
48
+
49
+ attr_accessor income: FinchAPI::Models::Income?
50
+
51
+ attr_accessor income_history: ::Array[FinchAPI::Models::Income?]?
52
+
53
+ attr_accessor is_active: bool?
54
+
55
+ attr_accessor last_name: String?
56
+
57
+ attr_accessor latest_rehire_date: String?
58
+
59
+ attr_accessor location: FinchAPI::Models::Location?
60
+
61
+ attr_accessor manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?
62
+
63
+ attr_accessor middle_name: String?
64
+
65
+ attr_reader source_id: String?
66
+
67
+ def source_id=: (String) -> String
68
+
69
+ attr_accessor start_date: String?
70
+
71
+ attr_accessor title: String?
72
+
73
+ def initialize:
74
+ (
75
+ class_code: String?,
76
+ custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField],
77
+ department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?,
78
+ employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?,
79
+ employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?,
80
+ end_date: String?,
81
+ first_name: String?,
82
+ income: FinchAPI::Models::Income?,
83
+ income_history: ::Array[FinchAPI::Models::Income?]?,
84
+ is_active: bool?,
85
+ last_name: String?,
86
+ latest_rehire_date: String?,
87
+ location: FinchAPI::Models::Location?,
88
+ manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?,
89
+ middle_name: String?,
90
+ source_id: String,
91
+ start_date: String?,
92
+ title: String?,
93
+ request_options: FinchAPI::request_opts
94
+ ) -> void
95
+ | (
96
+ ?FinchAPI::Models::Sandbox::employment_update_params
97
+ | FinchAPI::BaseModel data
98
+ ) -> void
99
+
100
+ def to_hash: -> FinchAPI::Models::Sandbox::employment_update_params
101
+
102
+ type custom_field = { name: String?, value: top }
103
+
104
+ class CustomField < FinchAPI::BaseModel
105
+ attr_accessor name: String?
106
+
107
+ attr_reader value: top?
108
+
109
+ def value=: (top) -> top
110
+
111
+ def initialize:
112
+ (name: String?, value: top) -> void
113
+ | (
114
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::custom_field
115
+ | FinchAPI::BaseModel data
116
+ ) -> void
117
+
118
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::custom_field
119
+ end
120
+
121
+ type department = { name: String? }
122
+
123
+ class Department < FinchAPI::BaseModel
124
+ attr_accessor name: String?
125
+
126
+ def initialize:
127
+ (name: String?) -> void
128
+ | (
129
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::department
130
+ | FinchAPI::BaseModel data
131
+ ) -> void
132
+
133
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::department
134
+ end
135
+
136
+ type employment =
137
+ {
138
+ subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?,
139
+ type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_?
140
+ }
141
+
142
+ class Employment < FinchAPI::BaseModel
143
+ attr_accessor subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?
144
+
145
+ attr_accessor type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_?
146
+
147
+ def initialize:
148
+ (
149
+ subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?,
150
+ type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_?
151
+ ) -> void
152
+ | (
153
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment
154
+ | FinchAPI::BaseModel data
155
+ ) -> void
156
+
157
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment
158
+
159
+ type subtype =
160
+ :full_time
161
+ | :intern
162
+ | :part_time
163
+ | :temp
164
+ | :seasonal
165
+ | :individual_contractor
166
+
167
+ class Subtype < FinchAPI::Enum
168
+ FULL_TIME: :full_time
169
+ INTERN: :intern
170
+ PART_TIME: :part_time
171
+ TEMP: :temp
172
+ SEASONAL: :seasonal
173
+ INDIVIDUAL_CONTRACTOR: :individual_contractor
174
+
175
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype]
176
+ end
177
+
178
+ type type_ = :employee | :contractor
179
+
180
+ class Type < FinchAPI::Enum
181
+ EMPLOYEE: :employee
182
+ CONTRACTOR: :contractor
183
+
184
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_]
185
+ end
186
+ end
187
+
188
+ type employment_status =
189
+ :active
190
+ | :deceased
191
+ | :leave
192
+ | :onboarding
193
+ | :prehire
194
+ | :retired
195
+ | :terminated
196
+
197
+ class EmploymentStatus < FinchAPI::Enum
198
+ ACTIVE: :active
199
+ DECEASED: :deceased
200
+ LEAVE: :leave
201
+ ONBOARDING: :onboarding
202
+ PREHIRE: :prehire
203
+ RETIRED: :retired
204
+ TERMINATED: :terminated
205
+
206
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status]
207
+ end
208
+
209
+ type manager = { id: String }
210
+
211
+ class Manager < FinchAPI::BaseModel
212
+ attr_reader id: String?
213
+
214
+ def id=: (String) -> String
215
+
216
+ def initialize:
217
+ (id: String) -> void
218
+ | (
219
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::manager
220
+ | FinchAPI::BaseModel data
221
+ ) -> void
222
+
223
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::manager
224
+ end
225
+ end
226
+ end
227
+ end
228
+ end
@@ -0,0 +1,229 @@
1
+ module FinchAPI
2
+ module Models
3
+ module Sandbox
4
+ type employment_update_response =
5
+ {
6
+ id: String,
7
+ class_code: String?,
8
+ custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField],
9
+ department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?,
10
+ employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?,
11
+ employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
12
+ end_date: String?,
13
+ first_name: String?,
14
+ income: FinchAPI::Models::Income?,
15
+ income_history: ::Array[FinchAPI::Models::Income?]?,
16
+ is_active: bool?,
17
+ last_name: String?,
18
+ latest_rehire_date: String?,
19
+ location: FinchAPI::Models::Location?,
20
+ manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?,
21
+ middle_name: String?,
22
+ source_id: String,
23
+ start_date: String?,
24
+ title: String?
25
+ }
26
+
27
+ class EmploymentUpdateResponse < FinchAPI::BaseModel
28
+ attr_reader id: String?
29
+
30
+ def id=: (String) -> String
31
+
32
+ attr_accessor class_code: String?
33
+
34
+ attr_reader custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]?
35
+
36
+ def custom_fields=: (
37
+ ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]
38
+ ) -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]
39
+
40
+ attr_accessor department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?
41
+
42
+ attr_accessor employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?
43
+
44
+ attr_accessor employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?
45
+
46
+ attr_accessor end_date: String?
47
+
48
+ attr_accessor first_name: String?
49
+
50
+ attr_accessor income: FinchAPI::Models::Income?
51
+
52
+ attr_accessor income_history: ::Array[FinchAPI::Models::Income?]?
53
+
54
+ attr_accessor is_active: bool?
55
+
56
+ attr_accessor last_name: String?
57
+
58
+ attr_accessor latest_rehire_date: String?
59
+
60
+ attr_accessor location: FinchAPI::Models::Location?
61
+
62
+ attr_accessor manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?
63
+
64
+ attr_accessor middle_name: String?
65
+
66
+ attr_reader source_id: String?
67
+
68
+ def source_id=: (String) -> String
69
+
70
+ attr_accessor start_date: String?
71
+
72
+ attr_accessor title: String?
73
+
74
+ def initialize:
75
+ (
76
+ id: String,
77
+ class_code: String?,
78
+ custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField],
79
+ department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?,
80
+ employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?,
81
+ employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?,
82
+ end_date: String?,
83
+ first_name: String?,
84
+ income: FinchAPI::Models::Income?,
85
+ income_history: ::Array[FinchAPI::Models::Income?]?,
86
+ is_active: bool?,
87
+ last_name: String?,
88
+ latest_rehire_date: String?,
89
+ location: FinchAPI::Models::Location?,
90
+ manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?,
91
+ middle_name: String?,
92
+ source_id: String,
93
+ start_date: String?,
94
+ title: String?
95
+ ) -> void
96
+ | (
97
+ ?FinchAPI::Models::Sandbox::employment_update_response
98
+ | FinchAPI::BaseModel data
99
+ ) -> void
100
+
101
+ def to_hash: -> FinchAPI::Models::Sandbox::employment_update_response
102
+
103
+ type custom_field = { name: String?, value: top }
104
+
105
+ class CustomField < FinchAPI::BaseModel
106
+ attr_accessor name: String?
107
+
108
+ attr_reader value: top?
109
+
110
+ def value=: (top) -> top
111
+
112
+ def initialize:
113
+ (name: String?, value: top) -> void
114
+ | (
115
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::custom_field
116
+ | FinchAPI::BaseModel data
117
+ ) -> void
118
+
119
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::custom_field
120
+ end
121
+
122
+ type department = { name: String? }
123
+
124
+ class Department < FinchAPI::BaseModel
125
+ attr_accessor name: String?
126
+
127
+ def initialize:
128
+ (name: String?) -> void
129
+ | (
130
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::department
131
+ | FinchAPI::BaseModel data
132
+ ) -> void
133
+
134
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::department
135
+ end
136
+
137
+ type employment =
138
+ {
139
+ subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?,
140
+ type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_?
141
+ }
142
+
143
+ class Employment < FinchAPI::BaseModel
144
+ attr_accessor subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?
145
+
146
+ attr_accessor type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_?
147
+
148
+ def initialize:
149
+ (
150
+ subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?,
151
+ type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_?
152
+ ) -> void
153
+ | (
154
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment
155
+ | FinchAPI::BaseModel data
156
+ ) -> void
157
+
158
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment
159
+
160
+ type subtype =
161
+ :full_time
162
+ | :intern
163
+ | :part_time
164
+ | :temp
165
+ | :seasonal
166
+ | :individual_contractor
167
+
168
+ class Subtype < FinchAPI::Enum
169
+ FULL_TIME: :full_time
170
+ INTERN: :intern
171
+ PART_TIME: :part_time
172
+ TEMP: :temp
173
+ SEASONAL: :seasonal
174
+ INDIVIDUAL_CONTRACTOR: :individual_contractor
175
+
176
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype]
177
+ end
178
+
179
+ type type_ = :employee | :contractor
180
+
181
+ class Type < FinchAPI::Enum
182
+ EMPLOYEE: :employee
183
+ CONTRACTOR: :contractor
184
+
185
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_]
186
+ end
187
+ end
188
+
189
+ type employment_status =
190
+ :active
191
+ | :deceased
192
+ | :leave
193
+ | :onboarding
194
+ | :prehire
195
+ | :retired
196
+ | :terminated
197
+
198
+ class EmploymentStatus < FinchAPI::Enum
199
+ ACTIVE: :active
200
+ DECEASED: :deceased
201
+ LEAVE: :leave
202
+ ONBOARDING: :onboarding
203
+ PREHIRE: :prehire
204
+ RETIRED: :retired
205
+ TERMINATED: :terminated
206
+
207
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status]
208
+ end
209
+
210
+ type manager = { id: String }
211
+
212
+ class Manager < FinchAPI::BaseModel
213
+ attr_reader id: String?
214
+
215
+ def id=: (String) -> String
216
+
217
+ def initialize:
218
+ (id: String) -> void
219
+ | (
220
+ ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::manager
221
+ | FinchAPI::BaseModel data
222
+ ) -> void
223
+
224
+ def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::manager
225
+ end
226
+ end
227
+ end
228
+ end
229
+ end
@@ -0,0 +1,178 @@
1
+ module FinchAPI
2
+ module Models
3
+ module Sandbox
4
+ type individual_update_params =
5
+ {
6
+ dob: String?,
7
+ emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?,
8
+ encrypted_ssn: String?,
9
+ ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?,
10
+ first_name: String?,
11
+ gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?,
12
+ last_name: String?,
13
+ middle_name: String?,
14
+ phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?,
15
+ preferred_name: String?,
16
+ residence: FinchAPI::Models::Location?,
17
+ ssn: String?
18
+ }
19
+ & FinchAPI::request_parameters
20
+
21
+ class IndividualUpdateParams < FinchAPI::BaseModel
22
+ extend FinchAPI::RequestParameters::Converter
23
+ include FinchAPI::RequestParameters
24
+
25
+ attr_accessor dob: String?
26
+
27
+ attr_accessor emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?
28
+
29
+ attr_accessor encrypted_ssn: String?
30
+
31
+ attr_accessor ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?
32
+
33
+ attr_accessor first_name: String?
34
+
35
+ attr_accessor gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?
36
+
37
+ attr_accessor last_name: String?
38
+
39
+ attr_accessor middle_name: String?
40
+
41
+ attr_accessor phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?
42
+
43
+ attr_accessor preferred_name: String?
44
+
45
+ attr_accessor residence: FinchAPI::Models::Location?
46
+
47
+ attr_accessor ssn: String?
48
+
49
+ def initialize:
50
+ (
51
+ dob: String?,
52
+ emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?,
53
+ encrypted_ssn: String?,
54
+ ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?,
55
+ first_name: String?,
56
+ gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?,
57
+ last_name: String?,
58
+ middle_name: String?,
59
+ phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?,
60
+ preferred_name: String?,
61
+ residence: FinchAPI::Models::Location?,
62
+ ssn: String?,
63
+ request_options: FinchAPI::request_opts
64
+ ) -> void
65
+ | (
66
+ ?FinchAPI::Models::Sandbox::individual_update_params
67
+ | FinchAPI::BaseModel data
68
+ ) -> void
69
+
70
+ def to_hash: -> FinchAPI::Models::Sandbox::individual_update_params
71
+
72
+ type email =
73
+ {
74
+ data: String,
75
+ type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_?
76
+ }
77
+
78
+ class Email < FinchAPI::BaseModel
79
+ attr_reader data: String?
80
+
81
+ def data=: (String) -> String
82
+
83
+ attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_?
84
+
85
+ def initialize:
86
+ (
87
+ data: String,
88
+ type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_?
89
+ ) -> void
90
+ | (
91
+ ?FinchAPI::Models::Sandbox::IndividualUpdateParams::email
92
+ | FinchAPI::BaseModel data
93
+ ) -> void
94
+
95
+ def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateParams::email
96
+
97
+ type type_ = :work | :personal
98
+
99
+ class Type < FinchAPI::Enum
100
+ WORK: :work
101
+ PERSONAL: :personal
102
+
103
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_]
104
+ end
105
+ end
106
+
107
+ type ethnicity =
108
+ :asian
109
+ | :white
110
+ | :black_or_african_american
111
+ | :native_hawaiian_or_pacific_islander
112
+ | :american_indian_or_alaska_native
113
+ | :hispanic_or_latino
114
+ | :two_or_more_races
115
+ | :decline_to_specify
116
+
117
+ class Ethnicity < FinchAPI::Enum
118
+ ASIAN: :asian
119
+ WHITE: :white
120
+ BLACK_OR_AFRICAN_AMERICAN: :black_or_african_american
121
+ NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER: :native_hawaiian_or_pacific_islander
122
+ AMERICAN_INDIAN_OR_ALASKA_NATIVE: :american_indian_or_alaska_native
123
+ HISPANIC_OR_LATINO: :hispanic_or_latino
124
+ TWO_OR_MORE_RACES: :two_or_more_races
125
+ DECLINE_TO_SPECIFY: :decline_to_specify
126
+
127
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity]
128
+ end
129
+
130
+ type gender = :female | :male | :other | :decline_to_specify
131
+
132
+ class Gender < FinchAPI::Enum
133
+ FEMALE: :female
134
+ MALE: :male
135
+ OTHER: :other
136
+ DECLINE_TO_SPECIFY: :decline_to_specify
137
+
138
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::gender]
139
+ end
140
+
141
+ type phone_number =
142
+ {
143
+ data: String,
144
+ type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_?
145
+ }
146
+
147
+ class PhoneNumber < FinchAPI::BaseModel
148
+ attr_reader data: String?
149
+
150
+ def data=: (String) -> String
151
+
152
+ attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_?
153
+
154
+ def initialize:
155
+ (
156
+ data: String,
157
+ type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_?
158
+ ) -> void
159
+ | (
160
+ ?FinchAPI::Models::Sandbox::IndividualUpdateParams::phone_number
161
+ | FinchAPI::BaseModel data
162
+ ) -> void
163
+
164
+ def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateParams::phone_number
165
+
166
+ type type_ = :work | :personal
167
+
168
+ class Type < FinchAPI::Enum
169
+ WORK: :work
170
+ PERSONAL: :personal
171
+
172
+ def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_]
173
+ end
174
+ end
175
+ end
176
+ end
177
+ end
178
+ end