finch-api 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.32

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 (205) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +48 -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/connect/session_new_params.rb +66 -50
  16. data/lib/finch_api/models/connect/session_reauthenticate_params.rb +10 -10
  17. data/lib/finch_api/models/create_access_token_response.rb +9 -1
  18. data/lib/finch_api/models/hris/benefit_contribution.rb +124 -29
  19. data/lib/finch_api/models/hris/benefit_create_params.rb +9 -1
  20. data/lib/finch_api/models/hris/benefit_list_params.rb +9 -1
  21. data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +9 -1
  22. data/lib/finch_api/models/hris/benefit_retrieve_params.rb +9 -1
  23. data/lib/finch_api/models/hris/benefit_update_params.rb +9 -1
  24. data/lib/finch_api/models/hris/benefits/individual_benefit.rb +222 -6
  25. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +40 -2
  26. data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +9 -1
  27. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +9 -1
  28. data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +9 -1
  29. data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +9 -1
  30. data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +9 -1
  31. data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_params.rb +9 -1
  32. data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +10 -1
  33. data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +9 -1
  34. data/lib/finch_api/models/hris/company_retrieve_params.rb +9 -1
  35. data/lib/finch_api/models/hris/directory_list_individuals_params.rb +9 -1
  36. data/lib/finch_api/models/hris/directory_list_params.rb +9 -1
  37. data/lib/finch_api/models/hris/document_list_params.rb +9 -1
  38. data/lib/finch_api/models/hris/document_response.rb +11 -11
  39. data/lib/finch_api/models/hris/document_retreive_params.rb +9 -1
  40. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +9 -1
  41. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +11 -1
  42. data/lib/finch_api/models/hris/pay_statement.rb +11 -15
  43. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +9 -1
  44. data/lib/finch_api/models/hris/payment_list_params.rb +9 -1
  45. data/lib/finch_api/models/hris/supported_benefit.rb +1 -0
  46. data/lib/finch_api/models/hris/w42005.rb +20 -20
  47. data/lib/finch_api/models/hris/w42020.rb +30 -30
  48. data/lib/finch_api/models/introspection.rb +38 -23
  49. data/lib/finch_api/models/jobs/automated_list_params.rb +1 -14
  50. data/lib/finch_api/models/jobs/automated_retrieve_params.rb +1 -14
  51. data/lib/finch_api/models/jobs/manual_retrieve_params.rb +1 -14
  52. data/lib/finch_api/models/payroll/pay_group_list_params.rb +11 -1
  53. data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +9 -1
  54. data/lib/finch_api/models/provider.rb +42 -1092
  55. data/lib/finch_api/models/provider_list_response.rb +143 -0
  56. data/lib/finch_api/models/request_forwarding_forward_params.rb +10 -6
  57. data/lib/finch_api/models/request_forwarding_forward_response.rb +69 -48
  58. data/lib/finch_api/resources/connect/sessions.rb +12 -12
  59. data/lib/finch_api/resources/hris/benefits/individuals.rb +24 -10
  60. data/lib/finch_api/resources/hris/benefits.rb +37 -16
  61. data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +38 -15
  62. data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
  63. data/lib/finch_api/resources/hris/company.rb +6 -2
  64. data/lib/finch_api/resources/hris/directory.rb +3 -1
  65. data/lib/finch_api/resources/hris/documents.rb +9 -3
  66. data/lib/finch_api/resources/hris/employments.rb +7 -3
  67. data/lib/finch_api/resources/hris/individuals.rb +10 -4
  68. data/lib/finch_api/resources/hris/pay_statements.rb +7 -3
  69. data/lib/finch_api/resources/hris/payments.rb +3 -1
  70. data/lib/finch_api/resources/jobs/automated.rb +3 -16
  71. data/lib/finch_api/resources/jobs/manual.rb +2 -10
  72. data/lib/finch_api/resources/payroll/pay_groups.rb +12 -3
  73. data/lib/finch_api/resources/providers.rb +2 -2
  74. data/lib/finch_api/resources/request_forwarding.rb +2 -2
  75. data/lib/finch_api/version.rb +1 -1
  76. data/lib/finch_api.rb +1 -0
  77. data/rbi/finch_api/errors.rbi +29 -2
  78. data/rbi/finch_api/file_part.rbi +1 -1
  79. data/rbi/finch_api/internal/transport/base_client.rbi +4 -5
  80. data/rbi/finch_api/internal/type/base_page.rbi +1 -1
  81. data/rbi/finch_api/internal/util.rbi +1 -1
  82. data/rbi/finch_api/models/connect/session_new_params.rbi +124 -98
  83. data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +23 -23
  84. data/rbi/finch_api/models/create_access_token_response.rbi +8 -0
  85. data/rbi/finch_api/models/hris/benefit_contribution.rbi +270 -52
  86. data/rbi/finch_api/models/hris/benefit_create_params.rbi +11 -0
  87. data/rbi/finch_api/models/hris/benefit_list_params.rbi +24 -5
  88. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +24 -5
  89. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +24 -5
  90. data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -1
  91. data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +515 -20
  92. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +87 -0
  93. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +22 -5
  94. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -0
  95. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +11 -0
  96. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +11 -0
  97. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +22 -5
  98. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +22 -5
  99. data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -1
  100. data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +11 -0
  101. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +24 -5
  102. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +11 -0
  103. data/rbi/finch_api/models/hris/directory_list_params.rbi +11 -0
  104. data/rbi/finch_api/models/hris/document_list_params.rbi +11 -0
  105. data/rbi/finch_api/models/hris/document_response.rbi +14 -29
  106. data/rbi/finch_api/models/hris/document_retreive_params.rbi +24 -5
  107. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +11 -0
  108. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +16 -1
  109. data/rbi/finch_api/models/hris/pay_statement.rbi +9 -34
  110. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +11 -0
  111. data/rbi/finch_api/models/hris/payment_list_params.rbi +11 -0
  112. data/rbi/finch_api/models/hris/supported_benefit.rbi +5 -0
  113. data/rbi/finch_api/models/hris/w42005.rbi +28 -38
  114. data/rbi/finch_api/models/hris/w42020.rbi +37 -43
  115. data/rbi/finch_api/models/introspection.rbi +57 -33
  116. data/rbi/finch_api/models/jobs/automated_list_params.rbi +0 -15
  117. data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +5 -25
  118. data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +5 -25
  119. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +11 -0
  120. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +24 -5
  121. data/rbi/finch_api/models/provider.rbi +75 -2507
  122. data/rbi/finch_api/models/provider_list_response.rbi +280 -0
  123. data/rbi/finch_api/models/request_forwarding_forward_params.rbi +6 -6
  124. data/rbi/finch_api/models/request_forwarding_forward_response.rbi +93 -60
  125. data/rbi/finch_api/resources/connect/sessions.rbi +22 -14
  126. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +20 -3
  127. data/rbi/finch_api/resources/hris/benefits.rbi +39 -12
  128. data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +35 -8
  129. data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +3 -0
  130. data/rbi/finch_api/resources/hris/company.rbi +9 -4
  131. data/rbi/finch_api/resources/hris/directory.rbi +3 -0
  132. data/rbi/finch_api/resources/hris/documents.rbi +6 -0
  133. data/rbi/finch_api/resources/hris/employments.rbi +4 -1
  134. data/rbi/finch_api/resources/hris/individuals.rbi +10 -1
  135. data/rbi/finch_api/resources/hris/pay_statements.rbi +4 -1
  136. data/rbi/finch_api/resources/hris/payments.rbi +3 -0
  137. data/rbi/finch_api/resources/jobs/automated.rbi +1 -14
  138. data/rbi/finch_api/resources/jobs/manual.rbi +1 -9
  139. data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -2
  140. data/rbi/finch_api/resources/providers.rbi +1 -1
  141. data/rbi/finch_api/resources/request_forwarding.rbi +2 -2
  142. data/sig/finch_api/errors.rbs +7 -0
  143. data/sig/finch_api/file_part.rbs +1 -1
  144. data/sig/finch_api/models/connect/session_new_params.rbs +45 -45
  145. data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +15 -15
  146. data/sig/finch_api/models/create_access_token_response.rbs +5 -0
  147. data/sig/finch_api/models/hris/benefit_contribution.rbs +107 -21
  148. data/sig/finch_api/models/hris/benefit_create_params.rbs +7 -0
  149. data/sig/finch_api/models/hris/benefit_list_params.rbs +14 -3
  150. data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +14 -3
  151. data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +14 -3
  152. data/sig/finch_api/models/hris/benefit_update_params.rbs +8 -1
  153. data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +201 -8
  154. data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +30 -1
  155. data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +14 -3
  156. data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +7 -1
  157. data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +7 -1
  158. data/sig/finch_api/models/hris/benfit_contribution.rbs +1 -1
  159. data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +7 -0
  160. data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +14 -3
  161. data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +14 -3
  162. data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +7 -1
  163. data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +7 -0
  164. data/sig/finch_api/models/hris/company_retrieve_params.rbs +14 -3
  165. data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +7 -1
  166. data/sig/finch_api/models/hris/directory_list_params.rbs +7 -1
  167. data/sig/finch_api/models/hris/document_list_params.rbs +7 -0
  168. data/sig/finch_api/models/hris/document_response.rbs +11 -19
  169. data/sig/finch_api/models/hris/document_retreive_params.rbs +14 -3
  170. data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +8 -1
  171. data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +7 -0
  172. data/sig/finch_api/models/hris/pay_statement.rbs +12 -12
  173. data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +8 -1
  174. data/sig/finch_api/models/hris/payment_list_params.rbs +7 -1
  175. data/sig/finch_api/models/hris/supported_benefit.rbs +2 -1
  176. data/sig/finch_api/models/hris/w42005.rbs +23 -37
  177. data/sig/finch_api/models/hris/w42020.rbs +35 -45
  178. data/sig/finch_api/models/introspection.rbs +29 -20
  179. data/sig/finch_api/models/jobs/automated_list_params.rbs +1 -7
  180. data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +3 -13
  181. data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +3 -13
  182. data/sig/finch_api/models/payroll/pay_group_list_params.rbs +11 -1
  183. data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +14 -3
  184. data/sig/finch_api/models/provider.rbs +31 -1366
  185. data/sig/finch_api/models/provider_list_response.rbs +128 -0
  186. data/sig/finch_api/models/request_forwarding_forward_params.rbs +8 -8
  187. data/sig/finch_api/models/request_forwarding_forward_response.rbs +40 -30
  188. data/sig/finch_api/resources/connect/sessions.rbs +9 -9
  189. data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -0
  190. data/sig/finch_api/resources/hris/benefits.rbs +5 -0
  191. data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +4 -0
  192. data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -0
  193. data/sig/finch_api/resources/hris/company.rbs +1 -0
  194. data/sig/finch_api/resources/hris/directory.rbs +1 -0
  195. data/sig/finch_api/resources/hris/documents.rbs +2 -0
  196. data/sig/finch_api/resources/hris/employments.rbs +1 -0
  197. data/sig/finch_api/resources/hris/individuals.rbs +1 -0
  198. data/sig/finch_api/resources/hris/pay_statements.rbs +1 -0
  199. data/sig/finch_api/resources/hris/payments.rbs +1 -0
  200. data/sig/finch_api/resources/jobs/automated.rbs +0 -2
  201. data/sig/finch_api/resources/jobs/manual.rbs +0 -1
  202. data/sig/finch_api/resources/payroll/pay_groups.rbs +2 -0
  203. data/sig/finch_api/resources/providers.rbs +1 -1
  204. data/sig/finch_api/resources/request_forwarding.rbs +2 -2
  205. metadata +5 -2
