finch-api 0.1.0.pre.alpha.29 → 0.1.0.pre.alpha.31

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 (211) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +49 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/errors.rb +25 -11
  5. data/lib/finch_api/file_part.rb +10 -7
  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/responses_page.rb +1 -1
  9. data/lib/finch_api/internal/single_page.rb +1 -1
  10. data/lib/finch_api/internal/transport/base_client.rb +11 -7
  11. data/lib/finch_api/internal/transport/pooled_net_requester.rb +34 -31
  12. data/lib/finch_api/internal/type/base_page.rb +1 -1
  13. data/lib/finch_api/internal/type/file_input.rb +7 -4
  14. data/lib/finch_api/internal/util.rb +8 -7
  15. data/lib/finch_api/models/access_token_create_params.rb +13 -13
  16. data/lib/finch_api/models/connect/session_new_params.rb +66 -50
  17. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +10 -10
  18. data/lib/finch_api/models/create_access_token_response.rb +9 -1
  19. data/lib/finch_api/models/hris/benefit_contribution.rb +124 -29
  20. data/lib/finch_api/models/hris/benefit_create_params.rb +9 -1
  21. data/lib/finch_api/models/hris/benefit_list_params.rb +9 -1
  22. data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +9 -1
  23. data/lib/finch_api/models/hris/benefit_retrieve_params.rb +9 -1
  24. data/lib/finch_api/models/hris/benefit_update_params.rb +9 -1
  25. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +222 -6
  26. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +40 -2
  27. data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +9 -1
  28. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +9 -1
  29. data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +9 -1
  30. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +9 -1
  31. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +9 -1
  32. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_params.rb +9 -1
  33. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +10 -1
  34. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +9 -1
  35. data/lib/finch_api/models/hris/company_retrieve_params.rb +9 -1
  36. data/lib/finch_api/models/hris/directory_list_individuals_params.rb +9 -1
  37. data/lib/finch_api/models/hris/directory_list_params.rb +9 -1
  38. data/lib/finch_api/models/hris/document_list_params.rb +9 -1
  39. data/lib/finch_api/models/hris/document_response.rb +11 -11
  40. data/lib/finch_api/models/hris/document_retreive_params.rb +9 -1
  41. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +9 -1
  42. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +11 -1
  43. data/lib/finch_api/models/hris/pay_statement.rb +53 -103
  44. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +9 -1
  45. data/lib/finch_api/models/hris/payment_list_params.rb +9 -1
  46. data/lib/finch_api/models/hris/supported_benefit.rb +1 -0
  47. data/lib/finch_api/models/hris/w42005.rb +20 -20
  48. data/lib/finch_api/models/hris/w42020.rb +30 -30
  49. data/lib/finch_api/models/introspection.rb +38 -23
  50. data/lib/finch_api/models/jobs/automated_list_params.rb +1 -14
  51. data/lib/finch_api/models/jobs/automated_retrieve_params.rb +1 -14
  52. data/lib/finch_api/models/jobs/manual_retrieve_params.rb +1 -14
  53. data/lib/finch_api/models/payroll/pay_group_list_params.rb +11 -1
  54. data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +9 -1
  55. data/lib/finch_api/models/provider.rb +42 -1092
  56. data/lib/finch_api/models/provider_list_response.rb +143 -0
  57. data/lib/finch_api/models/request_forwarding_forward_params.rb +10 -6
  58. data/lib/finch_api/models/request_forwarding_forward_response.rb +69 -48
  59. data/lib/finch_api/resources/access_tokens.rb +3 -3
  60. data/lib/finch_api/resources/connect/sessions.rb +12 -12
  61. data/lib/finch_api/resources/hris/benefits/individuals.rb +24 -10
  62. data/lib/finch_api/resources/hris/benefits.rb +37 -16
  63. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +38 -15
  64. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
  65. data/lib/finch_api/resources/hris/company.rb +6 -2
  66. data/lib/finch_api/resources/hris/directory.rb +3 -1
  67. data/lib/finch_api/resources/hris/documents.rb +9 -3
  68. data/lib/finch_api/resources/hris/employments.rb +7 -3
  69. data/lib/finch_api/resources/hris/individuals.rb +10 -4
  70. data/lib/finch_api/resources/hris/pay_statements.rb +7 -3
  71. data/lib/finch_api/resources/hris/payments.rb +3 -1
  72. data/lib/finch_api/resources/jobs/automated.rb +3 -16
  73. data/lib/finch_api/resources/jobs/manual.rb +2 -10
  74. data/lib/finch_api/resources/payroll/pay_groups.rb +12 -3
  75. data/lib/finch_api/resources/providers.rb +2 -2
  76. data/lib/finch_api/resources/request_forwarding.rb +2 -2
  77. data/lib/finch_api/version.rb +1 -1
  78. data/lib/finch_api.rb +1 -0
  79. data/rbi/finch_api/errors.rbi +29 -2
  80. data/rbi/finch_api/file_part.rbi +1 -1
  81. data/rbi/finch_api/internal/transport/base_client.rbi +4 -5
  82. data/rbi/finch_api/internal/type/base_page.rbi +1 -1
  83. data/rbi/finch_api/internal/util.rbi +1 -1
  84. data/rbi/finch_api/models/access_token_create_params.rbi +19 -13
  85. data/rbi/finch_api/models/connect/session_new_params.rbi +124 -98
  86. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +23 -23
  87. data/rbi/finch_api/models/create_access_token_response.rbi +8 -0
  88. data/rbi/finch_api/models/hris/benefit_contribution.rbi +270 -52
  89. data/rbi/finch_api/models/hris/benefit_create_params.rbi +11 -0
  90. data/rbi/finch_api/models/hris/benefit_list_params.rbi +24 -5
  91. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +24 -5
  92. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +24 -5
  93. data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -1
  94. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +515 -20
  95. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +87 -0
  96. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +22 -5
  97. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -0
  98. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +11 -0
  99. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +11 -0
  100. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +22 -5
  101. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +22 -5
  102. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -1
  103. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +11 -0
  104. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +24 -5
  105. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +11 -0
  106. data/rbi/finch_api/models/hris/directory_list_params.rbi +11 -0
  107. data/rbi/finch_api/models/hris/document_list_params.rbi +11 -0
  108. data/rbi/finch_api/models/hris/document_response.rbi +14 -29
  109. data/rbi/finch_api/models/hris/document_retreive_params.rbi +24 -5
  110. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +11 -0
  111. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +16 -1
  112. data/rbi/finch_api/models/hris/pay_statement.rbi +69 -272
  113. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +11 -0
  114. data/rbi/finch_api/models/hris/payment_list_params.rbi +11 -0
  115. data/rbi/finch_api/models/hris/supported_benefit.rbi +5 -0
  116. data/rbi/finch_api/models/hris/w42005.rbi +28 -38
  117. data/rbi/finch_api/models/hris/w42020.rbi +37 -43
  118. data/rbi/finch_api/models/introspection.rbi +57 -33
  119. data/rbi/finch_api/models/jobs/automated_list_params.rbi +0 -15
  120. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +5 -25
  121. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +5 -25
  122. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +11 -0
  123. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +24 -5
  124. data/rbi/finch_api/models/provider.rbi +75 -2507
  125. data/rbi/finch_api/models/provider_list_response.rbi +280 -0
  126. data/rbi/finch_api/models/request_forwarding_forward_params.rbi +6 -6
  127. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +93 -60
  128. data/rbi/finch_api/resources/access_tokens.rbi +5 -5
  129. data/rbi/finch_api/resources/connect/sessions.rbi +22 -14
  130. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +20 -3
  131. data/rbi/finch_api/resources/hris/benefits.rbi +39 -12
  132. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +35 -8
  133. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +3 -0
  134. data/rbi/finch_api/resources/hris/company.rbi +9 -4
  135. data/rbi/finch_api/resources/hris/directory.rbi +3 -0
  136. data/rbi/finch_api/resources/hris/documents.rbi +6 -0
  137. data/rbi/finch_api/resources/hris/employments.rbi +4 -1
  138. data/rbi/finch_api/resources/hris/individuals.rbi +10 -1
  139. data/rbi/finch_api/resources/hris/pay_statements.rbi +4 -1
  140. data/rbi/finch_api/resources/hris/payments.rbi +3 -0
  141. data/rbi/finch_api/resources/jobs/automated.rbi +1 -14
  142. data/rbi/finch_api/resources/jobs/manual.rbi +1 -9
  143. data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -2
  144. data/rbi/finch_api/resources/providers.rbi +1 -1
  145. data/rbi/finch_api/resources/request_forwarding.rbi +2 -2
  146. data/sig/finch_api/errors.rbs +7 -0
  147. data/sig/finch_api/file_part.rbs +1 -1
  148. data/sig/finch_api/models/access_token_create_params.rbs +11 -7
  149. data/sig/finch_api/models/connect/session_new_params.rbs +45 -45
  150. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +15 -15
  151. data/sig/finch_api/models/create_access_token_response.rbs +5 -0
  152. data/sig/finch_api/models/hris/benefit_contribution.rbs +107 -21
  153. data/sig/finch_api/models/hris/benefit_create_params.rbs +7 -0
  154. data/sig/finch_api/models/hris/benefit_list_params.rbs +14 -3
  155. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +14 -3
  156. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +14 -3
  157. data/sig/finch_api/models/hris/benefit_update_params.rbs +8 -1
  158. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +201 -8
  159. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +30 -1
  160. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +14 -3
  161. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +7 -1
  162. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +7 -1
  163. data/sig/finch_api/models/hris/benfit_contribution.rbs +1 -1
  164. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +7 -0
  165. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +14 -3
  166. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +14 -3
  167. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +7 -1
  168. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +7 -0
  169. data/sig/finch_api/models/hris/company_retrieve_params.rbs +14 -3
  170. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +7 -1
  171. data/sig/finch_api/models/hris/directory_list_params.rbs +7 -1
  172. data/sig/finch_api/models/hris/document_list_params.rbs +7 -0
  173. data/sig/finch_api/models/hris/document_response.rbs +11 -19
  174. data/sig/finch_api/models/hris/document_retreive_params.rbs +14 -3
  175. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +8 -1
  176. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +7 -0
  177. data/sig/finch_api/models/hris/pay_statement.rbs +28 -96
  178. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +8 -1
  179. data/sig/finch_api/models/hris/payment_list_params.rbs +7 -1
  180. data/sig/finch_api/models/hris/supported_benefit.rbs +2 -1
  181. data/sig/finch_api/models/hris/w42005.rbs +23 -37
  182. data/sig/finch_api/models/hris/w42020.rbs +35 -45
  183. data/sig/finch_api/models/introspection.rbs +29 -20
  184. data/sig/finch_api/models/jobs/automated_list_params.rbs +1 -7
  185. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +3 -13
  186. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +3 -13
  187. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +11 -1
  188. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +14 -3
  189. data/sig/finch_api/models/provider.rbs +31 -1366
  190. data/sig/finch_api/models/provider_list_response.rbs +128 -0
  191. data/sig/finch_api/models/request_forwarding_forward_params.rbs +8 -8
  192. data/sig/finch_api/models/request_forwarding_forward_response.rbs +40 -30
  193. data/sig/finch_api/resources/access_tokens.rbs +2 -2
  194. data/sig/finch_api/resources/connect/sessions.rbs +9 -9
  195. data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -0
  196. data/sig/finch_api/resources/hris/benefits.rbs +5 -0
  197. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +4 -0
  198. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -0
  199. data/sig/finch_api/resources/hris/company.rbs +1 -0
  200. data/sig/finch_api/resources/hris/directory.rbs +1 -0
  201. data/sig/finch_api/resources/hris/documents.rbs +2 -0
  202. data/sig/finch_api/resources/hris/employments.rbs +1 -0
  203. data/sig/finch_api/resources/hris/individuals.rbs +1 -0
  204. data/sig/finch_api/resources/hris/pay_statements.rbs +1 -0
  205. data/sig/finch_api/resources/hris/payments.rbs +1 -0
  206. data/sig/finch_api/resources/jobs/automated.rbs +0 -2
  207. data/sig/finch_api/resources/jobs/manual.rbs +0 -1
  208. data/sig/finch_api/resources/payroll/pay_groups.rbs +2 -0
  209. data/sig/finch_api/resources/providers.rbs +1 -1
  210. data/sig/finch_api/resources/request_forwarding.rbs +2 -2
  211. metadata +5 -2
