@vitable-inc/vitable-connect 0.2.1 → 1.0.0

package/dist/esm/api/types/GrantType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** * `client_credentials` - client_credentials */
+export const GrantType = {
+    ClientCredentials: "client_credentials",
+};

package/dist/esm/api/types/Group.d.mts

@@ -0,0 +1,14 @@
+export interface Group {
+    /** Prefixed group identifier (`grp_<base64-encoded-uuid>`). */
+    id: string;
+    /** Prefixed organization identifier (`org_<base64-encoded-uuid>`). */
+    organization_id: string;
+    /** Human-readable group name. */
+    name: string;
+    /** Stable identifier for this group in the integrator's own system. */
+    external_reference_id: string;
+    /** Group creation timestamp (ISO 8601, UTC). */
+    created_at: string | null;
+    /** Last-update timestamp (ISO 8601, UTC). */
+    updated_at: string | null;
+}

package/dist/esm/api/types/Group.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupId.d.mts

@@ -0,0 +1,4 @@
+/**
+ * Unique group identifier (grp_*)
+ */
+export type GroupId = string;

package/dist/esm/api/types/GroupId.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupListResponse.d.mts

@@ -0,0 +1,10 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * Paginated list response containing group resources.
+ */
+export interface GroupListResponse {
+    /** This page of groups. */
+    data: VitableConnect.Group[];
+    /** Page metadata. Request the next page by incrementing `page`. */
+    pagination: VitableConnect.Pagination;
+}

package/dist/esm/api/types/GroupListResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncDetailResponse.d.mts

@@ -0,0 +1,8 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * Response containing a single group member sync detail resource.
+ */
+export interface GroupMemberSyncDetailResponse {
+    /** The group member sync request, including its current processing status. */
+    data: VitableConnect.GroupMemberSyncResponse;
+}

package/dist/esm/api/types/GroupMemberSyncDetailResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncFailure.d.mts

@@ -0,0 +1,9 @@
+import type * as VitableConnect from "../index.mjs";
+export interface GroupMemberSyncFailure {
+    /** Your identifier for the member that failed to sync. */
+    reference_id: string;
+    /** The sync operation that failed for this member. */
+    operation: VitableConnect.Operation;
+    /** Human-readable explanation of why the operation failed. */
+    reason: string;
+}

package/dist/esm/api/types/GroupMemberSyncFailure.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncMemberRequest.d.mts

@@ -0,0 +1,19 @@
+import type * as VitableConnect from "../index.mjs";
+export interface GroupMemberSyncMemberRequest {
+    /** Your own identifier for this member. Vitable echoes it back on sync failures so you can match them to your records. */
+    reference_id: string;
+    /** Member's legal first name. */
+    first_name: string;
+    /** Member's legal last name. */
+    last_name: string;
+    /** Member's date of birth as `YYYY-MM-DD`. */
+    date_of_birth: string;
+    /** Member's contact phone number in E.164 format. */
+    phone?: (string | null) | undefined;
+    /** Plan the member should be subscribed to (`plan_*`). */
+    plan_id: string;
+    /** The member's postal address. */
+    address: VitableConnect.AddressRequest;
+    /** Member's email address. Vitable sends care and coverage notices here. */
+    email?: (string | null) | undefined;
+}

package/dist/esm/api/types/GroupMemberSyncMemberRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncRequestDetail.d.mts

@@ -0,0 +1,13 @@
+import type * as VitableConnect from "../index.mjs";
+export interface GroupMemberSyncRequestDetail {
+    /** Identifier for the sync request being reported on. */
+    request_id: string;
+    /** Group whose roster was synced (`grp_*`). */
+    group_id: string;
+    /** When Vitable accepted the sync request for processing (RFC 3339). */
+    accepted_at: string;
+    /** When processing finished (RFC 3339), or `null` while the sync is still in progress. */
+    completed_at: string | null;
+    /** Outcome of the sync, or `null` until processing completes. */
+    results: VitableConnect.GroupMemberSyncResults | null;
+}

package/dist/esm/api/types/GroupMemberSyncRequestDetail.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncRequestDetailResponse.d.mts

@@ -0,0 +1,8 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * Response containing a single group member sync request detail resource.
+ */
+export interface GroupMemberSyncRequestDetailResponse {
+    /** The group member sync request, including per-member results. */
+    data: VitableConnect.GroupMemberSyncRequestDetail;
+}

package/dist/esm/api/types/GroupMemberSyncRequestDetailResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncResponse.d.mts

@@ -0,0 +1,8 @@
+export interface GroupMemberSyncResponse {
+    /** Identifier for this sync request. Pass it to `GET /v1/groups/{group_id}/members/sync/{request_id}` to poll for results. */
+    request_id: string;
+    /** Group whose roster is being synced (`grp_*`). */
+    group_id: string;
+    /** When Vitable accepted the sync request for processing (RFC 3339). */
+    accepted_at: string;
+}

