finch-api 0.1.0.pre.alpha.19 → 0.1.0.pre.alpha.20

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 (288) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +37 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/finch_api/errors.rb +22 -0
  6. data/lib/finch_api/internal/individuals_page.rb +1 -1
  7. data/lib/finch_api/internal/page.rb +1 -1
  8. data/lib/finch_api/internal/type/array_of.rb +14 -1
  9. data/lib/finch_api/internal/type/base_model.rb +84 -25
  10. data/lib/finch_api/internal/type/boolean.rb +15 -1
  11. data/lib/finch_api/internal/type/converter.rb +42 -34
  12. data/lib/finch_api/internal/type/enum.rb +25 -2
  13. data/lib/finch_api/internal/type/file_input.rb +13 -1
  14. data/lib/finch_api/internal/type/hash_of.rb +14 -1
  15. data/lib/finch_api/internal/type/union.rb +27 -7
  16. data/lib/finch_api/internal/type/unknown.rb +15 -1
  17. data/lib/finch_api/internal/util.rb +62 -10
  18. data/lib/finch_api/internal.rb +3 -0
  19. data/lib/finch_api/models/account_update_event.rb +110 -109
  20. data/lib/finch_api/models/base_webhook_event.rb +1 -1
  21. data/lib/finch_api/models/company_event.rb +2 -2
  22. data/lib/finch_api/models/connect/session_new_params.rb +12 -12
  23. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +2 -2
  24. data/lib/finch_api/models/create_access_token_response.rb +7 -7
  25. data/lib/finch_api/models/directory_event.rb +4 -4
  26. data/lib/finch_api/models/employment_event.rb +4 -4
  27. data/lib/finch_api/models/hris/benefit_contribution.rb +3 -3
  28. data/lib/finch_api/models/hris/benefit_create_params.rb +11 -11
  29. data/lib/finch_api/models/hris/benefit_features_and_operations.rb +5 -120
  30. data/lib/finch_api/models/hris/benefit_type.rb +10 -10
  31. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +11 -11
  32. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +23 -23
  33. data/lib/finch_api/models/hris/benefits_support.rb +24 -24
  34. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +11 -11
  35. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +2 -2
  36. data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +18 -18
  37. data/lib/finch_api/models/hris/company.rb +23 -23
  38. data/lib/finch_api/models/hris/company_benefit.rb +12 -12
  39. data/lib/finch_api/models/hris/document_list_params.rb +2 -2
  40. data/lib/finch_api/models/hris/document_list_response.rb +4 -4
  41. data/lib/finch_api/models/hris/document_response.rb +4 -4
  42. data/lib/finch_api/models/hris/document_retreive_response.rb +1 -5
  43. data/lib/finch_api/models/hris/employment_data.rb +89 -100
  44. data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
  45. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +4 -3
  46. data/lib/finch_api/models/hris/individual.rb +20 -26
  47. data/lib/finch_api/models/hris/individual_in_directory.rb +6 -6
  48. data/lib/finch_api/models/hris/individual_response.rb +2 -2
  49. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +4 -4
  50. data/lib/finch_api/models/hris/pay_statement.rb +184 -182
  51. data/lib/finch_api/models/hris/pay_statement_data_sync_in_progress.rb +76 -0
  52. data/lib/finch_api/models/hris/pay_statement_response.rb +50 -8
  53. data/lib/finch_api/models/hris/pay_statement_response_body.rb +27 -9
  54. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +2 -2
  55. data/lib/finch_api/models/hris/payment.rb +37 -37
  56. data/lib/finch_api/models/hris/support_per_benefit_type.rb +4 -4
  57. data/lib/finch_api/models/hris/supported_benefit.rb +10 -9
  58. data/lib/finch_api/models/hris/w42005.rb +12 -12
  59. data/lib/finch_api/models/hris/w42020.rb +10 -10
  60. data/lib/finch_api/models/income.rb +8 -8
  61. data/lib/finch_api/models/individual_event.rb +4 -4
  62. data/lib/finch_api/models/introspection.rb +23 -23
  63. data/lib/finch_api/models/job_completion_event.rb +4 -4
  64. data/lib/finch_api/models/jobs/automated_async_job.rb +10 -10
  65. data/lib/finch_api/models/jobs/automated_create_params.rb +4 -4
  66. data/lib/finch_api/models/jobs/automated_list_response.rb +2 -2
  67. data/lib/finch_api/models/jobs/manual_async_job.rb +3 -3
  68. data/lib/finch_api/models/money.rb +4 -4
  69. data/lib/finch_api/models/operation_support_matrix.rb +9 -9
  70. data/lib/finch_api/models/pay_statement_event.rb +4 -4
  71. data/lib/finch_api/models/payment_event.rb +4 -4
  72. data/lib/finch_api/models/payroll/pay_group_list_response.rb +12 -12
  73. data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb +5 -5
  74. data/lib/finch_api/models/provider.rb +104 -104
  75. data/lib/finch_api/models/sandbox/company_update_params.rb +21 -21
  76. data/lib/finch_api/models/sandbox/company_update_response.rb +2 -2
  77. data/lib/finch_api/models/sandbox/connection_create_params.rb +2 -2
  78. data/lib/finch_api/models/sandbox/connections/account_create_params.rb +2 -2
  79. data/lib/finch_api/models/sandbox/connections/account_update_params.rb +2 -2
  80. data/lib/finch_api/models/sandbox/directory_create_params.rb +49 -48
  81. data/lib/finch_api/models/sandbox/employment_update_params.rb +24 -23
  82. data/lib/finch_api/models/sandbox/employment_update_response.rb +6 -6
  83. data/lib/finch_api/models/sandbox/individual_update_params.rb +16 -16
  84. data/lib/finch_api/models/sandbox/individual_update_response.rb +2 -2
  85. data/lib/finch_api/models/sandbox/job_create_params.rb +2 -2
  86. data/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +6 -6
  87. data/lib/finch_api/models/sandbox/payment_create_params.rb +160 -367
  88. data/lib/finch_api/models/webhook_event.rb +1 -16
  89. data/lib/finch_api/models.rb +30 -19
  90. data/lib/finch_api/resources/access_tokens.rb +1 -1
  91. data/lib/finch_api/resources/account.rb +2 -2
  92. data/lib/finch_api/resources/connect/sessions.rb +5 -5
  93. data/lib/finch_api/resources/hris/benefits/individuals.rb +4 -4
  94. data/lib/finch_api/resources/hris/benefits.rb +9 -9
  95. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +3 -3
  96. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +1 -1
  97. data/lib/finch_api/resources/hris/company.rb +1 -1
  98. data/lib/finch_api/resources/hris/directory.rb +1 -1
  99. data/lib/finch_api/resources/hris/documents.rb +2 -2
  100. data/lib/finch_api/resources/hris/employments.rb +2 -2
  101. data/lib/finch_api/resources/hris/individuals.rb +3 -3
  102. data/lib/finch_api/resources/hris/pay_statements.rb +2 -2
  103. data/lib/finch_api/resources/hris/payments.rb +1 -1
  104. data/lib/finch_api/resources/jobs/automated.rb +3 -3
  105. data/lib/finch_api/resources/jobs/manual.rb +1 -1
  106. data/lib/finch_api/resources/providers.rb +1 -1
  107. data/lib/finch_api/resources/sandbox/company.rb +4 -4
  108. data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -2
  109. data/lib/finch_api/resources/sandbox/connections.rb +1 -1
  110. data/lib/finch_api/resources/sandbox/directory.rb +1 -1
  111. data/lib/finch_api/resources/sandbox/employment.rb +8 -8
  112. data/lib/finch_api/resources/sandbox/individual.rb +5 -5
  113. data/lib/finch_api/resources/sandbox/jobs/configuration.rb +4 -4
  114. data/lib/finch_api/resources/sandbox/jobs.rb +1 -1
  115. data/lib/finch_api/resources/sandbox/payment.rb +6 -3
  116. data/lib/finch_api/version.rb +1 -1
  117. data/lib/finch_api.rb +4 -2
  118. data/rbi/finch_api/errors.rbi +16 -0
  119. data/rbi/finch_api/internal/type/array_of.rbi +6 -0
  120. data/rbi/finch_api/internal/type/base_model.rbi +5 -0
  121. data/rbi/finch_api/internal/type/boolean.rbi +8 -0
  122. data/rbi/finch_api/internal/type/converter.rbi +15 -15
  123. data/rbi/finch_api/internal/type/enum.rbi +5 -0
  124. data/rbi/finch_api/internal/type/file_input.rbi +5 -0
  125. data/rbi/finch_api/internal/type/hash_of.rbi +6 -0
  126. data/rbi/finch_api/internal/type/union.rbi +10 -0
  127. data/rbi/finch_api/internal/type/unknown.rbi +8 -0
  128. data/rbi/finch_api/internal/util.rbi +36 -0
  129. data/rbi/finch_api/internal.rbi +3 -0
  130. data/rbi/finch_api/models/connect/session_new_params.rbi +4 -4
  131. data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +4 -296
  132. data/rbi/finch_api/models/hris/benefit_type.rbi +16 -16
  133. data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +18 -33
  134. data/rbi/finch_api/models/hris/employment_data.rbi +123 -141
  135. data/rbi/finch_api/models/hris/employment_data_response.rbi +2 -13
  136. data/rbi/finch_api/models/hris/individual_response.rbi +2 -13
  137. data/rbi/finch_api/models/hris/pay_statement.rbi +275 -307
  138. data/rbi/finch_api/models/hris/pay_statement_data_sync_in_progress.rbi +188 -0
  139. data/rbi/finch_api/models/hris/pay_statement_response.rbi +84 -20
  140. data/rbi/finch_api/models/hris/pay_statement_response_body.rbi +45 -17
  141. data/rbi/finch_api/models/hris/payment.rbi +27 -30
  142. data/rbi/finch_api/models/hris/supported_benefit.rbi +12 -8
  143. data/rbi/finch_api/models/income.rbi +3 -3
  144. data/rbi/finch_api/models/money.rbi +4 -7
  145. data/rbi/finch_api/models/payroll/pay_group_list_response.rbi +25 -43
  146. data/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +14 -14
  147. data/rbi/finch_api/models/sandbox/payment_create_params.rbi +463 -727
  148. data/rbi/finch_api/resources/connect/sessions.rbi +2 -2
  149. data/rbi/finch_api/resources/hris/benefits.rbi +1 -3
  150. data/rbi/finch_api/resources/hris/documents.rbi +1 -1
  151. data/rbi/finch_api/resources/sandbox/payment.rbi +3 -2
  152. data/sig/finch_api/errors.rbs +9 -0
  153. data/sig/finch_api/internal/type/array_of.rbs +3 -0
  154. data/sig/finch_api/internal/type/base_model.rbs +2 -0
  155. data/sig/finch_api/internal/type/boolean.rbs +3 -0
  156. data/sig/finch_api/internal/type/converter.rbs +7 -1
  157. data/sig/finch_api/internal/type/enum.rbs +2 -0
  158. data/sig/finch_api/internal/type/file_input.rbs +2 -0
  159. data/sig/finch_api/internal/type/hash_of.rbs +3 -0
  160. data/sig/finch_api/internal/type/union.rbs +2 -0
  161. data/sig/finch_api/internal/type/unknown.rbs +3 -0
  162. data/sig/finch_api/internal/util.rbs +12 -0
  163. data/sig/finch_api/internal.rbs +2 -0
  164. data/sig/finch_api/models/access_token_create_params.rbs +8 -0
  165. data/sig/finch_api/models/account_disconnect_params.rbs +2 -0
  166. data/sig/finch_api/models/account_introspect_params.rbs +2 -0
  167. data/sig/finch_api/models/account_update_event.rbs +230 -12
  168. data/sig/finch_api/models/base_webhook_event.rbs +6 -0
  169. data/sig/finch_api/models/company_event.rbs +11 -6
  170. data/sig/finch_api/models/connect/session_new_params.rbs +26 -8
  171. data/sig/finch_api/models/connect/session_new_response.rbs +2 -0
  172. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +12 -4
  173. data/sig/finch_api/models/connect/session_reauthenticate_response.rbs +2 -0
  174. data/sig/finch_api/models/create_access_token_response.rbs +21 -8
  175. data/sig/finch_api/models/directory_event.rbs +13 -6
  176. data/sig/finch_api/models/disconnect_response.rbs +2 -0
  177. data/sig/finch_api/models/employment_event.rbs +13 -6
  178. data/sig/finch_api/models/hris/benefit_contribution.rbs +12 -4
  179. data/sig/finch_api/models/hris/benefit_create_params.rbs +21 -6
  180. data/sig/finch_api/models/hris/benefit_features_and_operations.rbs +9 -78
  181. data/sig/finch_api/models/hris/benefit_list_params.rbs +2 -0
  182. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +2 -0
  183. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +2 -0
  184. data/sig/finch_api/models/hris/benefit_type.rbs +21 -21
  185. data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -0
  186. data/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +2 -0
  187. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +18 -4
  188. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +47 -18
  189. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +2 -0
  190. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbs +5 -0
  191. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +5 -0
  192. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +5 -0
  193. data/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +2 -0
  194. data/sig/finch_api/models/hris/benefits_support.rbs +15 -0
  195. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +23 -6
  196. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +20 -0
  197. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +2 -0
  198. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +21 -0
  199. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +2 -0
  200. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +20 -0
  201. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +5 -0
  202. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +20 -0
  203. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +15 -6
  204. data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +23 -20
  205. data/sig/finch_api/models/hris/company.rbs +44 -12
  206. data/sig/finch_api/models/hris/company_benefit.rbs +21 -6
  207. data/sig/finch_api/models/hris/company_retrieve_params.rbs +2 -0
  208. data/sig/finch_api/models/hris/create_company_benefits_response.rbs +2 -0
  209. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +6 -0
  210. data/sig/finch_api/models/hris/directory_list_params.rbs +6 -0
  211. data/sig/finch_api/models/hris/document_list_params.rbs +14 -6
  212. data/sig/finch_api/models/hris/document_list_response.rbs +5 -0
  213. data/sig/finch_api/models/hris/document_response.rbs +14 -6
  214. data/sig/finch_api/models/hris/document_retreive_params.rbs +2 -0
  215. data/sig/finch_api/models/hris/employment_data.rbs +91 -47
  216. data/sig/finch_api/models/hris/employment_data_response.rbs +6 -0
  217. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +7 -0
  218. data/sig/finch_api/models/hris/individual.rbs +49 -16
  219. data/sig/finch_api/models/hris/individual_in_directory.rbs +14 -0
  220. data/sig/finch_api/models/hris/individual_response.rbs +6 -0
  221. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +10 -0
  222. data/sig/finch_api/models/hris/pay_statement.rbs +179 -133
  223. data/sig/finch_api/models/hris/pay_statement_data_sync_in_progress.rbs +78 -0
  224. data/sig/finch_api/models/hris/pay_statement_response.rbs +51 -13
  225. data/sig/finch_api/models/hris/pay_statement_response_body.rbs +24 -11
  226. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +11 -0
  227. data/sig/finch_api/models/hris/payment.rbs +44 -29
  228. data/sig/finch_api/models/hris/payment_list_params.rbs +6 -0
  229. data/sig/finch_api/models/hris/support_per_benefit_type.rbs +5 -0
  230. data/sig/finch_api/models/hris/supported_benefit.rbs +22 -12
  231. data/sig/finch_api/models/hris/update_company_benefit_response.rbs +2 -0
  232. data/sig/finch_api/models/hris/w42005.rbs +30 -16
  233. data/sig/finch_api/models/hris/w42020.rbs +27 -10
  234. data/sig/finch_api/models/income.rbs +14 -7
  235. data/sig/finch_api/models/individual_event.rbs +13 -6
  236. data/sig/finch_api/models/introspection.rbs +51 -14
  237. data/sig/finch_api/models/job_completion_event.rbs +13 -6
  238. data/sig/finch_api/models/jobs/automated_async_job.rbs +22 -8
  239. data/sig/finch_api/models/jobs/automated_create_params.rbs +8 -0
  240. data/sig/finch_api/models/jobs/automated_create_response.rbs +7 -0
  241. data/sig/finch_api/models/jobs/automated_list_params.rbs +6 -0
  242. data/sig/finch_api/models/jobs/automated_list_response.rbs +18 -0
  243. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +2 -0
  244. data/sig/finch_api/models/jobs/manual_async_job.rbs +10 -4
  245. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +2 -0
  246. data/sig/finch_api/models/location.rbs +11 -0
  247. data/sig/finch_api/models/money.rbs +3 -3
  248. data/sig/finch_api/models/operation_support_matrix.rbs +7 -0
  249. data/sig/finch_api/models/paging.rbs +2 -0
  250. data/sig/finch_api/models/pay_statement_event.rbs +13 -6
  251. data/sig/finch_api/models/payment_event.rbs +13 -6
  252. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +6 -0
  253. data/sig/finch_api/models/payroll/pay_group_list_response.rbs +22 -24
  254. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +2 -0
  255. data/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +17 -10
  256. data/sig/finch_api/models/provider.rbs +227 -6
  257. data/sig/finch_api/models/provider_list_params.rbs +2 -0
  258. data/sig/finch_api/models/request_forwarding_forward_params.rbs +9 -0
  259. data/sig/finch_api/models/request_forwarding_forward_response.rbs +15 -0
  260. data/sig/finch_api/models/sandbox/company_update_params.rbs +44 -12
  261. data/sig/finch_api/models/sandbox/company_update_response.rbs +31 -0
  262. data/sig/finch_api/models/sandbox/connection_create_params.rbs +8 -0
  263. data/sig/finch_api/models/sandbox/connection_create_response.rbs +11 -0
  264. data/sig/finch_api/models/sandbox/connections/account_create_params.rbs +8 -0
  265. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +10 -0
  266. data/sig/finch_api/models/sandbox/connections/account_update_params.rbs +5 -0
  267. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +9 -0
  268. data/sig/finch_api/models/sandbox/directory_create_params.rbs +84 -28
  269. data/sig/finch_api/models/sandbox/employment_update_params.rbs +41 -8
  270. data/sig/finch_api/models/sandbox/employment_update_response.rbs +33 -0
  271. data/sig/finch_api/models/sandbox/individual_update_params.rbs +34 -8
  272. data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
  273. data/sig/finch_api/models/sandbox/job_create_params.rbs +5 -0
  274. data/sig/finch_api/models/sandbox/job_create_response.rbs +7 -0
  275. data/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +2 -0
  276. data/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +2 -0
  277. data/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +13 -8
  278. data/sig/finch_api/models/sandbox/payment_create_params.rbs +287 -228
  279. data/sig/finch_api/models/sandbox/payment_create_response.rbs +2 -0
  280. data/sig/finch_api/resources/connect/sessions.rbs +2 -2
  281. data/sig/finch_api/resources/hris/benefits.rbs +1 -1
  282. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -1
  283. data/sig/finch_api/resources/hris/documents.rbs +1 -1
  284. data/sig/finch_api/resources/sandbox/payment.rbs +2 -2
  285. metadata +5 -5
  286. data/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +0 -110
  287. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +0 -290
  288. data/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +0 -79
