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
@@ -2,13 +2,17 @@ module FinchAPI
2
2
  module Models
3
3
  module HRIS
4
4
  type directory_list_params =
5
- { limit: Integer, offset: Integer }
5
+ { entity_ids: ::Array[String], limit: Integer, offset: Integer }
6
6
  & FinchAPI::Internal::Type::request_parameters
7
7
 
8
8
  class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
9
9
  extend FinchAPI::Internal::Type::RequestParameters::Converter
10
10
  include FinchAPI::Internal::Type::RequestParameters
11
11
 
12
+ attr_reader entity_ids: ::Array[String]?
13
+
14
+ def entity_ids=: (::Array[String]) -> ::Array[String]
15
+
12
16
  attr_reader limit: Integer?
13
17
 
14
18
  def limit=: (Integer) -> Integer
@@ -18,12 +22,14 @@ module FinchAPI
18
22
  def offset=: (Integer) -> Integer
19
23
 
20
24
  def initialize: (
25
+ ?entity_ids: ::Array[String],
21
26
  ?limit: Integer,
22
27
  ?offset: Integer,
23
28
  ?request_options: FinchAPI::request_opts
24
29
  ) -> void
25
30
 
26
31
  def to_hash: -> {
32
+ entity_ids: ::Array[String],
27
33
  limit: Integer,
28
34
  offset: Integer,
29
35
  request_options: FinchAPI::RequestOptions
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  module HRIS
4
4
  type document_list_params =
5
5
  {
6
+ entity_ids: ::Array[String],
6
7
  individual_ids: ::Array[String],
7
8
  limit: Integer,
8
9
  offset: Integer,
@@ -14,6 +15,10 @@ module FinchAPI
14
15
  extend FinchAPI::Internal::Type::RequestParameters::Converter
15
16
  include FinchAPI::Internal::Type::RequestParameters
16
17
 
18
+ attr_reader entity_ids: ::Array[String]?
19
+
20
+ def entity_ids=: (::Array[String]) -> ::Array[String]
21
+
17
22
  attr_reader individual_ids: ::Array[String]?
18
23
 
19
24
  def individual_ids=: (::Array[String]) -> ::Array[String]
@@ -33,6 +38,7 @@ module FinchAPI
33
38
  ) -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]
34
39
 
35
40
  def initialize: (
41
+ ?entity_ids: ::Array[String],
36
42
  ?individual_ids: ::Array[String],
37
43
  ?limit: Integer,
38
44
  ?offset: Integer,
@@ -41,6 +47,7 @@ module FinchAPI
41
47
  ) -> void
42
48
 
43
49
  def to_hash: -> {
50
+ entity_ids: ::Array[String],
44
51
  individual_ids: ::Array[String],
45
52
  limit: Integer,
46
53
  offset: Integer,
@@ -7,34 +7,26 @@ module FinchAPI
7
7
  individual_id: String?,
8
8
  type: FinchAPI::Models::HRIS::DocumentResponse::type_,
9
9
  url: String,
10
- year: Float?
10
+ year: Float
11
11
  }
12
12
 
13
13
  class DocumentResponse < FinchAPI::Internal::Type::BaseModel
14
- attr_reader id: String?
15
-
16
- def id=: (String) -> String
14
+ attr_accessor id: String
17
15
 
18
16
  attr_accessor individual_id: String?
19
17
 
20
- attr_reader type: FinchAPI::Models::HRIS::DocumentResponse::type_?
21
-
22
- def type=: (
23
- FinchAPI::Models::HRIS::DocumentResponse::type_
24
- ) -> FinchAPI::Models::HRIS::DocumentResponse::type_
18
+ attr_accessor type: FinchAPI::Models::HRIS::DocumentResponse::type_
25
19
 
26
- attr_reader url: String?
20
+ attr_accessor url: String
27
21
 
28
- def url=: (String) -> String
29
-
30
- attr_accessor year: Float?
22
+ attr_accessor year: Float
31
23
 
32
24
  def initialize: (
33
- ?id: String,
34
- ?individual_id: String?,
35
- ?type: FinchAPI::Models::HRIS::DocumentResponse::type_,
36
- ?url: String,
37
- ?year: Float?
25
+ id: String,
26
+ individual_id: String?,
27
+ type: FinchAPI::Models::HRIS::DocumentResponse::type_,
28
+ url: String,
29
+ year: Float
38
30
  ) -> void
39
31
 