package/dist/esm/api/types/GroupMemberSyncResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupMemberSyncResults.d.mts

@@ -0,0 +1,9 @@
+import type * as VitableConnect from "../index.mjs";
+export interface GroupMemberSyncResults {
+    /** IDs of members added to the group by this sync. */
+    added_group_member_ids: string[];
+    /** IDs of members removed from the group by this sync. */
+    removed_group_member_ids: string[];
+    /** Members that could not be synced, with a reason for each. */
+    failures: VitableConnect.GroupMemberSyncFailure[];
+}

package/dist/esm/api/types/GroupMemberSyncResults.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GroupResponse.d.mts

@@ -0,0 +1,8 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * Response containing a single group resource.
+ */
+export interface GroupResponse {
+    /** The group record. */
+    data: VitableConnect.Group;
+}

package/dist/esm/api/types/GroupResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/HouseholdMember.d.mts

@@ -0,0 +1,33 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * Wire serializer for :class:`HouseholdMemberDTO` (one household participant).
+ */
+export interface HouseholdMember {
+    /** Member identifier with 'mbr_' prefix */
+    member_id?: string | undefined;
+    /** Household member's first name */
+    first_name: string;
+    /** Household member's last name */
+    last_name: string;
+    /**
+     * Relationship to the head of household; null for the account holder themselves
+     *
+     * * `Child` - Child
+     * * `Spouse` - Spouse
+     * * `Roommate` - Roommate
+     * * `Other` - Other
+     */
+    relationship?: (VitableConnect.HouseholdMemberRelationship | null) | undefined;
+    /**
+     * What this participant is to the household: `Account Holder`, `Dependent`, or `Inactive`.
+     *
+     * * `Account Holder` - Account Holder
+     * * `Dependent` - Dependent
+     * * `Inactive` - Inactive
+     */
+    member_type: VitableConnect.HouseholdMemberType;
+    /** Date of birth (YYYY-MM-DD) */
+    date_of_birth: string;
+    /** Whether this participant is a household admin (the account holder always is) */
+    household_admin_in: boolean;
+}

package/dist/esm/api/types/HouseholdMember.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/HouseholdMemberRelationship.d.mts

@@ -0,0 +1,13 @@
+/**
+ * * `Child` - Child
+ * * `Spouse` - Spouse
+ * * `Roommate` - Roommate
+ * * `Other` - Other
+ */
+export declare const HouseholdMemberRelationship: {
+    readonly Child: "Child";
+    readonly Spouse: "Spouse";
+    readonly Roommate: "Roommate";
+    readonly Other: "Other";
+};
+export type HouseholdMemberRelationship = (typeof HouseholdMemberRelationship)[keyof typeof HouseholdMemberRelationship];

package/dist/esm/api/types/HouseholdMemberRelationship.mjs

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `Child` - Child
+ * * `Spouse` - Spouse
+ * * `Roommate` - Roommate
+ * * `Other` - Other
+ */
+export const HouseholdMemberRelationship = {
+    Child: "Child",
+    Spouse: "Spouse",
+    Roommate: "Roommate",
+    Other: "Other",
+};

package/dist/esm/api/types/HouseholdMemberType.d.mts

@@ -0,0 +1,11 @@
+/**
+ * * `Account Holder` - Account Holder
+ * * `Dependent` - Dependent
+ * * `Inactive` - Inactive
+ */
+export declare const HouseholdMemberType: {
+    readonly AccountHolder: "Account Holder";
+    readonly Dependent: "Dependent";
+    readonly Inactive: "Inactive";
+};
+export type HouseholdMemberType = (typeof HouseholdMemberType)[keyof typeof HouseholdMemberType];

package/dist/esm/api/types/HouseholdMemberType.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `Account Holder` - Account Holder
+ * * `Dependent` - Dependent
+ * * `Inactive` - Inactive
+ */
+export const HouseholdMemberType = {
+    AccountHolder: "Account Holder",
+    Dependent: "Dependent",
+    Inactive: "Inactive",
+};

package/dist/esm/api/types/HouseholdMembersResponse.d.mts

@@ -0,0 +1,8 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * Unpaginated ``{"data": [...]}`` list of the members of a member's household.
+ */
+export interface HouseholdMembersResponse {
+    /** The members of the household. */
+    data: VitableConnect.HouseholdMember[];
+}

package/dist/esm/api/types/HouseholdMembersResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/HrisConnection.d.mts

