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,41 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type individual_response =
5
+ {
6
+ body: FinchAPI::Models::HRIS::Individual,
7
+ code: Integer,
8
+ individual_id: String
9
+ }
10
+
11
+ class IndividualResponse < FinchAPI::BaseModel
12
+ attr_reader body: FinchAPI::Models::HRIS::Individual?
13
+
14
+ def body=: (
15
+ FinchAPI::Models::HRIS::Individual
16
+ ) -> FinchAPI::Models::HRIS::Individual
17
+
18
+ attr_reader code: Integer?
19
+
20
+ def code=: (Integer) -> Integer
21
+
22
+ attr_reader individual_id: String?
23
+
24
+ def individual_id=: (String) -> String
25
+
26
+ def initialize:
27
+ (
28
+ body: FinchAPI::Models::HRIS::Individual,
29
+ code: Integer,
30
+ individual_id: String
31
+ ) -> void
32
+ | (
33
+ ?FinchAPI::Models::HRIS::individual_response
34
+ | FinchAPI::BaseModel data
35
+ ) -> void
36
+
37
+ def to_hash: -> FinchAPI::Models::HRIS::individual_response
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,72 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type individual_retrieve_many_params =
5
+ {
6
+ options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?,
7
+ requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]
8
+ }
9
+ & FinchAPI::request_parameters
10
+
11
+ class IndividualRetrieveManyParams < FinchAPI::BaseModel
12
+ extend FinchAPI::RequestParameters::Converter
13
+ include FinchAPI::RequestParameters
14
+
15
+ attr_accessor options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?
16
+
17
+ attr_reader requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]?
18
+
19
+ def requests=: (
20
+ ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]
21
+ ) -> ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]
22
+
23
+ def initialize:
24
+ (
25
+ options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?,
26
+ requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request],
27
+ request_options: FinchAPI::request_opts
28
+ ) -> void
29
+ | (
30
+ ?FinchAPI::Models::HRIS::individual_retrieve_many_params
31
+ | FinchAPI::BaseModel data
32
+ ) -> void
33
+
34
+ def to_hash: -> FinchAPI::Models::HRIS::individual_retrieve_many_params
35
+
36
+ type options = { include: ::Array[String] }
37
+
38
+ class Options < FinchAPI::BaseModel
39
+ attr_reader include: ::Array[String]?
40
+
41
+ def include=: (::Array[String]) -> ::Array[String]
42
+
43
+ def initialize:
44
+ (include: ::Array[String]) -> void
45
+ | (
46
+ ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams::options
47
+ | FinchAPI::BaseModel data
48
+ ) -> void
49
+
50
+ def to_hash: -> FinchAPI::Models::HRIS::IndividualRetrieveManyParams::options
51
+ end
52
+
53
+ type request = { individual_id: String }
54
+
55
+ class Request < FinchAPI::BaseModel
56
+ attr_reader individual_id: String?
57
+
58
+ def individual_id=: (String) -> String
59
+
60
+ def initialize:
61
+ (individual_id: String) -> void
62
+ | (
63
+ ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams::request
64
+ | FinchAPI::BaseModel data
65
+ ) -> void
66
+
67
+ def to_hash: -> FinchAPI::Models::HRIS::IndividualRetrieveManyParams::request
68
+ end
69
+ end
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,445 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type pay_statement =
5
+ {
6
+ earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?,
7
+ employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?,
8
+ employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?,
9
+ gross_pay: FinchAPI::Models::Money?,
10
+ individual_id: String,
11
+ net_pay: FinchAPI::Models::Money?,
12
+ payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
13
+ taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?,
14
+ total_hours: Float?,
15
+ type: FinchAPI::Models::HRIS::PayStatement::type_?
16
+ }
17
+
18
+ class PayStatement < FinchAPI::BaseModel
19
+ attr_accessor earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?
20
+
21
+ attr_accessor employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?
22
+
23
+ attr_accessor employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?
24
+
25
+ attr_accessor gross_pay: FinchAPI::Models::Money?
26
+
27
+ attr_reader individual_id: String?
28
+
29
+ def individual_id=: (String) -> String
30
+
31
+ attr_accessor net_pay: FinchAPI::Models::Money?
32
+
33
+ attr_accessor payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?
34
+
35
+ attr_accessor taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?
36
+
37
+ attr_accessor total_hours: Float?
38
+
39
+ attr_accessor type: FinchAPI::Models::HRIS::PayStatement::type_?
40
+
41
+ def initialize:
42
+ (
43
+ earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?,
44
+ employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?,
45
+ employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?,
46
+ gross_pay: FinchAPI::Models::Money?,
47
+ individual_id: String,
48
+ net_pay: FinchAPI::Models::Money?,
49
+ payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
50
+ taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?,
51
+ total_hours: Float?,
52
+ type: FinchAPI::Models::HRIS::PayStatement::type_?
53
+ ) -> void
54
+ | (
55
+ ?FinchAPI::Models::HRIS::pay_statement | FinchAPI::BaseModel data
56
+ ) -> void
57
+
58
+ def to_hash: -> FinchAPI::Models::HRIS::pay_statement
59
+
60
+ type earning =
61
+ {
62
+ amount: Integer?,
63
+ attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?,
64
+ currency: String?,
65
+ hours: Float?,
66
+ name: String?,
67
+ type: FinchAPI::Models::HRIS::PayStatement::Earning::type_?
68
+ }
69
+
70
+ class Earning < FinchAPI::BaseModel
71
+ attr_accessor amount: Integer?
72
+
73
+ attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?
74
+
75
+ attr_accessor currency: String?
76
+
77
+ attr_accessor hours: Float?
78
+
79
+ attr_accessor name: String?
80
+
81
+ attr_accessor type: FinchAPI::Models::HRIS::PayStatement::Earning::type_?
82
+
83
+ def initialize:
84
+ (
85
+ amount: Integer?,
86
+ attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?,
87
+ currency: String?,
88
+ hours: Float?,
89
+ name: String?,
90
+ type: FinchAPI::Models::HRIS::PayStatement::Earning::type_?
91
+ ) -> void
92
+ | (
93
+ ?FinchAPI::Models::HRIS::PayStatement::earning
94
+ | FinchAPI::BaseModel data
95
+ ) -> void
96
+
97
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::earning
98
+
99
+ type attributes =
100
+ {
101
+ metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata
102
+ }
103
+
104
+ class Attributes < FinchAPI::BaseModel
105
+ attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata?
106
+
107
+ def metadata=: (
108
+ FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata
109
+ ) -> FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata
110
+
111
+ def initialize:
112
+ (
113
+ metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata
114
+ ) -> void
115
+ | (
116
+ ?FinchAPI::Models::HRIS::PayStatement::Earning::attributes
117
+ | FinchAPI::BaseModel data
118
+ ) -> void
119
+
120
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Earning::attributes
121
+
122
+ type metadata = { metadata: ::Hash[Symbol, top] }
123
+
124
+ class Metadata < FinchAPI::BaseModel
125
+ attr_reader metadata: ::Hash[Symbol, top]?
126
+
127
+ def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
128
+
129
+ def initialize:
130
+ (metadata: ::Hash[Symbol, top]) -> void
131
+ | (
132
+ ?FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::metadata
133
+ | FinchAPI::BaseModel data
134
+ ) -> void
135
+
136
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::metadata
137
+ end
138
+ end
139
+
140
+ type type_ =
141
+ :salary
142
+ | :wage
143
+ | :reimbursement
144
+ | :overtime
145
+ | :severance
146
+ | :double_overtime
147
+ | :pto
148
+ | :sick
149
+ | :bonus
150
+ | :commission
151
+ | :tips
152
+ | :"1099"
153
+ | :other
154
+
155
+ class Type < FinchAPI::Enum
156
+ SALARY: :salary
157
+ WAGE: :wage
158
+ REIMBURSEMENT: :reimbursement
159
+ OVERTIME: :overtime
160
+ SEVERANCE: :severance
161
+ DOUBLE_OVERTIME: :double_overtime
162
+ PTO: :pto
163
+ SICK: :sick
164
+ BONUS: :bonus
165
+ COMMISSION: :commission
166
+ TIPS: :tips
167
+ NUMBER_1099: :"1099"
168
+ OTHER: :other
169
+
170
+ def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Earning::type_]
171
+ end
172
+ end
173
+
174
+ type employee_deduction =
175
+ {
176
+ amount: Integer?,
177
+ attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?,
178
+ currency: String?,
179
+ name: String?,
180
+ pre_tax: bool?,
181
+ type: FinchAPI::Models::HRIS::benefit_type?
182
+ }
183
+
184
+ class EmployeeDeduction < FinchAPI::BaseModel
185
+ attr_accessor amount: Integer?
186
+
187
+ attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?
188
+
189
+ attr_accessor currency: String?
190
+
191
+ attr_accessor name: String?
192
+
193
+ attr_accessor pre_tax: bool?
194
+
195
+ attr_accessor type: FinchAPI::Models::HRIS::benefit_type?
196
+
197
+ def initialize:
198
+ (
199
+ amount: Integer?,
200
+ attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?,
201
+ currency: String?,
202
+ name: String?,
203
+ pre_tax: bool?,
204
+ type: FinchAPI::Models::HRIS::benefit_type?
205
+ ) -> void
206
+ | (
207
+ ?FinchAPI::Models::HRIS::PayStatement::employee_deduction
208
+ | FinchAPI::BaseModel data
209
+ ) -> void
210
+
211
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::employee_deduction
212
+
213
+ type attributes =
214
+ {
215
+ metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
216
+ }
217
+
218
+ class Attributes < FinchAPI::BaseModel
219
+ attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata?
220
+
221
+ def metadata=: (
222
+ FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
223
+ ) -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
224
+
225
+ def initialize:
226
+ (
227
+ metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
228
+ ) -> void
229
+ | (
230
+ ?FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::attributes
231
+ | FinchAPI::BaseModel data
232
+ ) -> void
233
+
234
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::attributes
235
+
236
+ type metadata = { metadata: ::Hash[Symbol, top] }
237
+
238
+ class Metadata < FinchAPI::BaseModel
239
+ attr_reader metadata: ::Hash[Symbol, top]?
240
+
241
+ def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
242
+
243
+ def initialize:
244
+ (metadata: ::Hash[Symbol, top]) -> void
245
+ | (
246
+ ?FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::metadata
247
+ | FinchAPI::BaseModel data
248
+ ) -> void
249
+
250
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::metadata
251
+ end
252
+ end
253
+ end
254
+
255
+ type employer_contribution =
256
+ {
257
+ amount: Integer?,
258
+ attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?,
259
+ currency: String?,
260
+ name: String?,
261
+ type: FinchAPI::Models::HRIS::benefit_type?
262
+ }
263
+
264
+ class EmployerContribution < FinchAPI::BaseModel
265
+ attr_accessor amount: Integer?
266
+
267
+ attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?
268
+
269
+ attr_accessor currency: String?
270
+
271
+ attr_accessor name: String?
272
+
273
+ attr_accessor type: FinchAPI::Models::HRIS::benefit_type?
274
+
275
+ def initialize:
276
+ (
277
+ amount: Integer?,
278
+ attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?,
279
+ currency: String?,
280
+ name: String?,
281
+ type: FinchAPI::Models::HRIS::benefit_type?
282
+ ) -> void
283
+ | (
284
+ ?FinchAPI::Models::HRIS::PayStatement::employer_contribution
285
+ | FinchAPI::BaseModel data
286
+ ) -> void
287
+
288
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::employer_contribution
289
+
290
+ type attributes =
291
+ {
292
+ metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
293
+ }
294
+
295
+ class Attributes < FinchAPI::BaseModel
296
+ attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata?
297
+
298
+ def metadata=: (
299
+ FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
300
+ ) -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
301
+
302
+ def initialize:
303
+ (
304
+ metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
305
+ ) -> void
306
+ | (
307
+ ?FinchAPI::Models::HRIS::PayStatement::EmployerContribution::attributes
308
+ | FinchAPI::BaseModel data
309
+ ) -> void
310
+
311
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::attributes
312
+
313
+ type metadata = { metadata: ::Hash[Symbol, top] }
314
+
315
+ class Metadata < FinchAPI::BaseModel
316
+ attr_reader metadata: ::Hash[Symbol, top]?
317
+
318
+ def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
319
+
320
+ def initialize:
321
+ (metadata: ::Hash[Symbol, top]) -> void
322
+ | (
323
+ ?FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::metadata
324
+ | FinchAPI::BaseModel data
325
+ ) -> void
326
+
327
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::metadata
328
+ end
329
+ end
330
+ end
331
+
332
+ type payment_method = :check | :direct_deposit
333
+
334
+ class PaymentMethod < FinchAPI::Enum
335
+ CHECK: :check
336
+ DIRECT_DEPOSIT: :direct_deposit
337
+
338
+ def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::payment_method]
339
+ end
340
+
341
+ type tax =
342
+ {
343
+ amount: Integer?,
344
+ attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?,
345
+ currency: String?,
346
+ employer: bool?,
347
+ name: String?,
348
+ type: FinchAPI::Models::HRIS::PayStatement::Tax::type_?
349
+ }
350
+
351
+ class Tax < FinchAPI::BaseModel
352
+ attr_accessor amount: Integer?
353
+
354
+ attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?
355
+
356
+ attr_accessor currency: String?
357
+
358
+ attr_accessor employer: bool?
359
+
360
+ attr_accessor name: String?
361
+
362
+ attr_accessor type: FinchAPI::Models::HRIS::PayStatement::Tax::type_?
363
+
364
+ def initialize:
365
+ (
366
+ amount: Integer?,
367
+ attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?,
368
+ currency: String?,
369
+ employer: bool?,
370
+ name: String?,
371
+ type: FinchAPI::Models::HRIS::PayStatement::Tax::type_?
372
+ ) -> void
373
+ | (
374
+ ?FinchAPI::Models::HRIS::PayStatement::tax
375
+ | FinchAPI::BaseModel data
376
+ ) -> void
377
+
378
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::tax
379
+
380
+ type attributes =
381
+ {
382
+ metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata
383
+ }
384
+
385
+ class Attributes < FinchAPI::BaseModel
386
+ attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata?
387
+
388
+ def metadata=: (
389
+ FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata
390
+ ) -> FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata
391
+
392
+ def initialize:
393
+ (
394
+ metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata
395
+ ) -> void
396
+ | (
397
+ ?FinchAPI::Models::HRIS::PayStatement::Tax::attributes
398
+ | FinchAPI::BaseModel data
399
+ ) -> void
400
+
401
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Tax::attributes
402
+
403
+ type metadata = { metadata: ::Hash[Symbol, top] }
404
+
405
+ class Metadata < FinchAPI::BaseModel
406
+ attr_reader metadata: ::Hash[Symbol, top]?
407
+
408
+ def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
409
+
410
+ def initialize:
411
+ (metadata: ::Hash[Symbol, top]) -> void
412
+ | (
413
+ ?FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::metadata
414
+ | FinchAPI::BaseModel data
415
+ ) -> void
416
+
417
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::metadata
418
+ end
419
+ end
420
+
421
+ type type_ = :state | :federal | :local | :fica
422
+
423
+ class Type < FinchAPI::Enum
424
+ STATE: :state
425
+ FEDERAL: :federal
426
+ LOCAL: :local
427
+ FICA: :fica
428
+
429
+ def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Tax::type_]
430
+ end
431
+ end
432
+
433
+ type type_ = :regular_payroll | :off_cycle_payroll | :one_time_payment
434
+
435
+ class Type < FinchAPI::Enum
436
+ REGULAR_PAYROLL: :regular_payroll
437
+ OFF_CYCLE_PAYROLL: :off_cycle_payroll
438
+ ONE_TIME_PAYMENT: :one_time_payment
439
+
440
+ def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::type_]
441
+ end
442
+ end
443
+ end
444
+ end
445
+ end
@@ -0,0 +1,41 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type pay_statement_response =
5
+ {
6
+ body: FinchAPI::Models::HRIS::PayStatementResponseBody,
7
+ code: Integer,
8
+ payment_id: String
9
+ }
10
+
11
+ class PayStatementResponse < FinchAPI::BaseModel
12
+ attr_reader body: FinchAPI::Models::HRIS::PayStatementResponseBody?
13
+
14
+ def body=: (
15
+ FinchAPI::Models::HRIS::PayStatementResponseBody
16
+ ) -> FinchAPI::Models::HRIS::PayStatementResponseBody
17
+
18
+ attr_reader code: Integer?
19
+
20
+ def code=: (Integer) -> Integer
21
+
22
+ attr_reader payment_id: String?
23
+
24
+ def payment_id=: (String) -> String
25
+
26
+ def initialize:
27
+ (
28
+ body: FinchAPI::Models::HRIS::PayStatementResponseBody,
29
+ code: Integer,
30
+ payment_id: String
31
+ ) -> void
32
+ | (
33
+ ?FinchAPI::Models::HRIS::pay_statement_response
34
+ | FinchAPI::BaseModel data
35
+ ) -> void
36
+
37
+ def to_hash: -> FinchAPI::Models::HRIS::pay_statement_response
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,35 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type pay_statement_response_body =
5
+ {
6
+ paging: FinchAPI::Models::Paging,
7
+ pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement]
8
+ }
9
+
10
+ class PayStatementResponseBody < FinchAPI::BaseModel
11
+ attr_reader paging: FinchAPI::Models::Paging?
12
+
13
+ def paging=: (FinchAPI::Models::Paging) -> FinchAPI::Models::Paging
14
+
15
+ attr_reader pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement]?
16
+
17
+ def pay_statements=: (
18
+ ::Array[FinchAPI::Models::HRIS::PayStatement]
19
+ ) -> ::Array[FinchAPI::Models::HRIS::PayStatement]
20
+
21
+ def initialize:
22
+ (
23
+ paging: FinchAPI::Models::Paging,
24
+ pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement]
25
+ ) -> void
26
+ | (
27
+ ?FinchAPI::Models::HRIS::pay_statement_response_body
28
+ | FinchAPI::BaseModel data
29
+ ) -> void
30
+
31
+ def to_hash: -> FinchAPI::Models::HRIS::pay_statement_response_body
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,53 @@
1
+ module FinchAPI
2
+ module Models
3
+ module HRIS
4
+ type pay_statement_retrieve_many_params =
5
+ {
6
+ requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]
7
+ }
8
+ & FinchAPI::request_parameters
9
+
10
+ class PayStatementRetrieveManyParams < FinchAPI::BaseModel
11
+ extend FinchAPI::RequestParameters::Converter
12
+ include FinchAPI::RequestParameters
13
+
14
+ attr_accessor requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]
15
+
16
+ def initialize:
17
+ (
18
+ requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request],
19
+ request_options: FinchAPI::request_opts
20
+ ) -> void
21
+ | (
22
+ ?FinchAPI::Models::HRIS::pay_statement_retrieve_many_params
23
+ | FinchAPI::BaseModel data
24
+ ) -> void
25
+
26
+ def to_hash: -> FinchAPI::Models::HRIS::pay_statement_retrieve_many_params
27
+
28
+ type request = { payment_id: String, limit: Integer, offset: Integer }
29
+
30
+ class Request < FinchAPI::BaseModel
31
+ attr_accessor payment_id: String
32
+
33
+ attr_reader limit: Integer?
34
+
35
+ def limit=: (Integer) -> Integer
36
+
37
+ attr_reader offset: Integer?
38
+
39
+ def offset=: (Integer) -> Integer
40
+
41
+ def initialize:
42
+ (payment_id: String, limit: Integer, offset: Integer) -> void
43
+ | (
44
+ ?FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::request
45
+ | FinchAPI::BaseModel data
46
+ ) -> void
47
+
48
+ def to_hash: -> FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::request
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end