@vitable-inc/vitable-connect 2.0.0 → 3.0.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.
Files changed (108) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/employers/client/Client.d.ts +2 -1
  3. package/dist/cjs/api/resources/employers/client/Client.js +40 -37
  4. package/dist/cjs/api/resources/employers/client/requests/CreateEmployerRequest.d.ts +2 -0
  5. package/dist/cjs/api/resources/employers/client/requests/EnsurePayrollIntegrationEmailEmployersRequest.d.ts +2 -0
  6. package/dist/cjs/api/resources/employers/client/requests/GetBenefitPlanYearEmployersRequest.d.ts +2 -0
  7. package/dist/cjs/api/resources/employers/client/requests/GetEmployersRequest.d.ts +2 -0
  8. package/dist/cjs/api/resources/employers/client/requests/GetHrisEmployersRequest.d.ts +2 -0
  9. package/dist/cjs/api/resources/employers/client/requests/GetInvoicePdfEmployersRequest.d.ts +2 -0
  10. package/dist/cjs/api/resources/employers/client/requests/GetPayrollAccessSetupEmployersRequest.d.ts +2 -0
  11. package/dist/cjs/api/resources/employers/client/requests/ListBenefitPlanYearEnrollmentsEmployersRequest.d.ts +2 -0
  12. package/dist/cjs/api/resources/employers/client/requests/ListBenefitPlanYearsEmployersRequest.d.ts +2 -0
  13. package/dist/cjs/api/resources/employers/client/requests/ListEmployeesEmployersRequest.d.ts +2 -0
  14. package/dist/cjs/api/resources/employers/client/requests/ListEmployersRequest.d.ts +2 -0
  15. package/dist/cjs/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.d.ts +9 -0
  16. package/dist/cjs/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.js +3 -0
  17. package/dist/cjs/api/resources/employers/client/requests/ListInvoicesEmployersRequest.d.ts +2 -0
  18. package/dist/cjs/api/resources/employers/client/requests/ListPayrollDeductionStatementsEmployersRequest.d.ts +2 -0
  19. package/dist/cjs/api/resources/employers/client/requests/SubmitPayrollAccessSetupRequest.d.ts +2 -0
  20. package/dist/cjs/api/resources/employers/client/requests/UpdateEmployerRequest.d.ts +2 -0
  21. package/dist/cjs/api/resources/employers/client/requests/UpdateEmployerSettingsRequest.d.ts +2 -0
  22. package/dist/cjs/api/resources/employers/client/requests/index.d.ts +1 -0
  23. package/dist/cjs/api/resources/enrollments/client/Client.js +6 -6
  24. package/dist/cjs/api/resources/enrollments/client/requests/GetEnrollmentsRequest.d.ts +2 -0
  25. package/dist/cjs/api/resources/enrollments/client/requests/ReissueEnrollmentRequest.d.ts +2 -0
  26. package/dist/cjs/api/resources/enrollments/client/requests/TerminateEnrollmentRequest.d.ts +2 -0
  27. package/dist/cjs/api/resources/members/client/Client.js +16 -16
  28. package/dist/cjs/api/resources/members/client/requests/GetHouseholdMembersRequest.d.ts +2 -0
  29. package/dist/cjs/api/resources/members/client/requests/GetMembersRequest.d.ts +2 -0
  30. package/dist/cjs/api/resources/members/client/requests/ListDependentsMembersRequest.d.ts +2 -0
  31. package/dist/cjs/api/resources/members/client/requests/ListEmploymentsMembersRequest.d.ts +2 -0
  32. package/dist/cjs/api/resources/members/client/requests/ListEnrollmentsMembersRequest.d.ts +2 -0
  33. package/dist/cjs/api/resources/members/client/requests/ListIdCardsMembersRequest.d.ts +2 -0
  34. package/dist/cjs/api/resources/members/client/requests/ListMembersRequest.d.ts +2 -0
  35. package/dist/cjs/api/resources/members/client/requests/ListQualifyingLifeEventsMembersRequest.d.ts +2 -0
  36. package/dist/cjs/api/resources/organizations/client/Client.d.ts +2 -2
  37. package/dist/cjs/api/resources/organizations/client/Client.js +2 -2
  38. package/dist/cjs/api/resources/organizations/client/requests/CreateOrganizationRequest.d.ts +1 -1
  39. package/dist/cjs/api/types/OrganizationMembership.d.ts +38 -0
  40. package/dist/cjs/api/types/OrganizationMembership.js +3 -0
  41. package/dist/cjs/api/types/OrganizationType.d.ts +5 -5
  42. package/dist/cjs/api/types/OrganizationType.js +5 -5
  43. package/dist/cjs/api/types/OrganizationUserRole.d.ts +13 -0
  44. package/dist/cjs/api/types/OrganizationUserRole.js +16 -0
  45. package/dist/cjs/api/types/OrganizationsListResponse.d.ts +1 -1
  46. package/dist/cjs/api/types/XVitableOrganization.d.ts +4 -0
  47. package/dist/cjs/api/types/XVitableOrganization.js +3 -0
  48. package/dist/cjs/api/types/index.d.ts +3 -1
  49. package/dist/cjs/api/types/index.js +3 -1
  50. package/dist/cjs/version.d.ts +1 -1
  51. package/dist/cjs/version.js +1 -1
  52. package/dist/esm/BaseClient.mjs +2 -2
  53. package/dist/esm/api/resources/employers/client/Client.d.mts +2 -1
  54. package/dist/esm/api/resources/employers/client/Client.mjs +41 -38
  55. package/dist/esm/api/resources/employers/client/requests/CreateEmployerRequest.d.mts +2 -0
  56. package/dist/esm/api/resources/employers/client/requests/EnsurePayrollIntegrationEmailEmployersRequest.d.mts +2 -0
  57. package/dist/esm/api/resources/employers/client/requests/GetBenefitPlanYearEmployersRequest.d.mts +2 -0
  58. package/dist/esm/api/resources/employers/client/requests/GetEmployersRequest.d.mts +2 -0
  59. package/dist/esm/api/resources/employers/client/requests/GetHrisEmployersRequest.d.mts +2 -0
  60. package/dist/esm/api/resources/employers/client/requests/GetInvoicePdfEmployersRequest.d.mts +2 -0
  61. package/dist/esm/api/resources/employers/client/requests/GetPayrollAccessSetupEmployersRequest.d.mts +2 -0
  62. package/dist/esm/api/resources/employers/client/requests/ListBenefitPlanYearEnrollmentsEmployersRequest.d.mts +2 -0
  63. package/dist/esm/api/resources/employers/client/requests/ListBenefitPlanYearsEmployersRequest.d.mts +2 -0
  64. package/dist/esm/api/resources/employers/client/requests/ListEmployeesEmployersRequest.d.mts +2 -0
  65. package/dist/esm/api/resources/employers/client/requests/ListEmployersRequest.d.mts +2 -0
  66. package/dist/esm/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.d.mts +9 -0
  67. package/dist/esm/api/resources/employers/client/requests/ListHrisProvidersEmployersRequest.mjs +2 -0
  68. package/dist/esm/api/resources/employers/client/requests/ListInvoicesEmployersRequest.d.mts +2 -0
  69. package/dist/esm/api/resources/employers/client/requests/ListPayrollDeductionStatementsEmployersRequest.d.mts +2 -0
  70. package/dist/esm/api/resources/employers/client/requests/SubmitPayrollAccessSetupRequest.d.mts +2 -0
  71. package/dist/esm/api/resources/employers/client/requests/UpdateEmployerRequest.d.mts +2 -0
  72. package/dist/esm/api/resources/employers/client/requests/UpdateEmployerSettingsRequest.d.mts +2 -0
  73. package/dist/esm/api/resources/employers/client/requests/index.d.mts +1 -0
  74. package/dist/esm/api/resources/enrollments/client/Client.mjs +7 -7
  75. package/dist/esm/api/resources/enrollments/client/requests/GetEnrollmentsRequest.d.mts +2 -0
  76. package/dist/esm/api/resources/enrollments/client/requests/ReissueEnrollmentRequest.d.mts +2 -0
  77. package/dist/esm/api/resources/enrollments/client/requests/TerminateEnrollmentRequest.d.mts +2 -0
  78. package/dist/esm/api/resources/members/client/Client.mjs +17 -17
  79. package/dist/esm/api/resources/members/client/requests/GetHouseholdMembersRequest.d.mts +2 -0
  80. package/dist/esm/api/resources/members/client/requests/GetMembersRequest.d.mts +2 -0
  81. package/dist/esm/api/resources/members/client/requests/ListDependentsMembersRequest.d.mts +2 -0
  82. package/dist/esm/api/resources/members/client/requests/ListEmploymentsMembersRequest.d.mts +2 -0
  83. package/dist/esm/api/resources/members/client/requests/ListEnrollmentsMembersRequest.d.mts +2 -0
  84. package/dist/esm/api/resources/members/client/requests/ListIdCardsMembersRequest.d.mts +2 -0
  85. package/dist/esm/api/resources/members/client/requests/ListMembersRequest.d.mts +2 -0
  86. package/dist/esm/api/resources/members/client/requests/ListQualifyingLifeEventsMembersRequest.d.mts +2 -0
  87. package/dist/esm/api/resources/organizations/client/Client.d.mts +2 -2
  88. package/dist/esm/api/resources/organizations/client/Client.mjs +2 -2
  89. package/dist/esm/api/resources/organizations/client/requests/CreateOrganizationRequest.d.mts +1 -1
  90. package/dist/esm/api/types/OrganizationMembership.d.mts +38 -0
  91. package/dist/esm/api/types/OrganizationMembership.mjs +2 -0
  92. package/dist/esm/api/types/OrganizationType.d.mts +5 -5
  93. package/dist/esm/api/types/OrganizationType.mjs +5 -5
  94. package/dist/esm/api/types/OrganizationUserRole.d.mts +13 -0
  95. package/dist/esm/api/types/OrganizationUserRole.mjs +13 -0
  96. package/dist/esm/api/types/OrganizationsListResponse.d.mts +1 -1
  97. package/dist/esm/api/types/XVitableOrganization.d.mts +4 -0
  98. package/dist/esm/api/types/XVitableOrganization.mjs +2 -0
  99. package/dist/esm/api/types/index.d.mts +3 -1
  100. package/dist/esm/api/types/index.mjs +3 -1
  101. package/dist/esm/version.d.mts +1 -1
  102. package/dist/esm/version.mjs +1 -1
  103. package/package.json +1 -1
  104. package/reference.md +11 -3
  105. package/dist/cjs/api/types/CreateOrganizationRequestType.d.ts +0 -17
  106. package/dist/cjs/api/types/CreateOrganizationRequestType.js +0 -20
  107. package/dist/esm/api/types/CreateOrganizationRequestType.d.mts +0 -17
  108. package/dist/esm/api/types/CreateOrganizationRequestType.mjs +0 -17