40
32
  def to_hash: -> {
@@ -42,7 +34,7 @@ module FinchAPI
42
34
  individual_id: String?,
43
35
  type: FinchAPI::Models::HRIS::DocumentResponse::type_,
44
36
  url: String,
45
- year: Float?
37
+ year: Float
46
38
  }
47
39
 
48
40
  type type_ = :w4_2020 | :w4_2005
@@ -2,15 +2,26 @@ module FinchAPI
2
2
  module Models
3
3
  module HRIS
4
4
  type document_retreive_params =
5
- { } & FinchAPI::Internal::Type::request_parameters
5
+ { entity_ids: ::Array[String] }
6
+ & FinchAPI::Internal::Type::request_parameters
6
7
 
7
8
  class DocumentRetreiveParams < FinchAPI::Internal::Type::BaseModel
8
9
  extend FinchAPI::Internal::Type::RequestParameters::Converter
9
10
  include FinchAPI::Internal::Type::RequestParameters
10
11
 
11
- def initialize: (?request_options: FinchAPI::request_opts) -> void
12
+ attr_reader entity_ids: ::Array[String]?
12
13
 
13
- def to_hash: -> { request_options: FinchAPI::RequestOptions }
14
+ def entity_ids=: (::Array[String]) -> ::Array[String]
15
+
16
+ def initialize: (
17
+ ?entity_ids: ::Array[String],
18
+ ?request_options: FinchAPI::request_opts
19
+ ) -> void
20
+
21
+ def to_hash: -> {
22
+ entity_ids: ::Array[String],
23
+ request_options: FinchAPI::RequestOptions
24
+ }
14
25
  end
15
26
  end
16
27
  end
@@ -3,7 +3,8 @@ module FinchAPI
3
3
  module HRIS
4
4
  type employment_retrieve_many_params =
5
5
  {
6
- requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
6
+ requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
7
+ entity_ids: ::Array[String]
7
8
  }
8
9
  & FinchAPI::Internal::Type::request_parameters
9
10
 
@@ -13,13 +14,19 @@ module FinchAPI
13
14
 
14
15
  attr_accessor requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
15
16
 
17
+ attr_reader entity_ids: ::Array[String]?
18
+
19
+ def entity_ids=: (::Array[String]) -> ::Array[String]
20
+
16
21
  def initialize: (
17
22
  requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
23
+ ?entity_ids: ::Array[String],
18
24
  ?request_options: FinchAPI::request_opts
19
25
  ) -> void
20
26
 
21
27
  def to_hash: -> {
22
28
  requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
29
+ entity_ids: ::Array[String],
23
30
  request_options: FinchAPI::RequestOptions
24
31
  }
25
32
 
@@ -3,6 +3,7 @@ module FinchAPI
3
3
  module HRIS
4
4
  type individual_retrieve_many_params =
5
5
  {
6
+ entity_ids: ::Array[String],
6
7
  options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
7
8
  requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
8
9
  }
@@ -12,6 +13,10 @@ module FinchAPI
12
13
  extend FinchAPI::Internal::Type::RequestParameters::Converter
13
14
  include FinchAPI::Internal::Type::RequestParameters
14
15
 
16
+ attr_reader entity_ids: ::Array[String]?
17
+
18
+ def entity_ids=: (::Array[String]) -> ::Array[String]
19
+
15
20
  attr_accessor options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?
16
21
 
17
22
  attr_reader requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]?
@@ -21,12 +26,14 @@ module FinchAPI
21
26
  ) -> ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
22
27
 
23
28
  def initialize: (
29
+ ?entity_ids: ::Array[String],
24
30
  ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
25
31
  ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
26
32
  ?request_options: FinchAPI::request_opts
27
33
  ) -> void
28
34
 