@@ -0,0 +1,128 @@
1
+ module FinchAPI
2
+ module Models
3
+ type provider_list_response =
4
+ {
5
+ id: String,
6
+ display_name: String,
7
+ products: ::Array[String],
8
+ authentication_methods: ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod],
9
+ beta: bool,
10
+ icon: String,
11
+ logo: String,
12
+ manual: bool,
13
+ mfa_required: bool,
14
+ primary_color: String
15
+ }
16
+
17
+ class ProviderListResponse < FinchAPI::Internal::Type::BaseModel
18
+ attr_accessor id: String
19
+
20
+ attr_accessor display_name: String
21
+
22
+ attr_accessor products: ::Array[String]
23
+
24
+ attr_reader authentication_methods: ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod]?
25
+
26
+ def authentication_methods=: (
27
+ ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod]
28
+ ) -> ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod]
29
+
30
+ attr_reader beta: bool?
31
+
32
+ def beta=: (bool) -> bool
33
+
34
+ attr_reader icon: String?
35
+
36
+ def icon=: (String) -> String
37
+
38
+ attr_reader logo: String?
39
+
40
+ def logo=: (String) -> String
41
+
42
+ attr_reader manual: bool?
43
+
44
+ def manual=: (bool) -> bool
45
+
46
+ attr_reader mfa_required: bool?
47
+
48
+ def mfa_required=: (bool) -> bool
49
+
50
+ attr_reader primary_color: String?
51
+
52
+ def primary_color=: (String) -> String
53
+
54
+ def initialize: (
55
+ id: String,
56
+ display_name: String,
57
+ products: ::Array[String],
58
+ ?authentication_methods: ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod],
59
+ ?beta: bool,
60
+ ?icon: String,
61
+ ?logo: String,
62
+ ?manual: bool,
63
+ ?mfa_required: bool,
64
+ ?primary_color: String
65
+ ) -> void
66
+
67
+ def to_hash: -> {
68
+ id: String,
69
+ display_name: String,
70
+ products: ::Array[String],
71
+ authentication_methods: ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod],
72
+ beta: bool,
73
+ icon: String,
74
+ logo: String,
75
+ manual: bool,
76
+ mfa_required: bool,
77
+ primary_color: String
78
+ }
79
+
80
+ type authentication_method =
81
+ {
82
+ type: FinchAPI::Models::ProviderListResponse::AuthenticationMethod::type_,
83
+ benefits_support: ::Hash[Symbol, top?],
84
+ supported_fields: ::Hash[Symbol, top?]
85
+ }
86
+
87
+ class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
88
+ attr_accessor type: FinchAPI::Models::ProviderListResponse::AuthenticationMethod::type_
89
+
90
+ attr_reader benefits_support: ::Hash[Symbol, top?]?
91
+
92
+ def benefits_support=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?]
93
+
94
+ attr_reader supported_fields: ::Hash[Symbol, top?]?
95
+
96
+ def supported_fields=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?]
97
+
98
+ def initialize: (
99
+ type: FinchAPI::Models::ProviderListResponse::AuthenticationMethod::type_,
100
+ ?benefits_support: ::Hash[Symbol, top?],
101
+ ?supported_fields: ::Hash[Symbol, top?]
102
+ ) -> void
103
+
104
+ def to_hash: -> {
105
+ type: FinchAPI::Models::ProviderListResponse::AuthenticationMethod::type_,
106
+ benefits_support: ::Hash[Symbol, top?],
107
+ supported_fields: ::Hash[Symbol, top?]
108
+ }
109
+
110
+ type type_ =
111
+ :assisted | :credential | :api_token | :api_credential | :oauth | :api
112
+
113
+ module Type
114
+ extend FinchAPI::Internal::Type::Enum
115
+
116
+ ASSISTED: :assisted
117
+ CREDENTIAL: :credential
118
+ API_TOKEN: :api_token
119
+ API_CREDENTIAL: :api_credential
120
+ OAUTH: :oauth
121
+ API: :api
122
+
123
+ def self?.values: -> ::Array[FinchAPI::Models::ProviderListResponse::AuthenticationMethod::type_]
124
+ end
125
+ end
126
+ end
127
+ end
128
+ end
@@ -5,8 +5,8 @@ module FinchAPI
5
5
  method_: String,