@@ -86,9 +86,9 @@ class MembersClient {
86
86
  __get(request, requestOptions) {
87
87
  return __awaiter(this, void 0, void 0, function* () {
88
88
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
89
- const { member_id: memberId } = request;
89
+ const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
90
90
  const _authRequest = yield this._options.authProvider.getAuthRequest();
91
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
91
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
92
92
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
93
93
  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)}`),
94
94
  method: "GET",
@@ -160,9 +160,9 @@ class MembersClient {
160
160
  __listDependents(request, requestOptions) {
161
161
  return __awaiter(this, void 0, void 0, function* () {
162
162
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
163
- const { member_id: memberId } = request;
163
+ const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
164
164
  const _authRequest = yield this._options.authProvider.getAuthRequest();
165
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
165
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
166
166
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
167
167
  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`),
168
168
  method: "GET",
@@ -237,9 +237,9 @@ class MembersClient {
237
237
  __listEmployments(request, requestOptions) {
238
238
  return __awaiter(this, void 0, void 0, function* () {
239
239
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
240
- const { member_id: memberId } = request;
240
+ const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
241
241
  const _authRequest = yield this._options.authProvider.getAuthRequest();
242
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
242
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
243
243
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
244
244
  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`),
245
245
  method: "GET",
@@ -314,9 +314,9 @@ class MembersClient {
314
314
  __listEnrollments(request, requestOptions) {
315
315
  return __awaiter(this, void 0, void 0, function* () {
316
316
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
317
- const { member_id: memberId } = request;
317
+ const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
318
318
  const _authRequest = yield this._options.authProvider.getAuthRequest();
319
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
319
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
320
320
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
321
321
  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`),
322
322
  method: "GET",
@@ -391,9 +391,9 @@ class MembersClient {
391
391
  __getHousehold(request, requestOptions) {
392
392
  return __awaiter(this, void 0, void 0, function* () {
393
393
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
394
- const { member_id: memberId } = request;
394
+ const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
395
395
  const _authRequest = yield this._options.authProvider.getAuthRequest();
396
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
396
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
397
397
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
398
398
  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`),
399
399
  method: "GET",
@@ -468,9 +468,9 @@ class MembersClient {
468
468
  __listIdCards(request, requestOptions) {
469
469
  return __awaiter(this, void 0, void 0, function* () {
470
470
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
471
- const { member_id: memberId } = request;
471
+ const { member_id: memberId, "X-Vitable-Organization": vitableOrganization } = request;
472
472
  const _authRequest = yield this._options.authProvider.getAuthRequest();
473
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
473
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
474
474
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
475
475
  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`),
476
476
  method: "GET",
@@ -545,14 +545,14 @@ class MembersClient {
545
545
  return __awaiter(this, void 0, void 0, function* () {
546
546
  const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
547
547
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
548
- const { member_id: memberId, limit, page, status } = request;
548
+ const { member_id: memberId, limit, page, status, "X-Vitable-Organization": vitableOrganization, } = request;
549
549
  const _queryParams = {
550
550
  limit,
551
551
  page,
552
552
  status: status != null ? status : undefined,
553
553
  };
554
554
  const _authRequest = yield this._options.authProvider.getAuthRequest();
555
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
555
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
556
556
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
557
557
  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`),
558
558
  method: "GET",
@@ -643,14 +643,14 @@ class MembersClient {
643
643
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
644
644
  const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
645
645
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
646
- const { limit, page, search } = request;
646
+ const { limit, page, search, "X-Vitable-Organization": vitableOrganization } = request;
647
647
  const _queryParams = {
648
648
  limit,
649
649
  page,
650
650
  search,
651
651
  };
652
652
  const _authRequest = yield this._options.authProvider.getAuthRequest();
653
- const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
653
+ const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Vitable-Organization": vitableOrganization }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
654
654
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
655
655
  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"),
656
656
  method: "GET",
@@ -7,4 +7,6 @@ import type * as VitableConnect from "../../../../index.js";
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.js";
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.js";
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.js";
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.js";
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.js";
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
  }
@@ -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
  }
@@ -14,7 +14,7 @@ export declare class OrganizationsClient {
14
14
  protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationsClient.Options>;
15
15
  constructor(options?: OrganizationsClient.Options);
16
16
  /**
17
- * Lists the organizations the authenticated caller is an active member of (paginated). Returns an empty list when the caller belongs to no organizations.
17
+ * Lists the organizations the authenticated caller is an active member of (paginated), each with the role the caller holds in it. Returns an empty list when the caller belongs to no organizations.
18
18
  *
19
19
  * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
20
20
  *
@@ -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). 409 `organization_already_exists` when the user already has an organization (v0: one organization per user).
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.
@@ -60,7 +60,7 @@ class OrganizationsClient {
60
60
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
61
61
  }
62
62
  /**
63
- * Lists the organizations the authenticated caller is an active member of (paginated). Returns an empty list when the caller belongs to no organizations.
63
+ * Lists the organizations the authenticated caller is an active member of (paginated), each with the role the caller holds in it. Returns an empty list when the caller belongs to no organizations.
64
64
  *
65
65
  * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
66
66
  *
@@ -133,7 +133,7 @@ class OrganizationsClient {
133
133
  });
134
134
  }
135
135
  /**
136
- * 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). 409 `organization_already_exists` when the user already has an organization (v0: one organization per user).
136
+ * 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.
137
137
  *
138
138
  * @param {VitableConnect.CreateOrganizationRequest} request
139
139
  * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -10,5 +10,5 @@ export interface CreateOrganizationRequest {
10
10
  /** Legal or trading name of the organization. */
11
11
  name: string;
12
12
  /** Category of organization being onboarded. */
13
- type?: VitableConnect.CreateOrganizationRequestType | null;
13
+ type?: VitableConnect.OrganizationType | null;
14
14
  }
@@ -0,0 +1,38 @@
1
+ import type * as VitableConnect from "../index.js";
2
+ export interface OrganizationMembership {
3
+ /** Prefixed organization identifier (`org_<base64-encoded-uuid>`). */
4
+ id: string;
5
+ /** Human-readable organization name. */
6
+ name: string;
7
+ /**
8
+ * Partner type (e.g. BROKERAGE, TPA).
9
+ *
10
+ * * `BROKERAGE` - Brokerage
11
+ * * `TPA` - TPA
12
+ * * `GENERAL_AGENT` - General Agent
13
+ * * `CHANNEL_PARTNER` - Channel Partner
14
+ * * `CONSULTING_FIRM` - Consulting Firm
15
+ * * `API_PLATFORM` - API Platform
16
+ */
17
+ type: VitableConnect.OrganizationType | null;
18
+ /** IdP-issued tenant id (WorkOS org id). */
19
+ idp_org_id: string | null;
20
+ /**
21
+ * IdP that minted idp_org_id (e.g. 'workos').
22
+ *
23
+ * * `workos` - WorkOS
24
+ * * `vitable` - Vitable
25
+ */
26
+ idp_provider: VitableConnect.IdpProvider | null;
27
+ /** Whether this organization reads across every organization. */
28
+ super_in: boolean;
29
+ /**
30
+ * The caller's role in this organization.
31
+ *
32
+ * * `ADMIN` - Admin
33
+ * * `OPERATIONS` - Operations
34
+ * * `SALES` - Sales
35
+ * * `ENROLLMENT_AGENT` - Enrollment Agent
36
+ */
37
+ role: VitableConnect.OrganizationUserRole;
38
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,10 +1,10 @@
1
1
  /**
2
- * * `BROKERAGE` - Brokerage
2
+ * * `BROKERAGE` - BROKERAGE
3
3
  * * `TPA` - TPA
4
- * * `GENERAL_AGENT` - General Agent
5
- * * `CHANNEL_PARTNER` - Channel Partner
6
- * * `CONSULTING_FIRM` - Consulting Firm
7
- * * `API_PLATFORM` - API Platform
4
+ * * `GENERAL_AGENT` - GENERAL_AGENT
5
+ * * `CHANNEL_PARTNER` - CHANNEL_PARTNER
6
+ * * `CONSULTING_FIRM` - CONSULTING_FIRM
7
+ * * `API_PLATFORM` - API_PLATFORM
8
8
  */
9
9
  export declare const OrganizationType: {
10
10
  readonly Brokerage: "BROKERAGE";
@@ -3,12 +3,12 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.OrganizationType = void 0;
5
5
  /**
6
- * * `BROKERAGE` - Brokerage
6
+ * * `BROKERAGE` - BROKERAGE
7
7
  * * `TPA` - TPA
8
- * * `GENERAL_AGENT` - General Agent
9
- * * `CHANNEL_PARTNER` - Channel Partner
10
- * * `CONSULTING_FIRM` - Consulting Firm
11
- * * `API_PLATFORM` - API Platform
8
+ * * `GENERAL_AGENT` - GENERAL_AGENT
9
+ * * `CHANNEL_PARTNER` - CHANNEL_PARTNER
10
+ * * `CONSULTING_FIRM` - CONSULTING_FIRM
11
+ * * `API_PLATFORM` - API_PLATFORM
12
12
  */
13
13
  exports.OrganizationType = {
14
14
  Brokerage: "BROKERAGE",
@@ -0,0 +1,13 @@
1
+ /**
2
+ * * `ADMIN` - Admin
3
+ * * `OPERATIONS` - Operations
4
+ * * `SALES` - Sales
5
+ * * `ENROLLMENT_AGENT` - Enrollment Agent
6
+ */
7
+ export declare const OrganizationUserRole: {
8
+ readonly Admin: "ADMIN";
9
+ readonly Operations: "OPERATIONS";
10
+ readonly Sales: "SALES";
11
+ readonly EnrollmentAgent: "ENROLLMENT_AGENT";
12
+ };
13
+ export type OrganizationUserRole = (typeof OrganizationUserRole)[keyof typeof OrganizationUserRole];
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.OrganizationUserRole = void 0;
5
+ /**
6
+ * * `ADMIN` - Admin
7
+ * * `OPERATIONS` - Operations
8
+ * * `SALES` - Sales
9
+ * * `ENROLLMENT_AGENT` - Enrollment Agent
10
+ */
11
+ exports.OrganizationUserRole = {
12
+ Admin: "ADMIN",
13
+ Operations: "OPERATIONS",
14
+ Sales: "SALES",
15
+ EnrollmentAgent: "ENROLLMENT_AGENT",
16
+ };
@@ -4,7 +4,7 @@ import type * as VitableConnect from "../index.js";
4
4
  */
5
5
  export interface OrganizationsListResponse {
6
6
  /** This page of organizations. */
7
- organizations: VitableConnect.Organization[];
7
+ organizations: VitableConnect.OrganizationMembership[];
8
8
  /** Total number of organizations the caller belongs to. */
9
9
  total: number;
10
10
  }
@@ -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;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -32,7 +32,6 @@ export * from "./ContributionTier.js";
32
32
  export * from "./CoverageTier.js";
33
33
  export * from "./CreatedAfter.js";
34
34
  export * from "./CreatedBefore.js";
35
- export * from "./CreateOrganizationRequestType.js";
36
35
  export * from "./DeductionDetail.js";
37
36
  export * from "./DeductionFrequency.js";
38
37
  export * from "./DigitalBenefitCard.js";
@@ -135,8 +134,10 @@ export * from "./OrganizationEmployer.js";
135
134
  export * from "./OrganizationEmployerListResponse.js";
136
135
  export * from "./OrganizationHrisProvider.js";
137
136
  export * from "./OrganizationHrisProvidersResponse.js";
137
+ export * from "./OrganizationMembership.js";
138
138
  export * from "./OrganizationsListResponse.js";
139
139
  export * from "./OrganizationType.js";
140
+ export * from "./OrganizationUserRole.js";
140
141
  export * from "./Page.js";
141
142
  export * from "./Pagination.js";
142
143
  export * from "./PayrollAccessSetupStatus.js";
@@ -173,3 +174,4 @@ export * from "./WebhookDelivery.js";
173
174
  export * from "./WebhookEvent.js";
174
175
  export * from "./WebhookEventListResponse.js";
175
176
  export * from "./WebhookEventResponse.js";
177
+ export * from "./XVitableOrganization.js";
@@ -48,7 +48,6 @@ __exportStar(require("./ContributionTier.js"), exports);
48
48
  __exportStar(require("./CoverageTier.js"), exports);
49
49
  __exportStar(require("./CreatedAfter.js"), exports);
50
50
  __exportStar(require("./CreatedBefore.js"), exports);
51
- __exportStar(require("./CreateOrganizationRequestType.js"), exports);
52
51
  __exportStar(require("./DeductionDetail.js"), exports);
53
52
  __exportStar(require("./DeductionFrequency.js"), exports);
54
53
  __exportStar(require("./DigitalBenefitCard.js"), exports);
@@ -151,8 +150,10 @@ __exportStar(require("./OrganizationEmployer.js"), exports);
151
150
  __exportStar(require("./OrganizationEmployerListResponse.js"), exports);
152
151
  __exportStar(require("./OrganizationHrisProvider.js"), exports);
153
152
  __exportStar(require("./OrganizationHrisProvidersResponse.js"), exports);
153
+ __exportStar(require("./OrganizationMembership.js"), exports);
154
154
  __exportStar(require("./OrganizationsListResponse.js"), exports);
155
155
  __exportStar(require("./OrganizationType.js"), exports);
156
+ __exportStar(require("./OrganizationUserRole.js"), exports);
156
157
  __exportStar(require("./Page.js"), exports);
157
158
  __exportStar(require("./Pagination.js"), exports);
158
159
  __exportStar(require("./PayrollAccessSetupStatus.js"), exports);
@@ -189,3 +190,4 @@ __exportStar(require("./WebhookDelivery.js"), exports);
189
190
  __exportStar(require("./WebhookEvent.js"), exports);
190
191
  __exportStar(require("./WebhookEventListResponse.js"), exports);
191
192
  __exportStar(require("./WebhookEventResponse.js"), exports);
193
+ __exportStar(require("./XVitableOrganization.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "2.0.0";
1
+ export declare const SDK_VERSION = "3.0.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 = "2.0.0";
4
+ exports.SDK_VERSION = "3.0.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": "2.0.0",
11
- "User-Agent": "@vitable-inc/vitable-connect/2.0.0",
10
+ "X-Fern-SDK-Version": "3.0.0",
11
+ "User-Agent": "@vitable-inc/vitable-connect/3.0.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);
@@ -484,6 +484,7 @@ export declare class EmployersClient {
484
484
  /**
485
485
  * Returns the distinct HRIS/payroll providers across the same book `GET /v1/employers` returns, sorted for display. Use these as the values for the employers list's `hris_provider` filter — filter on `provider`, show `provider_label`. The stored providers are free text, so they cannot be enumerated in advance.
486
486
  *
487
+ * @param {VitableConnect.ListHrisProvidersEmployersRequest} request
487
488
  * @param {EmployersClient.RequestOptions} requestOptions - Request-specific configuration.
488
489
  *
489
490
  * @throws {@link VitableConnect.BadRequestError}
@@ -500,6 +501,6 @@ export declare class EmployersClient {
500
501
  * @example
501
502
  * await client.employers.listHrisProviders()
502
503
  */
503
- listHrisProviders(requestOptions?: EmployersClient.RequestOptions): core.HttpResponsePromise<VitableConnect.OrganizationHrisProvidersResponse>;
504
+ listHrisProviders(request?: VitableConnect.ListHrisProvidersEmployersRequest, requestOptions?: EmployersClient.RequestOptions): core.HttpResponsePromise<VitableConnect.OrganizationHrisProvidersResponse>;
504
505
  private __listHrisProviders;
505
506
  }