finch-api 0.1.0.pre.alpha.59 → 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 (29) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -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/provider.rb +1371 -4
  7. data/lib/finch_api/models/provider_list_response.rb +1387 -4
  8. data/lib/finch_api/models/sandbox/directory_create_params.rb +11 -1
  9. data/lib/finch_api/models/sandbox/employment_update_params.rb +11 -1
  10. data/lib/finch_api/models/sandbox/employment_update_response.rb +11 -1
  11. data/lib/finch_api/resources/sandbox/employment.rb +3 -1
  12. data/lib/finch_api/version.rb +1 -1
  13. data/rbi/finch_api/models/account_update_event.rbi +738 -15
  14. data/rbi/finch_api/models/hris/employment_data.rbi +12 -0
  15. data/rbi/finch_api/models/provider.rbi +3137 -6
  16. data/rbi/finch_api/models/provider_list_response.rbi +3139 -6
  17. data/rbi/finch_api/models/sandbox/directory_create_params.rbi +12 -0
  18. data/rbi/finch_api/models/sandbox/employment_update_params.rbi +12 -0
  19. data/rbi/finch_api/models/sandbox/employment_update_response.rbi +12 -0
  20. data/rbi/finch_api/resources/sandbox/employment.rbi +5 -0
  21. data/sig/finch_api/models/account_update_event.rbs +405 -17
  22. data/sig/finch_api/models/hris/employment_data.rbs +5 -0
  23. data/sig/finch_api/models/provider.rbs +1722 -6
  24. data/sig/finch_api/models/provider_list_response.rbs +1722 -6
  25. data/sig/finch_api/models/sandbox/directory_create_params.rbs +5 -0
  26. data/sig/finch_api/models/sandbox/employment_update_params.rbs +5 -0
  27. data/sig/finch_api/models/sandbox/employment_update_response.rbs +5 -0
  28. data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
  29. metadata +2 -2
@@ -107,18 +107,21 @@ module FinchAPI
107
107
  FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
108
108
 
109
109
  # @!attribute supported_fields
110
- # The supported fields for each Finch product
110
+ # The supported data fields returned by our HR, payroll, and benefits endpoints
111
111
  #
112
- # @return [Hash{Symbol=>Object, nil}, nil]
112
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, nil]
113
113
  optional :supported_fields,
114
- FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
114
+ -> {
115
+ FinchAPI::Provider::AuthenticationMethod::SupportedFields
116
+ },
117
+ nil?: true
115
118
 
116
119
  # @!method initialize(type:, benefits_support: nil, supported_fields: nil)
117
120
  # @param type [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type] The type of authentication method
118
121
  #
119
122
  # @param benefits_support [Hash{Symbol=>Object, nil}] The supported benefit types and their configurations
120
123
  #
121
- # @param supported_fields [Hash{Symbol=>Object, nil}] The supported fields for each Finch product
124
+ # @param supported_fields [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR, payroll, and benefits endpoints
122
125
 
123
126
  # The type of authentication method
124
127
  #
@@ -136,6 +139,1370 @@ module FinchAPI
136
139
  # @!method self.values
137
140
  # @return [Array<Symbol>]
138
141
  end