@@ -13,7 +13,7 @@ module FinchAPI
13
13
  # @!attribute authentication_methods
14
14
  # The list of authentication methods supported by the provider.
15
15
  #
16
- # @return [Array<FinchAPI::Provider::AuthenticationMethod>, nil]
16
+ # @return [Array<FinchAPI::Models::Provider::AuthenticationMethod>, nil]
17
17
  optional :authentication_methods,
18
18
  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Provider::AuthenticationMethod] }
19
19
 
@@ -68,12 +68,12 @@ module FinchAPI
68
68
  optional :products, FinchAPI::Internal::Type::ArrayOf[String]
69
69
 
70
70
  # @!method initialize(id: nil, authentication_methods: nil, beta: nil, display_name: nil, icon: nil, logo: nil, manual: nil, mfa_required: nil, primary_color: nil, products: nil)
71
- # Some parameter documentations has been truncated, see {FinchAPI::Provider} for
72
- # more details.
71
+ # Some parameter documentations has been truncated, see
72
+ # {FinchAPI::Models::Provider} for more details.
73
73
  #
74
74
  # @param id [String] The id of the payroll provider used in Connect.
75
75
  #
76
- # @param authentication_methods [Array<FinchAPI::Provider::AuthenticationMethod>] The list of authentication methods supported by the provider.
76
+ # @param authentication_methods [Array<FinchAPI::Models::Provider::AuthenticationMethod>] The list of authentication methods supported by the provider.
77
77
  #
