finch-api 0.1.0.pre.alpha.58 → 0.1.0.pre.alpha.60

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/finch_api/models/account_update_event.rb +328 -8
  5. data/lib/finch_api/models/hris/employment_data.rb +11 -1
  6. data/lib/finch_api/models/hris/individual.rb +9 -1
  7. data/lib/finch_api/models/provider.rb +1371 -4
  8. data/lib/finch_api/models/provider_list_response.rb +1387 -4
  9. data/lib/finch_api/models/sandbox/directory_create_params.rb +20 -2
  10. data/lib/finch_api/models/sandbox/employment_update_params.rb +11 -1
  11. data/lib/finch_api/models/sandbox/employment_update_response.rb +11 -1
  12. data/lib/finch_api/models/sandbox/individual_update_params.rb +9 -1
  13. data/lib/finch_api/models/sandbox/individual_update_response.rb +9 -1
  14. data/lib/finch_api/resources/sandbox/employment.rb +3 -1
  15. data/lib/finch_api/version.rb +1 -1
  16. data/rbi/finch_api/models/account_update_event.rbi +738 -15
  17. data/rbi/finch_api/models/hris/employment_data.rbi +12 -0
  18. data/rbi/finch_api/models/hris/individual.rbi +10 -1
  19. data/rbi/finch_api/models/provider.rbi +3137 -6
  20. data/rbi/finch_api/models/provider_list_response.rbi +3139 -6
  21. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +22 -1
  22. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +12 -0
  23. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +12 -0
  24. data/rbi/finch_api/models/sandbox/individual_update_params.rbi +10 -1
  25. data/rbi/finch_api/models/sandbox/individual_update_response.rbi +10 -1
  26. data/rbi/finch_api/resources/sandbox/employment.rbi +5 -0
  27. data/sig/finch_api/models/account_update_event.rbs +405 -17
  28. data/sig/finch_api/models/hris/employment_data.rbs +5 -0
  29. data/sig/finch_api/models/provider.rbs +1722 -6
  30. data/sig/finch_api/models/provider_list_response.rbs +1722 -6
  31. data/sig/finch_api/models/sandbox/directory_create_params.rbs +5 -0
  32. data/sig/finch_api/models/sandbox/employment_update_params.rbs +5 -0
  33. data/sig/finch_api/models/sandbox/employment_update_response.rbs +5 -0
  34. data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
  35. metadata +2 -2
@@ -67,6 +67,12 @@ module FinchAPI
67
67
  )
68
68
  end
69
69
 
70
+ # The employer defined benefit eligibility class that groups an employee into a
71
+ # set of eligible benefit plans, as stored by the provider. Null when not
72
+ # configured.
73
+ sig { returns(T.nilable(String)) }
74
+ attr_accessor :benefit_eligibility_class
75
+
70
76
  # Worker's compensation classification code for this employee
71
77
  sig { returns(T.nilable(String)) }
72
78
  attr_accessor :class_code
@@ -316,6 +322,7 @@ module FinchAPI
316
322
 
317
323
  sig do