@@ -0,0 +1,12 @@
+export interface HrisConnection {
+    /** Id of the HRIS/payroll provider the employer is connected to (e.g. `paylocity`). */
+    provider: string;
+    /** Display name of that provider (e.g. `Paylocity`). */
+    provider_label: string;
+    /** Connection status reported by the integration. */
+    status: string;
+    /** When the last sync completed, or null when none has. */
+    last_sync_on: string | null;
+    /** Rows in the latest completed sync, or null when none has. */
+    synced_row_count: number | null;
+}

package/dist/esm/api/types/HrisConnection.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/HrisStatusItem.d.mts

@@ -0,0 +1,15 @@
+/**
+ * * `Pending` - Pending
+ * * `Active` - Active
+ * * `Inactive` - Inactive
+ * * `Paused` - Paused
+ * * `Terminated` - Terminated
+ */
+export declare const HrisStatusItem: {
+    readonly Pending: "Pending";
+    readonly Active: "Active";
+    readonly Inactive: "Inactive";
+    readonly Paused: "Paused";
+    readonly Terminated: "Terminated";
+};
+export type HrisStatusItem = (typeof HrisStatusItem)[keyof typeof HrisStatusItem];

package/dist/esm/api/types/HrisStatusItem.mjs

@@ -0,0 +1,15 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `Pending` - Pending
+ * * `Active` - Active
+ * * `Inactive` - Inactive
+ * * `Paused` - Paused
+ * * `Terminated` - Terminated
+ */
+export const HrisStatusItem = {
+    Pending: "Pending",
+    Active: "Active",
+    Inactive: "Inactive",
+    Paused: "Paused",
+    Terminated: "Terminated",
+};

package/dist/esm/api/types/IchraContributionClass.d.mts

@@ -0,0 +1,54 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * One ICHRA contribution class, mirroring the internal configuration endpoint's
+ * ``IchraContributionClassConfigurationEntitySerializer`` field-for-field. Two deliberate
+ * differences for the public surface: the identifier is the opaque prefixed ``iccl_*`` form rather
+ * than a raw UUID, and the matcher choices come from the domain enums rather than the model's.
+ */
+export interface IchraContributionClass {
+    /** Prefixed contribution-class identifier (`iccl_*`). */
+    contribution_class_id: string;
+    /** Monthly allowance in cents. */
+    amount_in_cents: number;
+    /**
+     * Employment matcher.
+     *
+     * * `Unspecified` - Unspecified
+     * * `Full Time` - Full Time
+     * * `Part Time` - Part Time
+     * * `Temporary` - Temporary
+     * * `Seasonal` - Seasonal
+     */
+    employment: VitableConnect.ContributionClassEmployment;
+    /**
+     * Compensation matcher.
+     *
+     * * `Unspecified` - Unspecified
+     * * `Salary` - Salary
+     * * `Hourly` - Hourly
+     */
+    compensation: VitableConnect.ContributionClassCompensation;
+    /**
+     * Location matcher type.
+     *
+     * * `Unspecified` - Unspecified
+     * * `State` - State
+     */
+    location: VitableConnect.ContributionClassLocation;
+    /** Location matcher value (CSV of state codes), or null. */
+    location_value: string | null;
+    /**
+     * Family-status matcher.
+     *
+     * * `Unspecified` - Unspecified
+     * * `EE` - Ee
+     * * `ES` - Es
+     * * `EC` - Ec
+     * * `EF` - Ef
+     */
+    family_status: VitableConnect.CoverageTier;
+    /** Age-band lower bound, or null. */
+    min_age: number | null;
+    /** Age-band upper bound, or null. */
+    max_age: number | null;
+}

package/dist/esm/api/types/IchraContributionClass.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/IdpProvider.d.mts

@@ -0,0 +1,9 @@
+/**
+ * * `workos` - WorkOS
+ * * `vitable` - Vitable
+ */
+export declare const IdpProvider: {
+    readonly Workos: "workos";
+    readonly Vitable: "vitable";
+};
+export type IdpProvider = (typeof IdpProvider)[keyof typeof IdpProvider];

package/dist/esm/api/types/IdpProvider.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `workos` - WorkOS
+ * * `vitable` - Vitable
+ */
+export const IdpProvider = {
+    Workos: "workos",
+    Vitable: "vitable",
+};

package/dist/esm/api/types/IncludeCancelled.d.mts

@@ -0,0 +1,4 @@
+/**
+ * Include cancelled employers (hidden by default unless their stage is explicitly requested).
+ */
+export type IncludeCancelled = boolean;

package/dist/esm/api/types/IncludeCancelled.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Invoice.d.mts

@@ -0,0 +1,10 @@
+export interface Invoice {
+    /** Chargebee invoice id (external id, not a prefixed UUID). */
+    invoice_id: string;
+    /** Invoice date as an ISO string, or null. */
+    period: string | null;
+    /** Invoice total in dollars, or null. */
+    total: number | null;
+    /** Chargebee invoice status (e.g. `paid`), or null. */
+    status: string | null;
+}