78
78
  # @param beta [Boolean] `true` if the integration is in a beta state, `false` otherwise
79
79
  #
@@ -96,13 +96,13 @@ module FinchAPI
96
96
  # Each benefit type and their supported features. If the benefit type is not
97
97
  # supported, the property will be null
98
98
  #
99
- # @return [FinchAPI::HRIS::BenefitsSupport, nil]
99
+ # @return [FinchAPI::Models::HRIS::BenefitsSupport, nil]
100
100
  optional :benefits_support, -> { FinchAPI::HRIS::BenefitsSupport }, nil?: true
101
101
 
102
102
  # @!attribute supported_fields
103
103
  # The supported data fields returned by our HR and payroll endpoints
104
104
  #
105
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields, nil]
105
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, nil]
106
106
  optional :supported_fields,
107
107
  -> {
108
108
  FinchAPI::Provider::AuthenticationMethod::SupportedFields
@@ -112,49 +112,49 @@ module FinchAPI
112
112
  # @!attribute type
113
113
  # The type of authentication method.
114
114
  #
115
- # @return [Symbol, FinchAPI::Provider::AuthenticationMethod::Type, nil]
115
+ # @return [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type, nil]
116
116
  optional :type, enum: -> { FinchAPI::Provider::AuthenticationMethod::Type }
117
117
 
118
118
  # @!method initialize(benefits_support: nil, supported_fields: nil, type: nil)
119
119
  # Some parameter documentations has been truncated, see
120
- # {FinchAPI::Provider::AuthenticationMethod} for more details.
120
+ # {FinchAPI::Models::Provider::AuthenticationMethod} for more details.
121
121
  #
122
- # @param benefits_support [FinchAPI::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo
122
+ # @param benefits_support [FinchAPI::Models::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo
123
123
  #
124
- # @param supported_fields [FinchAPI::Provider::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints
124
+ # @param supported_fields [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints
125
125
  #
126
- # @param type [Symbol, FinchAPI::Provider::AuthenticationMethod::Type] The type of authentication method.
126
+ # @param type [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type] The type of authentication method.
127
127
 
128
- # @see FinchAPI::Provider::AuthenticationMethod#supported_fields
128
+ # @see FinchAPI::Models::Provider::AuthenticationMethod#supported_fields
129
129
  class SupportedFields < FinchAPI::Internal::Type::BaseModel
130
130
  # @!attribute company
131
131
  #
132
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company, nil]
132
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, nil]
133
133
  optional :company, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company }
