finch-api 0.1.0.pre.alpha.48 → 0.1.0.pre.alpha.50

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 (120) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/models/base_webhook_event.rb +2 -5
  5. data/lib/finch_api/models/create_access_token_response.rb +2 -5
  6. data/lib/finch_api/models/hris/benefit_create_params.rb +3 -2
  7. data/lib/finch_api/models/hris/benefit_list_params.rb +6 -2
  8. data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +6 -2
  9. data/lib/finch_api/models/hris/benefit_register_params.rb +6 -2
  10. data/lib/finch_api/models/hris/benefit_retrieve_params.rb +6 -2
  11. data/lib/finch_api/models/hris/benefit_update_params.rb +6 -2
  12. data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +6 -2
  13. data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +7 -2
  14. data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +3 -2
  15. data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +7 -2
  16. data/lib/finch_api/models/hris/company_retrieve_params.rb +6 -2
  17. data/lib/finch_api/models/hris/directory_list_individuals_params.rb +6 -2
  18. data/lib/finch_api/models/hris/directory_list_params.rb +6 -2
  19. data/lib/finch_api/models/hris/document_list_params.rb +3 -2
  20. data/lib/finch_api/models/hris/document_retreive_params.rb +6 -2
  21. data/lib/finch_api/models/hris/employment_data.rb +36 -1
  22. data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +6 -2
  23. data/lib/finch_api/models/hris/individual.rb +30 -1
  24. data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +6 -2
  25. data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb +6 -2
  26. data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb +6 -2
  27. data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb +6 -2
  28. data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb +6 -2
  29. data/lib/finch_api/models/hris/pay_statement_item_list_params.rb +3 -2
  30. data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +6 -2
  31. data/lib/finch_api/models/hris/payment_list_params.rb +3 -2
  32. data/lib/finch_api/models/introspection.rb +2 -5
  33. data/lib/finch_api/models/payroll/pay_group_list_params.rb +6 -2
  34. data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +6 -2
  35. data/lib/finch_api/models/sandbox/connection_create_response.rb +2 -4
  36. data/lib/finch_api/models/sandbox/connections/account_create_response.rb +2 -4
  37. data/lib/finch_api/models/sandbox/connections/account_update_response.rb +2 -4
  38. data/lib/finch_api/models/sandbox/directory_create_params.rb +65 -1
  39. data/lib/finch_api/models/sandbox/employment_update_params.rb +36 -1
  40. data/lib/finch_api/models/sandbox/employment_update_response.rb +36 -1
  41. data/lib/finch_api/models/sandbox/individual_update_params.rb +28 -1
  42. data/lib/finch_api/models/sandbox/individual_update_response.rb +30 -1
  43. data/lib/finch_api/resources/hris/benefits/individuals.rb +15 -4
  44. data/lib/finch_api/resources/hris/benefits.rb +21 -6
  45. data/lib/finch_api/resources/hris/company.rb +4 -1
  46. data/lib/finch_api/resources/hris/directory.rb +4 -1
  47. data/lib/finch_api/resources/hris/documents.rb +5 -2
  48. data/lib/finch_api/resources/hris/employments.rb +4 -1
  49. data/lib/finch_api/resources/hris/individuals.rb +4 -1
  50. data/lib/finch_api/resources/hris/pay_statement_item/rules.rb +13 -4
  51. data/lib/finch_api/resources/hris/pay_statement_item.rb +1 -1
  52. data/lib/finch_api/resources/hris/pay_statements.rb +4 -1
  53. data/lib/finch_api/resources/hris/payments.rb +1 -1
  54. data/lib/finch_api/resources/payroll/pay_groups.rb +8 -2
  55. data/lib/finch_api/resources/sandbox/employment.rb +9 -1
  56. data/lib/finch_api/resources/sandbox/individual.rb +3 -1
  57. data/lib/finch_api/version.rb +1 -1
  58. data/rbi/finch_api/models/base_webhook_event.rbi +2 -4
  59. data/rbi/finch_api/models/create_access_token_response.rbi +2 -4
  60. data/rbi/finch_api/models/hris/benefit_create_params.rbi +4 -2
  61. data/rbi/finch_api/models/hris/benefit_list_params.rbi +4 -2
  62. data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +4 -2
  63. data/rbi/finch_api/models/hris/benefit_register_params.rbi +4 -2
  64. data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +4 -2
  65. data/rbi/finch_api/models/hris/benefit_update_params.rbi +4 -2
  66. data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +4 -2
  67. data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +4 -2
  68. data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +4 -2
  69. data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +4 -2
  70. data/rbi/finch_api/models/hris/company_retrieve_params.rbi +4 -2
  71. data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +4 -2
  72. data/rbi/finch_api/models/hris/directory_list_params.rbi +4 -2
  73. data/rbi/finch_api/models/hris/document_list_params.rbi +4 -2
  74. data/rbi/finch_api/models/hris/document_retreive_params.rbi +4 -2
  75. data/rbi/finch_api/models/hris/employment_data.rbi +38 -0
  76. data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +4 -2
  77. data/rbi/finch_api/models/hris/individual.rbi +78 -0
  78. data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +4 -2
  79. data/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi +4 -2
  80. data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi +4 -2
  81. data/rbi/finch_api/models/hris/pay_statement_item/rule_list_params.rbi +4 -2
  82. data/rbi/finch_api/models/hris/pay_statement_item/rule_update_params.rbi +4 -2
  83. data/rbi/finch_api/models/hris/pay_statement_item_list_params.rbi +4 -2
  84. data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +4 -2
  85. data/rbi/finch_api/models/hris/payment_list_params.rbi +4 -2
  86. data/rbi/finch_api/models/introspection.rbi +2 -4
  87. data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +4 -2
  88. data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +4 -2
  89. data/rbi/finch_api/models/sandbox/connection_create_response.rbi +2 -2
  90. data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +2 -2
  91. data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +2 -2
  92. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +119 -3
  93. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +38 -0
  94. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +41 -3
  95. data/rbi/finch_api/models/sandbox/individual_update_params.rbi +78 -0
  96. data/rbi/finch_api/models/sandbox/individual_update_response.rbi +78 -0
  97. data/rbi/finch_api/resources/hris/benefits/individuals.rbi +8 -4
  98. data/rbi/finch_api/resources/hris/benefits.rbi +12 -6
  99. data/rbi/finch_api/resources/hris/company.rbi +2 -1
  100. data/rbi/finch_api/resources/hris/directory.rbi +2 -1
  101. data/rbi/finch_api/resources/hris/documents.rbi +4 -2
  102. data/rbi/finch_api/resources/hris/employments.rbi +2 -1
  103. data/rbi/finch_api/resources/hris/individuals.rbi +2 -1
  104. data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi +8 -4
  105. data/rbi/finch_api/resources/hris/pay_statement_item.rbi +2 -1
  106. data/rbi/finch_api/resources/hris/pay_statements.rbi +2 -1
  107. data/rbi/finch_api/resources/hris/payments.rbi +2 -1
  108. data/rbi/finch_api/resources/payroll/pay_groups.rbi +4 -2
  109. data/rbi/finch_api/resources/sandbox/employment.rbi +15 -0
  110. data/rbi/finch_api/resources/sandbox/individual.rbi +7 -0
  111. data/sig/finch_api/models/hris/employment_data.rbs +20 -0
  112. data/sig/finch_api/models/hris/individual.rbs +26 -0
  113. data/sig/finch_api/models/sandbox/directory_create_params.rbs +49 -3
  114. data/sig/finch_api/models/sandbox/employment_update_params.rbs +21 -1
  115. data/sig/finch_api/models/sandbox/employment_update_response.rbs +23 -3
  116. data/sig/finch_api/models/sandbox/individual_update_params.rbs +26 -0
  117. data/sig/finch_api/models/sandbox/individual_update_response.rbs +26 -0
  118. data/sig/finch_api/resources/sandbox/employment.rbs +4 -0
  119. data/sig/finch_api/resources/sandbox/individual.rbs +1 -0
  120. metadata +2 -2
