@vitable-inc/vitable-connect 6.1.0 → 6.3.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.
@@ -44,8 +44,8 @@ function normalizeClientOptions(options) {
44
44
  const headers = (0, headers_js_1.mergeHeaders)({
45
45
  "X-Fern-Language": "JavaScript",
46
46
  "X-Fern-SDK-Name": "@vitable-inc/vitable-connect",
47
- "X-Fern-SDK-Version": "6.1.0",
48
- "User-Agent": "@vitable-inc/vitable-connect/6.1.0",
47
+ "X-Fern-SDK-Version": "6.3.0",
48
+ "User-Agent": "@vitable-inc/vitable-connect/6.3.0",
49
49
  "X-Fern-Runtime": core.RUNTIME.type,
50
50
  "X-Fern-Runtime-Version": core.RUNTIME.version,
51
51
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -72,7 +72,7 @@ export declare class EnrollmentsClient {
72
72
  reissue(request: VitableConnect.ReissueEnrollmentRequest, requestOptions?: EnrollmentsClient.RequestOptions): core.HttpResponsePromise<VitableConnect.ReissueEnrollmentResponse>;
73
73
  private __reissue;
74
74
  /**
75
- * Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. 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.
75
+ * 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.
76
76
  *
77
77
  * @param {VitableConnect.TerminateEnrollmentRequest} request
78
78
  * @param {EnrollmentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -100,6 +100,13 @@ export declare class EnrollmentsClient {
100
100
  * @example
101
101
  * await client.enrollments.terminate({
102
102
  * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
103
+ * reason: "Member cancelled directly with the carrier.",
104
+ * carrier_coverage_end_date: "2026-08-31"
105
+ * })
106
+ *
107
+ * @example
108
+ * await client.enrollments.terminate({
109
+ * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
103
110
  * reason: "Member requested coverage termination."
104
111
  * })
105
112
  */
@@ -237,7 +237,7 @@ class EnrollmentsClient {
237
237
  });
238
238
  }
239
239
  /**
240
- * Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. 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.
240
+ * 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.
241
241
  *
242
242
  * @param {VitableConnect.TerminateEnrollmentRequest} request
243
243
  * @param {EnrollmentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -265,6 +265,13 @@ class EnrollmentsClient {
265
265
  * @example
266
266
  * await client.enrollments.terminate({
267
267
  * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
268
+ * reason: "Member cancelled directly with the carrier.",
269
+ * carrier_coverage_end_date: "2026-08-31"
270
+ * })
271
+ *
272
+ * @example
273
+ * await client.enrollments.terminate({
274
+ * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
268
275
  * reason: "Member requested coverage termination."
269
276
  * })
270
277
  */
@@ -11,6 +11,13 @@ import type * as VitableConnect from "../../../../index.js";
11
11
  * @example
12
12
  * {
13
13
  * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
14
+ * reason: "Member cancelled directly with the carrier.",
15
+ * carrier_coverage_end_date: "2026-08-31"
16
+ * }
17
+ *
18
+ * @example
19
+ * {
20
+ * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
14
21
  * reason: "Member requested coverage termination."
15
22
  * }
16
23
  */
@@ -25,4 +32,6 @@ export interface TerminateEnrollmentRequest {
25
32
  ticket_number?: string | null;
26
33
  /** Accepted member qualifying life event identifier (qle_*) */
27
34
  qualifying_life_event_id?: string | null;
35
+ /** 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 */
36
+ carrier_coverage_end_date?: string | null;
28
37
  }
@@ -2,6 +2,7 @@ export declare const ElectionStatusItem: {
2
2
  readonly Enrolled: "Enrolled";
3
3
  readonly Expired: "Expired";
4
4
  readonly Pending: "Pending";
5
+ readonly Upcoming: "Upcoming";
5
6
  readonly Waived: "Waived";
6
7
  };
7
8
  export type ElectionStatusItem = (typeof ElectionStatusItem)[keyof typeof ElectionStatusItem];
@@ -6,5 +6,6 @@ exports.ElectionStatusItem = {
6
6
  Enrolled: "Enrolled",
7
7
  Expired: "Expired",
8
8
  Pending: "Pending",
9
+ Upcoming: "Upcoming",
9
10
  Waived: "Waived",
10
11
  };
@@ -68,16 +68,19 @@ export interface MemberEnrollment {
68
68
  issued_date: string;
69
69
  /** Date the member enrolled (YYYY-MM-DD); null unless the row is an election */
70
70
  enrolled_date: string | null;
71
+ /** When the employee enrolled or waived */
72
+ answered_at: string | null;
71
73
  /** First date the member could answer this enrollment (YYYY-MM-DD). Open enrollment's start date for a row issued before open enrollment opened, otherwise the date the row was issued -- an enrollment is never answerable before it exists, so this is never earlier than `issued_date`. */
72
74
  enrollment_window_start: string;
73
75
  /** Enrollment / open-enrollment window end date (YYYY-MM-DD); null when open-ended */
74
76
  enrollment_window_end?: (string | null) | undefined;
75
77
  /**
76
- * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open and `Expired` once it has closed.
78
+ * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open, `Upcoming` before it opens and `Expired` once it has closed. A terminated unanswered enrollment is `Expired`, even before its window opens.
77
79
  *
78
80
  * * `Enrolled` - Enrolled
79
81
  * * `Waived` - Waived
80
82
  * * `Pending` - Pending
83
+ * * `Upcoming` - Upcoming
81
84
  * * `Expired` - Expired
82
85
  */
83
86
  election_status: VitableConnect.PlanYearEnrollmentElectionStatus;
@@ -11,11 +11,12 @@ export interface PlanYearEnrollment {
11
11
  /** The member's last name. */
12
12
  member_last_name: string;
13
13
  /**
14
- * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open and `Expired` once it has closed.
14
+ * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open, `Upcoming` before it opens and `Expired` once it has closed. A terminated unanswered enrollment is `Expired`, even before its window opens.
15
15
  *
16
16
  * * `Enrolled` - Enrolled
17
17
  * * `Waived` - Waived
18
18
  * * `Pending` - Pending
19
+ * * `Upcoming` - Upcoming
19
20
  * * `Expired` - Expired
20
21
  */
21
22
  election_status: VitableConnect.PlanYearEnrollmentElectionStatus;
@@ -2,12 +2,14 @@
2
2
  * * `Enrolled` - Enrolled
3
3
  * * `Waived` - Waived
4
4
  * * `Pending` - Pending
5
+ * * `Upcoming` - Upcoming
5
6
  * * `Expired` - Expired
6
7
  */
7
8
  export declare const PlanYearEnrollmentElectionStatus: {
8
9
  readonly Enrolled: "Enrolled";
9
10
  readonly Waived: "Waived";
10
11
  readonly Pending: "Pending";
12
+ readonly Upcoming: "Upcoming";
11
13
  readonly Expired: "Expired";
12
14
  };
13
15
  export type PlanYearEnrollmentElectionStatus = (typeof PlanYearEnrollmentElectionStatus)[keyof typeof PlanYearEnrollmentElectionStatus];
@@ -6,11 +6,13 @@ exports.PlanYearEnrollmentElectionStatus = void 0;
6
6
  * * `Enrolled` - Enrolled
7
7
  * * `Waived` - Waived
8
8
  * * `Pending` - Pending
9
+ * * `Upcoming` - Upcoming
9
10
  * * `Expired` - Expired
10
11
  */
11
12
  exports.PlanYearEnrollmentElectionStatus = {
12
13
  Enrolled: "Enrolled",
13
14
  Waived: "Waived",
14
15
  Pending: "Pending",
16
+ Upcoming: "Upcoming",
15
17
  Expired: "Expired",
16
18
  };
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "6.1.0";
1
+ export declare const SDK_VERSION = "6.3.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "6.1.0";
4
+ exports.SDK_VERSION = "6.3.0";
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
7
7
  const headers = mergeHeaders({
8
8
  "X-Fern-Language": "JavaScript",
9
9
  "X-Fern-SDK-Name": "@vitable-inc/vitable-connect",
10
- "X-Fern-SDK-Version": "6.1.0",
11
- "User-Agent": "@vitable-inc/vitable-connect/6.1.0",
10
+ "X-Fern-SDK-Version": "6.3.0",
11
+ "User-Agent": "@vitable-inc/vitable-connect/6.3.0",
12
12
  "X-Fern-Runtime": core.RUNTIME.type,
13
13
  "X-Fern-Runtime-Version": core.RUNTIME.version,
14
14
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -72,7 +72,7 @@ export declare class EnrollmentsClient {
72
72
  reissue(request: VitableConnect.ReissueEnrollmentRequest, requestOptions?: EnrollmentsClient.RequestOptions): core.HttpResponsePromise<VitableConnect.ReissueEnrollmentResponse>;
73
73
  private __reissue;
74
74
  /**
75
- * Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. 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.
75
+ * 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.
76
76
  *
77
77
  * @param {VitableConnect.TerminateEnrollmentRequest} request
78
78
  * @param {EnrollmentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -100,6 +100,13 @@ export declare class EnrollmentsClient {
100
100
  * @example
101
101
  * await client.enrollments.terminate({
102
102
  * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
103
+ * reason: "Member cancelled directly with the carrier.",
104
+ * carrier_coverage_end_date: "2026-08-31"
105
+ * })
106
+ *
107
+ * @example
108
+ * await client.enrollments.terminate({
109
+ * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
103
110
  * reason: "Member requested coverage termination."
104
111
  * })
105
112
  */
@@ -201,7 +201,7 @@ export class EnrollmentsClient {
201
201
  });
202
202
  }
203
203
  /**
204
- * Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. 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.
204
+ * 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.
205
205
  *
206
206
  * @param {VitableConnect.TerminateEnrollmentRequest} request
207
207
  * @param {EnrollmentsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -229,6 +229,13 @@ export class EnrollmentsClient {
229
229
  * @example
230
230
  * await client.enrollments.terminate({
231
231
  * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
232
+ * reason: "Member cancelled directly with the carrier.",
233
+ * carrier_coverage_end_date: "2026-08-31"
234
+ * })
235
+ *
236
+ * @example
237
+ * await client.enrollments.terminate({
238
+ * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
232
239
  * reason: "Member requested coverage termination."
233
240
  * })
234
241
  */
@@ -11,6 +11,13 @@ import type * as VitableConnect from "../../../../index.mjs";
11
11
  * @example
12
12
  * {
13
13
  * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
14
+ * reason: "Member cancelled directly with the carrier.",
15
+ * carrier_coverage_end_date: "2026-08-31"
16
+ * }
17
+ *
18
+ * @example
19
+ * {
20
+ * enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
14
21
  * reason: "Member requested coverage termination."
15
22
  * }
16
23
  */
@@ -25,4 +32,6 @@ export interface TerminateEnrollmentRequest {
25
32
  ticket_number?: string | null;
26
33
  /** Accepted member qualifying life event identifier (qle_*) */
27
34
  qualifying_life_event_id?: string | null;
35
+ /** 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 */
36
+ carrier_coverage_end_date?: string | null;
28
37
  }
@@ -2,6 +2,7 @@ export declare const ElectionStatusItem: {
2
2
  readonly Enrolled: "Enrolled";
3
3
  readonly Expired: "Expired";
4
4
  readonly Pending: "Pending";
5
+ readonly Upcoming: "Upcoming";
5
6
  readonly Waived: "Waived";
6
7
  };
7
8
  export type ElectionStatusItem = (typeof ElectionStatusItem)[keyof typeof ElectionStatusItem];
@@ -3,5 +3,6 @@ export const ElectionStatusItem = {
3
3
  Enrolled: "Enrolled",
4
4
  Expired: "Expired",
5
5
  Pending: "Pending",
6
+ Upcoming: "Upcoming",
6
7
  Waived: "Waived",
7
8
  };
@@ -68,16 +68,19 @@ export interface MemberEnrollment {
68
68
  issued_date: string;
69
69
  /** Date the member enrolled (YYYY-MM-DD); null unless the row is an election */
70
70
  enrolled_date: string | null;
71
+ /** When the employee enrolled or waived */
72
+ answered_at: string | null;
71
73
  /** First date the member could answer this enrollment (YYYY-MM-DD). Open enrollment's start date for a row issued before open enrollment opened, otherwise the date the row was issued -- an enrollment is never answerable before it exists, so this is never earlier than `issued_date`. */
72
74
  enrollment_window_start: string;
73
75
  /** Enrollment / open-enrollment window end date (YYYY-MM-DD); null when open-ended */
74
76
  enrollment_window_end?: (string | null) | undefined;
75
77
  /**
76
- * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open and `Expired` once it has closed.
78
+ * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open, `Upcoming` before it opens and `Expired` once it has closed. A terminated unanswered enrollment is `Expired`, even before its window opens.
77
79
  *
78
80
  * * `Enrolled` - Enrolled
79
81
  * * `Waived` - Waived
80
82
  * * `Pending` - Pending
83
+ * * `Upcoming` - Upcoming
81
84
  * * `Expired` - Expired
82
85
  */
83
86
  election_status: VitableConnect.PlanYearEnrollmentElectionStatus;
@@ -11,11 +11,12 @@ export interface PlanYearEnrollment {
11
11
  /** The member's last name. */
12
12
  member_last_name: string;
13
13
  /**
14
- * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open and `Expired` once it has closed.
14
+ * Where the member stands: `Enrolled` or `Waived` if they answered, otherwise `Pending` while their enrollment window is open, `Upcoming` before it opens and `Expired` once it has closed. A terminated unanswered enrollment is `Expired`, even before its window opens.
15
15
  *
16
16
  * * `Enrolled` - Enrolled
17
17
  * * `Waived` - Waived
18
18
  * * `Pending` - Pending
19
+ * * `Upcoming` - Upcoming
19
20
  * * `Expired` - Expired
20
21
  */
21
22
  election_status: VitableConnect.PlanYearEnrollmentElectionStatus;
@@ -2,12 +2,14 @@
2
2
  * * `Enrolled` - Enrolled
3
3
  * * `Waived` - Waived
4
4
  * * `Pending` - Pending
5
+ * * `Upcoming` - Upcoming
5
6
  * * `Expired` - Expired
6
7
  */
7
8
  export declare const PlanYearEnrollmentElectionStatus: {
8
9
  readonly Enrolled: "Enrolled";
9
10
  readonly Waived: "Waived";
10
11
  readonly Pending: "Pending";
12
+ readonly Upcoming: "Upcoming";
11
13
  readonly Expired: "Expired";
12
14
  };
13
15
  export type PlanYearEnrollmentElectionStatus = (typeof PlanYearEnrollmentElectionStatus)[keyof typeof PlanYearEnrollmentElectionStatus];
@@ -3,11 +3,13 @@
3
3
  * * `Enrolled` - Enrolled
4
4
  * * `Waived` - Waived
5
5
  * * `Pending` - Pending
6
+ * * `Upcoming` - Upcoming
6
7
  * * `Expired` - Expired
7
8
  */
8
9
  export const PlanYearEnrollmentElectionStatus = {
9
10
  Enrolled: "Enrolled",
10
11
  Waived: "Waived",
11
12
  Pending: "Pending",
13
+ Upcoming: "Upcoming",
12
14
  Expired: "Expired",
13
15
  };
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "6.1.0";
1
+ export declare const SDK_VERSION = "6.3.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "6.1.0";
1
+ export const SDK_VERSION = "6.3.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vitable-inc/vitable-connect",
3
- "version": "6.1.0",
3
+ "version": "6.3.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -1722,7 +1722,7 @@ await client.enrollments.reissue({
1722
1722
  <dl>
1723
1723
  <dd>
1724
1724
 
1725
- Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. 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.
1725
+ 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.
1726
1726
  </dd>
1727
1727
  </dl>
1728
1728
  </dd>