134
134
 
135
135
  # @!attribute directory
136
136
  #
137
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory, nil]
137
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, nil]
138
138
  optional :directory, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory }
139
139
 
140
140
  # @!attribute employment
141
141
  #
142
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment, nil]
142
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, nil]
143
143
  optional :employment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment }
144
144
 
145
145
  # @!attribute individual
146
146
  #
147
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual, nil]
147
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, nil]
148
148
  optional :individual, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual }
149
149
 
150
150
  # @!attribute pay_group
151
151
  #
152
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil]
152
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil]
153
153
  optional :pay_group, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup }
154
154
 
155
155
  # @!attribute pay_statement
156
156
  #
157
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil]
157
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil]
158
158
  optional :pay_statement,
159
159
  -> {
160
160
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement
@@ -162,21 +162,21 @@ module FinchAPI
162
162
 
163
163
  # @!attribute payment
164
164
  #
165
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment, nil]
165
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, nil]
166
166
  optional :payment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment }
167
167
 
168
168
  # @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil)
169
169
  # The supported data fields returned by our HR and payroll endpoints
170
170
  #
171
- # @param company [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company]
172
- # @param directory [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory]
173
- # @param employment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment]
174
- # @param individual [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual]
175
- # @param pay_group [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup]
176
- # @param pay_statement [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement]
177
- # @param payment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment]
178
-
179
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#company
171
+ # @param company [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company]
172
+ # @param directory [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory]
173
+ # @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment]
174
+ # @param individual [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual]
175
+ # @param pay_group [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup]
176
+ # @param pay_statement [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement]
177
+ # @param payment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment]
178
+
179
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#company
180
180
  class Company < FinchAPI::Internal::Type::BaseModel
