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,646 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module Sandbox
6
+ class PaymentCreateParams < FinchAPI::BaseModel
7
+ # @!parse
8
+ # extend FinchAPI::RequestParameters::Converter
9
+ include FinchAPI::RequestParameters
10
+
11
+ # @!attribute [r] end_date
12
+ #
13
+ # @return [String, nil]
14
+ optional :end_date, String
15
+
16
+ # @!parse
17
+ # # @return [String]
18
+ # attr_writer :end_date
19
+
20
+ # @!attribute [r] pay_statements
21
+ #
22
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>, nil]
23
+ optional :pay_statements,
24
+ -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement] }
25
+
26
+ # @!parse
27
+ # # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>]
28
+ # attr_writer :pay_statements
29
+
30
+ # @!attribute [r] start_date
31
+ #
32
+ # @return [String, nil]
33
+ optional :start_date, String
34
+
35
+ # @!parse
36
+ # # @return [String]
37
+ # attr_writer :start_date
38
+
39
+ # @!parse
40
+ # # @param end_date [String]
41
+ # # @param pay_statements [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>]
42
+ # # @param start_date [String]
43
+ # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
44
+ # #
45
+ # def initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}, **) = super
46
+
47
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
48
+
49
+ class PayStatement < FinchAPI::BaseModel
50
+ # @!attribute earnings
51
+ # The array of earnings objects associated with this pay statement
52
+ #
53
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil>, nil]
54
+ optional :earnings,
55
+ -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil?: true] },
56
+ nil?: true
57
+
58
+ # @!attribute employee_deductions
59
+ # The array of deductions objects associated with this pay statement.
60
+ #
61
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil>, nil]
62
+ optional :employee_deductions,
63
+ -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil?: true] },
64
+ nil?: true
65
+
66
+ # @!attribute employer_contributions
67
+ #
68
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil>, nil]
69
+ optional :employer_contributions,
70
+ -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil?: true] },
71
+ nil?: true
72
+
73
+ # @!attribute gross_pay
74
+ #
75
+ # @return [FinchAPI::Models::Money, nil]
76
+ optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true
77
+
78
+ # @!attribute [r] individual_id
79
+ # A stable Finch `id` (UUID v4) for an individual in the company
80
+ #
81
+ # @return [String, nil]
82
+ optional :individual_id, String
83
+
84
+ # @!parse
85
+ # # @return [String]
86
+ # attr_writer :individual_id
87
+
88
+ # @!attribute net_pay
89
+ #
90
+ # @return [FinchAPI::Models::Money, nil]
91
+ optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true
92
+
93
+ # @!attribute payment_method
94
+ # The payment method.
95
+ #
96
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
97
+ optional :payment_method,
98
+ enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod },
99
+ nil?: true
100
+
101
+ # @!attribute taxes
102
+ # The array of taxes objects associated with this pay statement.
103
+ #
104
+ # @return [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil>, nil]
105
+ optional :taxes,
106
+ -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil?: true] },
107
+ nil?: true
108
+
109
+ # @!attribute total_hours
110
+ # The number of hours worked for this pay period
111
+ #
112
+ # @return [Float, nil]
113
+ optional :total_hours, Float, nil?: true
114
+
115
+ # @!attribute type
116
+ # The type of the payment associated with the pay statement.
117
+ #
118
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
119
+ optional :type,
120
+ enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type },
121
+ nil?: true
122
+
123
+ # @!parse
124
+ # # @param earnings [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil>, nil]
125
+ # # @param employee_deductions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil>, nil]
126
+ # # @param employer_contributions [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil>, nil]
127
+ # # @param gross_pay [FinchAPI::Models::Money, nil]
128
+ # # @param individual_id [String]
129
+ # # @param net_pay [FinchAPI::Models::Money, nil]
130
+ # # @param payment_method [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil]
131
+ # # @param taxes [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil>, nil]
132
+ # # @param total_hours [Float, nil]
133
+ # # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil]
134
+ # #
135
+ # def initialize(
136
+ # earnings: nil,
137
+ # employee_deductions: nil,
138
+ # employer_contributions: nil,
139
+ # gross_pay: nil,
140
+ # individual_id: nil,
141
+ # net_pay: nil,
142
+ # payment_method: nil,
143
+ # taxes: nil,
144
+ # total_hours: nil,
145
+ # type: nil,
146
+ # **
147
+ # )
148
+ # super
149
+ # end
150
+
151
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
152
+
153
+ class Earning < FinchAPI::BaseModel
154
+ # @!attribute amount
155
+ # The earnings amount in cents.
156
+ #
157
+ # @return [Integer, nil]
158
+ optional :amount, Integer, nil?: true
159
+
160
+ # @!attribute attributes
161
+ #
162
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil]
163
+ optional :attributes,
164
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes },
165
+ nil?: true
166
+
167
+ # @!attribute currency
168
+ # The earnings currency code.
169
+ #
170
+ # @return [String, nil]
171
+ optional :currency, String, nil?: true
172
+
173
+ # @!attribute hours
174
+ # The number of hours associated with this earning. (For salaried employees, this
175
+ # could be hours per pay period, `0` or `null`, depending on the provider).
176
+ #
177
+ # @return [Float, nil]
178
+ optional :hours, Float, nil?: true
179
+
180
+ # @!attribute name
181
+ # The exact name of the deduction from the pay statement.
182
+ #
183
+ # @return [String, nil]
184
+ optional :name, String, nil?: true
185
+
186
+ # @!attribute type
187
+ # The type of earning.
188
+ #
189
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil]
190
+ optional :type,
191
+ enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type },
192
+ nil?: true
193
+
194
+ # @!parse
195
+ # # @param amount [Integer, nil]
196
+ # # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil]
197
+ # # @param currency [String, nil]
198
+ # # @param hours [Float, nil]
199
+ # # @param name [String, nil]
200
+ # # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil]
201
+ # #
202
+ # def initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil, **) = super
203
+
204
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
205
+
206
+ class Attributes < FinchAPI::BaseModel
207
+ # @!attribute [r] metadata
208
+ #
209
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, nil]
210
+ optional :metadata,
211
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata }
212
+
213
+ # @!parse
214
+ # # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata]
215
+ # attr_writer :metadata
216
+
217
+ # @!parse
218
+ # # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata]
219
+ # #
220
+ # def initialize(metadata: nil, **) = super
221
+
222
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
223
+
224
+ class Metadata < FinchAPI::BaseModel
225
+ # @!attribute [r] metadata
226
+ # The metadata to be attached to the entity by existing rules. It is a key-value
227
+ # pairs where the values can be of any type (string, number, boolean, object,
228
+ # array, etc.).
229
+ #
230
+ # @return [Hash{Symbol=>Object}, nil]
231
+ optional :metadata, FinchAPI::HashOf[FinchAPI::Unknown]
232
+
233
+ # @!parse
234
+ # # @return [Hash{Symbol=>Object}]
235
+ # attr_writer :metadata
236
+
237
+ # @!parse
238
+ # # @param metadata [Hash{Symbol=>Object}]
239
+ # #
240
+ # def initialize(metadata: nil, **) = super
241
+
242
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
243
+ end
244
+ end
245
+
246
+ # @abstract
247
+ #
248
+ # The type of earning.
249
+ #
250
+ # @example
251
+ # ```ruby
252
+ # case type
253
+ # in :salary
254
+ # # ...
255
+ # in :wage
256
+ # # ...
257
+ # in :reimbursement
258
+ # # ...
259
+ # in :overtime
260
+ # # ...
261
+ # in :severance
262
+ # # ...
263
+ # in ...
264
+ # #...
265
+ # end
266
+ # ```
267
+ class Type < FinchAPI::Enum
268
+ SALARY = :salary
269
+ WAGE = :wage
270
+ REIMBURSEMENT = :reimbursement
271
+ OVERTIME = :overtime
272
+ SEVERANCE = :severance
273
+ DOUBLE_OVERTIME = :double_overtime
274
+ PTO = :pto
275
+ SICK = :sick
276
+ BONUS = :bonus
277
+ COMMISSION = :commission
278
+ TIPS = :tips
279
+ NUMBER_1099 = :"1099"
280
+ OTHER = :other
281
+
282
+ finalize!
283
+
284
+ # @!parse
285
+ # # @return [Array<Symbol>]
286
+ # #
287
+ # def self.values; end
288
+ end
289
+ end
290
+
291
+ class EmployeeDeduction < FinchAPI::BaseModel
292
+ # @!attribute amount
293
+ # The deduction amount in cents.
294
+ #
295
+ # @return [Integer, nil]
296
+ optional :amount, Integer, nil?: true
297
+
298
+ # @!attribute attributes
299
+ #
300
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil]
301
+ optional :attributes,
302
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes },
303
+ nil?: true
304
+
305
+ # @!attribute currency
306
+ # The deduction currency.
307
+ #
308
+ # @return [String, nil]
309
+ optional :currency, String, nil?: true
310
+
311
+ # @!attribute name
312
+ # The deduction name from the pay statement.
313
+ #
314
+ # @return [String, nil]
315
+ optional :name, String, nil?: true
316
+
317
+ # @!attribute pre_tax
318
+ # Boolean indicating if the deduction is pre-tax.
319
+ #
320
+ # @return [Boolean, nil]
321
+ optional :pre_tax, FinchAPI::BooleanModel, nil?: true
322
+
323
+ # @!attribute type
324
+ # Type of benefit.
325
+ #
326
+ # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
327
+ optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
328
+
329
+ # @!parse
330
+ # # @param amount [Integer, nil]
331
+ # # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil]
332
+ # # @param currency [String, nil]
333
+ # # @param name [String, nil]
334
+ # # @param pre_tax [Boolean, nil]
335
+ # # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
336
+ # #
337
+ # def initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil, **) = super
338
+
339
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
340
+
341
+ class Attributes < FinchAPI::BaseModel
342
+ # @!attribute [r] metadata
343
+ #
344
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, nil]
345
+ optional :metadata,
346
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata }
347
+
348
+ # @!parse
349
+ # # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata]
350
+ # attr_writer :metadata
351
+
352
+ # @!parse
353
+ # # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata]
354
+ # #
355
+ # def initialize(metadata: nil, **) = super
356
+
357
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
358
+
359
+ class Metadata < FinchAPI::BaseModel
360
+ # @!attribute [r] metadata
361
+ # The metadata to be attached to the entity by existing rules. It is a key-value
362
+ # pairs where the values can be of any type (string, number, boolean, object,
363
+ # array, etc.).
364
+ #
365
+ # @return [Hash{Symbol=>Object}, nil]
366
+ optional :metadata, FinchAPI::HashOf[FinchAPI::Unknown]
367
+
368
+ # @!parse
369
+ # # @return [Hash{Symbol=>Object}]
370
+ # attr_writer :metadata
371
+
372
+ # @!parse
373
+ # # @param metadata [Hash{Symbol=>Object}]
374
+ # #
375
+ # def initialize(metadata: nil, **) = super
376
+
377
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
378
+ end
379
+ end
380
+ end
381
+
382
+ class EmployerContribution < FinchAPI::BaseModel
383
+ # @!attribute amount
384
+ # The contribution amount in cents.
385
+ #
386
+ # @return [Integer, nil]
387
+ optional :amount, Integer, nil?: true
388
+
389
+ # @!attribute attributes
390
+ #
391
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil]
392
+ optional :attributes,
393
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes },
394
+ nil?: true
395
+
396
+ # @!attribute currency
397
+ # The contribution currency.
398
+ #
399
+ # @return [String, nil]
400
+ optional :currency, String, nil?: true
401
+
402
+ # @!attribute name
403
+ # The contribution name from the pay statement.
404
+ #
405
+ # @return [String, nil]
406
+ optional :name, String, nil?: true
407
+
408
+ # @!attribute type
409
+ # Type of benefit.
410
+ #
411
+ # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
412
+ optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
413
+
414
+ # @!parse
415
+ # # @param amount [Integer, nil]
416
+ # # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil]
417
+ # # @param currency [String, nil]
418
+ # # @param name [String, nil]
419
+ # # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
420
+ # #
421
+ # def initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil, **) = super
422
+
423
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
424
+
425
+ class Attributes < FinchAPI::BaseModel
426
+ # @!attribute [r] metadata
427
+ #
428
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, nil]
429
+ optional :metadata,
430
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata }
431
+
432
+ # @!parse
433
+ # # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata]
434
+ # attr_writer :metadata
435
+
436
+ # @!parse
437
+ # # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata]
438
+ # #
439
+ # def initialize(metadata: nil, **) = super
440
+
441
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
442
+
443
+ class Metadata < FinchAPI::BaseModel
444
+ # @!attribute [r] metadata
445
+ # The metadata to be attached to the entity by existing rules. It is a key-value
446
+ # pairs where the values can be of any type (string, number, boolean, object,
447
+ # array, etc.).
448
+ #
449
+ # @return [Hash{Symbol=>Object}, nil]
450
+ optional :metadata, FinchAPI::HashOf[FinchAPI::Unknown]
451
+
452
+ # @!parse
453
+ # # @return [Hash{Symbol=>Object}]
454
+ # attr_writer :metadata
455
+
456
+ # @!parse
457
+ # # @param metadata [Hash{Symbol=>Object}]
458
+ # #
459
+ # def initialize(metadata: nil, **) = super
460
+
461
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
462
+ end
463
+ end
464
+ end
465
+
466
+ # @abstract
467
+ #
468
+ # The payment method.
469
+ #
470
+ # @example
471
+ # ```ruby
472
+ # case payment_method
473
+ # in :check
474
+ # # ...
475
+ # in :direct_deposit
476
+ # # ...
477
+ # end
478
+ # ```
479
+ class PaymentMethod < FinchAPI::Enum
480
+ CHECK = :check
481
+ DIRECT_DEPOSIT = :direct_deposit
482
+
483
+ finalize!
484
+
485
+ # @!parse
486
+ # # @return [Array<Symbol>]
487
+ # #
488
+ # def self.values; end
489
+ end
490
+
491
+ class Tax < FinchAPI::BaseModel
492
+ # @!attribute amount
493
+ # The tax amount in cents.
494
+ #
495
+ # @return [Integer, nil]
496
+ optional :amount, Integer, nil?: true
497
+
498
+ # @!attribute attributes
499
+ #
500
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil]
501
+ optional :attributes,
502
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes },
503
+ nil?: true
504
+
505
+ # @!attribute currency
506
+ # The currency code.
507
+ #
508
+ # @return [String, nil]
509
+ optional :currency, String, nil?: true
510
+
511
+ # @!attribute employer
512
+ # `true` if the amount is paid by the employers.
513
+ #
514
+ # @return [Boolean, nil]
515
+ optional :employer, FinchAPI::BooleanModel, nil?: true
516
+
517
+ # @!attribute name
518
+ # The exact name of tax from the pay statement.
519
+ #
520
+ # @return [String, nil]
521
+ optional :name, String, nil?: true
522
+
523
+ # @!attribute type
524
+ # The type of taxes.
525
+ #
526
+ # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil]
527
+ optional :type,
528
+ enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type },
529
+ nil?: true
530
+
531
+ # @!parse
532
+ # # @param amount [Integer, nil]
533
+ # # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil]
534
+ # # @param currency [String, nil]
535
+ # # @param employer [Boolean, nil]
536
+ # # @param name [String, nil]
537
+ # # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil]
538
+ # #
539
+ # def initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil, **) = super
540
+
541
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
542
+
543
+ class Attributes < FinchAPI::BaseModel
544
+ # @!attribute [r] metadata
545
+ #
546
+ # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, nil]
547
+ optional :metadata,
548
+ -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata }
549
+
550
+ # @!parse
551
+ # # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata]
552
+ # attr_writer :metadata
553
+
554
+ # @!parse
555
+ # # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata]
556
+ # #
557
+ # def initialize(metadata: nil, **) = super
558
+
559
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
560
+
561
+ class Metadata < FinchAPI::BaseModel
562
+ # @!attribute [r] metadata
563
+ # The metadata to be attached to the entity by existing rules. It is a key-value
564
+ # pairs where the values can be of any type (string, number, boolean, object,
565
+ # array, etc.).
566
+ #
567
+ # @return [Hash{Symbol=>Object}, nil]
568
+ optional :metadata, FinchAPI::HashOf[FinchAPI::Unknown]
569
+
570
+ # @!parse
571
+ # # @return [Hash{Symbol=>Object}]
572
+ # attr_writer :metadata
573
+
574
+ # @!parse
575
+ # # @param metadata [Hash{Symbol=>Object}]
576
+ # #
577
+ # def initialize(metadata: nil, **) = super
578
+
579
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
580
+ end
581
+ end
582
+
583
+ # @abstract
584
+ #
585
+ # The type of taxes.
586
+ #
587
+ # @example
588
+ # ```ruby
589
+ # case type
590
+ # in :state
591
+ # # ...
592
+ # in :federal
593
+ # # ...
594
+ # in :local
595
+ # # ...
596
+ # in :fica
597
+ # # ...
598
+ # end
599
+ # ```
600
+ class Type < FinchAPI::Enum
601
+ STATE = :state
602
+ FEDERAL = :federal
603
+ LOCAL = :local
604
+ FICA = :fica
605
+
606
+ finalize!
607
+
608
+ # @!parse
609
+ # # @return [Array<Symbol>]
610
+ # #
611
+ # def self.values; end
612
+ end
613
+ end
614
+
615
+ # @abstract
616
+ #
617
+ # The type of the payment associated with the pay statement.
618
+ #
619
+ # @example
620
+ # ```ruby
621
+ # case type
622
+ # in :regular_payroll
623
+ # # ...
624
+ # in :off_cycle_payroll
625
+ # # ...
626
+ # in :one_time_payment
627
+ # # ...
628
+ # end
629
+ # ```
630
+ class Type < FinchAPI::Enum
631
+ REGULAR_PAYROLL = :regular_payroll
632
+ OFF_CYCLE_PAYROLL = :off_cycle_payroll
633
+ ONE_TIME_PAYMENT = :one_time_payment
634
+
635
+ finalize!
636
+
637
+ # @!parse
638
+ # # @return [Array<Symbol>]
639
+ # #
640
+ # def self.values; end
641
+ end
642
+ end
643
+ end
644
+ end
645
+ end
646
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ module FinchAPI
4
+ module Models
5
+ module Sandbox
6
+ class PaymentCreateResponse < FinchAPI::BaseModel
7
+ # @!attribute pay_date
8
+ # The date of the payment.
9
+ #
10
+ # @return [String]
11
+ required :pay_date, String
12
+
13
+ # @!attribute payment_id
14
+ # The ID of the payment.
15
+ #
16
+ # @return [String]
17
+ required :payment_id, String
18
+
19
+ # @!parse
20
+ # # @param pay_date [String]
21
+ # # @param payment_id [String]
22
+ # #
23
+ # def initialize(pay_date:, payment_id:, **) = super
24
+
25
+ # def initialize: (Hash | FinchAPI::BaseModel) -> void
26
+ end
27
+ end
28
+ end
29
+ end