vitable-connect 7.0.0 → 8.1.0
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/.fern/metadata.json +2 -2
- data/changelog.md +13 -0
- data/lib/VitableConnect/client.rb +6 -10
- data/lib/VitableConnect/employers/client.rb +96 -6
- data/lib/VitableConnect/employers/types/create_employer_request.rb +2 -0
- data/lib/VitableConnect/employers/types/ensure_payroll_integration_email_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/get_benefit_plan_year_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/get_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/get_hris_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/get_invoice_pdf_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/get_payroll_access_setup_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/list_benefit_plan_year_enrollments_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/list_benefit_plan_years_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/list_employees_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/list_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/list_hris_providers_employers_request.rb +11 -0
- data/lib/VitableConnect/employers/types/list_invoices_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/list_payroll_deduction_statements_employers_request.rb +2 -0
- data/lib/VitableConnect/employers/types/submit_payroll_access_setup_request.rb +2 -0
- data/lib/VitableConnect/employers/types/update_employer_request.rb +2 -0
- data/lib/VitableConnect/employers/types/update_employer_settings_request.rb +2 -0
- data/lib/VitableConnect/enrollments/client.rb +23 -6
- data/lib/VitableConnect/enrollments/types/get_enrollments_request.rb +2 -0
- data/lib/VitableConnect/enrollments/types/reissue_enrollment_request.rb +2 -0
- data/lib/VitableConnect/enrollments/types/terminate_enrollment_request.rb +4 -0
- data/lib/VitableConnect/members/client.rb +46 -1
- data/lib/VitableConnect/members/types/create_member_dependent_request.rb +2 -0
- data/lib/VitableConnect/members/types/get_household_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/get_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/list_dependents_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/list_employments_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/list_enrollments_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/list_id_cards_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/list_members_request.rb +2 -0
- data/lib/VitableConnect/members/types/list_qualifying_life_events_members_request.rb +2 -0
- data/lib/VitableConnect/types/member_enrollment.rb +2 -0
- data/lib/VitableConnect/types/x_vitable_organization.rb +23 -0
- data/lib/VitableConnect/version.rb +1 -1
- data/lib/VitableConnect.rb +2 -0
- data/reference.md +241 -1
- metadata +4 -2
data/reference.md
CHANGED
|
@@ -483,6 +483,14 @@ client.employers.list(
|
|
|
483
483
|
<dl>
|
|
484
484
|
<dd>
|
|
485
485
|
|
|
486
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
487
|
+
|
|
488
|
+
</dd>
|
|
489
|
+
</dl>
|
|
490
|
+
|
|
491
|
+
<dl>
|
|
492
|
+
<dd>
|
|
493
|
+
|
|
486
494
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
487
495
|
|
|
488
496
|
</dd>
|
|
@@ -551,6 +559,14 @@ client.employers.create(
|
|
|
551
559
|
<dl>
|
|
552
560
|
<dd>
|
|
553
561
|
|
|
562
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
563
|
+
|
|
564
|
+
</dd>
|
|
565
|
+
</dl>
|
|
566
|
+
|
|
567
|
+
<dl>
|
|
568
|
+
<dd>
|
|
569
|
+
|
|
554
570
|
**name:** `String` — Employer display name
|
|
555
571
|
|
|
556
572
|
</dd>
|
|
@@ -669,6 +685,14 @@ client.employers.get(employer_id: "empr_abc123def456")
|
|
|
669
685
|
<dl>
|
|
670
686
|
<dd>
|
|
671
687
|
|
|
688
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
689
|
+
|
|
690
|
+
</dd>
|
|
691
|
+
</dl>
|
|
692
|
+
|
|
693
|
+
<dl>
|
|
694
|
+
<dd>
|
|
695
|
+
|
|
672
696
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
673
697
|
|
|
674
698
|
</dd>
|
|
@@ -731,6 +755,14 @@ client.employers.update(employer_id: "empr_abc123def456")
|
|
|
731
755
|
<dl>
|
|
732
756
|
<dd>
|
|
733
757
|
|
|
758
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
759
|
+
|
|
760
|
+
</dd>
|
|
761
|
+
</dl>
|
|
762
|
+
|
|
763
|
+
<dl>
|
|
764
|
+
<dd>
|
|
765
|
+
|
|
734
766
|
**name:** `String` — Employer display name
|
|
735
767
|
|
|
736
768
|
</dd>
|
|
@@ -825,6 +857,14 @@ client.employers.list_benefit_plan_years(employer_id: "empr_abc123def456")
|
|
|
825
857
|
<dl>
|
|
826
858
|
<dd>
|
|
827
859
|
|
|
860
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
861
|
+
|
|
862
|
+
</dd>
|
|
863
|
+
</dl>
|
|
864
|
+
|
|
865
|
+
<dl>
|
|
866
|
+
<dd>
|
|
867
|
+
|
|
828
868
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
829
869
|
|
|
830
870
|
</dd>
|
|
@@ -898,6 +938,14 @@ client.employers.get_benefit_plan_year(
|
|
|
898
938
|
<dl>
|
|
899
939
|
<dd>
|
|
900
940
|
|
|
941
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
942
|
+
|
|
943
|
+
</dd>
|
|
944
|
+
</dl>
|
|
945
|
+
|
|
946
|
+
<dl>
|
|
947
|
+
<dd>
|
|
948
|
+
|
|
901
949
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
902
950
|
|
|
903
951
|
</dd>
|
|
@@ -1005,6 +1053,14 @@ client.employers.list_benefit_plan_year_enrollments(
|
|
|
1005
1053
|
<dl>
|
|
1006
1054
|
<dd>
|
|
1007
1055
|
|
|
1056
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1057
|
+
|
|
1058
|
+
</dd>
|
|
1059
|
+
</dl>
|
|
1060
|
+
|
|
1061
|
+
<dl>
|
|
1062
|
+
<dd>
|
|
1063
|
+
|
|
1008
1064
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1009
1065
|
|
|
1010
1066
|
</dd>
|
|
@@ -1203,6 +1259,14 @@ client.employers.list_employees(
|
|
|
1203
1259
|
<dl>
|
|
1204
1260
|
<dd>
|
|
1205
1261
|
|
|
1262
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1263
|
+
|
|
1264
|
+
</dd>
|
|
1265
|
+
</dl>
|
|
1266
|
+
|
|
1267
|
+
<dl>
|
|
1268
|
+
<dd>
|
|
1269
|
+
|
|
1206
1270
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1207
1271
|
|
|
1208
1272
|
</dd>
|
|
@@ -1265,6 +1329,14 @@ client.employers.get_hris(employer_id: "empr_abc123def456")
|
|
|
1265
1329
|
<dl>
|
|
1266
1330
|
<dd>
|
|
1267
1331
|
|
|
1332
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1333
|
+
|
|
1334
|
+
</dd>
|
|
1335
|
+
</dl>
|
|
1336
|
+
|
|
1337
|
+
<dl>
|
|
1338
|
+
<dd>
|
|
1339
|
+
|
|
1268
1340
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1269
1341
|
|
|
1270
1342
|
</dd>
|
|
@@ -1346,6 +1418,14 @@ client.employers.list_invoices(
|
|
|
1346
1418
|
<dl>
|
|
1347
1419
|
<dd>
|
|
1348
1420
|
|
|
1421
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1422
|
+
|
|
1423
|
+
</dd>
|
|
1424
|
+
</dl>
|
|
1425
|
+
|
|
1426
|
+
<dl>
|
|
1427
|
+
<dd>
|
|
1428
|
+
|
|
1349
1429
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1350
1430
|
|
|
1351
1431
|
</dd>
|
|
@@ -1419,6 +1499,14 @@ client.employers.get_invoice_pdf(
|
|
|
1419
1499
|
<dl>
|
|
1420
1500
|
<dd>
|
|
1421
1501
|
|
|
1502
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1503
|
+
|
|
1504
|
+
</dd>
|
|
1505
|
+
</dl>
|
|
1506
|
+
|
|
1507
|
+
<dl>
|
|
1508
|
+
<dd>
|
|
1509
|
+
|
|
1422
1510
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1423
1511
|
|
|
1424
1512
|
</dd>
|
|
@@ -1481,6 +1569,14 @@ client.employers.get_payroll_access_setup(employer_id: "empr_abc123def456")
|
|
|
1481
1569
|
<dl>
|
|
1482
1570
|
<dd>
|
|
1483
1571
|
|
|
1572
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1573
|
+
|
|
1574
|
+
</dd>
|
|
1575
|
+
</dl>
|
|
1576
|
+
|
|
1577
|
+
<dl>
|
|
1578
|
+
<dd>
|
|
1579
|
+
|
|
1484
1580
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1485
1581
|
|
|
1486
1582
|
</dd>
|
|
@@ -1552,6 +1648,14 @@ client.employers.submit_payroll_access_setup(
|
|
|
1552
1648
|
<dl>
|
|
1553
1649
|
<dd>
|
|
1554
1650
|
|
|
1651
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1652
|
+
|
|
1653
|
+
</dd>
|
|
1654
|
+
</dl>
|
|
1655
|
+
|
|
1656
|
+
<dl>
|
|
1657
|
+
<dd>
|
|
1658
|
+
|
|
1555
1659
|
**employees_in_payroll_acknowledged:** `Internal::Types::Boolean` — Attestation that all benefit-eligible employees appear in the payroll system.
|
|
1556
1660
|
|
|
1557
1661
|
</dd>
|
|
@@ -1818,6 +1922,14 @@ client.employers.list_payroll_deduction_statements(
|
|
|
1818
1922
|
<dl>
|
|
1819
1923
|
<dd>
|
|
1820
1924
|
|
|
1925
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1926
|
+
|
|
1927
|
+
</dd>
|
|
1928
|
+
</dl>
|
|
1929
|
+
|
|
1930
|
+
<dl>
|
|
1931
|
+
<dd>
|
|
1932
|
+
|
|
1821
1933
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1822
1934
|
|
|
1823
1935
|
</dd>
|
|
@@ -1880,6 +1992,14 @@ client.employers.ensure_payroll_integration_email(employer_id: "empr_abc123def45
|
|
|
1880
1992
|
<dl>
|
|
1881
1993
|
<dd>
|
|
1882
1994
|
|
|
1995
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
1996
|
+
|
|
1997
|
+
</dd>
|
|
1998
|
+
</dl>
|
|
1999
|
+
|
|
2000
|
+
<dl>
|
|
2001
|
+
<dd>
|
|
2002
|
+
|
|
1883
2003
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
1884
2004
|
|
|
1885
2005
|
</dd>
|
|
@@ -1945,6 +2065,14 @@ client.employers.update_settings(
|
|
|
1945
2065
|
<dl>
|
|
1946
2066
|
<dd>
|
|
1947
2067
|
|
|
2068
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2069
|
+
|
|
2070
|
+
</dd>
|
|
2071
|
+
</dl>
|
|
2072
|
+
|
|
2073
|
+
<dl>
|
|
2074
|
+
<dd>
|
|
2075
|
+
|
|
1948
2076
|
**pay_frequency:** `VitableConnect::Types::DeductionFrequency`
|
|
1949
2077
|
|
|
1950
2078
|
</dd>
|
|
@@ -2007,6 +2135,14 @@ client.employers.list_hris_providers
|
|
|
2007
2135
|
<dl>
|
|
2008
2136
|
<dd>
|
|
2009
2137
|
|
|
2138
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2139
|
+
|
|
2140
|
+
</dd>
|
|
2141
|
+
</dl>
|
|
2142
|
+
|
|
2143
|
+
<dl>
|
|
2144
|
+
<dd>
|
|
2145
|
+
|
|
2010
2146
|
**request_options:** `VitableConnect::Employers::RequestOptions`
|
|
2011
2147
|
|
|
2012
2148
|
</dd>
|
|
@@ -2070,6 +2206,14 @@ client.enrollments.get(enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ")
|
|
|
2070
2206
|
<dl>
|
|
2071
2207
|
<dd>
|
|
2072
2208
|
|
|
2209
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2210
|
+
|
|
2211
|
+
</dd>
|
|
2212
|
+
</dl>
|
|
2213
|
+
|
|
2214
|
+
<dl>
|
|
2215
|
+
<dd>
|
|
2216
|
+
|
|
2073
2217
|
**request_options:** `VitableConnect::Enrollments::RequestOptions`
|
|
2074
2218
|
|
|
2075
2219
|
</dd>
|
|
@@ -2137,6 +2281,14 @@ client.enrollments.reissue(
|
|
|
2137
2281
|
<dl>
|
|
2138
2282
|
<dd>
|
|
2139
2283
|
|
|
2284
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2285
|
+
|
|
2286
|
+
</dd>
|
|
2287
|
+
</dl>
|
|
2288
|
+
|
|
2289
|
+
<dl>
|
|
2290
|
+
<dd>
|
|
2291
|
+
|
|
2140
2292
|
**reason:** `String` — Audit reason for the reissue; required for user-backed callers and optional for long-lived organization API-key callers
|
|
2141
2293
|
|
|
2142
2294
|
</dd>
|
|
@@ -2185,7 +2337,7 @@ client.enrollments.reissue(
|
|
|
2185
2337
|
<dl>
|
|
2186
2338
|
<dd>
|
|
2187
2339
|
|
|
2188
|
-
Terminates enrolled coverage
|
|
2340
|
+
Terminates enrolled coverage; it ends on the last day of the termination month, or on the termination date for VPC. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. ICHRA callers may pass the date the carrier policy actually ended, which can be in the past. User-backed callers must provide a reason; it is optional for organization API-key callers. API keys may act across the caller organization's book. Tenant mismatches return the same non-disclosing 404 before the request body is validated.
|
|
2189
2341
|
</dd>
|
|
2190
2342
|
</dl>
|
|
2191
2343
|
</dd>
|
|
@@ -2228,6 +2380,14 @@ client.enrollments.terminate(
|
|
|
2228
2380
|
<dl>
|
|
2229
2381
|
<dd>
|
|
2230
2382
|
|
|
2383
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2384
|
+
|
|
2385
|
+
</dd>
|
|
2386
|
+
</dl>
|
|
2387
|
+
|
|
2388
|
+
<dl>
|
|
2389
|
+
<dd>
|
|
2390
|
+
|
|
2231
2391
|
**reason:** `String` — Audit reason for the termination; required for user-backed callers and optional for long-lived organization API-key callers
|
|
2232
2392
|
|
|
2233
2393
|
</dd>
|
|
@@ -2252,6 +2412,14 @@ client.enrollments.terminate(
|
|
|
2252
2412
|
<dl>
|
|
2253
2413
|
<dd>
|
|
2254
2414
|
|
|
2415
|
+
**carrier_coverage_end_date:** `String` — Last day the carrier policy covered the member, when it ended before this termination. Accepted for ICHRA enrollments only; coverage end is derived when omitted
|
|
2416
|
+
|
|
2417
|
+
</dd>
|
|
2418
|
+
</dl>
|
|
2419
|
+
|
|
2420
|
+
<dl>
|
|
2421
|
+
<dd>
|
|
2422
|
+
|
|
2255
2423
|
**request_options:** `VitableConnect::Enrollments::RequestOptions`
|
|
2256
2424
|
|
|
2257
2425
|
</dd>
|
|
@@ -2606,6 +2774,14 @@ client.members.get(member_id: "mbr_abc123def456")
|
|
|
2606
2774
|
<dl>
|
|
2607
2775
|
<dd>
|
|
2608
2776
|
|
|
2777
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2778
|
+
|
|
2779
|
+
</dd>
|
|
2780
|
+
</dl>
|
|
2781
|
+
|
|
2782
|
+
<dl>
|
|
2783
|
+
<dd>
|
|
2784
|
+
|
|
2609
2785
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
2610
2786
|
|
|
2611
2787
|
</dd>
|
|
@@ -2668,6 +2844,14 @@ client.members.list_dependents(member_id: "mbr_abc123def456")
|
|
|
2668
2844
|
<dl>
|
|
2669
2845
|
<dd>
|
|
2670
2846
|
|
|
2847
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2848
|
+
|
|
2849
|
+
</dd>
|
|
2850
|
+
</dl>
|
|
2851
|
+
|
|
2852
|
+
<dl>
|
|
2853
|
+
<dd>
|
|
2854
|
+
|
|
2671
2855
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
2672
2856
|
|
|
2673
2857
|
</dd>
|
|
@@ -2743,6 +2927,14 @@ client.members.create_dependent(
|
|
|
2743
2927
|
<dl>
|
|
2744
2928
|
<dd>
|
|
2745
2929
|
|
|
2930
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
2931
|
+
|
|
2932
|
+
</dd>
|
|
2933
|
+
</dl>
|
|
2934
|
+
|
|
2935
|
+
<dl>
|
|
2936
|
+
<dd>
|
|
2937
|
+
|
|
2746
2938
|
**first_name:** `String` — Dependent's legal first name
|
|
2747
2939
|
|
|
2748
2940
|
</dd>
|
|
@@ -2915,6 +3107,14 @@ client.members.list_employments(member_id: "mbr_abc123def456")
|
|
|
2915
3107
|
<dl>
|
|
2916
3108
|
<dd>
|
|
2917
3109
|
|
|
3110
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
3111
|
+
|
|
3112
|
+
</dd>
|
|
3113
|
+
</dl>
|
|
3114
|
+
|
|
3115
|
+
<dl>
|
|
3116
|
+
<dd>
|
|
3117
|
+
|
|
2918
3118
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
2919
3119
|
|
|
2920
3120
|
</dd>
|
|
@@ -2977,6 +3177,14 @@ client.members.list_enrollments(member_id: "mbr_abc123def456")
|
|
|
2977
3177
|
<dl>
|
|
2978
3178
|
<dd>
|
|
2979
3179
|
|
|
3180
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
3181
|
+
|
|
3182
|
+
</dd>
|
|
3183
|
+
</dl>
|
|
3184
|
+
|
|
3185
|
+
<dl>
|
|
3186
|
+
<dd>
|
|
3187
|
+
|
|
2980
3188
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
2981
3189
|
|
|
2982
3190
|
</dd>
|
|
@@ -3039,6 +3247,14 @@ client.members.get_household(member_id: "mbr_abc123def456")
|
|
|
3039
3247
|
<dl>
|
|
3040
3248
|
<dd>
|
|
3041
3249
|
|
|
3250
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
3251
|
+
|
|
3252
|
+
</dd>
|
|
3253
|
+
</dl>
|
|
3254
|
+
|
|
3255
|
+
<dl>
|
|
3256
|
+
<dd>
|
|
3257
|
+
|
|
3042
3258
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
3043
3259
|
|
|
3044
3260
|
</dd>
|
|
@@ -3101,6 +3317,14 @@ client.members.list_id_cards(member_id: "mbr_abc123def456")
|
|
|
3101
3317
|
<dl>
|
|
3102
3318
|
<dd>
|
|
3103
3319
|
|
|
3320
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
3321
|
+
|
|
3322
|
+
</dd>
|
|
3323
|
+
</dl>
|
|
3324
|
+
|
|
3325
|
+
<dl>
|
|
3326
|
+
<dd>
|
|
3327
|
+
|
|
3104
3328
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
3105
3329
|
|
|
3106
3330
|
</dd>
|
|
@@ -3191,6 +3415,14 @@ client.members.list_qualifying_life_events(
|
|
|
3191
3415
|
<dl>
|
|
3192
3416
|
<dd>
|
|
3193
3417
|
|
|
3418
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
3419
|
+
|
|
3420
|
+
</dd>
|
|
3421
|
+
</dl>
|
|
3422
|
+
|
|
3423
|
+
<dl>
|
|
3424
|
+
<dd>
|
|
3425
|
+
|
|
3194
3426
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
3195
3427
|
|
|
3196
3428
|
</dd>
|
|
@@ -3272,6 +3504,14 @@ client.members.list(
|
|
|
3272
3504
|
<dl>
|
|
3273
3505
|
<dd>
|
|
3274
3506
|
|
|
3507
|
+
**vitable_organization:** `String` — Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.
|
|
3508
|
+
|
|
3509
|
+
</dd>
|
|
3510
|
+
</dl>
|
|
3511
|
+
|
|
3512
|
+
<dl>
|
|
3513
|
+
<dd>
|
|
3514
|
+
|
|
3275
3515
|
**request_options:** `VitableConnect::Members::RequestOptions`
|
|
3276
3516
|
|
|
3277
3517
|
</dd>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: vitable-connect
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 8.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- VitableConnect
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-10-
|
|
11
|
+
date: 2026-10-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: The VitableConnect Ruby library provides convenient access to the VitableConnect
|
|
14
14
|
API from Ruby.
|
|
@@ -48,6 +48,7 @@ files:
|
|
|
48
48
|
- lib/VitableConnect/employers/types/list_benefit_plan_years_employers_request.rb
|
|
49
49
|
- lib/VitableConnect/employers/types/list_employees_employers_request.rb
|
|
50
50
|
- lib/VitableConnect/employers/types/list_employers_request.rb
|
|
51
|
+
- lib/VitableConnect/employers/types/list_hris_providers_employers_request.rb
|
|
51
52
|
- lib/VitableConnect/employers/types/list_invoices_employers_request.rb
|
|
52
53
|
- lib/VitableConnect/employers/types/list_payroll_deduction_statements_employers_request.rb
|
|
53
54
|
- lib/VitableConnect/employers/types/submit_payroll_access_setup_request.rb
|
|
@@ -290,6 +291,7 @@ files:
|
|
|
290
291
|
- lib/VitableConnect/types/webhook_event.rb
|
|
291
292
|
- lib/VitableConnect/types/webhook_event_list_response.rb
|
|
292
293
|
- lib/VitableConnect/types/webhook_event_response.rb
|
|
294
|
+
- lib/VitableConnect/types/x_vitable_organization.rb
|
|
293
295
|
- lib/VitableConnect/version.rb
|
|
294
296
|
- lib/VitableConnect/webhook_events/client.rb
|
|
295
297
|
- lib/VitableConnect/webhook_events/types/get_webhook_events_request.rb
|