181
181
  # @!attribute id
182
182
  #
@@ -185,7 +185,7 @@ module FinchAPI
185
185
 
186
186
  # @!attribute accounts
187
187
  #
188
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
188
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
189
189
  optional :accounts,
190
190
  -> {
191
191
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts
@@ -193,7 +193,7 @@ module FinchAPI
193
193
 
194
194
  # @!attribute departments
195
195
  #
196
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil]
196
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil]
197
197
  optional :departments,
198
198
  -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments }
199
199
 
@@ -204,7 +204,7 @@ module FinchAPI
204
204
 
205
205
  # @!attribute entity
206
206
  #
207
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil]
207
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil]
208
208
  optional :entity,
209
209
  -> {
210
210
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity
@@ -217,7 +217,7 @@ module FinchAPI
217
217
 
218
218
  # @!attribute locations
219
219
  #
220
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil]
220
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil]
221
221
  optional :locations,
222
222
  -> {
223
223
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations
@@ -235,16 +235,16 @@ module FinchAPI
235
235
 
236
236
  # @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil)
237
237
  # @param id [Boolean]
238
- # @param accounts [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts]
239
- # @param departments [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments]
238
+ # @param accounts [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts]
239
+ # @param departments [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments]
240
240
  # @param ein [Boolean]
241
- # @param entity [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity]
241
+ # @param entity [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity]
242
242
  # @param legal_name [Boolean]
243
- # @param locations [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations]
243
+ # @param locations [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations]
244
244
  # @param primary_email [Boolean]
245
245
  # @param primary_phone_number [Boolean]
246
246
 
247
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#accounts
247
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#accounts
248
248
  class Accounts < FinchAPI::Internal::Type::BaseModel
249
249
  # @!attribute account_name
250
250
  #
@@ -279,7 +279,7 @@ module FinchAPI
279
279
  # @param routing_number [Boolean]
280
280
  end
281
281
 
282
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#departments
282
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#departments
283
283
  class Departments < FinchAPI::Internal::Type::BaseModel
284
284
  # @!attribute name
285
285
  #
@@ -288,7 +288,7 @@ module FinchAPI
288
288
 
289
289
  # @!attribute parent
290
290
  #
291
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
291
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
292
292
  optional :parent,
293
293
  -> {
294
294
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent
@@ -296,9 +296,9 @@ module FinchAPI
296
296
 
297
297
  # @!method initialize(name: nil, parent: nil)
298
298
  # @param name [Boolean]
299
- # @param parent [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent]
299
+ # @param parent [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent]
300
300
 
301
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent
301
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent
302
302
  class Parent < FinchAPI::Internal::Type::BaseModel
303
303
  # @!attribute name
304
304
  #
@@ -310,7 +310,7 @@ module FinchAPI
310
310
  end
311
311
  end
312
312
 
313
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#entity
313
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#entity
314
314
  class Entity < FinchAPI::Internal::Type::BaseModel
315
315
  # @!attribute subtype
316
316
  #
@@ -327,7 +327,7 @@ module FinchAPI
327
327
  # @param type [Boolean]
328
328
  end
329
329
 
330
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#locations
330
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#locations
331
331
  class Locations < FinchAPI::Internal::Type::BaseModel
332
332
  # @!attribute city
333
333
  #
@@ -369,27 +369,27 @@ module FinchAPI
369
369
  end
370
370
  end
371
371
 
372
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#directory
372
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#directory
373
373
  class Directory < FinchAPI::Internal::Type::BaseModel
374
374
  # @!attribute individuals
375
375
  #
376
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
376
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
377
377
  optional :individuals,
378
378
  -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals }
379
379
 
380
380
  # @!attribute paging
381
381
  #
382
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
382
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
383
383
  optional :paging,
384
384
  -> {
385
385
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging
386
386
  }
387
387
 
388
388
  # @!method initialize(individuals: nil, paging: nil)
389
- # @param individuals [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals]
390
- # @param paging [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging]
389
+ # @param individuals [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals]
390
+ # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging]
391
391
 
392
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory#individuals
392
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#individuals
393
393
  class Individuals < FinchAPI::Internal::Type::BaseModel
394
394
  # @!attribute id
395
395
  #
@@ -418,7 +418,7 @@ module FinchAPI
418
418
 
419
419
  # @!attribute manager
420
420
  #
421
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
421
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
422
422
  optional :manager,
423
423
  -> {
424
424
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager
@@ -435,10 +435,10 @@ module FinchAPI
435
435
  # @param first_name [Boolean]
436
436
  # @param is_active [Boolean]
437
437
  # @param last_name [Boolean]
438
- # @param manager [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager]
438
+ # @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager]
439
439
  # @param middle_name [Boolean]
440
440
 
441
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager
441
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager
442
442
  class Manager < FinchAPI::Internal::Type::BaseModel
443
443
  # @!attribute id
444
444
  #
@@ -450,7 +450,7 @@ module FinchAPI
450
450
  end
451
451
  end
452
452
 
453
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory#paging
453
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#paging
454
454
  class Paging < FinchAPI::Internal::Type::BaseModel
455
455
  # @!attribute count
456
456
  #
@@ -468,7 +468,7 @@ module FinchAPI
468
468
  end
469
469
  end
470
470
 
471
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#employment
471
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#employment
472
472
  class Employment < FinchAPI::Internal::Type::BaseModel
473
473
  # @!attribute id
474
474
  #
@@ -487,13 +487,13 @@ module FinchAPI
487
487
 
488
488
  # @!attribute department
489
489
  #
490
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil]
490
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil]
491
491
  optional :department,