@@ -15,6 +15,13 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
+ # The entity IDs to specify which entities' data to access.
19
+ sig { returns(T.nilable(T::Array[String])) }
20
+ attr_reader :entity_ids
21
+
22
+ sig { params(entity_ids: T::Array[String]).void }
23
+ attr_writer :entity_ids
24
+
18
25
  sig { returns(T.nilable(String)) }
19
26
  attr_reader :individual_id
20
27
 
@@ -29,12 +36,15 @@ module FinchAPI
29
36
 
30
37
  sig do
31
38
  params(
39
+ entity_ids: T::Array[String],
32
40
  individual_id: String,
33
41
  pay_frequencies: T::Array[String],
34
42
  request_options: FinchAPI::RequestOptions::OrHash
35
43
  ).returns(T.attached_class)
36
44
  end
37
45
  def self.new(
46
+ # The entity IDs to specify which entities' data to access.
47
+ entity_ids: nil,
38
48
  individual_id: nil,
39
49
  pay_frequencies: nil,
40
50
  request_options: {}
@@ -44,6 +54,7 @@ module FinchAPI
44
54
  sig do
45
55
  override.returns(
46
56
  {
57
+ entity_ids: T::Array[String],
47
58
  individual_id: String,
48
59
  pay_frequencies: T::Array[String],
49
60
  request_options: FinchAPI::RequestOptions
@@ -15,15 +15,34 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
+ # The entity IDs to specify which entities' data to access.
19
+ sig { returns(T.nilable(T::Array[String])) }
20
+ attr_reader :entity_ids
21
+
22
+ sig { params(entity_ids: T::Array[String]).void }
23
+ attr_writer :entity_ids
24
+
18
25
  sig do
19
- params(request_options: FinchAPI::RequestOptions::OrHash).returns(
20
- T.attached_class
21
- )
26
+ params(
27
+ entity_ids: T::Array[String],
28
+ request_options: FinchAPI::RequestOptions::OrHash
29
+ ).returns(T.attached_class)
22
30
  end
23
- def self.new(request_options: {})
31
+ def self.new(
32
+ # The entity IDs to specify which entities' data to access.
33
+ entity_ids: nil,
34
+ request_options: {}
35
+ )
24
36
  end
25
37
 
26
- sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
38
+ sig do
39
+ override.returns(
40
+ {
41
+ entity_ids: T::Array[String],
42
+ request_options: FinchAPI::RequestOptions
43
+ }
44
+ )
45
+ end
27
46
  def to_hash
28
47
  end
29
48
  end