@@ -18,7 +18,8 @@ module FinchAPI
18
18
  sig { returns(String) }
19
19
  attr_accessor :benefit_id
20
20
 
21
- # The entity IDs to specify which entities' data to access.
21
+ # The entity IDs to specify which entities' data to access. Provide exactly one
22
+ # entity ID per request; a maximum of one is accepted.
22
23
  sig { returns(T.nilable(T::Array[String])) }
23
24
  attr_reader :entity_ids
24
25
 
@@ -34,7 +35,8 @@ module FinchAPI
34
35
  end
35
36
  def self.new(
36
37
  benefit_id:,
37
- # The entity IDs to specify which entities' data to access.
38
+ # The entity IDs to specify which entities' data to access. Provide exactly one
39
+ # entity ID per request; a maximum of one is accepted.
38
40
  entity_ids: nil,
39
41
  request_options: {}
40
42
  )
@@ -18,7 +18,8 @@ module FinchAPI
18
18
  sig { returns(String) }
19
19
  attr_accessor :benefit_id
20
20
 
21
- # The entity IDs to specify which entities' data to access.
21
+ # The entity IDs to specify which entities' data to access. Provide exactly one
22
+ # entity ID per request; a maximum of one is accepted.
22
23
  sig { returns(T.nilable(T::Array[String])) }