492
492
  -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department }
493
493
 
494
494
  # @!attribute employment
495
495
  #
496
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
496
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
497
497
  optional :employment,
498
498
  -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment }
499
499
 
@@ -514,7 +514,7 @@ module FinchAPI
514
514
 
515
515
  # @!attribute income
516
516
  #
517
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil]
517
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil]
518
518
  optional :income,
519
519
  -> {
520
520
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income
@@ -537,7 +537,7 @@ module FinchAPI
537
537
 
538
538
  # @!attribute location
539
539
  #
540
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil]
540
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil]
541
541
  optional :location,
542
542
  -> {
543
543
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location
@@ -545,7 +545,7 @@ module FinchAPI
545
545
 
546
546
  # @!attribute manager
547
547
  #
548
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
548
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
549
549
  optional :manager,
550
550
  -> {
551
551
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager
@@ -570,22 +570,22 @@ module FinchAPI
570
570
  # @param id [Boolean]
571
571
  # @param class_code [Boolean]
572
572
  # @param custom_fields [Boolean]
573
- # @param department [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department]
574
- # @param employment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment]
573
+ # @param department [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department]
574
+ # @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment]
575
575
  # @param employment_status [Boolean]
576
576
  # @param end_date [Boolean]
577
577
  # @param first_name [Boolean]
578
- # @param income [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income]
578
+ # @param income [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income]
579
579
  # @param income_history [Boolean]
580
580
  # @param is_active [Boolean]
581
581
  # @param last_name [Boolean]
582
- # @param location [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location]
583
- # @param manager [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager]
582
+ # @param location [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location]
583
+ # @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager]
584
584
  # @param middle_name [Boolean]
585
585
  # @param start_date [Boolean]
586
586
  # @param title [Boolean]
587
587
 
588
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#department
588
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#department
589
589
  class Department < FinchAPI::Internal::Type::BaseModel
590
590
  # @!attribute name
591
591
  #
@@ -596,7 +596,7 @@ module FinchAPI
596
596
  # @param name [Boolean]
597
597
  end
598
598
 
599
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#employment
599
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#employment
600
600
  class Employment < FinchAPI::Internal::Type::BaseModel
601
601
  # @!attribute subtype
602
602
  #
@@ -613,7 +613,7 @@ module FinchAPI
613
613
  # @param type [Boolean]
614
614
  end
615
615
 
616
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#income
616
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#income
617
617
  class Income < FinchAPI::Internal::Type::BaseModel
618
618
  # @!attribute amount
619
619
  #
@@ -636,7 +636,7 @@ module FinchAPI
636
636
  # @param unit [Boolean]
637
637
  end
638
638
 
639
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#location
639
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#location
640
640
  class Location < FinchAPI::Internal::Type::BaseModel
641
641
  # @!attribute city
642
642
  #
@@ -677,7 +677,7 @@ module FinchAPI
677
677
  # @param state [Boolean]
678
678
  end
679
679
 
680
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#manager
680
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#manager
681
681
  class Manager < FinchAPI::Internal::Type::BaseModel
682
682
  # @!attribute id
683
683
  #
@@ -689,7 +689,7 @@ module FinchAPI
689
689
  end
690
690
  end
691
691
 
692
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#individual
692
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#individual
693
693
  class Individual < FinchAPI::Internal::Type::BaseModel
694
694
  # @!attribute id
695
695
  #
@@ -703,7 +703,7 @@ module FinchAPI
703
703
 
704
704
  # @!attribute emails
705
705
  #
706
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
706
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
707
707
  optional :emails,
708
708
  -> {
709
709
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails
@@ -741,7 +741,7 @@ module FinchAPI
741
741
 
742
742
  # @!attribute phone_numbers
743
743
  #
744
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
744
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
745
745
  optional :phone_numbers,
746
746
  -> {
747
747
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers
@@ -754,7 +754,7 @@ module FinchAPI
754
754
 
755
755
  # @!attribute residence
756
756
  #
757
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
757
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
758
758
  optional :residence,
759
759
  -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence }
760
760
 
@@ -766,19 +766,19 @@ module FinchAPI
766
766
  # @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil)
767
767
  # @param id [Boolean]
768
768
  # @param dob [Boolean]
769
- # @param emails [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails]
769
+ # @param emails [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails]
770
770
  # @param encrypted_ssn [Boolean]
771
771
  # @param ethnicity [Boolean]
772
772
  # @param first_name [Boolean]
773
773
  # @param gender [Boolean]
774
774
  # @param last_name [Boolean]
775
775
  # @param middle_name [Boolean]
776
- # @param phone_numbers [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers]
776
+ # @param phone_numbers [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers]
777
777
  # @param preferred_name [Boolean]
778
- # @param residence [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence]
778
+ # @param residence [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence]
779
779
  # @param ssn [Boolean]
780
780
 
781
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#emails
781
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#emails
782
782
  class Emails < FinchAPI::Internal::Type::BaseModel
783
783
  # @!attribute data
784
784
  #
@@ -795,7 +795,7 @@ module FinchAPI
795
795
  # @param type [Boolean]
796
796
  end
797
797
 
798
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers
798
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers
799
799
  class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
800
800
  # @!attribute data
801
801
  #
@@ -812,7 +812,7 @@ module FinchAPI
812
812
  # @param type [Boolean]
813
813
  end
814
814
 
815
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#residence
815
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#residence
816
816
  class Residence < FinchAPI::Internal::Type::BaseModel
817
817
  # @!attribute city
818
818
  #
@@ -854,7 +854,7 @@ module FinchAPI
854
854
  end
855
855
  end
856
856
 
857
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#pay_group
857
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_group
858
858
  class PayGroup < FinchAPI::Internal::Type::BaseModel
859
859
  # @!attribute id
860
860
  #
@@ -883,11 +883,11 @@ module FinchAPI
883
883
  # @param pay_frequencies [Boolean]
884
884
  end
885
885
 
886
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#pay_statement
886
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_statement
887
887
  class PayStatement < FinchAPI::Internal::Type::BaseModel
888
888
  # @!attribute paging
889
889
  #
890
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
890
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
891
891
  optional :paging,
892
892
  -> {
893
893
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging
@@ -895,17 +895,17 @@ module FinchAPI
895
895
 
896
896
  # @!attribute pay_statements
897
897
  #
898
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
898
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
899
899
  optional :pay_statements,
900
900
  -> {
901
901
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements
902
902
  }
903
903
 
904
904
  # @!method initialize(paging: nil, pay_statements: nil)
905
- # @param paging [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging]
906
- # @param pay_statements [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements]
905
+ # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging]
906
+ # @param pay_statements [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements]
907
907
 
908
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging
908
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging
909
909
  class Paging < FinchAPI::Internal::Type::BaseModel
910
910
  # @!attribute count
911
911
  #
@@ -922,11 +922,11 @@ module FinchAPI
922
922
  # @param offset [Boolean]
923
923
  end
924
924
 
925
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements
925
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements
926
926
  class PayStatements < FinchAPI::Internal::Type::BaseModel
927
927
  # @!attribute earnings
928
928
  #
929
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
929
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
930
930
  optional :earnings,
931
931
  -> {
932
932
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings
@@ -934,7 +934,7 @@ module FinchAPI
934
934
 
935
935
  # @!attribute employee_deductions
936
936
  #
937
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
937
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
938
938
  optional :employee_deductions,
939
939
  -> {
940
940
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions
@@ -942,7 +942,7 @@ module FinchAPI
942
942
 
943
943
  # @!attribute employer_contributions
944
944
  #
945
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
945
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
946
946
  optional :employer_contributions,
947
947
  -> {
948
948
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions
@@ -970,7 +970,7 @@ module FinchAPI
970
970
 
971
971
  # @!attribute taxes
972
972
  #
973
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
973
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
974
974
  optional :taxes,
975
975
  -> {
976
976
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes
@@ -987,18 +987,18 @@ module FinchAPI
987
987
  optional :type, FinchAPI::Internal::Type::Boolean
988
988
 
989
989
  # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
990
- # @param earnings [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings]
991
- # @param employee_deductions [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions]
992
- # @param employer_contributions [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions]
990
+ # @param earnings [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings]
991
+ # @param employee_deductions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions]
992
+ # @param employer_contributions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions]
993
993
  # @param gross_pay [Boolean]
994
994
  # @param individual_id [Boolean]
995
995
  # @param net_pay [Boolean]
996
996
  # @param payment_method [Boolean]
997
- # @param taxes [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes]
997
+ # @param taxes [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes]
998
998
  # @param total_hours [Boolean]
999
999
  # @param type [Boolean]
1000
1000
 
1001
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings
1001
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings
1002
1002
  class Earnings < FinchAPI::Internal::Type::BaseModel
1003
1003
  # @!attribute amount
1004
1004
  #
@@ -1027,7 +1027,7 @@ module FinchAPI
1027
1027
  # @param type [Boolean]
1028
1028
  end
1029
1029
 
1030
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions
1030
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions
1031
1031
  class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
1032
1032
  # @!attribute amount
1033
1033
  #
@@ -1062,7 +1062,7 @@ module FinchAPI
1062
1062
  # @param type [Boolean]
1063
1063
  end
1064
1064
 
1065
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions
1065
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions
1066
1066
  class EmployerContributions < FinchAPI::Internal::Type::BaseModel
1067
1067
  # @!attribute amount
1068
1068
  #
@@ -1085,7 +1085,7 @@ module FinchAPI
1085
1085
  # @param name [Boolean]
1086
1086
  end
1087
1087
 
1088
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes
1088
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes
1089
1089
  class Taxes < FinchAPI::Internal::Type::BaseModel
1090
1090
  # @!attribute amount
1091
1091
  #
@@ -1122,7 +1122,7 @@ module FinchAPI
1122
1122
  end
1123
1123
  end
1124
1124
 
1125
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#payment
1125
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#payment
1126
1126
  class Payment < FinchAPI::Internal::Type::BaseModel
1127
1127
  # @!attribute id
1128
1128
  #
@@ -1181,7 +1181,7 @@ module FinchAPI
1181
1181
 
1182
1182
  # @!attribute pay_period
1183
1183
  #
1184
- # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
1184
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
1185
1185
  optional :pay_period,
1186
1186
  -> {
1187
1187
  FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod
@@ -1199,9 +1199,9 @@ module FinchAPI
1199
1199
  # @param pay_date [Boolean]
1200
1200
  # @param pay_frequencies [Boolean]
1201
1201
  # @param pay_group_ids [Boolean]
1202
- # @param pay_period [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod]
1202
+ # @param pay_period [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod]
1203
1203
 
1204
- # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period
1204
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period
1205
1205
  class PayPeriod < FinchAPI::Internal::Type::BaseModel
1206
1206
  # @!attribute end_date
1207
1207
  #
@@ -1222,7 +1222,7 @@ module FinchAPI
1222
1222
 
1223
1223
  # The type of authentication method.
1224
1224
  #
1225
- # @see FinchAPI::Provider::AuthenticationMethod#type
1225
+ # @see FinchAPI::Models::Provider::AuthenticationMethod#type
1226
1226
  module Type
1227
1227
  extend FinchAPI::Internal::Type::Enum
1228
1228