6
6
  route: String,
7
7
  data: String?,
8
- headers: top?,
9
- params: top?
8
+ headers: ::Hash[Symbol, top?]?,
9
+ params: ::Hash[Symbol, top?]?
10
10
  }
11
11
  & FinchAPI::Internal::Type::request_parameters
12
12
 
@@ -20,16 +20,16 @@ module FinchAPI
20
20
 
21
21
  attr_accessor data: String?
22
22
 
23
- attr_accessor headers: top?
23
+ attr_accessor headers: ::Hash[Symbol, top?]?
24
24
 
25
- attr_accessor params: top?
25
+ attr_accessor params: ::Hash[Symbol, top?]?
26
26
 
27
27
  def initialize: (
28
28
  method_: String,
29
29
  route: String,
30
30
  ?data: String?,
31
- ?headers: top?,
32
- ?params: top?,
31
+ ?headers: ::Hash[Symbol, top?]?,
32
+ ?params: ::Hash[Symbol, top?]?,
33
33
  ?request_options: FinchAPI::request_opts
34
34
  ) -> void
35
35
 
@@ -37,8 +37,8 @@ module FinchAPI
37
37
  method_: String,
38
38
  route: String,
39
39
  data: String?,
40
- headers: top?,
41
- params: top?,
40
+ headers: ::Hash[Symbol, top?]?,
41
+ params: ::Hash[Symbol, top?]?,
42
42
  request_options: FinchAPI::RequestOptions