29
35
  def to_hash: -> {
36
+ entity_ids: ::Array[String],
30
37
  options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
31
38
  requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
32
39
  request_options: FinchAPI::RequestOptions
@@ -4,13 +4,13 @@ module FinchAPI
4
4
  type pay_statement =
5
5
  {
6
6
  earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?,
7
- employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?,
8
- employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?,
7
+ employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?,
8
+ employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?,
9
9
  gross_pay: FinchAPI::Money?,
10
10
  individual_id: String,
11
11
  net_pay: FinchAPI::Money?,
12
12
  payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
13
- taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?,
13
+ taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?,
14
14
  total_hours: Float?,
15
15
  type: FinchAPI::Models::HRIS::PayStatement::type_?
16
16
  }
@@ -18,9 +18,9 @@ module FinchAPI
18
18
  class PayStatement < FinchAPI::Internal::Type::BaseModel
19
19
  attr_accessor earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?
20
20
 
21
- attr_accessor employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?
21
+ attr_accessor employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?
22
22
 
23
- attr_accessor employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?
23
+ attr_accessor employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?
24
24
 
25
25
  attr_accessor gross_pay: FinchAPI::Money?
26
26
 
@@ -30,7 +30,7 @@ module FinchAPI
30
30
 
31
31
  attr_accessor payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?
32
32
 
33
- attr_accessor taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?
33
+ attr_accessor taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?
34
34
 
35
35
  attr_accessor total_hours: Float?
36
36
 
@@ -38,26 +38,26 @@ module FinchAPI
38
38
 
39
39
  def initialize: (
40
40
  earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?,
41
- employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?,
42
- employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?,
41
+ employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?,
42
+ employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?,
43
43
  gross_pay: FinchAPI::Money?,
44
44
  individual_id: String,
45
45
  net_pay: FinchAPI::Money?,
46
46
  payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
47
- taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?,
47
+ taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?,
48
48
  total_hours: Float?,
49
49
  type: FinchAPI::Models::HRIS::PayStatement::type_?
50
50
  ) -> void
51
51
 
52
52
  def to_hash: -> {
53
53
  earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?,
54
- employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?,
55
- employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?,
54
+ employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?,
55
+ employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?,
56
56
  gross_pay: FinchAPI::Money?,
57
57
  individual_id: String,
58
58
  net_pay: FinchAPI::Money?,
59
59
  payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
60
- taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?,
60
+ taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?,
61
61
  total_hours: Float?,
62
62
  type: FinchAPI::Models::HRIS::PayStatement::type_?
63
63
  }
@@ -138,31 +138,14 @@ module FinchAPI
138
138
  def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Earning::type_]
139
139
  end
140
140
 
141
- type attributes =
142
- {
143
- metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
144
- }
141
+ type attributes = { metadata: ::Hash[Symbol, top?] }
145
142
 
146
143
  class Attributes < FinchAPI::Internal::Type::BaseModel
147
- attr_accessor metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
144
+ attr_accessor metadata: ::Hash[Symbol, top?]
148
145
 
149
- def initialize: (
150
- metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
151
- ) -> void
146
+ def initialize: (metadata: ::Hash[Symbol, top?]) -> void
152
147
 
153
- def to_hash: -> {
154
- metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
155
- }
156
-
157
- type metadata = { metadata: ::Hash[Symbol, top?] }
158
-
159
- class Metadata < FinchAPI::Internal::Type::BaseModel
160
- attr_accessor metadata: ::Hash[Symbol, top?]
161
-
162
- def initialize: (metadata: ::Hash[Symbol, top?]) -> void
163
-
164
- def to_hash: -> { metadata: ::Hash[Symbol, top?] }
165
- end
148
+ def to_hash: -> { metadata: ::Hash[Symbol, top?] }
166
149
  end
167
150
  end
168
151
 
@@ -207,31 +190,14 @@ module FinchAPI
207
190
  attributes: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes?
208
191
  }
209
192
 
210
- type attributes =
211
- {
212
- metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
213
- }
193
+ type attributes = { metadata: ::Hash[Symbol, top?] }
214
194
 
215
195
  class Attributes < FinchAPI::Internal::Type::BaseModel
216
- attr_accessor metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
217
-
218
- def initialize: (
219
- metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
220
- ) -> void
221
-
222
- def to_hash: -> {
223
- metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
224
- }
225
-
226
- type metadata = { metadata: ::Hash[Symbol, top?] }
227
-
228
- class Metadata < FinchAPI::Internal::Type::BaseModel
229
- attr_accessor metadata: ::Hash[Symbol, top?]
196
+ attr_accessor metadata: ::Hash[Symbol, top?]
230
197
 
231
- def initialize: (metadata: ::Hash[Symbol, top?]) -> void
198
+ def initialize: (metadata: ::Hash[Symbol, top?]) -> void
232
199
 
233
- def to_hash: -> { metadata: ::Hash[Symbol, top?] }
234
- end
200
+ def to_hash: -> { metadata: ::Hash[Symbol, top?] }
235
201
  end
236
202
  end
237
203
 
@@ -271,31 +237,14 @@ module FinchAPI
271
237
  attributes: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes?
272
238
  }