23
24
  attr_reader :entity_ids
24
25
 
@@ -42,7 +43,8 @@ module FinchAPI
42
43
  end
43
44
  def self.new(
44
45
  benefit_id:,
45
- # The entity IDs to specify which entities' data to access.
46
+ # The entity IDs to specify which entities' data to access. Provide exactly one
47
+ # entity ID per request; a maximum of one is accepted.
46
48
  entity_ids: nil,
47
49
  # Updated name or description.
48
50
  description: nil,
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :benefit_id
21
21
 
22
- # The entity IDs to specify which entities' data to access.
22
+ # The entity IDs to specify which entities' data to access. Provide exactly one
23
+ # entity ID per request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -61,7 +62,8 @@ module FinchAPI
61
62
  end
62
63
  def self.new(
63
64
  benefit_id:,
64
- # The entity IDs to specify which entities' data to access.
65
+ # The entity IDs to specify which entities' data to access. Provide exactly one
66
+ # entity ID per request; a maximum of one is accepted.
65
67
  entity_ids: nil,
66
68
  # Array of the individual_id to enroll and a configuration object.
67
69
  individuals: nil,
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :benefit_id
21
21
 
22
- # The entity IDs to specify which entities' data to access.
22
+ # The entity IDs to specify which entities' data to access. Provide exactly one
23
+ # entity ID per request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -35,7 +36,8 @@ module FinchAPI
35
36
  end
36
37
  def self.new(
37
38
  benefit_id:,
38
- # The entity IDs to specify which entities' data to access.
39
+ # The entity IDs to specify which entities' data to access. Provide exactly one
40
+ # entity ID per request; a maximum of one is accepted.
39
41
  entity_ids: nil,
40
42
  request_options: {}
41
43
  )
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :benefit_id
21
21
 
22
- # The entity IDs to specify which entities' data to access.
22
+ # The entity IDs to specify which entities' data to access. Provide exactly one
23
+ # entity ID per request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -44,7 +45,8 @@ module FinchAPI
44
45
  end
45
46
  def self.new(
46
47
  benefit_id:,
47
- # The entity IDs to specify which entities' data to access.
48
+ # The entity IDs to specify which entities' data to access. Provide exactly one
49
+ # entity ID per request; a maximum of one is accepted.
48
50
  entity_ids: nil,
49
51
  # comma-delimited list of stable Finch uuids for each individual. If empty,
50
52
  # defaults to all individuals
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :benefit_id
21
21
 
22
- # The entity IDs to specify which entities' data to access.
22
+ # The entity IDs to specify which entities' data to access. Provide exactly one
23
+ # entity ID per request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -43,7 +44,8 @@ module FinchAPI
43
44
  end
44
45
  def self.new(
45
46
  benefit_id:,
46
- # The entity IDs to specify which entities' data to access.
47
+ # The entity IDs to specify which entities' data to access. Provide exactly one
48
+ # entity ID per request; a maximum of one is accepted.
47
49
  entity_ids: nil,
48
50
  # Array of individual_ids to unenroll.
49
51
  individual_ids: nil,
@@ -15,7 +15,8 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- # The entity IDs to specify which entities' data to access.
18
+ # The entity IDs to specify which entities' data to access. Provide exactly one
19
+ # entity ID per request; a maximum of one is accepted.
19
20
  sig { returns(T.nilable(T::Array[String])) }
20
21
  attr_reader :entity_ids
21
22
 
@@ -29,7 +30,8 @@ module FinchAPI
29
30
  ).returns(T.attached_class)
30
31
  end
31
32
  def self.new(
32
- # The entity IDs to specify which entities' data to access.
33
+ # The entity IDs to specify which entities' data to access. Provide exactly one
34
+ # entity ID per request; a maximum of one is accepted.
33
35
  entity_ids: nil,
34
36
  request_options: {}
35
37
  )
@@ -15,7 +15,8 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- # The entity IDs to specify which entities' data to access.
18
+ # The entity IDs to specify which entities' data to access. Provide exactly one
19
+ # entity ID per request; a maximum of one is accepted.
19
20
  sig { returns(T.nilable(T::Array[String])) }
20
21
  attr_reader :entity_ids
21
22
 
@@ -45,7 +46,8 @@ module FinchAPI
45
46
  ).returns(T.attached_class)
46
47
  end
47
48
  def self.new(
48
- # The entity IDs to specify which entities' data to access.
49
+ # The entity IDs to specify which entities' data to access. Provide exactly one
50
+ # entity ID per request; a maximum of one is accepted.
49
51
  entity_ids: nil,
50
52
  # Number of employees to return (defaults to 100, maximum 10000)
51
53
  limit: nil,
@@ -15,7 +15,8 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- # The entity IDs to specify which entities' data to access.
18
+ # The entity IDs to specify which entities' data to access. Provide exactly one
19
+ # entity ID per request; a maximum of one is accepted.
19
20
  sig { returns(T.nilable(T::Array[String])) }
20
21
  attr_reader :entity_ids
21
22
 
@@ -45,7 +46,8 @@ module FinchAPI
45
46
  ).returns(T.attached_class)
46
47
  end
47
48
  def self.new(
48
- # The entity IDs to specify which entities' data to access.
49
+ # The entity IDs to specify which entities' data to access. Provide exactly one
50
+ # entity ID per request; a maximum of one is accepted.
49
51
  entity_ids: nil,
50
52
  # Number of employees to return (defaults to 100, maximum 10000)
51
53
  limit: nil,
@@ -15,7 +15,8 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- # The entity IDs to specify which entities' data to access.
18
+ # The entity IDs to specify which entities' data to access. Provide exactly one
19
+ # entity ID per request; a maximum of one is accepted.
19
20
  sig { returns(T.nilable(T::Array[String])) }
20
21
  attr_reader :entity_ids
21
22
 
@@ -73,7 +74,8 @@ module FinchAPI
73
74
  ).returns(T.attached_class)
74
75
  end
75
76
  def self.new(
76
- # The entity IDs to specify which entities' data to access.
77
+ # The entity IDs to specify which entities' data to access. Provide exactly one
78
+ # entity ID per request; a maximum of one is accepted.
77
79
  entity_ids: nil,
78
80
  # Comma-delimited list of stable Finch uuids for each individual. If empty,
79
81
  # defaults to all individuals
@@ -18,7 +18,8 @@ module FinchAPI
18
18
  sig { returns(String) }
19
19
  attr_accessor :document_id
20
20
 
21
- # The entity IDs to specify which entities' data to access.
21
+ # The entity IDs to specify which entities' data to access. Provide exactly one
22
+ # entity ID per request; a maximum of one is accepted.
22
23
  sig { returns(T.nilable(T::Array[String])) }
23
24
  attr_reader :entity_ids
24
25
 
@@ -34,7 +35,8 @@ module FinchAPI
34
35
  end
35
36
  def self.new(
36
37
  document_id:,
37
- # The entity IDs to specify which entities' data to access.
38
+ # The entity IDs to specify which entities' data to access. Provide exactly one
39
+ # entity ID per request; a maximum of one is accepted.
38
40
  entity_ids: nil,
39
41
  request_options: {}
40
42
  )
@@ -99,10 +99,20 @@ module FinchAPI
99
99
  end
100
100
  attr_accessor :flsa_status
101
101
 
102
+ # IRS flag indicating whether the employee is classified as a Highly Compensated
103
+ # Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
104
+ sig { returns(T.nilable(T::Boolean)) }
105
+ attr_accessor :highly_compensated_employee
106
+
102
107
  # `true` if the individual an an active employee or contractor at the company.
103
108
  sig { returns(T.nilable(T::Boolean)) }
104
109
  attr_accessor :is_active
105
110
 
111
+ # IRS flag indicating whether the employee is classified as a Key Employee for
112
+ # top-heavy testing purposes. US-only.
113
+ sig { returns(T.nilable(T::Boolean)) }
114
+ attr_accessor :key_employee
115
+
106
116
  # The legal last name of the individual.
107
117
  sig { returns(T.nilable(String)) }
108
118
  attr_accessor :last_name
@@ -147,6 +157,15 @@ module FinchAPI
147
157
  sig { returns(T.nilable(String)) }
148
158
  attr_accessor :title
149
159
 
160
+ # The code identifying the union the employee is a member of, as configured in the
161
+ # payroll system.
162
+ sig { returns(T.nilable(String)) }
163
+ attr_accessor :union_code
164
+
165
+ # The local chapter or local number within the employee's union.
166
+ sig { returns(T.nilable(String)) }
167
+ attr_accessor :union_local
168
+
150
169
  # Custom fields for the individual. These are fields which are defined by the
151
170
  # employer in the system. Custom fields are not currently supported for assisted
152
171
  # connections.
@@ -204,7 +223,9 @@ module FinchAPI
204
223
  T.nilable(
205
224
  FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus::OrSymbol
206
225
  ),
226
+ highly_compensated_employee: T.nilable(T::Boolean),
207
227
  is_active: T.nilable(T::Boolean),
228
+ key_employee: T.nilable(T::Boolean),
208
229
  last_name: T.nilable(String),
209
230
  latest_rehire_date: T.nilable(String),
210
231
  location: T.nilable(FinchAPI::Location::OrHash),
@@ -215,6 +236,8 @@ module FinchAPI
215
236
  middle_name: T.nilable(String),
216
237
  start_date: T.nilable(String),
217
238
  title: T.nilable(String),
239
+ union_code: T.nilable(String),
240
+ union_local: T.nilable(String),
218
241
  custom_fields:
219
242
  T.nilable(
220
243
  T::Array[
@@ -245,8 +268,14 @@ module FinchAPI
245
268
  # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
246
269
  # `unknown`.
247
270
  flsa_status:,
271
+ # IRS flag indicating whether the employee is classified as a Highly Compensated
272
+ # Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
273
+ highly_compensated_employee:,
248
274
  # `true` if the individual an an active employee or contractor at the company.
249
275
  is_active:,
276
+ # IRS flag indicating whether the employee is classified as a Key Employee for
277
+ # top-heavy testing purposes. US-only.
278
+ key_employee:,
250
279
  # The legal last name of the individual.
251
280
  last_name:,
252
281
  latest_rehire_date:,
@@ -258,6 +287,11 @@ module FinchAPI
258
287
  start_date:,
259
288
  # The current title of the individual.
260
289
  title:,
290
+ # The code identifying the union the employee is a member of, as configured in the
291
+ # payroll system.
292
+ union_code:,
293
+ # The local chapter or local number within the employee's union.
294
+ union_local:,
261
295
  # Custom fields for the individual. These are fields which are defined by the
262
296
  # employer in the system. Custom fields are not currently supported for assisted
263
297
  # connections.
@@ -298,7 +332,9 @@ module FinchAPI
298
332
  T.nilable(
299
333
  FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus::TaggedSymbol
300
334
  ),
335
+ highly_compensated_employee: T.nilable(T::Boolean),
301
336
  is_active: T.nilable(T::Boolean),
337
+ key_employee: T.nilable(T::Boolean),
302
338
  last_name: T.nilable(String),
303
339
  latest_rehire_date: T.nilable(String),
304
340
  location: T.nilable(FinchAPI::Location),
@@ -309,6 +345,8 @@ module FinchAPI
309
345
  middle_name: T.nilable(String),
310
346
  start_date: T.nilable(String),
311
347
  title: T.nilable(String),
348
+ union_code: T.nilable(String),
349
+ union_local: T.nilable(String),
312
350
  custom_fields:
313
351
  T.nilable(
314
352
  T::Array[
@@ -23,7 +23,8 @@ module FinchAPI
23
23
  end
24
24
  attr_accessor :requests
25
25
 
26
- # The entity IDs to specify which entities' data to access.
26
+ # The entity IDs to specify which entities' data to access. Provide exactly one
27
+ # entity ID per request; a maximum of one is accepted.
27
28
  sig { returns(T.nilable(T::Array[String])) }
28
29
  attr_reader :entity_ids
29
30
 
@@ -43,7 +44,8 @@ module FinchAPI
43
44
  def self.new(
44
45
  # The array of batch requests. Maximum 10000 items per request.
45
46
  requests:,
46
- # The entity IDs to specify which entities' data to access.
47
+ # The entity IDs to specify which entities' data to access. Provide exactly one
48
+ # entity ID per request; a maximum of one is accepted.
47
49
  entity_ids: nil,
48
50
  request_options: {}
49
51
  )
@@ -58,6 +58,17 @@ module FinchAPI
58
58
  sig { returns(T.nilable(String)) }
59
59
  attr_accessor :last_name
60
60
 
61
+ # The employee's marital status, used for beneficiary designation and spousal
62
+ # consent workflows.
63
+ sig do
64
+ returns(
65
+ T.nilable(
66
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
67
+ )
68
+ )
69
+ end
70
+ attr_accessor :marital_status
71
+
61
72
  # The legal middle name of the individual.
62
73
  sig { returns(T.nilable(String)) }
63
74
  attr_accessor :middle_name
@@ -123,6 +134,10 @@ module FinchAPI
123
134
  FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::OrSymbol
124
135
  ),
125
136
  last_name: T.nilable(String),
137
+ marital_status:
138
+ T.nilable(
139
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::OrSymbol
140
+ ),
126
141
  middle_name: T.nilable(String),
127
142
  phone_numbers:
128
143
  T.nilable(
@@ -156,6 +171,9 @@ module FinchAPI
156
171
  gender:,
157
172
  # The legal last name of the individual.
158
173
  last_name:,
174
+ # The employee's marital status, used for beneficiary designation and spousal
175
+ # consent workflows.
176
+ marital_status:,
159
177
  # The legal middle name of the individual.
160
178
  middle_name:,
161
179
  phone_numbers:,
@@ -190,6 +208,10 @@ module FinchAPI
190
208
  FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
191
209
  ),
192
210
  last_name: T.nilable(String),
211
+ marital_status:
212
+ T.nilable(
213
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
214
+ ),
193
215
  middle_name: T.nilable(String),
194
216
  phone_numbers:
195
217
  T.nilable(
@@ -325,6 +347,62 @@ module FinchAPI
325
347
  end
326
348
  end
327
349
 
350
+ # The employee's marital status, used for beneficiary designation and spousal
351
+ # consent workflows.
352
+ module MaritalStatus
353
+ extend FinchAPI::Internal::Type::Enum
354
+
355
+ TaggedSymbol =
356
+ T.type_alias do
357
+ T.all(
358
+ Symbol,
359
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus
360
+ )
361
+ end
362
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
363
+
364
+ SINGLE =
365
+ T.let(
366
+ :single,
367
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
368
+ )
369
+ MARRIED =
370
+ T.let(
371
+ :married,
372
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
373
+ )
374
+ DIVORCED =
375
+ T.let(
376
+ :divorced,
377
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
378
+ )
379
+ WIDOWED =
380
+ T.let(
381
+ :widowed,
382
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
383
+ )
384
+ DOMESTIC_PARTNER =
385
+ T.let(
386
+ :domestic_partner,
387
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
388
+ )
389
+ UNKNOWN =
390
+ T.let(
391
+ :unknown,
392
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
393
+ )
394
+
395
+ sig do
396
+ override.returns(
397
+ T::Array[
398
+ FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
399
+ ]
400
+ )
401
+ end
402
+ def self.values
403
+ end
404
+ end
405
+
328
406
  class PhoneNumber < FinchAPI::Internal::Type::BaseModel
329
407
  OrHash =
330
408
  T.type_alias do
@@ -23,7 +23,8 @@ module FinchAPI
23
23
  end
24
24
  attr_accessor :requests
25
25
 
26
- # The entity IDs to specify which entities' data to access.
26
+ # The entity IDs to specify which entities' data to access. Provide exactly one
27
+ # entity ID per request; a maximum of one is accepted.
27
28
  sig { returns(T.nilable(T::Array[String])) }
28
29
  attr_reader :entity_ids
29
30
 
@@ -64,7 +65,8 @@ module FinchAPI
64
65
  def self.new(
65
66
  # The array of batch requests. Maximum 10000 items per request.
66
67
  requests:,
67
- # The entity IDs to specify which entities' data to access.
68
+ # The entity IDs to specify which entities' data to access. Provide exactly one
69
+ # entity ID per request; a maximum of one is accepted.
68
70
  entity_ids: nil,
69
71
  options: nil,
70
72
  request_options: {}
@@ -16,7 +16,8 @@ module FinchAPI
16
16
  )
17
17
  end
18
18
 
19
- # The entity IDs to create the rule for.
19
+ # The entity IDs to create the rule for. Provide exactly one entity ID per
20
+ # request; a maximum of one is accepted.
20
21
  sig { returns(T.nilable(T::Array[String])) }
21
22
  attr_reader :entity_ids
22
23
 
@@ -105,7 +106,8 @@ module FinchAPI
105
106
  ).returns(T.attached_class)
106
107
  end
107
108
  def self.new(
108
- # The entity IDs to create the rule for.
109
+ # The entity IDs to create the rule for. Provide exactly one entity ID per
110
+ # request; a maximum of one is accepted.
109
111
  entity_ids: nil,
110
112
  # Specifies the fields to be applied when the condition is met.
111
113
  attributes: nil,
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :rule_id
21
21
 
22
- # The entity IDs to delete the rule for.
22
+ # The entity IDs to delete the rule for. Provide exactly one entity ID per
23
+ # request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -35,7 +36,8 @@ module FinchAPI
35
36
  end
36
37
  def self.new(
37
38
  rule_id:,
38
- # The entity IDs to delete the rule for.
39
+ # The entity IDs to delete the rule for. Provide exactly one entity ID per
40
+ # request; a maximum of one is accepted.
39
41
  entity_ids: nil,
40
42
  request_options: {}
41
43
  )
@@ -16,7 +16,8 @@ module FinchAPI
16
16
  )
17
17
  end
18
18
 
19
- # The entity IDs to retrieve rules for.
19
+ # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
20
+ # a maximum of one is accepted.
20
21
  sig { returns(T.nilable(T::Array[String])) }
21
22
  attr_reader :entity_ids
22
23
 
@@ -30,7 +31,8 @@ module FinchAPI
30
31
  ).returns(T.attached_class)
31
32
  end
32
33
  def self.new(
33
- # The entity IDs to retrieve rules for.
34
+ # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
35
+ # a maximum of one is accepted.
34
36
  entity_ids: nil,
35
37
  request_options: {}
36
38
  )
@@ -19,7 +19,8 @@ module FinchAPI
19
19
  sig { returns(String) }
20
20
  attr_accessor :rule_id
21
21
 
22
- # The entity IDs to update the rule for.
22
+ # The entity IDs to update the rule for. Provide exactly one entity ID per
23
+ # request; a maximum of one is accepted.
23
24
  sig { returns(T.nilable(T::Array[String])) }
24
25
  attr_reader :entity_ids
25
26
 
@@ -42,7 +43,8 @@ module FinchAPI
42
43
  end
43
44
  def self.new(
44
45
  rule_id:,
45
- # The entity IDs to update the rule for.
46
+ # The entity IDs to update the rule for. Provide exactly one entity ID per
47
+ # request; a maximum of one is accepted.
46
48
  entity_ids: nil,
47
49
  optional_property: nil,
48
50
  request_options: {}
@@ -46,7 +46,8 @@ module FinchAPI
46
46
  sig { params(end_date: Date).void }
47
47
  attr_writer :end_date
48
48
 
49
- # The entity IDs to specify which entities' data to access.
49
+ # The entity IDs to specify which entities' data to access. Provide exactly one
50
+ # entity ID per request; a maximum of one is accepted.
50
51
  sig { returns(T.nilable(T::Array[String])) }
51
52
  attr_reader :entity_ids
52
53
 
@@ -96,7 +97,8 @@ module FinchAPI
96
97
  # The end date to retrieve pay statement items by via their last seen pay date in
97
98
  # `YYYY-MM-DD` format.
98
99
  end_date: nil,
99
- # The entity IDs to specify which entities' data to access.
100
+ # The entity IDs to specify which entities' data to access. Provide exactly one
101
+ # entity ID per request; a maximum of one is accepted.
100
102
  entity_ids: nil,
101
103
  # Case-insensitive partial match search by pay statement item name.
102
104
  name: nil,
@@ -23,7 +23,8 @@ module FinchAPI
23
23
  end
24
24
  attr_accessor :requests
25
25
 
26
- # The entity IDs to specify which entities' data to access.
26
+ # The entity IDs to specify which entities' data to access. Provide exactly one
27
+ # entity ID per request; a maximum of one is accepted.
27
28
  sig { returns(T.nilable(T::Array[String])) }
28
29
  attr_reader :entity_ids
29
30
 
@@ -43,7 +44,8 @@ module FinchAPI
43
44
  def self.new(
44
45
  # The array of batch requests. Maximum 10 payment_ids per request.
45
46
  requests:,
46
- # The entity IDs to specify which entities' data to access.
47
+ # The entity IDs to specify which entities' data to access. Provide exactly one
48
+ # entity ID per request; a maximum of one is accepted.
47
49
  entity_ids: nil,
48
50
  request_options: {}
49
51
  )
@@ -25,7 +25,8 @@ module FinchAPI
25
25
  sig { returns(Date) }
26
26
  attr_accessor :start_date
27
27
 
28
- # The entity IDs to specify which entities' data to access.
28
+ # The entity IDs to specify which entities' data to access. Provide exactly one
29
+ # entity ID per request; a maximum of one is accepted.
29
30
  sig { returns(T.nilable(T::Array[String])) }
30
31
  attr_reader :entity_ids
31
32
 
@@ -47,7 +48,8 @@ module FinchAPI
47
48
  # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
48
49
  # format. Filters payments by their **pay_date** field.
49
50
  start_date:,
50
- # The entity IDs to specify which entities' data to access.
51
+ # The entity IDs to specify which entities' data to access. Provide exactly one
52
+ # entity ID per request; a maximum of one is accepted.
51
53
  entity_ids: nil,
52
54
  request_options: {}
53
55
  )
@@ -72,8 +72,7 @@ module FinchAPI
72
72
  end
73
73
  attr_writer :authentication_methods
74
74
 
75
- # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
76
- # instead of this company ID
75
+ # The Finch UUID of the company associated with the `access_token`.
77
76
  sig { returns(T.nilable(String)) }
78
77
  attr_reader :company_id
79
78
 
@@ -172,8 +171,7 @@ module FinchAPI
172
171
  # instead of this account ID
173
172
  account_id: nil,
174
173
  authentication_methods: nil,
175
- # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
176
- # instead of this company ID
174
+ # The Finch UUID of the company associated with the `access_token`.
177
175
  company_id: nil,
178
176
  # The email of your customer you provided to Finch when a connect session was
179
177
  # created for this connection
@@ -15,7 +15,8 @@ module FinchAPI
15
15
  )
16
16
  end
17
17
 
18
- # The entity IDs to specify which entities' data to access.
18
+ # The entity IDs to specify which entities' data to access. Provide exactly one
19
+ # entity ID per request; a maximum of one is accepted.
19
20
  sig { returns(T.nilable(T::Array[String])) }
20
21
  attr_reader :entity_ids
21
22
 
@@ -43,7 +44,8 @@ module FinchAPI
43
44
  ).returns(T.attached_class)
44
45
  end
45
46
  def self.new(
46
- # The entity IDs to specify which entities' data to access.
47
+ # The entity IDs to specify which entities' data to access. Provide exactly one
48
+ # entity ID per request; a maximum of one is accepted.
47
49
  entity_ids: nil,
48
50
  individual_id: nil,
49
51
  pay_frequencies: nil,