142
+
143
+ # @see FinchAPI::Models::Provider::AuthenticationMethod#supported_fields
144
+ class SupportedFields < FinchAPI::Internal::Type::BaseModel
145
+ # @!attribute company
146
+ #
147
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, nil]
148
+ optional :company, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company }
149
+
150
+ # @!attribute directory
151
+ #
152
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, nil]
153
+ optional :directory, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory }
154
+
155
+ # @!attribute employment
156
+ #
157
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, nil]
158
+ optional :employment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment }
159
+
160
+ # @!attribute individual
161
+ #
162
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, nil]
163
+ optional :individual, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual }
164
+
165
+ # @!attribute pay_group
166
+ #
167
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil]
168
+ optional :pay_group, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup }
169
+
170
+ # @!attribute pay_statement
171
+ #
172
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil]
173
+ optional :pay_statement, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement }
174
+
175
+ # @!attribute payment
176
+ #
177
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, nil]
178
+ optional :payment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment }
179
+
180
+ # @!attribute plan_dependents
181
+ #
182
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents, nil]
183
+ optional :plan_dependents,
184
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanDependents }
185
+
186
+ # @!attribute plan_enrollments
187
+ #
188
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments, nil]
189
+ optional :plan_enrollments,
190
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments }
191
+
192
+ # @!attribute plans
193
+ #
194
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Plans, nil]
195
+ optional :plans, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Plans }
196
+
197
+ # @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil, plan_dependents: nil, plan_enrollments: nil, plans: nil)
198
+ # The supported data fields returned by our HR, payroll, and benefits endpoints
199
+ #
200
+ # @param company [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company]
201
+ # @param directory [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory]
202
+ # @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment]
203
+ # @param individual [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual]
204
+ # @param pay_group [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup]
205
+ # @param pay_statement [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement]
206
+ # @param payment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment]
207
+ # @param plan_dependents [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents]
208
+ # @param plan_enrollments [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments]
209
+ # @param plans [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Plans]
210
+
211
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#company
212
+ class Company < FinchAPI::Internal::Type::BaseModel
213
+ # @!attribute id
214
+ #
215
+ # @return [Boolean, nil]
216
+ optional :id, FinchAPI::Internal::Type::Boolean
217
+
218
+ # @!attribute accounts
219
+ #
220
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
221
+ optional :accounts, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts }
222
+
223
+ # @!attribute departments
224
+ #
225
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil]
226
+ optional :departments,
227
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments }
228
+
229
+ # @!attribute ein
230
+ #
231
+ # @return [Boolean, nil]
232
+ optional :ein, FinchAPI::Internal::Type::Boolean
233
+
234
+ # @!attribute entity
235
+ #
236
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil]
237
+ optional :entity, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity }
238
+
239
+ # @!attribute legal_name
240
+ #
241
+ # @return [Boolean, nil]
242
+ optional :legal_name, FinchAPI::Internal::Type::Boolean
243
+
244
+ # @!attribute locations
245
+ #
246
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil]
247
+ optional :locations, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations }
248
+
249
+ # @!attribute primary_email
250
+ #
251
+ # @return [Boolean, nil]
252
+ optional :primary_email, FinchAPI::Internal::Type::Boolean
253
+
254
+ # @!attribute primary_phone_number
255
+ #
256
+ # @return [Boolean, nil]
257
+ optional :primary_phone_number, FinchAPI::Internal::Type::Boolean
258
+
259
+ # @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil)
260
+ # @param id [Boolean]
261
+ # @param accounts [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts]
262
+ # @param departments [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments]
263
+ # @param ein [Boolean]
264
+ # @param entity [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity]
265
+ # @param legal_name [Boolean]
266
+ # @param locations [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations]
267
+ # @param primary_email [Boolean]
268
+ # @param primary_phone_number [Boolean]
269
+
270
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#accounts
271
+ class Accounts < FinchAPI::Internal::Type::BaseModel
272
+ # @!attribute account_name
273
+ #
274
+ # @return [Boolean, nil]
275
+ optional :account_name, FinchAPI::Internal::Type::Boolean
276
+
277
+ # @!attribute account_number
278
+ #
279
+ # @return [Boolean, nil]
280
+ optional :account_number, FinchAPI::Internal::Type::Boolean
281
+
282
+ # @!attribute account_type
283
+ #
284
+ # @return [Boolean, nil]
285
+ optional :account_type, FinchAPI::Internal::Type::Boolean
286
+
287
+ # @!attribute institution_name
288
+ #
289
+ # @return [Boolean, nil]
290
+ optional :institution_name, FinchAPI::Internal::Type::Boolean
291
+
292
+ # @!attribute routing_number
293
+ #
294
+ # @return [Boolean, nil]
295
+ optional :routing_number, FinchAPI::Internal::Type::Boolean
296
+
297
+ # @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
298
+ # @param account_name [Boolean]
299
+ # @param account_number [Boolean]
300
+ # @param account_type [Boolean]
301
+ # @param institution_name [Boolean]
302
+ # @param routing_number [Boolean]
303
+ end
304
+
305
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#departments
306
+ class Departments < FinchAPI::Internal::Type::BaseModel
307
+ # @!attribute name
308
+ #
309
+ # @return [Boolean, nil]
310
+ optional :name, FinchAPI::Internal::Type::Boolean
311
+
312
+ # @!attribute parent
313
+ #
314
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
315
+ optional :parent,
316
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent }
317
+
318
+ # @!method initialize(name: nil, parent: nil)
319
+ # @param name [Boolean]
320
+ # @param parent [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent]
321
+
322
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent
323
+ class Parent < FinchAPI::Internal::Type::BaseModel
324
+ # @!attribute name
325
+ #
326
+ # @return [Boolean, nil]
327
+ optional :name, FinchAPI::Internal::Type::Boolean
328
+
329
+ # @!method initialize(name: nil)
330
+ # @param name [Boolean]
331
+ end
332
+ end
333
+
334
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#entity
335
+ class Entity < FinchAPI::Internal::Type::BaseModel
336
+ # @!attribute subtype
337
+ #
338
+ # @return [Boolean, nil]
339
+ optional :subtype, FinchAPI::Internal::Type::Boolean
340
+
341
+ # @!attribute type
342
+ #
343
+ # @return [Boolean, nil]
344
+ optional :type, FinchAPI::Internal::Type::Boolean
345
+
346
+ # @!method initialize(subtype: nil, type: nil)
347
+ # @param subtype [Boolean]
348
+ # @param type [Boolean]
349
+ end
350
+
351
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#locations
352
+ class Locations < FinchAPI::Internal::Type::BaseModel
353
+ # @!attribute city
354
+ #
355
+ # @return [Boolean, nil]
356
+ optional :city, FinchAPI::Internal::Type::Boolean
357
+
358
+ # @!attribute country
359
+ #
360
+ # @return [Boolean, nil]
361
+ optional :country, FinchAPI::Internal::Type::Boolean
362
+
363
+ # @!attribute line1
364
+ #
365
+ # @return [Boolean, nil]
366
+ optional :line1, FinchAPI::Internal::Type::Boolean
367
+
368
+ # @!attribute line2
369
+ #
370
+ # @return [Boolean, nil]
371
+ optional :line2, FinchAPI::Internal::Type::Boolean
372
+
373
+ # @!attribute postal_code
374
+ #
375
+ # @return [Boolean, nil]
376
+ optional :postal_code, FinchAPI::Internal::Type::Boolean
377
+
378
+ # @!attribute state
379
+ #
380
+ # @return [Boolean, nil]
381
+ optional :state, FinchAPI::Internal::Type::Boolean
382
+
383
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
384
+ # @param city [Boolean]
385
+ # @param country [Boolean]
386
+ # @param line1 [Boolean]
387
+ # @param line2 [Boolean]
388
+ # @param postal_code [Boolean]
389
+ # @param state [Boolean]
390
+ end
391
+ end
392
+
393
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#directory
394
+ class Directory < FinchAPI::Internal::Type::BaseModel
395
+ # @!attribute individuals
396
+ #
397
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
398
+ optional :individuals,
399
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals }
400
+
401
+ # @!attribute paging
402
+ #
403
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
404
+ optional :paging, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging }
405
+
406
+ # @!method initialize(individuals: nil, paging: nil)
407
+ # @param individuals [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals]
408
+ # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging]
409
+
410
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#individuals
411
+ class Individuals < FinchAPI::Internal::Type::BaseModel
412
+ # @!attribute id
413
+ #
414
+ # @return [Boolean, nil]
415
+ optional :id, FinchAPI::Internal::Type::Boolean
416
+
417
+ # @!attribute department
418
+ #
419
+ # @return [Boolean, nil]
420
+ optional :department, FinchAPI::Internal::Type::Boolean, nil?: true
421
+
422
+ # @!attribute first_name
423
+ #
424
+ # @return [Boolean, nil]
425
+ optional :first_name, FinchAPI::Internal::Type::Boolean
426
+
427
+ # @!attribute is_active
428
+ #
429
+ # @return [Boolean, nil]
430
+ optional :is_active, FinchAPI::Internal::Type::Boolean
431
+
432
+ # @!attribute last_name
433
+ #
434
+ # @return [Boolean, nil]
435
+ optional :last_name, FinchAPI::Internal::Type::Boolean
436
+
437
+ # @!attribute manager
438
+ #
439
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
440
+ optional :manager,
441
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager }
442
+
443
+ # @!attribute middle_name
444
+ #
445
+ # @return [Boolean, nil]
446
+ optional :middle_name, FinchAPI::Internal::Type::Boolean
447
+
448
+ # @!method initialize(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil)
449
+ # @param id [Boolean]
450
+ # @param department [Boolean, nil]
451
+ # @param first_name [Boolean]
452
+ # @param is_active [Boolean]
453
+ # @param last_name [Boolean]
454
+ # @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager]
455
+ # @param middle_name [Boolean]
456
+
457
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager
458
+ class Manager < FinchAPI::Internal::Type::BaseModel
459
+ # @!attribute id
460
+ #
461
+ # @return [Boolean, nil]
462
+ optional :id, FinchAPI::Internal::Type::Boolean
463
+
464
+ # @!method initialize(id: nil)
465
+ # @param id [Boolean]
466
+ end
467
+ end
468
+
469
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#paging
470
+ class Paging < FinchAPI::Internal::Type::BaseModel
471
+ # @!attribute count
472
+ #
473
+ # @return [Boolean, nil]
474
+ optional :count, FinchAPI::Internal::Type::Boolean
475
+
476
+ # @!attribute offset
477
+ #
478
+ # @return [Boolean, nil]
479
+ optional :offset, FinchAPI::Internal::Type::Boolean
480
+
481
+ # @!method initialize(count: nil, offset: nil)
482
+ # @param count [Boolean]
483
+ # @param offset [Boolean]
484
+ end
485
+ end
486
+
487
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#employment
488
+ class Employment < FinchAPI::Internal::Type::BaseModel
489
+ # @!attribute id
490
+ #
491
+ # @return [Boolean, nil]
492
+ optional :id, FinchAPI::Internal::Type::Boolean
493
+
494
+ # @!attribute class_code
495
+ #
496
+ # @return [Boolean, nil]
497
+ optional :class_code, FinchAPI::Internal::Type::Boolean
498
+
499
+ # @!attribute custom_fields
500
+ #
501
+ # @return [Boolean, nil]
502
+ optional :custom_fields, FinchAPI::Internal::Type::Boolean
503
+
504
+ # @!attribute department
505
+ #
506
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil]
507
+ optional :department,
508
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department }
509
+
510
+ # @!attribute employment
511
+ #
512
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
513
+ optional :employment,
514
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment }
515
+
516
+ # @!attribute employment_status
517
+ #
518
+ # @return [Boolean, nil]
519
+ optional :employment_status, FinchAPI::Internal::Type::Boolean
520
+
521
+ # @!attribute end_date
522
+ #
523
+ # @return [Boolean, nil]
524
+ optional :end_date, FinchAPI::Internal::Type::Boolean
525
+
526
+ # @!attribute first_name
527
+ #
528
+ # @return [Boolean, nil]
529
+ optional :first_name, FinchAPI::Internal::Type::Boolean
530
+
531
+ # @!attribute income
532
+ #
533
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil]
534
+ optional :income, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income }
535
+
536
+ # @!attribute income_history
537
+ #
538
+ # @return [Boolean, nil]
539
+ optional :income_history, FinchAPI::Internal::Type::Boolean
540
+
541
+ # @!attribute is_active
542
+ #
543
+ # @return [Boolean, nil]
544
+ optional :is_active, FinchAPI::Internal::Type::Boolean
545
+
546
+ # @!attribute last_name
547
+ #
548
+ # @return [Boolean, nil]
549
+ optional :last_name, FinchAPI::Internal::Type::Boolean
550
+
551
+ # @!attribute location
552
+ #
553
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil]
554
+ optional :location, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location }
555
+
556
+ # @!attribute manager
557
+ #
558
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
559
+ optional :manager,
560
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager },
561
+ nil?: true
562
+
563
+ # @!attribute middle_name
564
+ #
565
+ # @return [Boolean, nil]
566
+ optional :middle_name, FinchAPI::Internal::Type::Boolean
567
+
568
+ # @!attribute start_date
569
+ #
570
+ # @return [Boolean, nil]
571
+ optional :start_date, FinchAPI::Internal::Type::Boolean
572
+
573
+ # @!attribute title
574
+ #
575
+ # @return [Boolean, nil]
576
+ optional :title, FinchAPI::Internal::Type::Boolean
577
+
578
+ # @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, location: nil, manager: nil, middle_name: nil, start_date: nil, title: nil)
579
+ # @param id [Boolean]
580
+ # @param class_code [Boolean]
581
+ # @param custom_fields [Boolean]
582
+ # @param department [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department]
583
+ # @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment]
584
+ # @param employment_status [Boolean]
585
+ # @param end_date [Boolean]
586
+ # @param first_name [Boolean]
587
+ # @param income [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income]
588
+ # @param income_history [Boolean]
589
+ # @param is_active [Boolean]
590
+ # @param last_name [Boolean]
591
+ # @param location [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location]
592
+ # @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
593
+ # @param middle_name [Boolean]
594
+ # @param start_date [Boolean]
595
+ # @param title [Boolean]
596
+
597
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#department
598
+ class Department < FinchAPI::Internal::Type::BaseModel
599
+ # @!attribute name
600
+ #
601
+ # @return [Boolean, nil]
602
+ optional :name, FinchAPI::Internal::Type::Boolean
603
+
604
+ # @!method initialize(name: nil)
605
+ # @param name [Boolean]
606
+ end
607
+
608
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#employment
609
+ class Employment < FinchAPI::Internal::Type::BaseModel
610
+ # @!attribute subtype
611
+ #
612
+ # @return [Boolean, nil]
613
+ optional :subtype, FinchAPI::Internal::Type::Boolean
614
+
615
+ # @!attribute type
616
+ #
617
+ # @return [Boolean, nil]
618
+ optional :type, FinchAPI::Internal::Type::Boolean
619
+
620
+ # @!method initialize(subtype: nil, type: nil)
621
+ # @param subtype [Boolean]
622
+ # @param type [Boolean]
623
+ end
624
+
625
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#income
626
+ class Income < FinchAPI::Internal::Type::BaseModel
627
+ # @!attribute amount
628
+ #
629
+ # @return [Boolean, nil]
630
+ optional :amount, FinchAPI::Internal::Type::Boolean
631
+
632
+ # @!attribute currency
633
+ #
634
+ # @return [Boolean, nil]
635
+ optional :currency, FinchAPI::Internal::Type::Boolean
636
+
637
+ # @!attribute unit
638
+ #
639
+ # @return [Boolean, nil]
640
+ optional :unit, FinchAPI::Internal::Type::Boolean
641
+
642
+ # @!method initialize(amount: nil, currency: nil, unit: nil)
643
+ # @param amount [Boolean]
644
+ # @param currency [Boolean]
645
+ # @param unit [Boolean]
646
+ end
647
+
648
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#location
649
+ class Location < FinchAPI::Internal::Type::BaseModel
650
+ # @!attribute city
651
+ #
652
+ # @return [Boolean, nil]
653
+ optional :city, FinchAPI::Internal::Type::Boolean
654
+
655
+ # @!attribute country
656
+ #
657
+ # @return [Boolean, nil]
658
+ optional :country, FinchAPI::Internal::Type::Boolean
659
+
660
+ # @!attribute line1
661
+ #
662
+ # @return [Boolean, nil]
663
+ optional :line1, FinchAPI::Internal::Type::Boolean
664
+
665
+ # @!attribute line2
666
+ #
667
+ # @return [Boolean, nil]
668
+ optional :line2, FinchAPI::Internal::Type::Boolean
669
+
670
+ # @!attribute postal_code
671
+ #
672
+ # @return [Boolean, nil]
673
+ optional :postal_code, FinchAPI::Internal::Type::Boolean
674
+
675
+ # @!attribute state
676
+ #
677
+ # @return [Boolean, nil]
678
+ optional :state, FinchAPI::Internal::Type::Boolean
679
+
680
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
681
+ # @param city [Boolean]
682
+ # @param country [Boolean]
683
+ # @param line1 [Boolean]
684
+ # @param line2 [Boolean]
685
+ # @param postal_code [Boolean]
686
+ # @param state [Boolean]
687
+ end
688
+
689
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#manager
690
+ class Manager < FinchAPI::Internal::Type::BaseModel
691
+ # @!attribute id
692
+ #
693
+ # @return [Boolean, nil]
694
+ optional :id, FinchAPI::Internal::Type::Boolean
695
+
696
+ # @!method initialize(id: nil)
697
+ # @param id [Boolean]
698
+ end
699
+ end
700
+
701
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#individual
702
+ class Individual < FinchAPI::Internal::Type::BaseModel
703
+ # @!attribute id
704
+ #
705
+ # @return [Boolean, nil]
706
+ optional :id, FinchAPI::Internal::Type::Boolean
707
+
708
+ # @!attribute dob
709
+ #
710
+ # @return [Boolean, nil]
711
+ optional :dob, FinchAPI::Internal::Type::Boolean
712
+
713
+ # @!attribute emails
714
+ #
715
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
716
+ optional :emails, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails }
717
+
718
+ # @!attribute encrypted_ssn
719
+ #
720
+ # @return [Boolean, nil]
721
+ optional :encrypted_ssn, FinchAPI::Internal::Type::Boolean
722
+
723
+ # @!attribute ethnicity
724
+ #
725
+ # @return [Boolean, nil]
726
+ optional :ethnicity, FinchAPI::Internal::Type::Boolean
727
+
728
+ # @!attribute first_name
729
+ #
730
+ # @return [Boolean, nil]
731
+ optional :first_name, FinchAPI::Internal::Type::Boolean
732
+
733
+ # @!attribute gender
734
+ #
735
+ # @return [Boolean, nil]
736
+ optional :gender, FinchAPI::Internal::Type::Boolean
737
+
738
+ # @!attribute last_name
739
+ #
740
+ # @return [Boolean, nil]
741
+ optional :last_name, FinchAPI::Internal::Type::Boolean
742
+
743
+ # @!attribute middle_name
744
+ #
745
+ # @return [Boolean, nil]
746
+ optional :middle_name, FinchAPI::Internal::Type::Boolean
747
+
748
+ # @!attribute phone_numbers
749
+ #
750
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
751
+ optional :phone_numbers,
752
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers }
753
+
754
+ # @!attribute preferred_name
755
+ #
756
+ # @return [Boolean, nil]
757
+ optional :preferred_name, FinchAPI::Internal::Type::Boolean
758
+
759
+ # @!attribute residence
760
+ #
761
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
762
+ optional :residence,
763
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence }
764
+
765
+ # @!attribute ssn
766
+ #
767
+ # @return [Boolean, nil]
768
+ optional :ssn, FinchAPI::Internal::Type::Boolean
769
+
770
+ # @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil)
771
+ # @param id [Boolean]
772
+ # @param dob [Boolean]
773
+ # @param emails [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails]
774
+ # @param encrypted_ssn [Boolean]
775
+ # @param ethnicity [Boolean]
776
+ # @param first_name [Boolean]
777
+ # @param gender [Boolean]
778
+ # @param last_name [Boolean]
779
+ # @param middle_name [Boolean]
780
+ # @param phone_numbers [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers]
781
+ # @param preferred_name [Boolean]
782
+ # @param residence [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence]
783
+ # @param ssn [Boolean]
784
+
785
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#emails
786
+ class Emails < FinchAPI::Internal::Type::BaseModel
787
+ # @!attribute data
788
+ #
789
+ # @return [Boolean, nil]
790
+ optional :data, FinchAPI::Internal::Type::Boolean
791
+
792
+ # @!attribute type
793
+ #
794
+ # @return [Boolean, nil]
795
+ optional :type, FinchAPI::Internal::Type::Boolean
796
+
797
+ # @!method initialize(data: nil, type: nil)
798
+ # @param data [Boolean]
799
+ # @param type [Boolean]
800
+ end
801
+
802
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers
803
+ class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
804
+ # @!attribute data
805
+ #
806
+ # @return [Boolean, nil]
807
+ optional :data, FinchAPI::Internal::Type::Boolean
808
+
809
+ # @!attribute type
810
+ #
811
+ # @return [Boolean, nil]
812
+ optional :type, FinchAPI::Internal::Type::Boolean
813
+
814
+ # @!method initialize(data: nil, type: nil)
815
+ # @param data [Boolean]
816
+ # @param type [Boolean]
817
+ end
818
+
819
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#residence
820
+ class Residence < FinchAPI::Internal::Type::BaseModel
821
+ # @!attribute city
822
+ #
823
+ # @return [Boolean, nil]
824
+ optional :city, FinchAPI::Internal::Type::Boolean
825
+
826
+ # @!attribute country
827
+ #
828
+ # @return [Boolean, nil]
829
+ optional :country, FinchAPI::Internal::Type::Boolean
830
+
831
+ # @!attribute line1
832
+ #
833
+ # @return [Boolean, nil]
834
+ optional :line1, FinchAPI::Internal::Type::Boolean
835
+
836
+ # @!attribute line2
837
+ #
838
+ # @return [Boolean, nil]
839
+ optional :line2, FinchAPI::Internal::Type::Boolean
840
+
841
+ # @!attribute postal_code
842
+ #
843
+ # @return [Boolean, nil]
844
+ optional :postal_code, FinchAPI::Internal::Type::Boolean
845
+
846
+ # @!attribute state
847
+ #
848
+ # @return [Boolean, nil]
849
+ optional :state, FinchAPI::Internal::Type::Boolean
850
+
851
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
852
+ # @param city [Boolean]
853
+ # @param country [Boolean]
854
+ # @param line1 [Boolean]
855
+ # @param line2 [Boolean]
856
+ # @param postal_code [Boolean]
857
+ # @param state [Boolean]
858
+ end
859
+ end
860
+
861
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_group
862
+ class PayGroup < FinchAPI::Internal::Type::BaseModel
863
+ # @!attribute id
864
+ #
865
+ # @return [Boolean, nil]
866
+ optional :id, FinchAPI::Internal::Type::Boolean
867
+
868
+ # @!attribute individual_ids
869
+ #
870
+ # @return [Boolean, nil]
871
+ optional :individual_ids, FinchAPI::Internal::Type::Boolean
872
+
873
+ # @!attribute name
874
+ #
875
+ # @return [Boolean, nil]
876
+ optional :name, FinchAPI::Internal::Type::Boolean
877
+
878
+ # @!attribute pay_frequencies
879
+ #
880
+ # @return [Boolean, nil]
881
+ optional :pay_frequencies, FinchAPI::Internal::Type::Boolean
882
+
883
+ # @!method initialize(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil)
884
+ # @param id [Boolean]
885
+ # @param individual_ids [Boolean]
886
+ # @param name [Boolean]
887
+ # @param pay_frequencies [Boolean]
888
+ end
889
+
890
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_statement
891
+ class PayStatement < FinchAPI::Internal::Type::BaseModel
892
+ # @!attribute paging
893
+ #
894
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
895
+ optional :paging, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging }
896
+
897
+ # @!attribute pay_statements
898
+ #
899
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
900
+ optional :pay_statements,
901
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements }
902
+
903
+ # @!method initialize(paging: nil, pay_statements: nil)
904
+ # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging]
905
+ # @param pay_statements [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements]
906
+
907
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging
908
+ class Paging < FinchAPI::Internal::Type::BaseModel
909
+ # @!attribute count
910
+ #
911
+ # @return [Boolean]
912
+ required :count, FinchAPI::Internal::Type::Boolean
913
+
914
+ # @!attribute offset
915
+ #
916
+ # @return [Boolean]
917
+ required :offset, FinchAPI::Internal::Type::Boolean
918
+
919
+ # @!method initialize(count:, offset:)
920
+ # @param count [Boolean]
921
+ # @param offset [Boolean]
922
+ end
923
+
924
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements
925
+ class PayStatements < FinchAPI::Internal::Type::BaseModel
926
+ # @!attribute earnings
927
+ #
928
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
929
+ optional :earnings,
930
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings }
931
+
932
+ # @!attribute employee_deductions
933
+ #
934
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
935
+ optional :employee_deductions,
936
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions }
937
+
938
+ # @!attribute employer_contributions
939
+ #
940
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
941
+ optional :employer_contributions,
942
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions }
943
+
944
+ # @!attribute gross_pay
945
+ #
946
+ # @return [Boolean, nil]
947
+ optional :gross_pay, FinchAPI::Internal::Type::Boolean
948
+
949
+ # @!attribute individual_id
950
+ #
951
+ # @return [Boolean, nil]
952
+ optional :individual_id, FinchAPI::Internal::Type::Boolean
953
+
954
+ # @!attribute net_pay
955
+ #
956
+ # @return [Boolean, nil]
957
+ optional :net_pay, FinchAPI::Internal::Type::Boolean
958
+
959
+ # @!attribute payment_method
960
+ #
961
+ # @return [Boolean, nil]
962
+ optional :payment_method, FinchAPI::Internal::Type::Boolean
963
+
964
+ # @!attribute taxes
965
+ #
966
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
967
+ optional :taxes,
968
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes }
969
+
970
+ # @!attribute total_hours
971
+ #
972
+ # @return [Boolean, nil]
973
+ optional :total_hours, FinchAPI::Internal::Type::Boolean
974
+
975
+ # @!attribute type
976
+ #
977
+ # @return [Boolean, nil]
978
+ optional :type, FinchAPI::Internal::Type::Boolean
979
+
980
+ # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
981
+ # @param earnings [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings]
982
+ # @param employee_deductions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions]
983
+ # @param employer_contributions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions]
984
+ # @param gross_pay [Boolean]
985
+ # @param individual_id [Boolean]
986
+ # @param net_pay [Boolean]
987
+ # @param payment_method [Boolean]
988
+ # @param taxes [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes]
989
+ # @param total_hours [Boolean]
990
+ # @param type [Boolean]
991
+
992
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings
993
+ class Earnings < FinchAPI::Internal::Type::BaseModel
994
+ # @!attribute amount
995
+ #
996
+ # @return [Boolean, nil]
997
+ optional :amount, FinchAPI::Internal::Type::Boolean
998
+
999
+ # @!attribute currency
1000
+ #
1001
+ # @return [Boolean, nil]
1002
+ optional :currency, FinchAPI::Internal::Type::Boolean
1003
+
1004
+ # @!attribute name
1005
+ #
1006
+ # @return [Boolean, nil]
1007
+ optional :name, FinchAPI::Internal::Type::Boolean
1008
+
1009
+ # @!attribute type
1010
+ #
1011
+ # @return [Boolean, nil]
1012
+ optional :type, FinchAPI::Internal::Type::Boolean
1013
+
1014
+ # @!method initialize(amount: nil, currency: nil, name: nil, type: nil)
1015
+ # @param amount [Boolean]
1016
+ # @param currency [Boolean]
1017
+ # @param name [Boolean]
1018
+ # @param type [Boolean]
1019
+ end
1020
+
1021
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions
1022
+ class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
1023
+ # @!attribute amount
1024
+ #
1025
+ # @return [Boolean, nil]
1026
+ optional :amount, FinchAPI::Internal::Type::Boolean
1027
+
1028
+ # @!attribute currency
1029
+ #
1030
+ # @return [Boolean, nil]
1031
+ optional :currency, FinchAPI::Internal::Type::Boolean
1032
+
1033
+ # @!attribute name
1034
+ #
1035
+ # @return [Boolean, nil]
1036
+ optional :name, FinchAPI::Internal::Type::Boolean
1037
+
1038
+ # @!attribute pre_tax
1039
+ #
1040
+ # @return [Boolean, nil]
1041
+ optional :pre_tax, FinchAPI::Internal::Type::Boolean
1042
+
1043
+ # @!attribute type
1044
+ #
1045
+ # @return [Boolean, nil]
1046
+ optional :type, FinchAPI::Internal::Type::Boolean
1047
+
1048
+ # @!method initialize(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
1049
+ # @param amount [Boolean]
1050
+ # @param currency [Boolean]
1051
+ # @param name [Boolean]
1052
+ # @param pre_tax [Boolean]
1053
+ # @param type [Boolean]
1054
+ end
1055
+
1056
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions
1057
+ class EmployerContributions < FinchAPI::Internal::Type::BaseModel
1058
+ # @!attribute amount
1059
+ #
1060
+ # @return [Boolean, nil]
1061
+ optional :amount, FinchAPI::Internal::Type::Boolean
1062
+
1063
+ # @!attribute currency
1064
+ #
1065
+ # @return [Boolean, nil]
1066
+ optional :currency, FinchAPI::Internal::Type::Boolean
1067
+
1068
+ # @!attribute name
1069
+ #
1070
+ # @return [Boolean, nil]
1071
+ optional :name, FinchAPI::Internal::Type::Boolean
1072
+
1073
+ # @!method initialize(amount: nil, currency: nil, name: nil)
1074
+ # @param amount [Boolean]
1075
+ # @param currency [Boolean]
1076
+ # @param name [Boolean]
1077
+ end
1078
+
1079
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes
1080
+ class Taxes < FinchAPI::Internal::Type::BaseModel
1081
+ # @!attribute amount
1082
+ #
1083
+ # @return [Boolean, nil]
1084
+ optional :amount, FinchAPI::Internal::Type::Boolean
1085
+
1086
+ # @!attribute currency
1087
+ #
1088
+ # @return [Boolean, nil]
1089
+ optional :currency, FinchAPI::Internal::Type::Boolean
1090
+
1091
+ # @!attribute employer
1092
+ #
1093
+ # @return [Boolean, nil]
1094
+ optional :employer, FinchAPI::Internal::Type::Boolean
1095
+
1096
+ # @!attribute name
1097
+ #
1098
+ # @return [Boolean, nil]
1099
+ optional :name, FinchAPI::Internal::Type::Boolean
1100
+
1101
+ # @!attribute type
1102
+ #
1103
+ # @return [Boolean, nil]
1104
+ optional :type, FinchAPI::Internal::Type::Boolean
1105
+
1106
+ # @!method initialize(amount: nil, currency: nil, employer: nil, name: nil, type: nil)
1107
+ # @param amount [Boolean]
1108
+ # @param currency [Boolean]
1109
+ # @param employer [Boolean]
1110
+ # @param name [Boolean]
1111
+ # @param type [Boolean]
1112
+ end
1113
+ end
1114
+ end
1115
+
1116
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#payment
1117
+ class Payment < FinchAPI::Internal::Type::BaseModel
1118
+ # @!attribute id
1119
+ #
1120
+ # @return [Boolean, nil]
1121
+ optional :id, FinchAPI::Internal::Type::Boolean
1122
+
1123
+ # @!attribute company_debit
1124
+ #
1125
+ # @return [Boolean, nil]
1126
+ optional :company_debit, FinchAPI::Internal::Type::Boolean
1127
+
1128
+ # @!attribute debit_date
1129
+ #
1130
+ # @return [Boolean, nil]
1131
+ optional :debit_date, FinchAPI::Internal::Type::Boolean
1132
+
1133
+ # @!attribute employee_taxes
1134
+ #
1135
+ # @return [Boolean, nil]
1136
+ optional :employee_taxes, FinchAPI::Internal::Type::Boolean
1137
+
1138
+ # @!attribute employer_taxes
1139
+ #
1140
+ # @return [Boolean, nil]
1141
+ optional :employer_taxes, FinchAPI::Internal::Type::Boolean
1142
+
1143
+ # @!attribute gross_pay
1144
+ #
1145
+ # @return [Boolean, nil]
1146
+ optional :gross_pay, FinchAPI::Internal::Type::Boolean
1147
+
1148
+ # @!attribute individual_ids
1149
+ #
1150
+ # @return [Boolean, nil]
1151
+ optional :individual_ids, FinchAPI::Internal::Type::Boolean
1152
+
1153
+ # @!attribute net_pay
1154
+ #
1155
+ # @return [Boolean, nil]
1156
+ optional :net_pay, FinchAPI::Internal::Type::Boolean
1157
+
1158
+ # @!attribute pay_date
1159
+ #
1160
+ # @return [Boolean, nil]
1161
+ optional :pay_date, FinchAPI::Internal::Type::Boolean
1162
+
1163
+ # @!attribute pay_frequencies
1164
+ #
1165
+ # @return [Boolean, nil]
1166
+ optional :pay_frequencies, FinchAPI::Internal::Type::Boolean
1167
+
1168
+ # @!attribute pay_group_ids
1169
+ #
1170
+ # @return [Boolean, nil]
1171
+ optional :pay_group_ids, FinchAPI::Internal::Type::Boolean
1172
+
1173
+ # @!attribute pay_period
1174
+ #
1175
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
1176
+ optional :pay_period, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod }
1177
+
1178
+ # @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
1179
+ # @param id [Boolean]
1180
+ # @param company_debit [Boolean]
1181
+ # @param debit_date [Boolean]
1182
+ # @param employee_taxes [Boolean]
1183
+ # @param employer_taxes [Boolean]
1184
+ # @param gross_pay [Boolean]
1185
+ # @param individual_ids [Boolean]
1186
+ # @param net_pay [Boolean]
1187
+ # @param pay_date [Boolean]
1188
+ # @param pay_frequencies [Boolean]
1189
+ # @param pay_group_ids [Boolean]
1190
+ # @param pay_period [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod]
1191
+
1192
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period
1193
+ class PayPeriod < FinchAPI::Internal::Type::BaseModel
1194
+ # @!attribute end_date
1195
+ #
1196
+ # @return [Boolean, nil]
1197
+ optional :end_date, FinchAPI::Internal::Type::Boolean
1198
+
1199
+ # @!attribute start_date
1200
+ #
1201
+ # @return [Boolean, nil]
1202
+ optional :start_date, FinchAPI::Internal::Type::Boolean
1203
+
1204
+ # @!method initialize(end_date: nil, start_date: nil)
1205
+ # @param end_date [Boolean]
1206
+ # @param start_date [Boolean]
1207
+ end
1208
+ end
1209
+
1210
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#plan_dependents
1211
+ class PlanDependents < FinchAPI::Internal::Type::BaseModel
1212
+ # @!attribute coverage
1213
+ #
1214
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage, nil]
1215
+ optional :coverage,
1216
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage }
1217
+
1218
+ # @!attribute date_of_birth
1219
+ #
1220
+ # @return [Boolean, nil]
1221
+ optional :date_of_birth, FinchAPI::Internal::Type::Boolean
1222
+
1223
+ # @!attribute dependent_id
1224
+ #
1225
+ # @return [Boolean, nil]
1226
+ optional :dependent_id, FinchAPI::Internal::Type::Boolean
1227
+
1228
+ # @!attribute first_name
1229
+ #
1230
+ # @return [Boolean, nil]
1231
+ optional :first_name, FinchAPI::Internal::Type::Boolean
1232
+
1233
+ # @!attribute gender
1234
+ #
1235
+ # @return [Boolean, nil]
1236
+ optional :gender, FinchAPI::Internal::Type::Boolean
1237
+
1238
+ # @!attribute last_name
1239
+ #
1240
+ # @return [Boolean, nil]
1241
+ optional :last_name, FinchAPI::Internal::Type::Boolean
1242
+
1243
+ # @!attribute middle_name
1244
+ #
1245
+ # @return [Boolean, nil]
1246
+ optional :middle_name, FinchAPI::Internal::Type::Boolean
1247
+
1248
+ # @!attribute ssn
1249
+ #
1250
+ # @return [Boolean, nil]
1251
+ optional :ssn, FinchAPI::Internal::Type::Boolean
1252
+
1253
+ # @!method initialize(coverage: nil, date_of_birth: nil, dependent_id: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, ssn: nil)
1254
+ # @param coverage [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage]
1255
+ # @param date_of_birth [Boolean]
1256
+ # @param dependent_id [Boolean]
1257
+ # @param first_name [Boolean]
1258
+ # @param gender [Boolean]
1259
+ # @param last_name [Boolean]
1260
+ # @param middle_name [Boolean]
1261
+ # @param ssn [Boolean]
1262
+
1263
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents#coverage
1264
+ class Coverage < FinchAPI::Internal::Type::BaseModel
1265
+ # @!attribute enrollments
1266
+ #
1267
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments, nil]
1268
+ optional :enrollments,
1269
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments }
1270
+
1271
+ # @!attribute individual_id
1272
+ #
1273
+ # @return [Boolean, nil]
1274
+ optional :individual_id, FinchAPI::Internal::Type::Boolean
1275
+
1276
+ # @!attribute relationship_to_individual
1277
+ #
1278
+ # @return [Boolean, nil]
1279
+ optional :relationship_to_individual, FinchAPI::Internal::Type::Boolean
1280
+
1281
+ # @!method initialize(enrollments: nil, individual_id: nil, relationship_to_individual: nil)
1282
+ # @param enrollments [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments]
1283
+ # @param individual_id [Boolean]
1284
+ # @param relationship_to_individual [Boolean]
1285
+
1286
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanDependents::Coverage#enrollments
1287
+ class Enrollments < FinchAPI::Internal::Type::BaseModel
1288
+ # @!attribute id
1289
+ #
1290
+ # @return [Boolean, nil]
1291
+ optional :id, FinchAPI::Internal::Type::Boolean
1292
+
1293
+ # @!attribute type
1294
+ #
1295
+ # @return [Boolean, nil]
1296
+ optional :type, FinchAPI::Internal::Type::Boolean
1297
+
1298
+ # @!method initialize(id: nil, type: nil)
1299
+ # @param id [Boolean]
1300
+ # @param type [Boolean]
1301
+ end
1302
+ end
1303
+ end
1304
+
1305
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#plan_enrollments
1306
+ class PlanEnrollments < FinchAPI::Internal::Type::BaseModel
1307
+ # @!attribute id
1308
+ #
1309
+ # @return [Boolean, nil]
1310
+ optional :id, FinchAPI::Internal::Type::Boolean
1311
+
1312
+ # @!attribute contributions
1313
+ #
1314
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions, nil]
1315
+ optional :contributions,
1316
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions }
1317
+
1318
+ # @!attribute coverage_end_date
1319
+ #
1320
+ # @return [Boolean, nil]
1321
+ optional :coverage_end_date, FinchAPI::Internal::Type::Boolean
1322
+
1323
+ # @!attribute coverage_start_date
1324
+ #
1325
+ # @return [Boolean, nil]
1326
+ optional :coverage_start_date, FinchAPI::Internal::Type::Boolean
1327
+
1328
+ # @!attribute coverage_tier
1329
+ #
1330
+ # @return [Boolean, nil]
1331
+ optional :coverage_tier, FinchAPI::Internal::Type::Boolean
1332
+
1333
+ # @!attribute dependent_ids
1334
+ #
1335
+ # @return [Boolean, nil]
1336
+ optional :dependent_ids, FinchAPI::Internal::Type::Boolean
1337
+
1338
+ # @!attribute individual_id
1339
+ #
1340
+ # @return [Boolean, nil]
1341
+ optional :individual_id, FinchAPI::Internal::Type::Boolean
1342
+
1343
+ # @!attribute plan_id
1344
+ #
1345
+ # @return [Boolean, nil]
1346
+ optional :plan_id, FinchAPI::Internal::Type::Boolean
1347
+
1348
+ # @!attribute status
1349
+ #
1350
+ # @return [Boolean, nil]
1351
+ optional :status, FinchAPI::Internal::Type::Boolean
1352
+
1353
+ # @!method initialize(id: nil, contributions: nil, coverage_end_date: nil, coverage_start_date: nil, coverage_tier: nil, dependent_ids: nil, individual_id: nil, plan_id: nil, status: nil)
1354
+ # @param id [Boolean]
1355
+ # @param contributions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions]
1356
+ # @param coverage_end_date [Boolean]
1357
+ # @param coverage_start_date [Boolean]
1358
+ # @param coverage_tier [Boolean]
1359
+ # @param dependent_ids [Boolean]
1360
+ # @param individual_id [Boolean]
1361
+ # @param plan_id [Boolean]
1362
+ # @param status [Boolean]
1363
+
1364
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments#contributions
1365
+ class Contributions < FinchAPI::Internal::Type::BaseModel
1366
+ # @!attribute employee_contribution
1367
+ #
1368
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution, nil]
1369
+ optional :employee_contribution,
1370
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution }
1371
+
1372
+ # @!attribute employer_contribution
1373
+ #
1374
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution, nil]
1375
+ optional :employer_contribution,
1376
+ -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution }
1377
+
1378
+ # @!attribute frequency
1379
+ #
1380
+ # @return [Boolean, nil]
1381
+ optional :frequency, FinchAPI::Internal::Type::Boolean
1382
+
1383
+ # @!method initialize(employee_contribution: nil, employer_contribution: nil, frequency: nil)
1384
+ # @param employee_contribution [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution]
1385
+ # @param employer_contribution [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution]
1386
+ # @param frequency [Boolean]
1387
+
1388
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employee_contribution
1389
+ class EmployeeContribution < FinchAPI::Internal::Type::BaseModel
1390
+ # @!attribute amount
1391
+ #
1392
+ # @return [Boolean, nil]
1393
+ optional :amount, FinchAPI::Internal::Type::Boolean
1394
+
1395
+ # @!attribute currency
1396
+ #
1397
+ # @return [Boolean, nil]
1398
+ optional :currency, FinchAPI::Internal::Type::Boolean
1399
+
1400
+ # @!method initialize(amount: nil, currency: nil)
1401
+ # @param amount [Boolean]
1402
+ # @param currency [Boolean]
1403
+ end
1404
+
1405
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employer_contribution
1406
+ class EmployerContribution < FinchAPI::Internal::Type::BaseModel
1407
+ # @!attribute amount
1408
+ #
1409
+ # @return [Boolean, nil]
1410
+ optional :amount, FinchAPI::Internal::Type::Boolean
1411
+
1412
+ # @!attribute currency
1413
+ #
1414
+ # @return [Boolean, nil]
1415
+ optional :currency, FinchAPI::Internal::Type::Boolean
1416
+
1417
+ # @!method initialize(amount: nil, currency: nil)
1418
+ # @param amount [Boolean]
1419
+ # @param currency [Boolean]
1420
+ end
1421
+ end
1422
+ end
1423
+
1424
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#plans
1425
+ class Plans < FinchAPI::Internal::Type::BaseModel
1426
+ # @!attribute id
1427
+ #
1428
+ # @return [Boolean, nil]
1429
+ optional :id, FinchAPI::Internal::Type::Boolean
1430
+
1431
+ # @!attribute carrier
1432
+ #
1433
+ # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Plans::Carrier, nil]
1434
+ optional :carrier, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Plans::Carrier }
1435
+
1436
+ # @!attribute coverage_tiers
1437
+ #
1438
+ # @return [Boolean, nil]
1439
+ optional :coverage_tiers, FinchAPI::Internal::Type::Boolean
1440
+
1441
+ # @!attribute deduction_codes
1442
+ #
1443
+ # @return [Boolean, nil]
1444
+ optional :deduction_codes, FinchAPI::Internal::Type::Boolean
1445
+
1446
+ # @!attribute description
1447
+ #
1448
+ # @return [Boolean, nil]
1449
+ optional :description, FinchAPI::Internal::Type::Boolean
1450
+
1451
+ # @!attribute end_date
1452
+ #
1453
+ # @return [Boolean, nil]
1454
+ optional :end_date, FinchAPI::Internal::Type::Boolean
1455
+
1456
+ # @!attribute name
1457
+ #
1458
+ # @return [Boolean, nil]
1459
+ optional :name, FinchAPI::Internal::Type::Boolean
1460
+
1461
+ # @!attribute network_type
1462
+ #
1463
+ # @return [Boolean, nil]
1464
+ optional :network_type, FinchAPI::Internal::Type::Boolean
1465
+
1466
+ # @!attribute start_date
1467
+ #
1468
+ # @return [Boolean, nil]
1469
+ optional :start_date, FinchAPI::Internal::Type::Boolean
1470
+
1471
+ # @!attribute type
1472
+ #
1473
+ # @return [Boolean, nil]
1474
+ optional :type, FinchAPI::Internal::Type::Boolean
1475
+
1476
+ # @!method initialize(id: nil, carrier: nil, coverage_tiers: nil, deduction_codes: nil, description: nil, end_date: nil, name: nil, network_type: nil, start_date: nil, type: nil)
1477
+ # @param id [Boolean]
1478
+ # @param carrier [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Plans::Carrier]
1479
+ # @param coverage_tiers [Boolean]
1480
+ # @param deduction_codes [Boolean]
1481
+ # @param description [Boolean]
1482
+ # @param end_date [Boolean]
1483
+ # @param name [Boolean]
1484
+ # @param network_type [Boolean]
1485
+ # @param start_date [Boolean]
1486
+ # @param type [Boolean]
1487
+
1488
+ # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Plans#carrier
1489
+ class Carrier < FinchAPI::Internal::Type::BaseModel
1490
+ # @!attribute id
1491
+ #
1492
+ # @return [Boolean, nil]
1493
+ optional :id, FinchAPI::Internal::Type::Boolean
1494
+
1495
+ # @!attribute name
1496
+ #
1497
+ # @return [Boolean, nil]
1498
+ optional :name, FinchAPI::Internal::Type::Boolean
1499
+
1500
+ # @!method initialize(id: nil, name: nil)
1501
+ # @param id [Boolean]
1502
+ # @param name [Boolean]
1503
+ end
1504
+ end
1505
+ end
139
1506
  end
140
1507
  end
141
1508
  end