318
324
  params(
325
+ benefit_eligibility_class: T.nilable(String),
319
326
  class_code: T.nilable(String),
320
327
  custom_fields:
321
328
  T.nilable(
@@ -394,6 +401,10 @@ module FinchAPI
394
401
  ).returns(T.attached_class)
395
402
  end
396
403
  def self.new(
404
+ # The employer defined benefit eligibility class that groups an employee into a
405
+ # set of eligible benefit plans, as stored by the provider. Null when not
406
+ # configured.
407
+ benefit_eligibility_class: nil,
397
408
  # Worker's compensation classification code for this employee
398
409
  class_code: nil,
399
410
  # Custom fields for the individual. These are fields which are defined by the
@@ -472,6 +483,7 @@ module FinchAPI
472
483
  sig do
473
484
  override.returns(
474
485
  {
486
+ benefit_eligibility_class: T.nilable(String),
475
487
  class_code: T.nilable(String),
476
488
  custom_fields:
477
489
  T.nilable(
@@ -1213,6 +1225,9 @@ module FinchAPI
1213
1225
  )
1214
1226
  end
1215
1227
 
1228
+ # The phone number. Format: E.164, with extension where applicable, e.g.
1229
+ # `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
1230
+ # the provider is returned.
1216
1231
  sig { returns(T.nilable(String)) }
1217
1232
  attr_accessor :data
1218
1233
 
@@ -1234,7 +1249,13 @@ module FinchAPI
1234
1249
  )
1235
1250
  ).returns(T.attached_class)
1236
1251
  end
1237
- def self.new(data: nil, type: nil)
1252
+ def self.new(
1253
+ # The phone number. Format: E.164, with extension where applicable, e.g.
1254
+ # `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
1255
+ # the provider is returned.
1256
+ data: nil,
1257
+ type: nil
1258
+ )
1238
1259
  end
1239
1260
 
1240
1261
  sig do
@@ -18,6 +18,12 @@ module FinchAPI
18
18
  sig { returns(String) }
19
19
  attr_accessor :individual_id
20
20
 
21
+ # The employer defined benefit eligibility class that groups an employee into a
22
+ # set of eligible benefit plans, as stored by the provider. Null when not
23
+ # configured.
24
+ sig { returns(T.nilable(String)) }
25
+ attr_accessor :benefit_eligibility_class
26
+
21
27
  # Worker's compensation classification code for this employee
22
28
  sig { returns(T.nilable(String)) }
23
29
  attr_accessor :class_code
@@ -181,6 +187,7 @@ module FinchAPI
181
187
  sig do
182
188
  params(
183
189
  individual_id: String,
190
+ benefit_eligibility_class: T.nilable(String),
184
191
  class_code: T.nilable(String),
185
192
  custom_fields:
186
193
  T.nilable(
@@ -230,6 +237,10 @@ module FinchAPI
230
237
  end
231
238
  def self.new(
232
239
  individual_id:,
240
+ # The employer defined benefit eligibility class that groups an employee into a
241
+ # set of eligible benefit plans, as stored by the provider. Null when not
242
+ # configured.
243
+ benefit_eligibility_class: nil,
233
244
  # Worker's compensation classification code for this employee
234
245
  class_code: nil,
235
246
  # Custom fields for the individual. These are fields which are defined by the
@@ -288,6 +299,7 @@ module FinchAPI
288
299
  override.returns(
289
300
  {
290
301
  individual_id: String,
302
+ benefit_eligibility_class: T.nilable(String),
291
303
  class_code: T.nilable(String),
292
304
  custom_fields:
293
305
  T.nilable(
@@ -19,6 +19,12 @@ module FinchAPI
19
19
  sig { params(id: String).void }
20
20
  attr_writer :id
21
21
 
22
+ # The employer defined benefit eligibility class that groups an employee into a
23
+ # set of eligible benefit plans, as stored by the provider. Null when not
24
+ # configured.
25
+ sig { returns(T.nilable(String)) }
26
+ attr_accessor :benefit_eligibility_class
27
+
22
28
  # Worker's compensation classification code for this employee
23
29
  sig { returns(T.nilable(String)) }
24
30
  attr_accessor :class_code
@@ -192,6 +198,7 @@ module FinchAPI
192
198
  sig do
193
199
  params(
194
200
  id: String,
201
+ benefit_eligibility_class: T.nilable(String),
195
202
  class_code: T.nilable(String),
196
203
  custom_fields:
197
204
  T.nilable(
@@ -241,6 +248,10 @@ module FinchAPI
241
248
  def self.new(
242
249
  # A stable Finch `id` (UUID v4) for an individual in the company.
243
250
  id: nil,
251
+ # The employer defined benefit eligibility class that groups an employee into a
252
+ # set of eligible benefit plans, as stored by the provider. Null when not
253
+ # configured.
254
+ benefit_eligibility_class: nil,
244
255
  # Worker's compensation classification code for this employee
245
256
  class_code: nil,
246
257
  # Custom fields for the individual. These are fields which are defined by the
@@ -298,6 +309,7 @@ module FinchAPI
298
309
  override.returns(
299
310
  {
300
311
  id: String,
312
+ benefit_eligibility_class: T.nilable(String),
301
313
  class_code: T.nilable(String),
302
314
  custom_fields:
303
315
  T.nilable(
@@ -483,6 +483,9 @@ module FinchAPI
483
483
  )
484
484
  end
485
485
 
486
+ # The phone number. Format: E.164, with extension where applicable, e.g.
487
+ # `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
488
+ # the provider is returned.
486
489
  sig { returns(T.nilable(String)) }
487
490
  attr_accessor :data
488
491
 
@@ -504,7 +507,13 @@ module FinchAPI
504
507
  )
505
508
  ).returns(T.attached_class)
506
509
  end
507
- def self.new(data: nil, type: nil)
510
+ def self.new(
511
+ # The phone number. Format: E.164, with extension where applicable, e.g.
512
+ # `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
513
+ # the provider is returned.
514
+ data: nil,
515
+ type: nil
516
+ )
508
517
  end
509
518
 
510
519
  sig do
@@ -489,6 +489,9 @@ module FinchAPI
489
489
  )
490
490
  end
491
491
 
492
+ # The phone number. Format: E.164, with extension where applicable, e.g.
493
+ # `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
494
+ # the provider is returned.
492
495
  sig { returns(T.nilable(String)) }
493
496
  attr_accessor :data
494
497
 
@@ -510,7 +513,13 @@ module FinchAPI
510
513
  )
511
514
  ).returns(T.attached_class)
512
515
  end
513
- def self.new(data: nil, type: nil)
516
+ def self.new(
517
+ # The phone number. Format: E.164, with extension where applicable, e.g.
518
+ # `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
519
+ # the provider is returned.
520
+ data: nil,
521
+ type: nil
522
+ )
514
523
  end
515
524
 
516
525
  sig do
@@ -8,6 +8,7 @@ module FinchAPI
8
8
  sig do
9
9
  params(
10
10
  individual_id: String,
11
+ benefit_eligibility_class: T.nilable(String),
11
12
  class_code: T.nilable(String),
12
13
  custom_fields:
13
14
  T.nilable(
@@ -57,6 +58,10 @@ module FinchAPI
57
58
  end
58
59
  def update(
59
60
  individual_id,
61
+ # The employer defined benefit eligibility class that groups an employee into a
62
+ # set of eligible benefit plans, as stored by the provider. Null when not
63
+ # configured.
64
+ benefit_eligibility_class: nil,
60
65
  # Worker's compensation classification code for this employee
61
66
  class_code: nil,
62
67
  # Custom fields for the individual. These are fields which are defined by the