43
43
  }
44
44
  end
@@ -2,70 +2,80 @@ module FinchAPI
2
2
  module Models
3
3
  type request_forwarding_forward_response =
4
4
  {
5
- data: String?,
6
- headers: top?,
7
5
  request: FinchAPI::Models::RequestForwardingForwardResponse::Request,
8
- status_code: Integer
6
+ status_code: Integer,
7
+ data: String?,
8
+ headers: ::Hash[Symbol, top?]?
9
9
  }
10
10
 
11
11
  class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel
12
- attr_accessor data: String?
13
-
14
- attr_accessor headers: top?
15
-
16
12
  attr_accessor request: FinchAPI::Models::RequestForwardingForwardResponse::Request
17
13
 
18
14
  attr_accessor status_code: Integer
19
15
 
16
+ attr_accessor data: String?
17
+
18
+ attr_accessor headers: ::Hash[Symbol, top?]?
19
+
20
20
  def initialize: (
21
- data: String?,
22
- headers: top?,
23
21
  request: FinchAPI::Models::RequestForwardingForwardResponse::Request,
24
- status_code: Integer
22
+ status_code: Integer,
23
+ ?data: String?,
24
+ ?headers: ::Hash[Symbol, top?]?
25
25
  ) -> void
26
26
 
27
27
  def to_hash: -> {
28
- data: String?,
29
- headers: top?,
30
28
  request: FinchAPI::Models::RequestForwardingForwardResponse::Request,
31
- status_code: Integer
29
+ status_code: Integer,
30
+ data: String?,
31
+ headers: ::Hash[Symbol, top?]?
32
32
  }
