api.md

Auth

Types:

from vitable_connect.types import Type, AuthIssueAccessTokenResponse

Methods:

• client.auth.issue_access_token(**params) -> AuthIssueAccessTokenResponse

Employees

Types:

from vitable_connect.types import Employee, EmployeeClass, Pagination, EmployeeRetrieveResponse

Methods:

• client.employees.retrieve(employee_id) -> EmployeeRetrieveResponse
• client.employees.list_enrollments(employee_id, **params) -> SyncPageNumberPage[Enrollment]

Employers

Types:

from vitable_connect.types import (
    Employer,
    EmployerResponse,
    EmployerSubmitCensusSyncResponse,
    EmployerUpdateSettingsResponse,
)

Methods:

• client.employers.create(**params) -> EmployerResponse
• client.employers.retrieve(employer_id) -> EmployerResponse
• client.employers.list(**params) -> SyncPageNumberPage[Employer]
• client.employers.list_employees(employer_id, **params) -> SyncPageNumberPage[Employee]
• client.employers.submit_census_sync(employer_id, **params) -> EmployerSubmitCensusSyncResponse
• client.employers.update_settings(employer_id, **params) -> EmployerUpdateSettingsResponse

Enrollments

Types:

from vitable_connect.types import Enrollment, EnrollmentStatus, EnrollmentRetrieveResponse

Methods:

• client.enrollments.retrieve(enrollment_id) -> EnrollmentRetrieveResponse

WebhookEvents

Types:

from vitable_connect.types import (
    WebhookEvent,
    WebhookEventRetrieveResponse,
    WebhookEventListDeliveriesResponse,
)

Methods:

• client.webhook_events.retrieve(event_id) -> WebhookEventRetrieveResponse
• client.webhook_events.list(**params) -> SyncPageNumberPage[WebhookEvent]
• client.webhook_events.list_deliveries(event_id) -> WebhookEventListDeliveriesResponse

Groups

Types:

from vitable_connect.types import Group, GroupResponse

Methods:

• client.groups.create(**params) -> GroupResponse
• client.groups.retrieve(group_id) -> GroupResponse
• client.groups.update(group_id, **params) -> GroupResponse
• client.groups.list(**params) -> SyncPageNumberPage[Group]

Members

Sync

Types:

from vitable_connect.types.groups.members import SyncRetrieveResponse, SyncSubmitResponse

Methods:

• client.groups.members.sync.retrieve(request_id, *, group_id) -> SyncRetrieveResponse
• client.groups.members.sync.submit(group_id, **params) -> SyncSubmitResponse

Plans

Types:

from vitable_connect.types import PlanListResponse

Methods:

• client.plans.list(**params) -> SyncPageNumberPage[PlanListResponse]