vitable-connect 0.4.0 → 0.6.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/CHANGELOG.md +52 -0
- data/README.md +9 -9
- data/lib/vitable_connect/client.rb +19 -6
- data/lib/vitable_connect/internal/transport/base_client.rb +28 -4
- data/lib/vitable_connect/internal/type/enum.rb +13 -9
- data/lib/vitable_connect/models/auth_issue_access_token_params.rb +17 -3
- data/lib/vitable_connect/models/auth_issue_access_token_response.rb +17 -3
- data/lib/vitable_connect/models/employee.rb +98 -30
- data/lib/vitable_connect/models/employee_update_params.rb +185 -0
- data/lib/vitable_connect/models/employee_update_response.rb +18 -0
- data/lib/vitable_connect/models/employer.rb +36 -10
- data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_params.rb +22 -0
- data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_response.rb +29 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rb +80 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rb +175 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_years_params.rb +22 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_years_response.rb +301 -0
- data/lib/vitable_connect/models/employer_list_employees_params.rb +28 -1
- data/lib/vitable_connect/models/employer_list_hris_providers_params.rb +14 -0
- data/lib/vitable_connect/models/employer_list_hris_providers_response.rb +30 -0
- data/lib/vitable_connect/models/employer_list_invoices_params.rb +38 -0
- data/lib/vitable_connect/models/employer_list_invoices_response.rb +77 -0
- data/lib/vitable_connect/models/employer_list_params.rb +118 -5
- data/lib/vitable_connect/models/employer_list_payroll_deduction_statements_params.rb +38 -0
- data/lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb +113 -0
- data/lib/vitable_connect/models/employer_list_response.rb +283 -0
- data/lib/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rb +30 -0
- data/lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb +813 -0
- data/lib/vitable_connect/models/employer_retrieve_hris_params.rb +22 -0
- data/lib/vitable_connect/models/employer_retrieve_hris_response.rb +55 -0
- data/lib/vitable_connect/models/employer_retrieve_invoice_pdf_params.rb +30 -0
- data/lib/vitable_connect/models/employer_retrieve_invoice_pdf_response.rb +17 -0
- data/lib/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rb +22 -0
- data/lib/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rb +35 -0
- data/lib/vitable_connect/models/employer_submit_census_sync_params.rb +9 -8
- data/lib/vitable_connect/models/employer_submit_payroll_access_setup_params.rb +267 -0
- data/lib/vitable_connect/models/employer_submit_payroll_access_setup_response.rb +35 -0
- data/lib/vitable_connect/models/employer_update_params.rb +99 -0
- data/lib/vitable_connect/models/employer_update_settings_params.rb +9 -9
- data/lib/vitable_connect/models/employer_update_settings_response.rb +4 -4
- data/lib/vitable_connect/models/enrollment_reissue_params.rb +50 -0
- data/lib/vitable_connect/models/enrollment_reissue_response.rb +30 -0
- data/lib/vitable_connect/models/enrollment_terminate_params.rb +50 -0
- data/lib/vitable_connect/models/group.rb +17 -6
- data/lib/vitable_connect/models/groups/members/sync_retrieve_response.rb +74 -3
- data/lib/vitable_connect/models/groups/members/sync_submit_params.rb +7 -7
- data/lib/vitable_connect/models/member_list_dependents_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_dependents_response.rb +132 -0
- data/lib/vitable_connect/models/member_list_employments_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_employments_response.rb +18 -0
- data/lib/vitable_connect/models/member_list_enrollments_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_enrollments_response.rb +319 -0
- data/lib/vitable_connect/models/member_list_id_cards_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_id_cards_response.rb +368 -0
- data/lib/vitable_connect/models/member_list_params.rb +38 -0
- data/lib/vitable_connect/models/member_list_qualifying_life_events_params.rb +57 -0
- data/lib/vitable_connect/models/member_list_qualifying_life_events_response.rb +96 -0
- data/lib/vitable_connect/models/member_list_response.rb +108 -0
- data/lib/vitable_connect/models/member_retrieve_household_params.rb +20 -0
- data/lib/vitable_connect/models/member_retrieve_household_response.rb +128 -0
- data/lib/vitable_connect/models/member_retrieve_params.rb +20 -0
- data/lib/vitable_connect/models/member_retrieve_response.rb +195 -0
- data/lib/vitable_connect/models/organization_create_params.rb +57 -0
- data/lib/vitable_connect/models/organization_create_response.rb +104 -0
- data/lib/vitable_connect/models/organization_list_params.rb +14 -0
- data/lib/vitable_connect/models/organization_list_response.rb +128 -0
- data/lib/vitable_connect/models/webhook_event_list_params.rb +3 -3
- data/lib/vitable_connect/models.rb +54 -11
- data/lib/vitable_connect/resources/employees.rb +49 -3
- data/lib/vitable_connect/resources/employers.rb +402 -28
- data/lib/vitable_connect/resources/enrollments.rb +75 -0
- data/lib/vitable_connect/resources/members.rb +231 -0
- data/lib/vitable_connect/resources/organizations.rb +66 -0
- data/lib/vitable_connect/version.rb +1 -1
- data/lib/vitable_connect.rb +51 -6
- data/rbi/vitable_connect/client.rbi +18 -6
- data/rbi/vitable_connect/internal/transport/base_client.rbi +4 -1
- data/rbi/vitable_connect/models/auth_issue_access_token_params.rbi +53 -5
- data/rbi/vitable_connect/models/auth_issue_access_token_response.rbi +51 -5
- data/rbi/vitable_connect/models/employee.rbi +138 -37
- data/rbi/vitable_connect/models/employee_update_params.rbi +323 -0
- data/rbi/vitable_connect/models/employee_update_response.rbi +32 -0
- data/rbi/vitable_connect/models/employer.rbi +58 -8
- data/rbi/vitable_connect/models/employer_ensure_payroll_integration_email_params.rbi +46 -0
- data/rbi/vitable_connect/models/employer_ensure_payroll_integration_email_response.rbi +72 -0
- data/rbi/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rbi +165 -0
- data/rbi/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rbi +278 -0
- data/rbi/vitable_connect/models/{benefit_eligibility_policy_retrieve_params.rbi → employer_list_benefit_plan_years_params.rbi} +11 -8
- data/rbi/vitable_connect/models/employer_list_benefit_plan_years_response.rbi +539 -0
- data/rbi/vitable_connect/models/employer_list_employees_params.rbi +70 -0
- data/rbi/vitable_connect/models/employer_list_hris_providers_params.rbi +32 -0
- data/rbi/vitable_connect/models/employer_list_hris_providers_response.rbi +74 -0
- data/rbi/vitable_connect/models/employer_list_invoices_params.rbi +65 -0
- data/rbi/vitable_connect/models/employer_list_invoices_response.rbi +151 -0
- data/rbi/vitable_connect/models/employer_list_params.rbi +292 -4
- data/rbi/vitable_connect/models/{employer_create_benefit_eligibility_policy_params.rbi → employer_list_payroll_deduction_statements_params.rbi} +22 -18
- data/rbi/vitable_connect/models/employer_list_payroll_deduction_statements_response.rbi +169 -0
- data/rbi/vitable_connect/models/employer_list_response.rbi +426 -0
- data/rbi/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rbi +54 -0
- data/rbi/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rbi +1574 -0
- data/rbi/vitable_connect/models/employer_retrieve_hris_params.rbi +46 -0
- data/rbi/vitable_connect/models/employer_retrieve_hris_response.rbi +120 -0
- data/rbi/vitable_connect/models/employer_retrieve_invoice_pdf_params.rbi +54 -0
- data/rbi/vitable_connect/models/employer_retrieve_invoice_pdf_response.rbi +30 -0
- data/rbi/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rbi +46 -0
- data/rbi/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rbi +83 -0
- data/rbi/vitable_connect/models/employer_submit_census_sync_params.rbi +8 -6
- data/rbi/vitable_connect/models/employer_submit_payroll_access_setup_params.rbi +441 -0
- data/rbi/vitable_connect/models/employer_submit_payroll_access_setup_response.rbi +83 -0
- data/rbi/vitable_connect/models/employer_update_params.rbi +155 -0
- data/rbi/vitable_connect/models/employer_update_settings_params.rbi +12 -12
- data/rbi/vitable_connect/models/employer_update_settings_response.rbi +6 -6
- data/rbi/vitable_connect/models/enrollment_reissue_params.rbi +72 -0
- data/rbi/vitable_connect/models/enrollment_reissue_response.rbi +67 -0
- data/rbi/vitable_connect/models/enrollment_terminate_params.rbi +72 -0
- data/rbi/vitable_connect/models/group.rbi +12 -0
- data/rbi/vitable_connect/models/groups/members/sync_retrieve_response.rbi +174 -4
- data/rbi/vitable_connect/models/groups/members/sync_submit_params.rbi +9 -9
- data/rbi/vitable_connect/models/member_list_dependents_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_dependents_response.rbi +249 -0
- data/rbi/vitable_connect/models/member_list_employments_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_employments_response.rbi +31 -0
- data/rbi/vitable_connect/models/member_list_enrollments_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_enrollments_response.rbi +579 -0
- data/rbi/vitable_connect/models/member_list_id_cards_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_id_cards_response.rbi +624 -0
- data/rbi/vitable_connect/models/member_list_params.rbi +71 -0
- data/rbi/vitable_connect/models/member_list_qualifying_life_events_params.rbi +130 -0
- data/rbi/vitable_connect/models/member_list_qualifying_life_events_response.rbi +192 -0
- data/rbi/vitable_connect/models/member_list_response.rbi +166 -0
- data/rbi/vitable_connect/models/member_retrieve_household_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_retrieve_household_response.rbi +251 -0
- data/rbi/vitable_connect/models/member_retrieve_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_retrieve_response.rbi +312 -0
- data/rbi/vitable_connect/models/organization_create_params.rbi +127 -0
- data/rbi/vitable_connect/models/organization_create_response.rbi +212 -0
- data/rbi/vitable_connect/models/organization_list_params.rbi +32 -0
- data/rbi/vitable_connect/models/organization_list_response.rbi +266 -0
- data/rbi/vitable_connect/models/webhook_event_list_params.rbi +8 -8
- data/rbi/vitable_connect/models.rbi +66 -13
- data/rbi/vitable_connect/resources/employees.rbi +62 -3
- data/rbi/vitable_connect/resources/employers.rbi +373 -24
- data/rbi/vitable_connect/resources/enrollments.rbi +61 -0
- data/rbi/vitable_connect/resources/members.rbi +169 -0
- data/rbi/vitable_connect/resources/organizations.rbi +48 -0
- data/rbi/vitable_connect/resources/webhook_events.rbi +1 -1
- data/sig/vitable_connect/client.rbs +9 -3
- data/sig/vitable_connect/internal/transport/base_client.rbs +2 -0
- data/sig/vitable_connect/models/auth_issue_access_token_params.rbs +22 -4
- data/sig/vitable_connect/models/auth_issue_access_token_response.rbs +22 -4
- data/sig/vitable_connect/models/employee.rbs +65 -18
- data/sig/vitable_connect/models/employee_update_params.rbs +140 -0
- data/sig/vitable_connect/models/employee_update_response.rbs +13 -0
- data/sig/vitable_connect/models/employer.rbs +17 -5
- data/sig/vitable_connect/models/employer_ensure_payroll_integration_email_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_ensure_payroll_integration_email_response.rbs +30 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rbs +74 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rbs +111 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_years_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_years_response.rbs +197 -0
- data/sig/vitable_connect/models/employer_list_employees_params.rbs +32 -1
- data/sig/vitable_connect/models/employer_list_hris_providers_params.rbs +15 -0
- data/sig/vitable_connect/models/employer_list_hris_providers_response.rbs +30 -0
- data/sig/vitable_connect/models/employer_list_invoices_params.rbs +34 -0
- data/sig/vitable_connect/models/employer_list_invoices_response.rbs +62 -0
- data/sig/vitable_connect/models/employer_list_params.rbs +94 -1
- data/sig/vitable_connect/models/{employer_create_benefit_eligibility_policy_params.rbs → employer_list_payroll_deduction_statements_params.rbs} +13 -9
- data/sig/vitable_connect/models/employer_list_payroll_deduction_statements_response.rbs +73 -0
- data/sig/vitable_connect/models/employer_list_response.rbs +179 -0
- data/sig/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rbs +28 -0
- data/sig/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rbs +540 -0
- data/sig/vitable_connect/models/employer_retrieve_hris_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_retrieve_hris_response.rbs +50 -0
- data/sig/vitable_connect/models/employer_retrieve_invoice_pdf_params.rbs +28 -0
- data/sig/vitable_connect/models/employer_retrieve_invoice_pdf_response.rbs +13 -0
- data/sig/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rbs +32 -0
- data/sig/vitable_connect/models/employer_submit_census_sync_params.rbs +5 -5
- data/sig/vitable_connect/models/employer_submit_payroll_access_setup_params.rbs +198 -0
- data/sig/vitable_connect/models/employer_submit_payroll_access_setup_response.rbs +32 -0
- data/sig/vitable_connect/models/employer_update_params.rbs +83 -0
- data/sig/vitable_connect/models/enrollment_reissue_params.rbs +41 -0
- data/sig/vitable_connect/models/enrollment_reissue_response.rbs +28 -0
- data/sig/vitable_connect/models/enrollment_terminate_params.rbs +41 -0
- data/sig/vitable_connect/models/groups/members/sync_retrieve_response.rbs +69 -4
- data/sig/vitable_connect/models/groups/members/sync_submit_params.rbs +8 -8
- data/sig/vitable_connect/models/{benefit_eligibility_policy_retrieve_params.rbs → member_list_dependents_params.rbs} +6 -6
- data/sig/vitable_connect/models/member_list_dependents_response.rbs +96 -0
- data/sig/vitable_connect/models/member_list_employments_params.rbs +23 -0
- data/sig/vitable_connect/models/member_list_employments_response.rbs +14 -0
- data/sig/vitable_connect/models/member_list_enrollments_params.rbs +23 -0
- data/sig/vitable_connect/models/member_list_enrollments_response.rbs +215 -0
- data/sig/vitable_connect/models/member_list_id_cards_params.rbs +23 -0
- data/sig/vitable_connect/models/member_list_id_cards_response.rbs +256 -0
- data/sig/vitable_connect/models/member_list_params.rbs +38 -0
- data/sig/vitable_connect/models/member_list_qualifying_life_events_params.rbs +61 -0
- data/sig/vitable_connect/models/member_list_qualifying_life_events_response.rbs +67 -0
- data/sig/vitable_connect/models/member_list_response.rbs +82 -0
- data/sig/vitable_connect/models/member_retrieve_household_params.rbs +23 -0
- data/sig/vitable_connect/models/member_retrieve_household_response.rbs +92 -0
- data/sig/vitable_connect/models/member_retrieve_params.rbs +23 -0
- data/sig/vitable_connect/models/member_retrieve_response.rbs +143 -0
- data/sig/vitable_connect/models/organization_create_params.rbs +52 -0
- data/sig/vitable_connect/models/organization_create_response.rbs +77 -0
- data/sig/vitable_connect/models/organization_list_params.rbs +15 -0
- data/sig/vitable_connect/models/organization_list_response.rbs +99 -0
- data/sig/vitable_connect/models/webhook_event_list_params.rbs +2 -2
- data/sig/vitable_connect/models.rbs +50 -10
- data/sig/vitable_connect/resources/employees.rbs +13 -0
- data/sig/vitable_connect/resources/employers.rbs +103 -5
- data/sig/vitable_connect/resources/enrollments.rbs +16 -0
- data/sig/vitable_connect/resources/members.rbs +52 -0
- data/sig/vitable_connect/resources/organizations.rbs +17 -0
- metadata +155 -20
- data/lib/vitable_connect/models/benefit_eligibility_policy.rb +0 -53
- data/lib/vitable_connect/models/benefit_eligibility_policy_response.rb +0 -18
- data/lib/vitable_connect/models/benefit_eligibility_policy_retrieve_params.rb +0 -22
- data/lib/vitable_connect/models/employer_create_benefit_eligibility_policy_params.rb +0 -43
- data/lib/vitable_connect/models/type.rb +0 -17
- data/lib/vitable_connect/resources/benefit_eligibility_policies.rb +0 -35
- data/rbi/vitable_connect/models/benefit_eligibility_policy.rbi +0 -74
- data/rbi/vitable_connect/models/benefit_eligibility_policy_response.rbi +0 -38
- data/rbi/vitable_connect/models/type.rbi +0 -21
- data/rbi/vitable_connect/resources/benefit_eligibility_policies.rbi +0 -27
- data/sig/vitable_connect/models/benefit_eligibility_policy.rbs +0 -50
- data/sig/vitable_connect/models/benefit_eligibility_policy_response.rbs +0 -14
- data/sig/vitable_connect/models/type.rbs +0 -14
- data/sig/vitable_connect/resources/benefit_eligibility_policies.rbs +0 -12
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4d04d86c9bf83e95324f9f67db4112f50154df2953ac028c0c51187f7d15dd35
|
|
4
|
+
data.tar.gz: ded0a148b80bcf67f00c814029bf677cd47992a10e5e8426a23cfae0c20fe55d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6dbe00ee9a908088044efbddd2a4f724b3f34f7c51dc25a7c1754194eb73d5947cf5b85148281a31e2a97a96094aa1becf92ac10aefb409a2db2d8bdb63d7383
|
|
7
|
+
data.tar.gz: 66f3d6ca4f27d134529a4d782171e07b30cefb0a4f95555ac6c664ee9eb2ba5f61b73379aba7eee7b49b3b5a5f50a4152d39b04b284964791037517bee7812e1
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,57 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.6.0 (2026-08-20)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.5.0...v0.6.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.5.0...v0.6.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([a8fa255](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/a8fa25571fcc0dfffd2cea62c700c7612837ab0e))
|
|
10
|
+
* **api:** api update ([8ea65ec](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/8ea65ec4ca7cbd824bd8f84757de396be2f2d763))
|
|
11
|
+
* **api:** api update ([e4c0d55](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/e4c0d55037684ff1728c169be424b135470b6a20))
|
|
12
|
+
* **api:** api update ([1313a69](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/1313a69bae839b3507b9c0d99208b7a4a8fb8be3))
|
|
13
|
+
* **api:** api update ([b7c3059](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/b7c3059ddbbf2e0ebb11c45d4666b8e7b15b8cf0))
|
|
14
|
+
* **api:** api update ([1541690](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/1541690e7b4417b0f96fef30ca1cfb3bf501c8a0))
|
|
15
|
+
* **api:** api update ([3cbc2db](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/3cbc2db1c901083f82bcf2cc5033548850a7b7ef))
|
|
16
|
+
* **api:** api update ([87cb259](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/87cb259ac824d9f3132bdbae4cc126113c76f104))
|
|
17
|
+
* **api:** api update ([59ec0e4](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/59ec0e49fcaf2073d7aa8d23f30fa4f66da2dc06))
|
|
18
|
+
* **api:** api update ([d27c533](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/d27c533ad620cce795687476e75da6c6ca58c981))
|
|
19
|
+
* **api:** api update ([9977677](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/99776776cfdda16a6c1d747411f593e6a6604a93))
|
|
20
|
+
* **api:** configure all public v1 endpoints and drop dangling Type model ref ([266eb2d](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/266eb2dbb74bd7691dde067954b6cabb52feece0))
|
|
21
|
+
* **api:** removed benefit policies from api reference ([a030ce5](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/a030ce509786dee1f6c331bd0d74914caaf79b16))
|
|
22
|
+
* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([432db79](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/432db791d9bb609ce1f65cbbe338e41254edf038))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Bug Fixes
|
|
26
|
+
|
|
27
|
+
* **client:** bind IdentityProviderBearer to an identity_token client option ([d6fa230](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/d6fa230a5b7b4e97e6dde37fd4bc078b1cb7b4a4))
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### Chores
|
|
31
|
+
|
|
32
|
+
* **internal:** bound formatter parallelism to CPU count ([fa81169](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/fa811693161dee1bc144df4db95258ca4755ed51))
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Refactors
|
|
36
|
+
|
|
37
|
+
* **api:** drop the IdP session endpoints from the SDK surface ([30a9c2e](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/30a9c2e3724bed64bf808615943e43e7324de9c5))
|
|
38
|
+
|
|
39
|
+
## 0.5.0 (2026-06-18)
|
|
40
|
+
|
|
41
|
+
Full Changelog: [v0.4.0...v0.5.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.4.0...v0.5.0)
|
|
42
|
+
|
|
43
|
+
### Features
|
|
44
|
+
|
|
45
|
+
* **api:** api update ([a8bcdc8](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/a8bcdc81db4619608b5119a9077ae3b56e441e5c))
|
|
46
|
+
* **api:** api update ([b94afbd](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/b94afbd4992d43ed37036930d0697416b8698946))
|
|
47
|
+
* **api:** api update ([f3374eb](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/f3374eb5c25f3da5c2511fa2b89b049b8fdffbba))
|
|
48
|
+
* **api:** api update ([4c48eb5](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/4c48eb5ebb5f4d939c0604656806fbab0498fabe))
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Bug Fixes
|
|
52
|
+
|
|
53
|
+
* **client:** send content-type header for requests with an omitted optional body ([c2bffd5](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/c2bffd51607ee207814ebca6d6774bfd276d2254))
|
|
54
|
+
|
|
3
55
|
## 0.4.0 (2026-05-15)
|
|
4
56
|
|
|
5
57
|
Full Changelog: [v0.3.0...v0.4.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.3.0...v0.4.0)
|
data/README.md
CHANGED
|
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
17
17
|
<!-- x-release-please-start-version -->
|
|
18
18
|
|
|
19
19
|
```ruby
|
|
20
|
-
gem "vitable-connect", "~> 0.
|
|
20
|
+
gem "vitable-connect", "~> 0.6.0"
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
<!-- x-release-please-end -->
|
|
@@ -229,25 +229,25 @@ vitable_connect.auth.issue_access_token(**params)
|
|
|
229
229
|
Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
|
|
230
230
|
|
|
231
231
|
```ruby
|
|
232
|
-
# :
|
|
233
|
-
puts(VitableConnect::
|
|
232
|
+
# :Salary
|
|
233
|
+
puts(VitableConnect::EmployeeUpdateParams::CompensationType::SALARY)
|
|
234
234
|
|
|
235
|
-
# Revealed type: `T.all(VitableConnect::
|
|
236
|
-
T.reveal_type(VitableConnect::
|
|
235
|
+
# Revealed type: `T.all(VitableConnect::EmployeeUpdateParams::CompensationType, Symbol)`
|
|
236
|
+
T.reveal_type(VitableConnect::EmployeeUpdateParams::CompensationType::SALARY)
|
|
237
237
|
```
|
|
238
238
|
|
|
239
239
|
Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
|
|
240
240
|
|
|
241
241
|
```ruby
|
|
242
242
|
# Using the enum constants preserves the tagged type information:
|
|
243
|
-
vitable_connect.
|
|
244
|
-
|
|
243
|
+
vitable_connect.employees.update(
|
|
244
|
+
compensation_type: VitableConnect::EmployeeUpdateParams::CompensationType::SALARY,
|
|
245
245
|
# …
|
|
246
246
|
)
|
|
247
247
|
|
|
248
248
|
# Literal values are also permissible:
|
|
249
|
-
vitable_connect.
|
|
250
|
-
|
|
249
|
+
vitable_connect.employees.update(
|
|
250
|
+
compensation_type: :Salary,
|
|
251
251
|
# …
|
|
252
252
|
)
|
|
253
253
|
```
|
|
@@ -30,10 +30,6 @@ module VitableConnect
|
|
|
30
30
|
# @return [VitableConnect::Resources::Auth]
|
|
31
31
|
attr_reader :auth
|
|
32
32
|
|
|
33
|
-
# Define rules that determine which employees qualify for benefits
|
|
34
|
-
# @return [VitableConnect::Resources::BenefitEligibilityPolicies]
|
|
35
|
-
attr_reader :benefit_eligibility_policies
|
|
36
|
-
|
|
37
33
|
# @return [VitableConnect::Resources::Employees]
|
|
38
34
|
attr_reader :employees
|
|
39
35
|
|
|
@@ -50,13 +46,29 @@ module VitableConnect
|
|
|
50
46
|
# @return [VitableConnect::Resources::Groups]
|
|
51
47
|
attr_reader :groups
|
|
52
48
|
|
|
49
|
+
# Browse the members covered across your book and read a member's profile
|
|
50
|
+
# @return [VitableConnect::Resources::Members]
|
|
51
|
+
attr_reader :members
|
|
52
|
+
|
|
53
|
+
# @return [VitableConnect::Resources::Organizations]
|
|
54
|
+
attr_reader :organizations
|
|
55
|
+
|
|
53
56
|
# @return [VitableConnect::Resources::Plans]
|
|
54
57
|
attr_reader :plans
|
|
55
58
|
|
|
59
|
+
# @api private
|
|
60
|
+
#
|
|
61
|
+
# @param security [Hash{Symbol=>Boolean}]
|
|
62
|
+
#
|
|
63
|
+
# @return [Hash{String=>String}]
|
|
64
|
+
private def auth_headers(security:)
|
|
65
|
+
{api_key_auth:}.slice(*security.keys).values.reduce({}, :merge)
|
|
66
|
+
end
|
|
67
|
+
|
|
56
68
|
# @api private
|
|
57
69
|
#
|
|
58
70
|
# @return [Hash{String=>String}]
|
|
59
|
-
private def
|
|
71
|
+
private def api_key_auth
|
|
60
72
|
return {} if @api_key.nil?
|
|
61
73
|
|
|
62
74
|
{"authorization" => "Bearer #{@api_key}"}
|
|
@@ -128,12 +140,13 @@ module VitableConnect
|
|
|
128
140
|
)
|
|
129
141
|
|
|
130
142
|
@auth = VitableConnect::Resources::Auth.new(client: self)
|
|
131
|
-
@benefit_eligibility_policies = VitableConnect::Resources::BenefitEligibilityPolicies.new(client: self)
|
|
132
143
|
@employees = VitableConnect::Resources::Employees.new(client: self)
|
|
133
144
|
@employers = VitableConnect::Resources::Employers.new(client: self)
|
|
134
145
|
@enrollments = VitableConnect::Resources::Enrollments.new(client: self)
|
|
135
146
|
@webhook_events = VitableConnect::Resources::WebhookEvents.new(client: self)
|
|
136
147
|
@groups = VitableConnect::Resources::Groups.new(client: self)
|
|
148
|
+
@members = VitableConnect::Resources::Members.new(client: self)
|
|
149
|
+
@organizations = VitableConnect::Resources::Organizations.new(client: self)
|
|
137
150
|
@plans = VitableConnect::Resources::Plans.new(client: self)
|
|
138
151
|
end
|
|
139
152
|
end
|
|
@@ -31,7 +31,19 @@ module VitableConnect
|
|
|
31
31
|
#
|
|
32
32
|
# @raise [ArgumentError]
|
|
33
33
|
def validate!(req)
|
|
34
|
-
keys = [
|
|
34
|
+
keys = [
|
|
35
|
+
:method,
|
|
36
|
+
:path,
|
|
37
|
+
:query,
|
|
38
|
+
:headers,
|
|
39
|
+
:body,
|
|
40
|
+
:unwrap,
|
|
41
|
+
:page,
|
|
42
|
+
:stream,
|
|
43
|
+
:model,
|
|
44
|
+
:security,
|
|
45
|
+
:options
|
|
46
|
+
]
|
|
35
47
|
case req
|
|
36
48
|
in Hash
|
|
37
49
|
req.each_key do |k|
|
|
@@ -252,6 +264,8 @@ module VitableConnect
|
|
|
252
264
|
#
|
|
253
265
|
# @option req [VitableConnect::Internal::Type::Converter, Class, nil] :model
|
|
254
266
|
#
|
|
267
|
+
# @option req [Hash{Symbol=>Boolean}, nil] :security
|
|
268
|
+
#
|
|
255
269
|
# @param opts [Hash{Symbol=>Object}] .
|
|
256
270
|
#
|
|
257
271
|
# @option opts [String, nil] :idempotency_key
|
|
@@ -276,7 +290,11 @@ module VitableConnect
|
|
|
276
290
|
|
|
277
291
|
headers = VitableConnect::Internal::Util.normalized_headers(
|
|
278
292
|
@headers,
|
|
279
|
-
auth_headers
|
|
293
|
+
auth_headers(
|
|
294
|
+
security: req.fetch(
|
|
295
|
+
:security, {api_key_auth: true}
|
|
296
|
+
)
|
|
297
|
+
),
|
|
280
298
|
req[:headers].to_h,
|
|
281
299
|
opts[:extra_headers].to_h
|
|
282
300
|
)
|
|
@@ -306,7 +324,10 @@ module VitableConnect
|
|
|
306
324
|
VitableConnect::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
|
|
307
325
|
end
|
|
308
326
|
|
|
309
|
-
|
|
327
|
+
# Generated methods always pass `req[:body]` for operations that define a
|
|
328
|
+
# request body, so only elide the content-type header when the operation
|
|
329
|
+
# has no body at all, not when an optional body param was omitted.
|
|
330
|
+
headers.delete("content-type") if body.nil? && !req.key?(:body)
|
|
310
331
|
|
|
311
332
|
url = VitableConnect::Internal::Util.join_parsed_uri(
|
|
312
333
|
@base_url_components,
|
|
@@ -445,7 +466,7 @@ module VitableConnect
|
|
|
445
466
|
# Execute the request specified by `req`. This is the method that all resource
|
|
446
467
|
# methods call into.
|
|
447
468
|
#
|
|
448
|
-
# @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: VitableConnect::Internal::Type::Unknown, options: {})
|
|
469
|
+
# @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: VitableConnect::Internal::Type::Unknown, security: {api_key_auth: true}, options: {})
|
|
449
470
|
#
|
|
450
471
|
# @param method [Symbol]
|
|
451
472
|
#
|
|
@@ -465,6 +486,8 @@ module VitableConnect
|
|
|
465
486
|
#
|
|
466
487
|
# @param model [VitableConnect::Internal::Type::Converter, Class, nil]
|
|
467
488
|
#
|
|
489
|
+
# @param security [Hash{Symbol=>Boolean}, nil]
|
|
490
|
+
#
|
|
468
491
|
# @param options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil] .
|
|
469
492
|
#
|
|
470
493
|
# @option options [String, nil] :idempotency_key
|
|
@@ -557,6 +580,7 @@ module VitableConnect
|
|
|
557
580
|
page: T.nilable(T::Class[VitableConnect::Internal::Type::BasePage[VitableConnect::Internal::Type::BaseModel]]),
|
|
558
581
|
stream: T.nilable(T::Class[T.anything]),
|
|
559
582
|
model: T.nilable(VitableConnect::Internal::Type::Converter::Input),
|
|
583
|
+
security: T.nilable({api_key_auth: T::Boolean}),
|
|
560
584
|
options: T.nilable(VitableConnect::RequestOptions::OrHash)
|
|
561
585
|
}
|
|
562
586
|
end
|
|
@@ -17,24 +17,28 @@ module VitableConnect
|
|
|
17
17
|
# values safely.
|
|
18
18
|
#
|
|
19
19
|
# @example
|
|
20
|
-
# # `
|
|
21
|
-
# case
|
|
22
|
-
# when VitableConnect::
|
|
20
|
+
# # `employee_class` is a `VitableConnect::EmployeeClass`
|
|
21
|
+
# case employee_class
|
|
22
|
+
# when VitableConnect::EmployeeClass::FULL_TIME
|
|
23
23
|
# # ...
|
|
24
|
-
# when VitableConnect::
|
|
24
|
+
# when VitableConnect::EmployeeClass::PART_TIME
|
|
25
|
+
# # ...
|
|
26
|
+
# when VitableConnect::EmployeeClass::TEMPORARY
|
|
25
27
|
# # ...
|
|
26
28
|
# else
|
|
27
|
-
# puts(
|
|
29
|
+
# puts(employee_class)
|
|
28
30
|
# end
|
|
29
31
|
#
|
|
30
32
|
# @example
|
|
31
|
-
# case
|
|
32
|
-
# in :
|
|
33
|
+
# case employee_class
|
|
34
|
+
# in :"Full Time"
|
|
35
|
+
# # ...
|
|
36
|
+
# in :"Part Time"
|
|
33
37
|
# # ...
|
|
34
|
-
# in :
|
|
38
|
+
# in :Temporary
|
|
35
39
|
# # ...
|
|
36
40
|
# else
|
|
37
|
-
# puts(
|
|
41
|
+
# puts(employee_class)
|
|
38
42
|
# end
|
|
39
43
|
module Enum
|
|
40
44
|
include VitableConnect::Internal::Type::Converter
|
|
@@ -48,8 +48,8 @@ module VitableConnect
|
|
|
48
48
|
# - `employer` - employer
|
|
49
49
|
# - `employee` - employee
|
|
50
50
|
#
|
|
51
|
-
# @return [Symbol, VitableConnect::Models::Type]
|
|
52
|
-
required :type, enum: -> { VitableConnect::Type }
|
|
51
|
+
# @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity::Type]
|
|
52
|
+
required :type, enum: -> { VitableConnect::AuthIssueAccessTokenParams::BoundEntity::Type }
|
|
53
53
|
|
|
54
54
|
# @!method initialize(id:, type:)
|
|
55
55
|
# Some parameter documentations has been truncated, see
|
|
@@ -61,7 +61,21 @@ module VitableConnect
|
|
|
61
61
|
# @param id [String] Prefixed entity ID to bind the token to (empr*\* for employer, empl*\* for
|
|
62
62
|
# employe
|
|
63
63
|
#
|
|
64
|
-
# @param type [Symbol, VitableConnect::Models::Type] - `employer` - employer
|
|
64
|
+
# @param type [Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity::Type] - `employer` - employer
|
|
65
|
+
|
|
66
|
+
# - `employer` - employer
|
|
67
|
+
# - `employee` - employee
|
|
68
|
+
#
|
|
69
|
+
# @see VitableConnect::Models::AuthIssueAccessTokenParams::BoundEntity#type
|
|
70
|
+
module Type
|
|
71
|
+
extend VitableConnect::Internal::Type::Enum
|
|
72
|
+
|
|
73
|
+
EMPLOYER = :employer
|
|
74
|
+
EMPLOYEE = :employee
|
|
75
|
+
|
|
76
|
+
# @!method self.values
|
|
77
|
+
# @return [Array<Symbol>]
|
|
78
|
+
end
|
|
65
79
|
end
|
|
66
80
|
end
|
|
67
81
|
end
|
|
@@ -51,8 +51,8 @@ module VitableConnect
|
|
|
51
51
|
# - `employer` - employer
|
|
52
52
|
# - `employee` - employee
|
|
53
53
|
#
|
|
54
|
-
# @return [Symbol, VitableConnect::Models::Type]
|
|
55
|
-
required :type, enum: -> { VitableConnect::Type }
|
|
54
|
+
# @return [Symbol, VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type]
|
|
55
|
+
required :type, enum: -> { VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type }
|
|
56
56
|
|
|
57
57
|
# @!method initialize(id:, type:)
|
|
58
58
|
# Some parameter documentations has been truncated, see
|
|
@@ -63,7 +63,21 @@ module VitableConnect
|
|
|
63
63
|
#
|
|
64
64
|
# @param id [String] Prefixed entity ID the token is bound to (empr*\* or empl*\*)
|
|
65
65
|
#
|
|
66
|
-
# @param type [Symbol, VitableConnect::Models::Type] - `employer` - employer
|
|
66
|
+
# @param type [Symbol, VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity::Type] - `employer` - employer
|
|
67
|
+
|
|
68
|
+
# - `employer` - employer
|
|
69
|
+
# - `employee` - employee
|
|
70
|
+
#
|
|
71
|
+
# @see VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity#type
|
|
72
|
+
module Type
|
|
73
|
+
extend VitableConnect::Internal::Type::Enum
|
|
74
|
+
|
|
75
|
+
EMPLOYER = :employer
|
|
76
|
+
EMPLOYEE = :employee
|
|
77
|
+
|
|
78
|
+
# @!method self.values
|
|
79
|
+
# @return [Array<Symbol>]
|
|
80
|
+
end
|
|
67
81
|
end
|
|
68
82
|
end
|
|
69
83
|
end
|
|
@@ -28,6 +28,17 @@ module VitableConnect
|
|
|
28
28
|
# @return [String]
|
|
29
29
|
required :email, String
|
|
30
30
|
|
|
31
|
+
# @!attribute employee_class
|
|
32
|
+
# - `Full Time` - Full Time
|
|
33
|
+
# - `Part Time` - Part Time
|
|
34
|
+
# - `Temporary` - Temporary
|
|
35
|
+
# - `Intern` - Intern
|
|
36
|
+
# - `Seasonal` - Seasonal
|
|
37
|
+
# - `Individual Contractor` - Individual Contractor
|
|
38
|
+
#
|
|
39
|
+
# @return [Symbol, VitableConnect::Models::EmployeeClass]
|
|
40
|
+
required :employee_class, enum: -> { VitableConnect::EmployeeClass }
|
|
41
|
+
|
|
31
42
|
# @!attribute first_name
|
|
32
43
|
# Employee's legal first name
|
|
33
44
|
#
|
|
@@ -52,16 +63,11 @@ module VitableConnect
|
|
|
52
63
|
# @return [VitableConnect::Models::Employee::Address, nil]
|
|
53
64
|
optional :address, -> { VitableConnect::Employee::Address }, nil?: true
|
|
54
65
|
|
|
55
|
-
# @!attribute
|
|
56
|
-
#
|
|
57
|
-
# - `Part Time` - Part Time
|
|
58
|
-
# - `Temporary` - Temporary
|
|
59
|
-
# - `Intern` - Intern
|
|
60
|
-
# - `Seasonal` - Seasonal
|
|
61
|
-
# - `Individual Contractor` - Individual Contractor
|
|
66
|
+
# @!attribute employer_name
|
|
67
|
+
# Name of the employer this employment is with
|
|
62
68
|
#
|
|
63
|
-
# @return [
|
|
64
|
-
optional :
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :employer_name, String, nil?: true
|
|
65
71
|
|
|
66
72
|
# @!attribute gender
|
|
67
73
|
# Gender identity, if provided
|
|
@@ -69,18 +75,6 @@ module VitableConnect
|
|
|
69
75
|
# @return [String, nil]
|
|
70
76
|
optional :gender, String, nil?: true
|
|
71
77
|
|
|
72
|
-
# @!attribute hire_date
|
|
73
|
-
# Employee's hire date with the employer
|
|
74
|
-
#
|
|
75
|
-
# @return [Date, nil]
|
|
76
|
-
optional :hire_date, Date, nil?: true
|
|
77
|
-
|
|
78
|
-
# @!attribute phone
|
|
79
|
-
# Phone number (10-digit US domestic string)
|
|
80
|
-
#
|
|
81
|
-
# @return [String, nil]
|
|
82
|
-
optional :phone, String, nil?: true
|
|
83
|
-
|
|
84
78
|
# @!attribute reference_id
|
|
85
79
|
# Partner-assigned reference ID for the employee
|
|
86
80
|
#
|
|
@@ -106,25 +100,68 @@ module VitableConnect
|
|
|
106
100
|
# @return [String]
|
|
107
101
|
required :id, String
|
|
108
102
|
|
|
103
|
+
# @!attribute classification_effective_date
|
|
104
|
+
# Date the employee's current classification took effect
|
|
105
|
+
#
|
|
106
|
+
# @return [Date]
|
|
107
|
+
required :classification_effective_date, Date
|
|
108
|
+
|
|
109
|
+
# @!attribute compensation_type
|
|
110
|
+
# - `Salary` - Salary
|
|
111
|
+
# - `Hourly` - Hourly
|
|
112
|
+
#
|
|
113
|
+
# @return [Symbol, VitableConnect::Models::Employee::CompensationType, nil]
|
|
114
|
+
required :compensation_type, enum: -> { VitableConnect::Employee::CompensationType }, nil?: true
|
|
115
|
+
|
|
116
|
+
# @!attribute compensation_type_effective_date
|
|
117
|
+
# Date the employee's current compensation type took effect
|
|
118
|
+
#
|
|
119
|
+
# @return [Date]
|
|
120
|
+
required :compensation_type_effective_date, Date
|
|
121
|
+
|
|
122
|
+
# @!attribute employer_id
|
|
123
|
+
# Unique identifier of the employer this employment is with (empr\_\*)
|
|
124
|
+
#
|
|
125
|
+
# @return [String]
|
|
126
|
+
required :employer_id, String
|
|
127
|
+
|
|
109
128
|
# @!attribute member_id
|
|
110
129
|
# Unique member identifier with 'mbr\_' prefix
|
|
111
130
|
#
|
|
112
131
|
# @return [String]
|
|
113
132
|
required :member_id, String
|
|
114
133
|
|
|
134
|
+
# @!attribute phone
|
|
135
|
+
# Phone number (10-digit US domestic string)
|
|
136
|
+
#
|
|
137
|
+
# @return [String, nil]
|
|
138
|
+
required :phone, String, nil?: true
|
|
139
|
+
|
|
140
|
+
# @!attribute start_date
|
|
141
|
+
# Employee's start date with the employer
|
|
142
|
+
#
|
|
143
|
+
# @return [Date]
|
|
144
|
+
required :start_date, Date
|
|
145
|
+
|
|
115
146
|
# @!attribute status
|
|
116
147
|
# Employee status (active or terminated)
|
|
117
148
|
#
|
|
118
|
-
# @return [
|
|
119
|
-
required :status,
|
|
149
|
+
# @return [Symbol, VitableConnect::Models::Employee::Status]
|
|
150
|
+
required :status, enum: -> { VitableConnect::Employee::Status }
|
|
120
151
|
end
|
|
121
152
|
|
|
122
|
-
# @!method initialize(id:, created_at:, date_of_birth:, deductions:, email:, first_name:, last_name:, member_id:, status:, updated_at:, address: nil,
|
|
153
|
+
# @!method initialize(id:, classification_effective_date:, compensation_type:, compensation_type_effective_date:, created_at:, date_of_birth:, deductions:, email:, employee_class:, employer_id:, first_name:, last_name:, member_id:, phone:, start_date:, status:, updated_at:, address: nil, employer_name: nil, gender: nil, reference_id: nil, suffix: nil, termination_date: nil)
|
|
123
154
|
# Some parameter documentations has been truncated, see
|
|
124
155
|
# {VitableConnect::Models::Employee} for more details.
|
|
125
156
|
#
|
|
126
157
|
# @param id [String] Unique employee identifier with 'empl\_' prefix
|
|
127
158
|
#
|
|
159
|
+
# @param classification_effective_date [Date] Date the employee's current classification took effect
|
|
160
|
+
#
|
|
161
|
+
# @param compensation_type [Symbol, VitableConnect::Models::Employee::CompensationType, nil] - `Salary` - Salary
|
|
162
|
+
#
|
|
163
|
+
# @param compensation_type_effective_date [Date] Date the employee's current compensation type took effect
|
|
164
|
+
#
|
|
128
165
|
# @param created_at [Time] Timestamp when the employee was created
|
|
129
166
|
#
|
|
130
167
|
# @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
|
|
@@ -133,32 +170,50 @@ module VitableConnect
|
|
|
133
170
|
#
|
|
134
171
|
# @param email [String] Email address
|
|
135
172
|
#
|
|
173
|
+
# @param employee_class [Symbol, VitableConnect::Models::EmployeeClass] - `Full Time` - Full Time
|
|
174
|
+
#
|
|
175
|
+
# @param employer_id [String] Unique identifier of the employer this employment is with (empr\_\*)
|
|
176
|
+
#
|
|
136
177
|
# @param first_name [String] Employee's legal first name
|
|
137
178
|
#
|
|
138
179
|
# @param last_name [String] Employee's legal last name
|
|
139
180
|
#
|
|
140
181
|
# @param member_id [String] Unique member identifier with 'mbr\_' prefix
|
|
141
182
|
#
|
|
142
|
-
# @param
|
|
183
|
+
# @param phone [String, nil] Phone number (10-digit US domestic string)
|
|
184
|
+
#
|
|
185
|
+
# @param start_date [Date] Employee's start date with the employer
|
|
186
|
+
#
|
|
187
|
+
# @param status [Symbol, VitableConnect::Models::Employee::Status] Employee status (active or terminated)
|
|
143
188
|
#
|
|
144
189
|
# @param updated_at [Time] Timestamp when the employee was last updated
|
|
145
190
|
#
|
|
146
191
|
# @param address [VitableConnect::Models::Employee::Address, nil] Employee's residential address
|
|
147
192
|
#
|
|
148
|
-
# @param
|
|
193
|
+
# @param employer_name [String, nil] Name of the employer this employment is with
|
|
149
194
|
#
|
|
150
195
|
# @param gender [String, nil] Gender identity, if provided
|
|
151
196
|
#
|
|
152
|
-
# @param hire_date [Date, nil] Employee's hire date with the employer
|
|
153
|
-
#
|
|
154
|
-
# @param phone [String, nil] Phone number (10-digit US domestic string)
|
|
155
|
-
#
|
|
156
197
|
# @param reference_id [String, nil] Partner-assigned reference ID for the employee
|
|
157
198
|
#
|
|
158
199
|
# @param suffix [String, nil] Name suffix (e.g., Jr., Sr., III)
|
|
159
200
|
#
|
|
160
201
|
# @param termination_date [Date, nil] Employee's termination date, if terminated
|
|
161
202
|
|
|
203
|
+
# - `Salary` - Salary
|
|
204
|
+
# - `Hourly` - Hourly
|
|
205
|
+
#
|
|
206
|
+
# @see VitableConnect::Models::Employee#compensation_type
|
|
207
|
+
module CompensationType
|
|
208
|
+
extend VitableConnect::Internal::Type::Enum
|
|
209
|
+
|
|
210
|
+
SALARY = :Salary
|
|
211
|
+
HOURLY = :Hourly
|
|
212
|
+
|
|
213
|
+
# @!method self.values
|
|
214
|
+
# @return [Array<Symbol>]
|
|
215
|
+
end
|
|
216
|
+
|
|
162
217
|
class Deduction < VitableConnect::Internal::Type::BaseModel
|
|
163
218
|
# @!attribute benefit_name
|
|
164
219
|
# Name of the benefit plan
|
|
@@ -260,6 +315,19 @@ module VitableConnect
|
|
|
260
315
|
end
|
|
261
316
|
end
|
|
262
317
|
|
|
318
|
+
# Employee status (active or terminated)
|
|
319
|
+
#
|
|
320
|
+
# @see VitableConnect::Models::Employee#status
|
|
321
|
+
module Status
|
|
322
|
+
extend VitableConnect::Internal::Type::Enum
|
|
323
|
+
|
|
324
|
+
ACTIVE = :active
|
|
325
|
+
TERMINATED = :terminated
|
|
326
|
+
|
|
327
|
+
# @!method self.values
|
|
328
|
+
# @return [Array<Symbol>]
|
|
329
|
+
end
|
|
330
|
+
|
|
263
331
|
# @see VitableConnect::Models::Employee#address
|
|
264
332
|
class Address < VitableConnect::Internal::Type::BaseModel
|
|
265
333
|
# @!attribute address_line_1
|