33
33
 
34
34
  type request =
35
35
  {
36
- data: String?,
37
- headers: top?,
38
36
  method_: String,
39
- params: top?,
40
- route: String
37
+ route: String,
38
+ data: FinchAPI::Models::RequestForwardingForwardResponse::Request::data?,
39
+ headers: ::Hash[Symbol, top?]?,
40
+ params: ::Hash[Symbol, top?]?
41
41
  }
42
42
 
43
43
  class Request < FinchAPI::Internal::Type::BaseModel
44
- attr_accessor data: String?
44
+ attr_accessor method_: String
45
45
 
46
- attr_accessor headers: top?
46
+ attr_accessor route: String
47
47
 
48
- attr_accessor method_: String
48
+ attr_accessor data: FinchAPI::Models::RequestForwardingForwardResponse::Request::data?
49
49
 
50
- attr_accessor params: top?
50
+ attr_accessor headers: ::Hash[Symbol, top?]?
51
51
 
52
- attr_accessor route: String
52
+ attr_accessor params: ::Hash[Symbol, top?]?
53
53
 
54
54
  def initialize: (
55
- data: String?,
56
- headers: top?,
57
55
  method_: String,
58
- params: top?,
59
- route: String
56
+ route: String,
57
+ ?data: FinchAPI::Models::RequestForwardingForwardResponse::Request::data?,
58
+ ?headers: ::Hash[Symbol, top?]?,
59
+ ?params: ::Hash[Symbol, top?]?
60
60
  ) -> void
61
61
 
62
62
  def to_hash: -> {
63
- data: String?,
64
- headers: top?,
65
63
  method_: String,
66
- params: top?,
67
- route: String
64
+ route: String,
65
+ data: FinchAPI::Models::RequestForwardingForwardResponse::Request::data?,
66
+ headers: ::Hash[Symbol, top?]?,
67
+ params: ::Hash[Symbol, top?]?
68
68
  }
