@vitable-inc/vitable-connect 1.0.0 → 2.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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/employers/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/employers/client/Client.js +40 -37
- package/dist/cjs/api/resources/employers/client/requests/CreateEmployerRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/EnsurePayrollIntegrationEmailEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/GetBenefitPlanYearEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/GetEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/GetHrisEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/GetInvoicePdfEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/GetPayrollAccessSetupEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/ListBenefitPlanYearEnrollmentsEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/ListBenefitPlanYearsEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/ListEmployeesEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/ListEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.d.ts +9 -0
- package/dist/cjs/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.js +3 -0
- package/dist/cjs/api/resources/employers/client/requests/ListInvoicesEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/ListPayrollDeductionStatementsEmployersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/SubmitPayrollAccessSetupRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/UpdateEmployerRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/UpdateEmployerSettingsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/employers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/enrollments/client/Client.js +6 -6
- package/dist/cjs/api/resources/enrollments/client/requests/GetEnrollmentsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/enrollments/client/requests/ReissueEnrollmentRequest.d.ts +2 -0
- package/dist/cjs/api/resources/enrollments/client/requests/TerminateEnrollmentRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/Client.js +16 -16
- package/dist/cjs/api/resources/members/client/requests/GetHouseholdMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/GetMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/ListDependentsMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/ListEmploymentsMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/ListEnrollmentsMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/ListIdCardsMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/ListMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/members/client/requests/ListQualifyingLifeEventsMembersRequest.d.ts +2 -0
- package/dist/cjs/api/resources/organizations/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/client/Client.js +1 -1
- package/dist/cjs/api/types/GroupMemberSyncFailure.d.ts +1 -1
- package/dist/cjs/api/types/GroupMemberSyncFailureOperation.d.ts +9 -0
- package/dist/cjs/api/types/{Operation.js → GroupMemberSyncFailureOperation.js} +2 -2
- package/dist/cjs/api/types/XVitableOrganization.d.ts +4 -0
- package/dist/cjs/api/types/XVitableOrganization.js +3 -0
- package/dist/cjs/api/types/index.d.ts +2 -1
- package/dist/cjs/api/types/index.js +2 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/employers/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/employers/client/Client.mjs +41 -38
- package/dist/esm/api/resources/employers/client/requests/CreateEmployerRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/EnsurePayrollIntegrationEmailEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/GetBenefitPlanYearEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/GetEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/GetHrisEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/GetInvoicePdfEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/GetPayrollAccessSetupEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListBenefitPlanYearEnrollmentsEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListBenefitPlanYearsEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListEmployeesEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.d.mts +9 -0
- package/dist/esm/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.mjs +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListInvoicesEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/ListPayrollDeductionStatementsEmployersRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/SubmitPayrollAccessSetupRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/UpdateEmployerRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/UpdateEmployerSettingsRequest.d.mts +2 -0
- package/dist/esm/api/resources/employers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/enrollments/client/Client.mjs +7 -7
- package/dist/esm/api/resources/enrollments/client/requests/GetEnrollmentsRequest.d.mts +2 -0
- package/dist/esm/api/resources/enrollments/client/requests/ReissueEnrollmentRequest.d.mts +2 -0
- package/dist/esm/api/resources/enrollments/client/requests/TerminateEnrollmentRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/Client.mjs +17 -17
- package/dist/esm/api/resources/members/client/requests/GetHouseholdMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/GetMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/ListDependentsMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/ListEmploymentsMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/ListEnrollmentsMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/ListIdCardsMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/ListMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/members/client/requests/ListQualifyingLifeEventsMembersRequest.d.mts +2 -0
- package/dist/esm/api/resources/organizations/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/organizations/client/Client.mjs +1 -1
- package/dist/esm/api/types/GroupMemberSyncFailure.d.mts +1 -1
- package/dist/esm/api/types/GroupMemberSyncFailureOperation.d.mts +9 -0
- package/dist/esm/api/types/{Operation.mjs → GroupMemberSyncFailureOperation.mjs} +1 -1
- package/dist/esm/api/types/XVitableOrganization.d.mts +4 -0
- package/dist/esm/api/types/XVitableOrganization.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +2 -1
- package/dist/esm/api/types/index.mjs +2 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +10 -2
- package/dist/cjs/api/types/Operation.d.ts +0 -9
- package/dist/esm/api/types/Operation.d.mts +0 -9
|
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
11
|
import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
12
|
-
import { mergeHeaders } from "../../../../core/headers.mjs";
|
|
12
|
+
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
|
|
13
13
|
import * as core from "../../../../core/index.mjs";
|
|
14
14
|
import * as environments from "../../../../environments.mjs";
|
|
15
15
|
import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
|
|
@@ -50,9 +50,9 @@ export class MembersClient {
|
|
|
50
50
|
__get(request, requestOptions) {
|
|
51
51
|
return __awaiter(this, void 0, void 0, function* () {
|
|
52
52
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
53
|
-
const { member_id: memberId } = request;
|
|
53
|
+
const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
|
|
54
54
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
55
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
55
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
56
56
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
57
57
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}`),
|
|
58
58
|
method: "GET",
|
|
@@ -124,9 +124,9 @@ export class MembersClient {
|
|
|
124
124
|
__listDependents(request, requestOptions) {
|
|
125
125
|
return __awaiter(this, void 0, void 0, function* () {
|
|
126
126
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
127
|
-
const { member_id: memberId } = request;
|
|
127
|
+
const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
|
|
128
128
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
129
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
129
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
130
130
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
131
131
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}/dependents`),
|
|
132
132
|
method: "GET",
|
|
@@ -201,9 +201,9 @@ export class MembersClient {
|
|
|
201
201
|
__listEmployments(request, requestOptions) {
|
|
202
202
|
return __awaiter(this, void 0, void 0, function* () {
|
|
203
203
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
204
|
-
const { member_id: memberId } = request;
|
|
204
|
+
const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
|
|
205
205
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
206
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
206
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
207
207
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
208
208
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}/employments`),
|
|
209
209
|
method: "GET",
|
|
@@ -278,9 +278,9 @@ export class MembersClient {
|
|
|
278
278
|
__listEnrollments(request, requestOptions) {
|
|
279
279
|
return __awaiter(this, void 0, void 0, function* () {
|
|
280
280
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
281
|
-
const { member_id: memberId } = request;
|
|
281
|
+
const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
|
|
282
282
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
283
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
283
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
284
284
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
285
285
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}/enrollments`),
|
|
286
286
|
method: "GET",
|
|
@@ -355,9 +355,9 @@ export class MembersClient {
|
|
|
355
355
|
__getHousehold(request, requestOptions) {
|
|
356
356
|
return __awaiter(this, void 0, void 0, function* () {
|
|
357
357
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
358
|
-
const { member_id: memberId } = request;
|
|
358
|
+
const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
|
|
359
359
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
360
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
360
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
361
361
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
362
362
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}/household`),
|
|
363
363
|
method: "GET",
|
|
@@ -432,9 +432,9 @@ export class MembersClient {
|
|
|
432
432
|
__listIdCards(request, requestOptions) {
|
|
433
433
|
return __awaiter(this, void 0, void 0, function* () {
|
|
434
434
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
435
|
-
const { member_id: memberId } = request;
|
|
435
|
+
const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
|
|
436
436
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
437
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
437
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
438
438
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
439
439
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}/id-cards`),
|
|
440
440
|
method: "GET",
|
|
@@ -509,14 +509,14 @@ export class MembersClient {
|
|
|
509
509
|
return __awaiter(this, void 0, void 0, function* () {
|
|
510
510
|
const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
|
|
511
511
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
512
|
-
const { member_id: memberId, limit, page, status } = request;
|
|
512
|
+
const { member_id: memberId, limit, page, status, "X-Vitable-Organization": vitableOrganization, } = request;
|
|
513
513
|
const _queryParams = {
|
|
514
514
|
limit,
|
|
515
515
|
page,
|
|
516
516
|
status: status != null ? status : undefined,
|
|
517
517
|
};
|
|
518
518
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
519
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
519
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
520
520
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
521
521
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, `v1/members/${core.url.encodePathParam(memberId)}/qualifying-life-events`),
|
|
522
522
|
method: "GET",
|
|
@@ -607,14 +607,14 @@ export class MembersClient {
|
|
|
607
607
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
608
608
|
const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
|
|
609
609
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
610
|
-
const { limit, page, search } = request;
|
|
610
|
+
const { limit, page, search, "X-Vitable-Organization": vitableOrganization } = request;
|
|
611
611
|
const _queryParams = {
|
|
612
612
|
limit,
|
|
613
613
|
page,
|
|
614
614
|
search,
|
|
615
615
|
};
|
|
616
616
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
617
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
617
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
618
618
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
619
619
|
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VitableConnectEnvironment.Production, "v2/members"),
|
|
620
620
|
method: "GET",
|
|
@@ -7,4 +7,6 @@ import type * as VitableConnect from "../../../../index.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface GetHouseholdMembersRequest {
|
|
9
9
|
member_id: VitableConnect.MemberId;
|
|
10
|
+
/** 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`. */
|
|
11
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
10
12
|
}
|
|
@@ -8,4 +8,6 @@ import type * as VitableConnect from "../../../../index.mjs";
|
|
|
8
8
|
export interface GetMembersRequest {
|
|
9
9
|
/** Unique member identifier (mbr_*) */
|
|
10
10
|
member_id: VitableConnect.MemberId;
|
|
11
|
+
/** 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`. */
|
|
12
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
11
13
|
}
|
|
@@ -7,4 +7,6 @@ import type * as VitableConnect from "../../../../index.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface ListDependentsMembersRequest {
|
|
9
9
|
member_id: VitableConnect.MemberId;
|
|
10
|
+
/** 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`. */
|
|
11
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
10
12
|
}
|
|
@@ -7,4 +7,6 @@ import type * as VitableConnect from "../../../../index.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface ListEmploymentsMembersRequest {
|
|
9
9
|
member_id: VitableConnect.MemberId;
|
|
10
|
+
/** 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`. */
|
|
11
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
10
12
|
}
|
|
@@ -7,4 +7,6 @@ import type * as VitableConnect from "../../../../index.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface ListEnrollmentsMembersRequest {
|
|
9
9
|
member_id: VitableConnect.MemberId;
|
|
10
|
+
/** 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`. */
|
|
11
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
10
12
|
}
|
|
@@ -7,4 +7,6 @@ import type * as VitableConnect from "../../../../index.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface ListIdCardsMembersRequest {
|
|
9
9
|
member_id: VitableConnect.MemberId;
|
|
10
|
+
/** 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`. */
|
|
11
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
10
12
|
}
|
|
@@ -13,4 +13,6 @@ export interface ListMembersRequest {
|
|
|
13
13
|
page?: VitableConnect.Page;
|
|
14
14
|
/** Case-insensitive search across member name, email, and phone number; exact match on member id (prefixed or raw uuid) */
|
|
15
15
|
search?: VitableConnect.MemberSearch;
|
|
16
|
+
/** 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`. */
|
|
17
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
16
18
|
}
|
package/dist/esm/api/resources/members/client/requests/ListQualifyingLifeEventsMembersRequest.d.mts
CHANGED
|
@@ -16,4 +16,6 @@ export interface ListQualifyingLifeEventsMembersRequest {
|
|
|
16
16
|
page?: VitableConnect.Page;
|
|
17
17
|
/** Optional. Filter to a single QLE status; omit to return all statuses. */
|
|
18
18
|
status?: VitableConnect.Status;
|
|
19
|
+
/** 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`. */
|
|
20
|
+
"X-Vitable-Organization"?: VitableConnect.XVitableOrganization;
|
|
19
21
|
}
|
|
@@ -35,7 +35,7 @@ export declare class OrganizationsClient {
|
|
|
35
35
|
list(requestOptions?: OrganizationsClient.RequestOptions): core.HttpResponsePromise<VitableConnect.OrganizationsListResponse>;
|
|
36
36
|
private __list;
|
|
37
37
|
/**
|
|
38
|
-
* Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin).
|
|
38
|
+
* Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header. The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with its owner rather than rejected.
|
|
39
39
|
*
|
|
40
40
|
* @param {VitableConnect.CreateOrganizationRequest} request
|
|
41
41
|
* @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -97,7 +97,7 @@ export class OrganizationsClient {
|
|
|
97
97
|
});
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
* Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin).
|
|
100
|
+
* Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header. The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with its owner rather than rejected.
|
|
101
101
|
*
|
|
102
102
|
* @param {VitableConnect.CreateOrganizationRequest} request
|
|
103
103
|
* @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3,7 +3,7 @@ export interface GroupMemberSyncFailure {
|
|
|
3
3
|
/** Your identifier for the member that failed to sync. */
|
|
4
4
|
reference_id: string;
|
|
5
5
|
/** The sync operation that failed for this member. */
|
|
6
|
-
operation: VitableConnect.
|
|
6
|
+
operation: VitableConnect.GroupMemberSyncFailureOperation;
|
|
7
7
|
/** Human-readable explanation of why the operation failed. */
|
|
8
8
|
reason: string;
|
|
9
9
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* * `add` - add
|
|
3
|
+
* * `remove` - remove
|
|
4
|
+
*/
|
|
5
|
+
export declare const GroupMemberSyncFailureOperation: {
|
|
6
|
+
readonly Add: "add";
|
|
7
|
+
readonly Remove: "remove";
|
|
8
|
+
};
|
|
9
|
+
export type GroupMemberSyncFailureOperation = (typeof GroupMemberSyncFailureOperation)[keyof typeof GroupMemberSyncFailureOperation];
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 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`.
|
|
3
|
+
*/
|
|
4
|
+
export type XVitableOrganization = string;
|
|
@@ -89,6 +89,7 @@ export * from "./GroupId.mjs";
|
|
|
89
89
|
export * from "./GroupListResponse.mjs";
|
|
90
90
|
export * from "./GroupMemberSyncDetailResponse.mjs";
|
|
91
91
|
export * from "./GroupMemberSyncFailure.mjs";
|
|
92
|
+
export * from "./GroupMemberSyncFailureOperation.mjs";
|
|
92
93
|
export * from "./GroupMemberSyncMemberRequest.mjs";
|
|
93
94
|
export * from "./GroupMemberSyncRequestDetail.mjs";
|
|
94
95
|
export * from "./GroupMemberSyncRequestDetailResponse.mjs";
|
|
@@ -129,7 +130,6 @@ export * from "./MemberStatus.mjs";
|
|
|
129
130
|
export * from "./MissingEmployeeResolution.mjs";
|
|
130
131
|
export * from "./NameSuffix.mjs";
|
|
131
132
|
export * from "./Offset.mjs";
|
|
132
|
-
export * from "./Operation.mjs";
|
|
133
133
|
export * from "./Organization.mjs";
|
|
134
134
|
export * from "./OrganizationEmployer.mjs";
|
|
135
135
|
export * from "./OrganizationEmployerListResponse.mjs";
|
|
@@ -173,3 +173,4 @@ export * from "./WebhookDelivery.mjs";
|
|
|
173
173
|
export * from "./WebhookEvent.mjs";
|
|
174
174
|
export * from "./WebhookEventListResponse.mjs";
|
|
175
175
|
export * from "./WebhookEventResponse.mjs";
|
|
176
|
+
export * from "./XVitableOrganization.mjs";
|
|
@@ -89,6 +89,7 @@ export * from "./GroupId.mjs";
|
|
|
89
89
|
export * from "./GroupListResponse.mjs";
|
|
90
90
|
export * from "./GroupMemberSyncDetailResponse.mjs";
|
|
91
91
|
export * from "./GroupMemberSyncFailure.mjs";
|
|
92
|
+
export * from "./GroupMemberSyncFailureOperation.mjs";
|
|
92
93
|
export * from "./GroupMemberSyncMemberRequest.mjs";
|
|
93
94
|
export * from "./GroupMemberSyncRequestDetail.mjs";
|
|
94
95
|
export * from "./GroupMemberSyncRequestDetailResponse.mjs";
|
|
@@ -129,7 +130,6 @@ export * from "./MemberStatus.mjs";
|
|
|
129
130
|
export * from "./MissingEmployeeResolution.mjs";
|
|
130
131
|
export * from "./NameSuffix.mjs";
|
|
131
132
|
export * from "./Offset.mjs";
|
|
132
|
-
export * from "./Operation.mjs";
|
|
133
133
|
export * from "./Organization.mjs";
|
|
134
134
|
export * from "./OrganizationEmployer.mjs";
|
|
135
135
|
export * from "./OrganizationEmployerListResponse.mjs";
|
|
@@ -173,3 +173,4 @@ export * from "./WebhookDelivery.mjs";
|
|
|
173
173
|
export * from "./WebhookEvent.mjs";
|
|
174
174
|
export * from "./WebhookEventListResponse.mjs";
|
|
175
175
|
export * from "./WebhookEventResponse.mjs";
|
|
176
|
+
export * from "./XVitableOrganization.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.0
|
|
1
|
+
export declare const SDK_VERSION = "2.1.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.0
|
|
1
|
+
export const SDK_VERSION = "2.1.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1513,7 +1513,7 @@ await client.employers.updateSettings({
|
|
|
1513
1513
|
</dl>
|
|
1514
1514
|
</details>
|
|
1515
1515
|
|
|
1516
|
-
<details><summary><code>client.employers.<a href="/src/api/resources/employers/client/Client.ts">listHrisProviders</a>() -> VitableConnect.OrganizationHrisProvidersResponse</code></summary>
|
|
1516
|
+
<details><summary><code>client.employers.<a href="/src/api/resources/employers/client/Client.ts">listHrisProviders</a>({ ...params }) -> VitableConnect.OrganizationHrisProvidersResponse</code></summary>
|
|
1517
1517
|
<dl>
|
|
1518
1518
|
<dd>
|
|
1519
1519
|
|
|
@@ -1556,6 +1556,14 @@ await client.employers.listHrisProviders();
|
|
|
1556
1556
|
<dl>
|
|
1557
1557
|
<dd>
|
|
1558
1558
|
|
|
1559
|
+
**request:** `VitableConnect.ListHrisProvidersEmployersRequest`
|
|
1560
|
+
|
|
1561
|
+
</dd>
|
|
1562
|
+
</dl>
|
|
1563
|
+
|
|
1564
|
+
<dl>
|
|
1565
|
+
<dd>
|
|
1566
|
+
|
|
1559
1567
|
**requestOptions:** `EmployersClient.RequestOptions`
|
|
1560
1568
|
|
|
1561
1569
|
</dd>
|
|
@@ -2673,7 +2681,7 @@ await client.organizations.list();
|
|
|
2673
2681
|
<dl>
|
|
2674
2682
|
<dd>
|
|
2675
2683
|
|
|
2676
|
-
Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin).
|
|
2684
|
+
Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header. The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with its owner rather than rejected.
|
|
2677
2685
|
</dd>
|
|
2678
2686
|
</dl>
|
|
2679
2687
|
</dd>
|