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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +1 -1
- data/lib/finch_api/models/account_update_event.rb +328 -8
- data/lib/finch_api/models/hris/employment_data.rb +11 -1
- data/lib/finch_api/models/hris/individual.rb +9 -1
- data/lib/finch_api/models/provider.rb +1371 -4
- data/lib/finch_api/models/provider_list_response.rb +1387 -4
- data/lib/finch_api/models/sandbox/directory_create_params.rb +20 -2
- data/lib/finch_api/models/sandbox/employment_update_params.rb +11 -1
- data/lib/finch_api/models/sandbox/employment_update_response.rb +11 -1
- data/lib/finch_api/models/sandbox/individual_update_params.rb +9 -1
- data/lib/finch_api/models/sandbox/individual_update_response.rb +9 -1
- data/lib/finch_api/resources/sandbox/employment.rb +3 -1
- data/lib/finch_api/version.rb +1 -1
- data/rbi/finch_api/models/account_update_event.rbi +738 -15
- data/rbi/finch_api/models/hris/employment_data.rbi +12 -0
- data/rbi/finch_api/models/hris/individual.rbi +10 -1
- data/rbi/finch_api/models/provider.rbi +3137 -6
- data/rbi/finch_api/models/provider_list_response.rbi +3139 -6
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +22 -1
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +12 -0
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +12 -0
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +10 -1
- data/rbi/finch_api/models/sandbox/individual_update_response.rbi +10 -1
- data/rbi/finch_api/resources/sandbox/employment.rbi +5 -0
- data/sig/finch_api/models/account_update_event.rbs +405 -17
- data/sig/finch_api/models/hris/employment_data.rbs +5 -0
- data/sig/finch_api/models/provider.rbs +1722 -6
- data/sig/finch_api/models/provider_list_response.rbs +1722 -6
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +5 -0
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +5 -0
- data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5f5cb88b8975aae0a24fb06c065cf76417ee66e03e8db7221fb8b92e9b67b17d
|
|
4
|
+
data.tar.gz: 3dace0e8387c06d6c82541f4078d7c2d5c1941fb8fa11e09df7b71c4b0a7e966
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9e84aa7dd599db34a4577e884fa714ec0ad5162eb38ea985fa78d82b6d4f61412b3d1ca561bf10118e28b7510e941d672fead59824a9231bf02137f6d84c8a32
|
|
7
|
+
data.tar.gz: c65456c96829458109ace2482577700bec8897814fd078e2c8771bd31b5775c388b0378c37ae867365259d30769c60c991f9e455dfa258d7ddecf6d63184cba2
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.1.0-alpha.60](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.59...v0.1.0-alpha.60) (2026-10-13)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **employment:** expose benefit_eligibility_class on the API surface [INT-4092] ([5bd28e8](https://github.com/Finch-API/finch-api-ruby/commit/5bd28e84fe7d95f7731b0b4d752be7561e37172b))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Chores
|
|
12
|
+
|
|
13
|
+
* **api:** rebuild SDK ([e544049](https://github.com/Finch-API/finch-api-ruby/commit/e544049748fe698fadb1615c36f7190fdd6eff8c))
|
|
14
|
+
|
|
15
|
+
## [0.1.0-alpha.59](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.58...v0.1.0-alpha.59) (2026-10-01)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Chores
|
|
19
|
+
|
|
20
|
+
* **api:** rebuild SDK ([8c752f2](https://github.com/Finch-API/finch-api-ruby/commit/8c752f231041e66e4dbaf16bf5701c809266dfa3))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Documentation
|
|
24
|
+
|
|
25
|
+
* **spec:** document phone number format on individual phone_numbers ([015efe5](https://github.com/Finch-API/finch-api-ruby/commit/015efe5f87553064cf3b1711cd998cb583a8f5d2))
|
|
26
|
+
|
|
3
27
|
## [0.1.0-alpha.58](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.57...v0.1.0-alpha.58) (2026-09-15)
|
|
4
28
|
|
|
5
29
|
|
data/README.md
CHANGED
|
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
26
26
|
<!-- x-release-please-start-version -->
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
gem "finch-api", "~> 0.1.0-alpha.
|
|
29
|
+
gem "finch-api", "~> 0.1.0-alpha.60.pre.alpha.59"
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<!-- x-release-please-end -->
|
|
@@ -42,7 +42,7 @@ module FinchAPI
|
|
|
42
42
|
optional :benefits_support, -> { FinchAPI::HRIS::BenefitsSupport }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute supported_fields
|
|
45
|
-
# The supported data fields returned by our HR and
|
|
45
|
+
# The supported data fields returned by our HR, payroll, and benefits endpoints
|
|
46
46
|
#
|
|
47
47
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil]
|
|
48
48
|
optional :supported_fields,
|
|
@@ -62,7 +62,7 @@ module FinchAPI
|
|
|
62
62
|
#
|
|
63
63
|
# @param benefits_support [FinchAPI::Models::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo
|
|
64
64
|
#
|
|
65
|
-
# @param supported_fields [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and
|
|
65
|
+
# @param supported_fields [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR, payroll, and benefits endpoints
|
|
66
66
|
#
|
|
67
67
|
# @param type [Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type] The type of authentication method.
|
|
68
68
|
|
|
@@ -110,8 +110,25 @@ module FinchAPI
|
|
|
110
110
|
optional :payment,
|
|
111
111
|
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment }
|
|
112
112
|
|
|
113
|
-
# @!
|
|
114
|
-
#
|
|
113
|
+
# @!attribute plan_dependents
|
|
114
|
+
#
|
|
115
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents, nil]
|
|
116
|
+
optional :plan_dependents,
|
|
117
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents }
|
|
118
|
+
|
|
119
|
+
# @!attribute plan_enrollments
|
|
120
|
+
#
|
|
121
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments, nil]
|
|
122
|
+
optional :plan_enrollments,
|
|
123
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments }
|
|
124
|
+
|
|
125
|
+
# @!attribute plans
|
|
126
|
+
#
|
|
127
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans, nil]
|
|
128
|
+
optional :plans, -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans }
|
|
129
|
+
|
|
130
|
+
# @!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)
|
|
131
|
+
# The supported data fields returned by our HR, payroll, and benefits endpoints
|
|
115
132
|
#
|
|
116
133
|
# @param company [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company]
|
|
117
134
|
# @param directory [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory]
|
|
@@ -120,6 +137,9 @@ module FinchAPI
|
|
|
120
137
|
# @param pay_group [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup]
|
|
121
138
|
# @param pay_statement [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement]
|
|
122
139
|
# @param payment [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment]
|
|
140
|
+
# @param plan_dependents [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents]
|
|
141
|
+
# @param plan_enrollments [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments]
|
|
142
|
+
# @param plans [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans]
|
|
123
143
|
|
|
124
144
|
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#company
|
|
125
145
|
class Company < FinchAPI::Internal::Type::BaseModel
|
|
@@ -334,7 +354,7 @@ module FinchAPI
|
|
|
334
354
|
# @!attribute department
|
|
335
355
|
#
|
|
336
356
|
# @return [Boolean, nil]
|
|
337
|
-
optional :department, FinchAPI::Internal::Type::Boolean
|
|
357
|
+
optional :department, FinchAPI::Internal::Type::Boolean, nil?: true
|
|
338
358
|
|
|
339
359
|
# @!attribute first_name
|
|
340
360
|
#
|
|
@@ -364,7 +384,7 @@ module FinchAPI
|
|
|
364
384
|
|
|
365
385
|
# @!method initialize(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil)
|
|
366
386
|
# @param id [Boolean]
|
|
367
|
-
# @param department [Boolean]
|
|
387
|
+
# @param department [Boolean, nil]
|
|
368
388
|
# @param first_name [Boolean]
|
|
369
389
|
# @param is_active [Boolean]
|
|
370
390
|
# @param last_name [Boolean]
|
|
@@ -476,7 +496,10 @@ module FinchAPI
|
|
|
476
496
|
#
|
|
477
497
|
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
|
478
498
|
optional :manager,
|
|
479
|
-
-> {
|
|
499
|
+
-> {
|
|
500
|
+
FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager
|
|
501
|
+
},
|
|
502
|
+
nil?: true
|
|
480
503
|
|
|
481
504
|
# @!attribute middle_name
|
|
482
505
|
#
|
|
@@ -507,7 +530,7 @@ module FinchAPI
|
|
|
507
530
|
# @param is_active [Boolean]
|
|
508
531
|
# @param last_name [Boolean]
|
|
509
532
|
# @param location [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location]
|
|
510
|
-
# @param manager [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager]
|
|
533
|
+
# @param manager [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
|
511
534
|
# @param middle_name [Boolean]
|
|
512
535
|
# @param start_date [Boolean]
|
|
513
536
|
# @param title [Boolean]
|
|
@@ -1127,6 +1150,303 @@ module FinchAPI
|
|
|
1127
1150
|
# @param start_date [Boolean]
|
|
1128
1151
|
end
|
|
1129
1152
|
end
|
|
1153
|
+
|
|
1154
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#plan_dependents
|
|
1155
|
+
class PlanDependents < FinchAPI::Internal::Type::BaseModel
|
|
1156
|
+
# @!attribute coverage
|
|
1157
|
+
#
|
|
1158
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage, nil]
|
|
1159
|
+
optional :coverage,
|
|
1160
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage }
|
|
1161
|
+
|
|
1162
|
+
# @!attribute date_of_birth
|
|
1163
|
+
#
|
|
1164
|
+
# @return [Boolean, nil]
|
|
1165
|
+
optional :date_of_birth, FinchAPI::Internal::Type::Boolean
|
|
1166
|
+
|
|
1167
|
+
# @!attribute dependent_id
|
|
1168
|
+
#
|
|
1169
|
+
# @return [Boolean, nil]
|
|
1170
|
+
optional :dependent_id, FinchAPI::Internal::Type::Boolean
|
|
1171
|
+
|
|
1172
|
+
# @!attribute first_name
|
|
1173
|
+
#
|
|
1174
|
+
# @return [Boolean, nil]
|
|
1175
|
+
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
1176
|
+
|
|
1177
|
+
# @!attribute gender
|
|
1178
|
+
#
|
|
1179
|
+
# @return [Boolean, nil]
|
|
1180
|
+
optional :gender, FinchAPI::Internal::Type::Boolean
|
|
1181
|
+
|
|
1182
|
+
# @!attribute last_name
|
|
1183
|
+
#
|
|
1184
|
+
# @return [Boolean, nil]
|
|
1185
|
+
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
1186
|
+
|
|
1187
|
+
# @!attribute middle_name
|
|
1188
|
+
#
|
|
1189
|
+
# @return [Boolean, nil]
|
|
1190
|
+
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
1191
|
+
|
|
1192
|
+
# @!attribute ssn
|
|
1193
|
+
#
|
|
1194
|
+
# @return [Boolean, nil]
|
|
1195
|
+
optional :ssn, FinchAPI::Internal::Type::Boolean
|
|
1196
|
+
|
|
1197
|
+
# @!method initialize(coverage: nil, date_of_birth: nil, dependent_id: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, ssn: nil)
|
|
1198
|
+
# @param coverage [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage]
|
|
1199
|
+
# @param date_of_birth [Boolean]
|
|
1200
|
+
# @param dependent_id [Boolean]
|
|
1201
|
+
# @param first_name [Boolean]
|
|
1202
|
+
# @param gender [Boolean]
|
|
1203
|
+
# @param last_name [Boolean]
|
|
1204
|
+
# @param middle_name [Boolean]
|
|
1205
|
+
# @param ssn [Boolean]
|
|
1206
|
+
|
|
1207
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents#coverage
|
|
1208
|
+
class Coverage < FinchAPI::Internal::Type::BaseModel
|
|
1209
|
+
# @!attribute enrollments
|
|
1210
|
+
#
|
|
1211
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments, nil]
|
|
1212
|
+
optional :enrollments,
|
|
1213
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments }
|
|
1214
|
+
|
|
1215
|
+
# @!attribute individual_id
|
|
1216
|
+
#
|
|
1217
|
+
# @return [Boolean, nil]
|
|
1218
|
+
optional :individual_id, FinchAPI::Internal::Type::Boolean
|
|
1219
|
+
|
|
1220
|
+
# @!attribute relationship_to_individual
|
|
1221
|
+
#
|
|
1222
|
+
# @return [Boolean, nil]
|
|
1223
|
+
optional :relationship_to_individual, FinchAPI::Internal::Type::Boolean
|
|
1224
|
+
|
|
1225
|
+
# @!method initialize(enrollments: nil, individual_id: nil, relationship_to_individual: nil)
|
|
1226
|
+
# @param enrollments [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage::Enrollments]
|
|
1227
|
+
# @param individual_id [Boolean]
|
|
1228
|
+
# @param relationship_to_individual [Boolean]
|
|
1229
|
+
|
|
1230
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanDependents::Coverage#enrollments
|
|
1231
|
+
class Enrollments < FinchAPI::Internal::Type::BaseModel
|
|
1232
|
+
# @!attribute id
|
|
1233
|
+
#
|
|
1234
|
+
# @return [Boolean, nil]
|
|
1235
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1236
|
+
|
|
1237
|
+
# @!attribute type
|
|
1238
|
+
#
|
|
1239
|
+
# @return [Boolean, nil]
|
|
1240
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1241
|
+
|
|
1242
|
+
# @!method initialize(id: nil, type: nil)
|
|
1243
|
+
# @param id [Boolean]
|
|
1244
|
+
# @param type [Boolean]
|
|
1245
|
+
end
|
|
1246
|
+
end
|
|
1247
|
+
end
|
|
1248
|
+
|
|
1249
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#plan_enrollments
|
|
1250
|
+
class PlanEnrollments < FinchAPI::Internal::Type::BaseModel
|
|
1251
|
+
# @!attribute id
|
|
1252
|
+
#
|
|
1253
|
+
# @return [Boolean, nil]
|
|
1254
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1255
|
+
|
|
1256
|
+
# @!attribute contributions
|
|
1257
|
+
#
|
|
1258
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions, nil]
|
|
1259
|
+
optional :contributions,
|
|
1260
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions }
|
|
1261
|
+
|
|
1262
|
+
# @!attribute coverage_end_date
|
|
1263
|
+
#
|
|
1264
|
+
# @return [Boolean, nil]
|
|
1265
|
+
optional :coverage_end_date, FinchAPI::Internal::Type::Boolean
|
|
1266
|
+
|
|
1267
|
+
# @!attribute coverage_start_date
|
|
1268
|
+
#
|
|
1269
|
+
# @return [Boolean, nil]
|
|
1270
|
+
optional :coverage_start_date, FinchAPI::Internal::Type::Boolean
|
|
1271
|
+
|
|
1272
|
+
# @!attribute coverage_tier
|
|
1273
|
+
#
|
|
1274
|
+
# @return [Boolean, nil]
|
|
1275
|
+
optional :coverage_tier, FinchAPI::Internal::Type::Boolean
|
|
1276
|
+
|
|
1277
|
+
# @!attribute dependent_ids
|
|
1278
|
+
#
|
|
1279
|
+
# @return [Boolean, nil]
|
|
1280
|
+
optional :dependent_ids, FinchAPI::Internal::Type::Boolean
|
|
1281
|
+
|
|
1282
|
+
# @!attribute individual_id
|
|
1283
|
+
#
|
|
1284
|
+
# @return [Boolean, nil]
|
|
1285
|
+
optional :individual_id, FinchAPI::Internal::Type::Boolean
|
|
1286
|
+
|
|
1287
|
+
# @!attribute plan_id
|
|
1288
|
+
#
|
|
1289
|
+
# @return [Boolean, nil]
|
|
1290
|
+
optional :plan_id, FinchAPI::Internal::Type::Boolean
|
|
1291
|
+
|
|
1292
|
+
# @!attribute status
|
|
1293
|
+
#
|
|
1294
|
+
# @return [Boolean, nil]
|
|
1295
|
+
optional :status, FinchAPI::Internal::Type::Boolean
|
|
1296
|
+
|
|
1297
|
+
# @!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)
|
|
1298
|
+
# @param id [Boolean]
|
|
1299
|
+
# @param contributions [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions]
|
|
1300
|
+
# @param coverage_end_date [Boolean]
|
|
1301
|
+
# @param coverage_start_date [Boolean]
|
|
1302
|
+
# @param coverage_tier [Boolean]
|
|
1303
|
+
# @param dependent_ids [Boolean]
|
|
1304
|
+
# @param individual_id [Boolean]
|
|
1305
|
+
# @param plan_id [Boolean]
|
|
1306
|
+
# @param status [Boolean]
|
|
1307
|
+
|
|
1308
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments#contributions
|
|
1309
|
+
class Contributions < FinchAPI::Internal::Type::BaseModel
|
|
1310
|
+
# @!attribute employee_contribution
|
|
1311
|
+
#
|
|
1312
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution, nil]
|
|
1313
|
+
optional :employee_contribution,
|
|
1314
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution }
|
|
1315
|
+
|
|
1316
|
+
# @!attribute employer_contribution
|
|
1317
|
+
#
|
|
1318
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution, nil]
|
|
1319
|
+
optional :employer_contribution,
|
|
1320
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution }
|
|
1321
|
+
|
|
1322
|
+
# @!attribute frequency
|
|
1323
|
+
#
|
|
1324
|
+
# @return [Boolean, nil]
|
|
1325
|
+
optional :frequency, FinchAPI::Internal::Type::Boolean
|
|
1326
|
+
|
|
1327
|
+
# @!method initialize(employee_contribution: nil, employer_contribution: nil, frequency: nil)
|
|
1328
|
+
# @param employee_contribution [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployeeContribution]
|
|
1329
|
+
# @param employer_contribution [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions::EmployerContribution]
|
|
1330
|
+
# @param frequency [Boolean]
|
|
1331
|
+
|
|
1332
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employee_contribution
|
|
1333
|
+
class EmployeeContribution < FinchAPI::Internal::Type::BaseModel
|
|
1334
|
+
# @!attribute amount
|
|
1335
|
+
#
|
|
1336
|
+
# @return [Boolean, nil]
|
|
1337
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1338
|
+
|
|
1339
|
+
# @!attribute currency
|
|
1340
|
+
#
|
|
1341
|
+
# @return [Boolean, nil]
|
|
1342
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1343
|
+
|
|
1344
|
+
# @!method initialize(amount: nil, currency: nil)
|
|
1345
|
+
# @param amount [Boolean]
|
|
1346
|
+
# @param currency [Boolean]
|
|
1347
|
+
end
|
|
1348
|
+
|
|
1349
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PlanEnrollments::Contributions#employer_contribution
|
|
1350
|
+
class EmployerContribution < FinchAPI::Internal::Type::BaseModel
|
|
1351
|
+
# @!attribute amount
|
|
1352
|
+
#
|
|
1353
|
+
# @return [Boolean, nil]
|
|
1354
|
+
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1355
|
+
|
|
1356
|
+
# @!attribute currency
|
|
1357
|
+
#
|
|
1358
|
+
# @return [Boolean, nil]
|
|
1359
|
+
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1360
|
+
|
|
1361
|
+
# @!method initialize(amount: nil, currency: nil)
|
|
1362
|
+
# @param amount [Boolean]
|
|
1363
|
+
# @param currency [Boolean]
|
|
1364
|
+
end
|
|
1365
|
+
end
|
|
1366
|
+
end
|
|
1367
|
+
|
|
1368
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#plans
|
|
1369
|
+
class Plans < FinchAPI::Internal::Type::BaseModel
|
|
1370
|
+
# @!attribute id
|
|
1371
|
+
#
|
|
1372
|
+
# @return [Boolean, nil]
|
|
1373
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1374
|
+
|
|
1375
|
+
# @!attribute carrier
|
|
1376
|
+
#
|
|
1377
|
+
# @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans::Carrier, nil]
|
|
1378
|
+
optional :carrier,
|
|
1379
|
+
-> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans::Carrier }
|
|
1380
|
+
|
|
1381
|
+
# @!attribute coverage_tiers
|
|
1382
|
+
#
|
|
1383
|
+
# @return [Boolean, nil]
|
|
1384
|
+
optional :coverage_tiers, FinchAPI::Internal::Type::Boolean
|
|
1385
|
+
|
|
1386
|
+
# @!attribute deduction_codes
|
|
1387
|
+
#
|
|
1388
|
+
# @return [Boolean, nil]
|
|
1389
|
+
optional :deduction_codes, FinchAPI::Internal::Type::Boolean
|
|
1390
|
+
|
|
1391
|
+
# @!attribute description
|
|
1392
|
+
#
|
|
1393
|
+
# @return [Boolean, nil]
|
|
1394
|
+
optional :description, FinchAPI::Internal::Type::Boolean
|
|
1395
|
+
|
|
1396
|
+
# @!attribute end_date
|
|
1397
|
+
#
|
|
1398
|
+
# @return [Boolean, nil]
|
|
1399
|
+
optional :end_date, FinchAPI::Internal::Type::Boolean
|
|
1400
|
+
|
|
1401
|
+
# @!attribute name
|
|
1402
|
+
#
|
|
1403
|
+
# @return [Boolean, nil]
|
|
1404
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1405
|
+
|
|
1406
|
+
# @!attribute network_type
|
|
1407
|
+
#
|
|
1408
|
+
# @return [Boolean, nil]
|
|
1409
|
+
optional :network_type, FinchAPI::Internal::Type::Boolean
|
|
1410
|
+
|
|
1411
|
+
# @!attribute start_date
|
|
1412
|
+
#
|
|
1413
|
+
# @return [Boolean, nil]
|
|
1414
|
+
optional :start_date, FinchAPI::Internal::Type::Boolean
|
|
1415
|
+
|
|
1416
|
+
# @!attribute type
|
|
1417
|
+
#
|
|
1418
|
+
# @return [Boolean, nil]
|
|
1419
|
+
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1420
|
+
|
|
1421
|
+
# @!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)
|
|
1422
|
+
# @param id [Boolean]
|
|
1423
|
+
# @param carrier [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans::Carrier]
|
|
1424
|
+
# @param coverage_tiers [Boolean]
|
|
1425
|
+
# @param deduction_codes [Boolean]
|
|
1426
|
+
# @param description [Boolean]
|
|
1427
|
+
# @param end_date [Boolean]
|
|
1428
|
+
# @param name [Boolean]
|
|
1429
|
+
# @param network_type [Boolean]
|
|
1430
|
+
# @param start_date [Boolean]
|
|
1431
|
+
# @param type [Boolean]
|
|
1432
|
+
|
|
1433
|
+
# @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Plans#carrier
|
|
1434
|
+
class Carrier < FinchAPI::Internal::Type::BaseModel
|
|
1435
|
+
# @!attribute id
|
|
1436
|
+
#
|
|
1437
|
+
# @return [Boolean, nil]
|
|
1438
|
+
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1439
|
+
|
|
1440
|
+
# @!attribute name
|
|
1441
|
+
#
|
|
1442
|
+
# @return [Boolean, nil]
|
|
1443
|
+
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1444
|
+
|
|
1445
|
+
# @!method initialize(id: nil, name: nil)
|
|
1446
|
+
# @param id [Boolean]
|
|
1447
|
+
# @param name [Boolean]
|
|
1448
|
+
end
|
|
1449
|
+
end
|
|
1130
1450
|
end
|
|
1131
1451
|
|
|
1132
1452
|
# The type of authentication method.
|
|
@@ -17,6 +17,14 @@ module FinchAPI
|
|
|
17
17
|
# @return [String]
|
|
18
18
|
required :id, String
|
|
19
19
|
|
|
20
|
+
# @!attribute benefit_eligibility_class
|
|
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
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
required :benefit_eligibility_class, String, nil?: true
|
|
27
|
+
|
|
20
28
|
# @!attribute class_code
|
|
21
29
|
# Worker's compensation classification code for this employee
|
|
22
30
|
#
|
|
@@ -185,13 +193,15 @@ module FinchAPI
|
|
|
185
193
|
# @return [String, nil]
|
|
186
194
|
optional :work_id, String, nil?: true
|
|
187
195
|
|
|
188
|
-
# @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, highly_compensated_employee:, is_active:, key_employee:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, union_code:, union_local:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
|
|
196
|
+
# @!method initialize(id:, benefit_eligibility_class:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, highly_compensated_employee:, is_active:, key_employee:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, union_code:, union_local:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
|
|
189
197
|
# Some parameter documentations has been truncated, see
|
|
190
198
|
# {FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody} for more
|
|
191
199
|
# details.
|
|
192
200
|
#
|
|
193
201
|
# @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
|
194
202
|
#
|
|
203
|
+
# @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
|
|
204
|
+
#
|
|
195
205
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
|
196
206
|
#
|
|
197
207
|
# @param department [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Department, nil] The department object.
|
|
@@ -200,6 +200,9 @@ module FinchAPI
|
|
|
200
200
|
|
|
201
201
|
class PhoneNumber < FinchAPI::Internal::Type::BaseModel
|
|
202
202
|
# @!attribute data
|
|
203
|
+
# The phone number. Format: E.164, with extension where applicable, e.g.
|
|
204
|
+
# `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
|
|
205
|
+
# the provider is returned.
|
|
203
206
|
#
|
|
204
207
|
# @return [String, nil]
|
|
205
208
|
required :data, String, nil?: true
|
|
@@ -212,7 +215,12 @@ module FinchAPI
|
|
|
212
215
|
nil?: true
|
|
213
216
|
|
|
214
217
|
# @!method initialize(data:, type:)
|
|
215
|
-
#
|
|
218
|
+
# Some parameter documentations has been truncated, see
|
|
219
|
+
# {FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber} for
|
|
220
|
+
# more details.
|
|
221
|
+
#
|
|
222
|
+
# @param data [String, nil] The phone number. Format: E.164, with extension where applicable, e.g. `+NNNNNNN
|
|
223
|
+
#
|
|
216
224
|
# @param type [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type, nil]
|
|
217
225
|
|
|
218
226
|
# @see FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber#type
|