69
+
70
+ type data = String | ::Hash[Symbol, top?]
71
+
72
+ module Data
73
+ extend FinchAPI::Internal::Type::Union
74
+
75
+ def self?.variants: -> ::Array[FinchAPI::Models::RequestForwardingForwardResponse::Request::data]
76
+
77
+ UnionMember1Map: FinchAPI::Internal::Type::Converter
78
+ end
69
79
  end
70
80
  end
71
81
  end
@@ -3,23 +3,23 @@ module FinchAPI
3
3
  class Connect
4
4
  class Sessions
5
5
  def new: (
6
+ customer_email: String?,
6
7
  customer_id: String,
7
8
  customer_name: String,
9
+ integration: FinchAPI::Connect::SessionNewParams::Integration?,
10
+ manual: bool?,
11
+ minutes_to_expire: Float?,
8
12
  products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product],
9
- ?customer_email: String?,
10
- ?integration: FinchAPI::Connect::SessionNewParams::Integration?,
11
- ?manual: bool?,
12
- ?minutes_to_expire: Float?,
13
- ?redirect_uri: String?,
14
- ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?,
13
+ redirect_uri: String?,
14
+ sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?,
15
15
  ?request_options: FinchAPI::request_opts
16
16
  ) -> FinchAPI::Models::Connect::SessionNewResponse
17
17
 
18
18
  def reauthenticate: (
19
19
  connection_id: String,
20
- ?minutes_to_expire: Integer?,
21
- ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?,
22
- ?redirect_uri: String?,
20
+ minutes_to_expire: Integer,
21
+ products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?,
22
+ redirect_uri: String?,
23
23
  ?request_options: FinchAPI::request_opts
24
24
  ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse
25
25
 
@@ -5,23 +5,27 @@ module FinchAPI
5
5
  class Individuals
6
6
  def enroll_many: (
7
7
  String benefit_id,
8
+ ?entity_ids: ::Array[String],
8
9
  ?individuals: ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual],
9
10
  ?request_options: FinchAPI::request_opts
10
11
  ) -> FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse
11
12
 