package/dist/esm/api/types/Invoice.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/InvoiceId.d.mts

@@ -0,0 +1,4 @@
+/**
+ * External Chargebee invoice id (not a prefixed UUID).
+ */
+export type InvoiceId = string;

package/dist/esm/api/types/InvoiceId.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/InvoicesCursorPagination.d.mts

@@ -0,0 +1,4 @@
+export interface InvoicesCursorPagination {
+    /** Opaque JSON-encoded cursor for the next page; null when there are no more pages. */
+    next_offset: string | null;
+}

package/dist/esm/api/types/InvoicesCursorPagination.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Limit.d.mts

@@ -0,0 +1,4 @@
+/**
+ * Items per page (default: 20, max: 100)
+ */
+export type Limit = number;

package/dist/esm/api/types/Limit.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ListWebhookEventDeliveriesResponse.d.mts

@@ -0,0 +1,5 @@
+import type * as VitableConnect from "../index.mjs";
+export interface ListWebhookEventDeliveriesResponse {
+    /** Delivery attempts for the webhook event, most recent first. */
+    data: VitableConnect.WebhookDelivery[];
+}

package/dist/esm/api/types/ListWebhookEventDeliveriesResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MaritalStatus.d.mts

@@ -0,0 +1,9 @@
+/**
+ * * `Single` - Single
+ * * `Married` - Married
+ */
+export declare const MaritalStatus: {
+    readonly Single: "Single";
+    readonly Married: "Married";
+};
+export type MaritalStatus = (typeof MaritalStatus)[keyof typeof MaritalStatus];

package/dist/esm/api/types/MaritalStatus.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * * `Single` - Single
+ * * `Married` - Married
+ */
+export const MaritalStatus = {
+    Single: "Single",
+    Married: "Married",
+};

package/dist/esm/api/types/Member.d.mts

@@ -0,0 +1,79 @@
+import type * as VitableConnect from "../index.mjs";
+/**
+ * A member's profile: identity, contact details, address, demographics, and onboarding status.
+ */
+export interface Member {
+    /** Unique member identifier with 'mbr_' prefix */
+    id?: string | undefined;
+    /** Member's legal first name */
+    first_name: string;
+    /** Member's legal last name */
+    last_name: string;
+    /** Email address */
+    email?: (string | null) | undefined;
+    /** Phone number (10-digit US domestic string) */
+    phone?: (string | null) | undefined;
+    /** Member's residential address */
+    address?: (VitableConnect.MemberAddress | null) | undefined;
+    /** Member's full legal name */
+    name?: string | undefined;
+    /** Member's legal middle name */
+    middle_name?: (string | null) | undefined;
+    /**
+     * Member's name suffix
+     *
+     * * `Sr` - Senior
+     * * `Jr` - Junior
+     * * `I` - First
+     * * `II` - Second
+     * * `III` - Third
+     * * `IV` - Fourth
+     * * `V` - Fifth
+     */
+    suffix?: (VitableConnect.NameSuffix | null) | undefined;
+    /** Date of birth (YYYY-MM-DD) */
+    date_of_birth: string;
+    /** Member's age in years, derived from date of birth */
+    age: number;
+    /**
+     * Sex assigned at birth, if provided
+     *
+     * * `Male` - Male
+     * * `Female` - Female
+     * * `Other` - Other
+     * * `Unknown` - Unknown
+     */
+    sex_at_birth?: (VitableConnect.SexAtBirth | null) | undefined;
+    /**
+     * Member's gender identity
+     *
+     * * `Male` - Male
+     * * `Female` - Female
+     * * `Transgender` - Transgender
+     * * `Non-binary` - Non Binary
+     * * `Prefer not to respond` - Prefer Not To Respond
+     */
+    gender?: (VitableConnect.Gender | null) | undefined;
+    /**
+     * Member's preferred language code (e.g., en, es)
+     *
+     * * `en` - English
+     * * `es` - Spanish
+     * * `zh` - Chinese
+     * * `ru` - Russian
+     * * `sw` - Swahili
+     * * `th` - Thai
+     */
+    preferred_language?: (VitableConnect.PreferredLanguage | null) | undefined;
+    /** Whether the member uses tobacco, if known */
+    tobacco_status?: (boolean | null) | undefined;
+    /**
+     * Member's marital status, if provided
+     *
+     * * `Single` - Single
+     * * `Married` - Married
+     */
+    marital_status?: (VitableConnect.MaritalStatus | null) | undefined;
+    /** Member profile status (onboarded or pending onboarding) */
+    status?: VitableConnect.MemberStatus | undefined;
+}

package/dist/esm/api/types/Member.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};