273
239
 
274
- type attributes =
275
- {
276
- metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
277
- }
240
+ type attributes = { metadata: ::Hash[Symbol, top?] }
278
241
 
279
242
  class Attributes < FinchAPI::Internal::Type::BaseModel
280
- attr_accessor metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
243
+ attr_accessor metadata: ::Hash[Symbol, top?]
281
244
 
282
- def initialize: (
283
- metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
284
- ) -> void
245
+ def initialize: (metadata: ::Hash[Symbol, top?]) -> void
285
246
 
286
- def to_hash: -> {
287
- metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
288
- }
289
-
290
- type metadata = { metadata: ::Hash[Symbol, top?] }
291
-
292
- class Metadata < FinchAPI::Internal::Type::BaseModel
293
- attr_accessor metadata: ::Hash[Symbol, top?]
294
-
295
- def initialize: (metadata: ::Hash[Symbol, top?]) -> void
296
-
297
- def to_hash: -> { metadata: ::Hash[Symbol, top?] }
298
- end
247
+ def to_hash: -> { metadata: ::Hash[Symbol, top?] }
299
248
  end
300
249
  end
301
250
 
@@ -365,31 +314,14 @@ module FinchAPI
365
314
  def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Tax::type_]
366
315
  end
367
316
 
368
- type attributes =
369
- {
370
- metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
371
- }
317
+ type attributes = { metadata: ::Hash[Symbol, top?] }
372
318
 
373
319
  class Attributes < FinchAPI::Internal::Type::BaseModel
374
- attr_accessor metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
375
-
376
- def initialize: (
377
- metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
378
- ) -> void
379
-
380
- def to_hash: -> {
381
- metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
382
- }
383
-
384
- type metadata = { metadata: ::Hash[Symbol, top?] }
385
-
386
- class Metadata < FinchAPI::Internal::Type::BaseModel
387
- attr_accessor metadata: ::Hash[Symbol, top?]
320
+ attr_accessor metadata: ::Hash[Symbol, top?]
388
321
 
389
- def initialize: (metadata: ::Hash[Symbol, top?]) -> void
322
+ def initialize: (metadata: ::Hash[Symbol, top?]) -> void
390
323
 
391
- def to_hash: -> { metadata: ::Hash[Symbol, top?] }
392
- end
324
+ def to_hash: -> { metadata: ::Hash[Symbol, top?] }
393
325
  end
394
326
  end
395
327
 
@@ -3,7 +3,8 @@ module FinchAPI
3
3
  module HRIS
4
4
  type pay_statement_retrieve_many_params =
5
5
  {
6
- requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
6
+ requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
7
+ entity_ids: ::Array[String]
7
8
  }
8
9
  & FinchAPI::Internal::Type::request_parameters
9
10
 
@@ -13,13 +14,19 @@ module FinchAPI
13
14
 
14
15
  attr_accessor requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
15
16
 
17
+ attr_reader entity_ids: ::Array[String]?
18
+
19
+ def entity_ids=: (::Array[String]) -> ::Array[String]
20
+
16
21
  def initialize: (
17
22
  requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
23
+ ?entity_ids: ::Array[String],
18
24
  ?request_options: FinchAPI::request_opts
19
25
  ) -> void
20
26
 
21
27
  def to_hash: -> {
22
28
  requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
29
+ entity_ids: ::Array[String],
23
30
  request_options: FinchAPI::RequestOptions
24
31
  }
25
32
 
@@ -2,7 +2,7 @@ module FinchAPI
2
2
  module Models
3
3
  module HRIS
4
4
  type payment_list_params =
5
- { end_date: Date, start_date: Date }
5
+ { end_date: Date, start_date: Date, entity_ids: ::Array[String] }
6
6
  & FinchAPI::Internal::Type::request_parameters
7
7
 
8
8
  class PaymentListParams < FinchAPI::Internal::Type::BaseModel
@@ -13,15 +13,21 @@ module FinchAPI
13
13
 
14
14
  attr_accessor start_date: Date
15
15
 
16
+ attr_reader entity_ids: ::Array[String]?
17
+
18
+ def entity_ids=: (::Array[String]) -> ::Array[String]
19
+
16
20
  def initialize: (
17
21
  end_date: Date,
18
22
  start_date: Date,
23
+ ?entity_ids: ::Array[String],
19
24
  ?request_options: FinchAPI::request_opts
20
25
  ) -> void
21
26
 