12
13
  def enrolled_ids: (
13
14
  String benefit_id,
15
+ ?entity_ids: ::Array[String],
14
16
  ?request_options: FinchAPI::request_opts
15
17
  ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse
16
18
 
17
19
  def retrieve_many_benefits: (
18
20
  String benefit_id,
21
+ ?entity_ids: ::Array[String],
19
22
  ?individual_ids: String,
20
23
  ?request_options: FinchAPI::request_opts
21
24
  ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::Benefits::IndividualBenefit]
22
25
 
23
26
  def unenroll_many: (
24
27
  String benefit_id,
28
+ ?entity_ids: ::Array[String],
25
29
  ?individual_ids: ::Array[String],
26
30
  ?request_options: FinchAPI::request_opts
27
31
  ) -> FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse
@@ -5,6 +5,7 @@ module FinchAPI
5
5
  attr_reader individuals: FinchAPI::Resources::HRIS::Benefits::Individuals
6
6
 
7
7
  def create: (
8
+ ?entity_ids: ::Array[String],
8
9
  ?company_contribution: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution?,
9
10
  ?description: String,
10
11
  ?frequency: FinchAPI::Models::HRIS::benefit_frequency?,
@@ -14,20 +15,24 @@ module FinchAPI
14
15
 
15
16
  def retrieve: (
16
17
  String benefit_id,
18
+ ?entity_ids: ::Array[String],
17
19
  ?request_options: FinchAPI::request_opts
18
20
  ) -> FinchAPI::HRIS::CompanyBenefit
19
21
 
20
22
  def update: (
21
23
  String benefit_id,
24
+ ?entity_ids: ::Array[String],
22
25
  ?description: String,
23
26
  ?request_options: FinchAPI::request_opts
24
27
  ) -> FinchAPI::HRIS::UpdateCompanyBenefitResponse
25
28
 
26
29
  def list: (
30
+ ?entity_ids: ::Array[String],
27
31
  ?request_options: FinchAPI::request_opts
28
32
  ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::CompanyBenefit]
29
33
 
30
34
  def list_supported_benefits: (
35
+ ?entity_ids: ::Array[String],
31
36
  ?request_options: FinchAPI::request_opts
32
37
  ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::SupportedBenefit]
33
38
 
@@ -5,6 +5,7 @@ module FinchAPI
5
5
  class PayStatementItem
6
6
  class Rules
7
7
  def create: (
8
+ ?entity_ids: ::Array[String],
8
9
  ?attributes: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes,
9
10
  ?conditions: ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition],
10
11
  ?effective_end_date: String?,
@@ -15,16 +16,19 @@ module FinchAPI
15
16
 
16
17
  def update: (
17
18
  String rule_id,
19
+ ?entity_ids: ::Array[String],
18
20
  ?optional_property: top,
19
21
  ?request_options: FinchAPI::request_opts
20
22
  ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse
21
23
 
22
24
  def list: (
25
+ ?entity_ids: ::Array[String],
23
26
  ?request_options: FinchAPI::request_opts
24
27
  ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse]
25
28
 
26
29
  def delete: (
27
30
  String rule_id,
31
+ ?entity_ids: ::Array[String],
28
32
  ?request_options: FinchAPI::request_opts
29
33
  ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse
30
34
 
@@ -8,6 +8,7 @@ module FinchAPI
8
8
  def list: (
9
9
  ?categories: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category],
10
10
  ?end_date: Date,
11
+ ?entity_ids: ::Array[String],
11
12
  ?name: String,
12
13
  ?start_date: Date,
13
14
  ?type: String,
@@ -5,6 +5,7 @@ module FinchAPI
5
5
  attr_reader pay_statement_item: FinchAPI::Resources::HRIS::Company::PayStatementItem
6
6
 
7
7
  def retrieve: (
8
+ ?entity_ids: ::Array[String],
8
9
  ?request_options: FinchAPI::request_opts
9
10
  ) -> FinchAPI::HRIS::HRISCompany
10
11
 
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  class HRIS
4
4
  class Directory
5
5
  def list: (
6
+ ?entity_ids: ::Array[String],
6
7
  ?limit: Integer,
7
8
  ?offset: Integer,
8
9
  ?request_options: FinchAPI::request_opts
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  class HRIS
4
4
  class Documents
5
5
  def list: (
6
+ ?entity_ids: ::Array[String],
6
7
  ?individual_ids: ::Array[String],
7
8
  ?limit: Integer,
8
9
  ?offset: Integer,
@@ -12,6 +13,7 @@ module FinchAPI
12
13
 
13
14
  def retreive: (
14
15
  String document_id,
16
+ ?entity_ids: ::Array[String],
15
17
  ?request_options: FinchAPI::request_opts
16
18
  ) -> FinchAPI::Models::HRIS::document_retreive_response
17
19
 
@@ -4,6 +4,7 @@ module FinchAPI
4
4
  class Employments
5
5
  def retrieve_many: (
6
6
  requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
7
+ ?entity_ids: ::Array[String],
7
8
  ?request_options: FinchAPI::request_opts
8
9
  ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::HRIS::EmploymentDataResponse]
9
10
 
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  class HRIS
4
4
  class Individuals
5
5
  def retrieve_many: (
6
+ ?entity_ids: ::Array[String],
6
7
  ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
7
8
  ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
8
9
  ?request_options: FinchAPI::request_opts
@@ -4,6 +4,7 @@ module FinchAPI
4
4
  class PayStatements
5
5
  def retrieve_many: (
6
6
  requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
7
+ ?entity_ids: ::Array[String],
7
8
  ?request_options: FinchAPI::request_opts
8
9
  ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::HRIS::PayStatementResponse]
9
10
 
@@ -5,6 +5,7 @@ module FinchAPI
5
5
  def list: (
6
6
  end_date: Date,
7
7
  start_date: Date,
8
+ ?entity_ids: ::Array[String],
8
9
  ?request_options: FinchAPI::request_opts
9
10
  ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::Payment]
10
11
 
@@ -10,12 +10,10 @@ module FinchAPI
10
10
 
11
11
  def retrieve: (
12
12
  String job_id,
13
- ?entity_id: String,
14
13
  ?request_options: FinchAPI::request_opts
15
14
  ) -> FinchAPI::Jobs::AutomatedAsyncJob
16
15
 
17
16
  def list: (
18
- ?entity_id: String,
19
17
  ?limit: Integer,
20
18
  ?offset: Integer,
21
19
  ?request_options: FinchAPI::request_opts
@@ -4,7 +4,6 @@ module FinchAPI
4
4
  class Manual
5
5
  def retrieve: (
6
6
  String job_id,
7
- ?entity_id: String,
8
7
  ?request_options: FinchAPI::request_opts
9
8
  ) -> FinchAPI::Jobs::ManualAsyncJob
10
9
 
@@ -4,10 +4,12 @@ module FinchAPI
4
4
  class PayGroups
5
5
  def retrieve: (
6
6
  String pay_group_id,
7
+ ?entity_ids: ::Array[String],
7
8
  ?request_options: FinchAPI::request_opts
8
9
  ) -> FinchAPI::Models::Payroll::PayGroupRetrieveResponse
9
10
 
10
11
  def list: (
12
+ ?entity_ids: ::Array[String],
11
13
  ?individual_id: String,
12
14
  ?pay_frequencies: ::Array[String],
13
15
  ?request_options: FinchAPI::request_opts
@@ -3,7 +3,7 @@ module FinchAPI
3
3
  class Providers
4
4
  def list: (
5
5
  ?request_options: FinchAPI::request_opts
6
- ) -> FinchAPI::Internal::SinglePage[FinchAPI::Provider]
6
+ ) -> FinchAPI::Internal::SinglePage[FinchAPI::Models::ProviderListResponse]
7
7
 
8
8
  def initialize: (client: FinchAPI::Client) -> void
9
9
  end
@@ -5,8 +5,8 @@ module FinchAPI
5
5
  method_: String,
6
6
  route: String,
7
7
  ?data: String?,
8
- ?headers: top?,
9
- ?params: top?,
8
+ ?headers: ::Hash[Symbol, top?]?,
9
+ ?params: ::Hash[Symbol, top?]?,
10
10
  ?request_options: FinchAPI::request_opts
11
11
  ) -> FinchAPI::Models::RequestForwardingForwardResponse
12
12
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: finch-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre.alpha.30
4
+ version: 0.1.0.pre.alpha.32
5
5
  platform: ruby
6
6
  authors:
7
7
  - Finch
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-09-16 00:00:00.000000000 Z
11
+ date: 2025-10-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool
@@ -158,6 +158,7 @@ files:
158
158
  - lib/finch_api/models/payroll/pay_group_retrieve_response.rb
159
159
  - lib/finch_api/models/provider.rb
160
160
  - lib/finch_api/models/provider_list_params.rb
161
+ - lib/finch_api/models/provider_list_response.rb
161
162
  - lib/finch_api/models/request_forwarding_forward_params.rb
162
163
  - lib/finch_api/models/request_forwarding_forward_response.rb
163
164
  - lib/finch_api/models/sandbox/company_update_params.rb
@@ -342,6 +343,7 @@ files:
342
343
  - rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi
343
344
  - rbi/finch_api/models/provider.rbi
344
345
  - rbi/finch_api/models/provider_list_params.rbi
346
+ - rbi/finch_api/models/provider_list_response.rbi
345
347
  - rbi/finch_api/models/request_forwarding_forward_params.rbi
346
348
  - rbi/finch_api/models/request_forwarding_forward_response.rbi
347
349
  - rbi/finch_api/models/sandbox/company_update_params.rbi
@@ -525,6 +527,7 @@ files:
525
527
  - sig/finch_api/models/payroll/pay_group_retrieve_response.rbs
526
528
  - sig/finch_api/models/provider.rbs
527
529
  - sig/finch_api/models/provider_list_params.rbs
530
+ - sig/finch_api/models/provider_list_response.rbs
528
531
  - sig/finch_api/models/request_forwarding_forward_params.rbs
529
532
  - sig/finch_api/models/request_forwarding_forward_response.rbs
530
533
  - sig/finch_api/models/sandbox/company_update_params.rbs