22
27
  def to_hash: -> {
23
28
  end_date: Date,
24
29
  start_date: Date,
30
+ entity_ids: ::Array[String],
25
31
  request_options: FinchAPI::RequestOptions
26
32
  }
27
33
  end
@@ -47,13 +47,14 @@ module FinchAPI
47
47
  hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?
48
48
  }
49
49
 
50
- type company_contribution = :fixed | :percent
50
+ type company_contribution = :fixed | :percent | :tiered
51
51
 
52
52
  module CompanyContribution
53
53
  extend FinchAPI::Internal::Type::Enum
54
54
 
55
55
  FIXED: :fixed
56
56
  PERCENT: :percent
57
+ TIERED: :tiered
57
58
 
58
59
  def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution]
59
60
  end
@@ -5,76 +5,62 @@ module FinchAPI
5
5
  {
6
6
  data: FinchAPI::HRIS::W42005::Data,
7
7
  type: FinchAPI::Models::HRIS::W42005::type_,
8
- year: Float?
8
+ year: Float
9
9
  }
10
10
 
11
11
  class W42005 < FinchAPI::Internal::Type::BaseModel
12
- attr_reader data: FinchAPI::HRIS::W42005::Data?
12
+ attr_accessor data: FinchAPI::HRIS::W42005::Data
13
13
 
14
- def data=: (
15
- FinchAPI::HRIS::W42005::Data
16
- ) -> FinchAPI::HRIS::W42005::Data
14
+ attr_accessor type: FinchAPI::Models::HRIS::W42005::type_
17
15
 
18
- attr_reader type: FinchAPI::Models::HRIS::W42005::type_?
19
-
20
- def type=: (
21
- FinchAPI::Models::HRIS::W42005::type_
22
- ) -> FinchAPI::Models::HRIS::W42005::type_
23
-
24
- attr_accessor year: Float?
16
+ attr_accessor year: Float
25
17
 
26
18
  def initialize: (
27
- ?data: FinchAPI::HRIS::W42005::Data,
28
- ?type: FinchAPI::Models::HRIS::W42005::type_,
29
- ?year: Float?
19
+ data: FinchAPI::HRIS::W42005::Data,
20
+ type: FinchAPI::Models::HRIS::W42005::type_,
21
+ year: Float
30
22
  ) -> void
31
23
 
32
24
  def to_hash: -> {
33
25
  data: FinchAPI::HRIS::W42005::Data,
34
26
  type: FinchAPI::Models::HRIS::W42005::type_,
35
- year: Float?
27
+ year: Float
36
28
  }
37
29
 
38
30
  type data =
39
31
  {
40
- additional_withholding: Integer?,
41
- exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
32
+ additional_withholding: Integer,
33
+ exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?,
42
34
  filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
43
35
  individual_id: String,
44
- total_number_of_allowances: Integer?
36
+ total_number_of_allowances: Integer
45
37
  }
46
38
 
47
39
  class Data < FinchAPI::Internal::Type::BaseModel
48
- attr_accessor additional_withholding: Integer?
40
+ attr_accessor additional_withholding: Integer
49
41
 
50
- attr_reader exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?
51
-
52
- def exemption=: (
53
- FinchAPI::Models::HRIS::W42005::Data::exemption
54
- ) -> FinchAPI::Models::HRIS::W42005::Data::exemption
42
+ attr_accessor exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?
55
43
 
56
44
  attr_accessor filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?
57
45
 
58
- attr_reader individual_id: String?
59
-
60
- def individual_id=: (String) -> String
46
+ attr_accessor individual_id: String
61
47
 
62
- attr_accessor total_number_of_allowances: Integer?
48
+ attr_accessor total_number_of_allowances: Integer
63
49
 
64
50
  def initialize: (
65
- ?additional_withholding: Integer?,
66
- ?exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
67
- ?filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
68
- ?individual_id: String,
69
- ?total_number_of_allowances: Integer?
51
+ additional_withholding: Integer,
52
+ exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?,
53
+ filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
54
+ individual_id: String,
55
+ total_number_of_allowances: Integer
70
56
  ) -> void
71
57
 
72
58
  def to_hash: -> {
73
- additional_withholding: Integer?,
74
- exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
59
+ additional_withholding: Integer,
60
+ exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?,
75
61
  filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
76
62
  individual_id: String,
77
- total_number_of_allowances: Integer?
63
+ total_number_of_allowances: Integer
78
64
  }
79
65
 
80
66
  type exemption = :exempt | :non_exempt