@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250502.1 → 1.20250509.1

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.
@@ -913,6 +913,7 @@ docs/ActiveSubscriberListVBAResponse.md
913
913
  docs/AddEnrollmentRequest.md
914
914
  docs/AdjudicateBenefitMatchDetail.md
915
915
  docs/AdjudicateBenefitMatchDetailListVBAResponse.md
916
+ docs/AdjudicationSummary.md
916
917
  docs/AdmissionTypePlace.md
917
918
  docs/AdmissionTypePlaceListVBAResponse.md
918
919
  docs/AdmissionTypePlaceVBAResponse.md
@@ -4282,6 +4283,8 @@ docs/VBAClient.md
4282
4283
  docs/VBAClientEnvironment.md
4283
4284
  docs/VBAClientEnvironmentListVBAResponse.md
4284
4285
  docs/VBAClientListVBAResponse.md
4286
+ docs/VBAClientSummary.md
4287
+ docs/VBAClientSummaryVBAResponse.md
4285
4288
  docs/VBAClientVBAResponse.md
4286
4289
  docs/VBACommissionRateSubscriber.md
4287
4290
  docs/VBACommissionRateSubscriberListVBAResponse.md
@@ -4454,6 +4457,7 @@ models/active-subscriber.ts
4454
4457
  models/add-enrollment-request.ts
4455
4458
  models/adjudicate-benefit-match-detail-list-vbaresponse.ts
4456
4459
  models/adjudicate-benefit-match-detail.ts
4460
+ models/adjudication-summary.ts
4457
4461
  models/admission-type-place-list-vbaresponse.ts
4458
4462
  models/admission-type-place-vbaresponse.ts
4459
4463
  models/admission-type-place.ts
@@ -6985,6 +6989,8 @@ models/vbaclaim-timeline.ts
6985
6989
  models/vbaclient-environment-list-vbaresponse.ts
6986
6990
  models/vbaclient-environment.ts
6987
6991
  models/vbaclient-list-vbaresponse.ts
6992
+ models/vbaclient-summary-vbaresponse.ts
6993
+ models/vbaclient-summary.ts
6988
6994
  models/vbaclient-vbaresponse.ts
6989
6995
  models/vbaclient.ts
6990
6996
  models/vbacommission-rate-subscriber-list-vbaresponse.ts
@@ -58,6 +58,53 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
58
58
 
59
59
 
60
60
 
61
+ if (vbasoftwareDatabase != null) {
62
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
63
+ }
64
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
65
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
66
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
67
+
68
+ return {
69
+ url: toPathString(localVarUrlObj),
70
+ options: localVarRequestOptions,
71
+ };
72
+ },
73
+ /**
74
+ * Ends the session of the specified user.
75
+ * @summary Forcefully terminate a user session
76
+ * @param {string} vbasoftwareDatabase Target database
77
+ * @param {string} userId User ID to kick
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ kickUser: async (vbasoftwareDatabase: string, userId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
82
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
83
+ assertParamExists('kickUser', 'vbasoftwareDatabase', vbasoftwareDatabase)
84
+ // verify required parameter 'userId' is not null or undefined
85
+ assertParamExists('kickUser', 'userId', userId)
86
+ const localVarPath = `/kick/{userId}`
87
+ .replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
88
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
89
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
90
+ let baseOptions;
91
+ if (configuration) {
92
+ baseOptions = configuration.baseOptions;
93
+ }
94
+
95
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
96
+ const localVarHeaderParameter = {} as any;
97
+ const localVarQueryParameter = {} as any;
98
+
99
+ // authentication apiKeyAuth required
100
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
101
+
102
+ // authentication bearerAuth required
103
+ // http bearer authentication required
104
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
105
+
106
+
107
+
61
108
  if (vbasoftwareDatabase != null) {
62
109
  localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
63
110
  }
@@ -136,6 +183,20 @@ export const AuthenticationApiFp = function(configuration?: Configuration) {
136
183
  const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.kickLongestSessionUser']?.[localVarOperationServerIndex]?.url;
137
184
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
138
185
  },
186
+ /**
187
+ * Ends the session of the specified user.
188
+ * @summary Forcefully terminate a user session
189
+ * @param {string} vbasoftwareDatabase Target database
190
+ * @param {string} userId User ID to kick
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ async kickUser(vbasoftwareDatabase: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
195
+ const localVarAxiosArgs = await localVarAxiosParamCreator.kickUser(vbasoftwareDatabase, userId, options);
196
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
197
+ const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.kickUser']?.[localVarOperationServerIndex]?.url;
198
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
199
+ },
139
200
  /**
140
201
  * Terminates the current user\'s session and logs them out of the system.
141
202
  * @summary Log out user
@@ -169,6 +230,17 @@ export const AuthenticationApiFactory = function (configuration?: Configuration,
169
230
  kickLongestSessionUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
170
231
  return localVarFp.kickLongestSessionUser(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
171
232
  },
233
+ /**
234
+ * Ends the session of the specified user.
235
+ * @summary Forcefully terminate a user session
236
+ * @param {string} vbasoftwareDatabase Target database
237
+ * @param {string} userId User ID to kick
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ */
241
+ kickUser(vbasoftwareDatabase: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
242
+ return localVarFp.kickUser(vbasoftwareDatabase, userId, options).then((request) => request(axios, basePath));
243
+ },
172
244
  /**
173
245
  * Terminates the current user\'s session and logs them out of the system.
174
246
  * @summary Log out user
@@ -198,6 +270,17 @@ export interface AuthenticationApiInterface {
198
270
  */
199
271
  kickLongestSessionUser(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
200
272
 
273
+ /**
274
+ * Ends the session of the specified user.
275
+ * @summary Forcefully terminate a user session
276
+ * @param {string} vbasoftwareDatabase Target database
277
+ * @param {string} userId User ID to kick
278
+ * @param {*} [options] Override http request option.
279
+ * @throws {RequiredError}
280
+ * @memberof AuthenticationApiInterface
281
+ */
282
+ kickUser(vbasoftwareDatabase: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
283
+
201
284
  /**
202
285
  * Terminates the current user\'s session and logs them out of the system.
203
286
  * @summary Log out user
@@ -229,6 +312,19 @@ export class AuthenticationApi extends BaseAPI implements AuthenticationApiInter
229
312
  return AuthenticationApiFp(this.configuration).kickLongestSessionUser(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
230
313
  }
231
314
 
315
+ /**
316
+ * Ends the session of the specified user.
317
+ * @summary Forcefully terminate a user session
318
+ * @param {string} vbasoftwareDatabase Target database
319
+ * @param {string} userId User ID to kick
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ * @memberof AuthenticationApi
323
+ */
324
+ public kickUser(vbasoftwareDatabase: string, userId: string, options?: RawAxiosRequestConfig) {
325
+ return AuthenticationApiFp(this.configuration).kickUser(vbasoftwareDatabase, userId, options).then((request) => request(this.axios, this.basePath));
326
+ }
327
+
232
328
  /**
233
329
  * Terminates the current user\'s session and logs them out of the system.
234
330
  * @summary Log out user
@@ -27,6 +27,8 @@ import type { CompanyData } from '../models';
27
27
  import type { CompanyDataListVBAResponse } from '../models';
28
28
  // @ts-ignore
29
29
  import type { CompanyDataVBAResponse } from '../models';
30
+ // @ts-ignore
31
+ import type { VBAClientSummaryVBAResponse } from '../models';
30
32
  /**
31
33
  * CompanyDataApi - axios parameter creator
32
34
  * @export
@@ -68,6 +70,49 @@ export const CompanyDataApiAxiosParamCreator = function (configuration?: Configu
68
70
 
69
71
 
70
72
 
73
+ if (vbasoftwareDatabase != null) {
74
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
75
+ }
76
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
77
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
78
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
79
+
80
+ return {
81
+ url: toPathString(localVarUrlObj),
82
+ options: localVarRequestOptions,
83
+ };
84
+ },
85
+ /**
86
+ * Get a system wide summary of various functions and information.
87
+ * @summary Get a Company Summary
88
+ * @param {string} vbasoftwareDatabase Target database
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ getCompanySummary: async (vbasoftwareDatabase: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
93
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
94
+ assertParamExists('getCompanySummary', 'vbasoftwareDatabase', vbasoftwareDatabase)
95
+ const localVarPath = `/company-summary`;
96
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
97
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
98
+ let baseOptions;
99
+ if (configuration) {
100
+ baseOptions = configuration.baseOptions;
101
+ }
102
+
103
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
104
+ const localVarHeaderParameter = {} as any;
105
+ const localVarQueryParameter = {} as any;
106
+
107
+ // authentication apiKeyAuth required
108
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
109
+
110
+ // authentication bearerAuth required
111
+ // http bearer authentication required
112
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
113
+
114
+
115
+
71
116
  if (vbasoftwareDatabase != null) {
72
117
  localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
73
118
  }
@@ -215,6 +260,19 @@ export const CompanyDataApiFp = function(configuration?: Configuration) {
215
260
  const localVarOperationServerBasePath = operationServerMap['CompanyDataApi.getCompanyData']?.[localVarOperationServerIndex]?.url;
216
261
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
217
262
  },
263
+ /**
264
+ * Get a system wide summary of various functions and information.
265
+ * @summary Get a Company Summary
266
+ * @param {string} vbasoftwareDatabase Target database
267
+ * @param {*} [options] Override http request option.
268
+ * @throws {RequiredError}
269
+ */
270
+ async getCompanySummary(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAClientSummaryVBAResponse>> {
271
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCompanySummary(vbasoftwareDatabase, options);
272
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
273
+ const localVarOperationServerBasePath = operationServerMap['CompanyDataApi.getCompanySummary']?.[localVarOperationServerIndex]?.url;
274
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
275
+ },
218
276
  /**
219
277
  * Lists all CompanyData
220
278
  * @summary List CompanyData
@@ -267,6 +325,16 @@ export const CompanyDataApiFactory = function (configuration?: Configuration, ba
267
325
  getCompanyData(vbasoftwareDatabase: string, keyValue: number, options?: RawAxiosRequestConfig): AxiosPromise<CompanyDataVBAResponse> {
268
326
  return localVarFp.getCompanyData(vbasoftwareDatabase, keyValue, options).then((request) => request(axios, basePath));
269
327
  },
328
+ /**
329
+ * Get a system wide summary of various functions and information.
330
+ * @summary Get a Company Summary
331
+ * @param {string} vbasoftwareDatabase Target database
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ getCompanySummary(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAClientSummaryVBAResponse> {
336
+ return localVarFp.getCompanySummary(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
337
+ },
270
338
  /**
271
339
  * Lists all CompanyData
272
340
  * @summary List CompanyData
@@ -312,6 +380,16 @@ export interface CompanyDataApiInterface {
312
380
  */
313
381
  getCompanyData(vbasoftwareDatabase: string, keyValue: number, options?: RawAxiosRequestConfig): AxiosPromise<CompanyDataVBAResponse>;
314
382
 
383
+ /**
384
+ * Get a system wide summary of various functions and information.
385
+ * @summary Get a Company Summary
386
+ * @param {string} vbasoftwareDatabase Target database
387
+ * @param {*} [options] Override http request option.
388
+ * @throws {RequiredError}
389
+ * @memberof CompanyDataApiInterface
390
+ */
391
+ getCompanySummary(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<VBAClientSummaryVBAResponse>;
392
+
315
393
  /**
316
394
  * Lists all CompanyData
317
395
  * @summary List CompanyData
@@ -359,6 +437,18 @@ export class CompanyDataApi extends BaseAPI implements CompanyDataApiInterface {
359
437
  return CompanyDataApiFp(this.configuration).getCompanyData(vbasoftwareDatabase, keyValue, options).then((request) => request(this.axios, this.basePath));
360
438
  }
361
439
 
440
+ /**
441
+ * Get a system wide summary of various functions and information.
442
+ * @summary Get a Company Summary
443
+ * @param {string} vbasoftwareDatabase Target database
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ * @memberof CompanyDataApi
447
+ */
448
+ public getCompanySummary(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig) {
449
+ return CompanyDataApiFp(this.configuration).getCompanySummary(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
450
+ }
451
+
362
452
  /**
363
453
  * Lists all CompanyData
364
454
  * @summary List CompanyData
package/api/user-api.ts CHANGED
@@ -501,13 +501,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
501
501
  };
502
502
  },
503
503
  /**
504
- * Lists all Users
504
+ * Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
505
505
  * @summary List Users
506
506
  * @param {string} vbasoftwareDatabase Target database
507
+ * @param {number} [loginStatus] Optional filter for login status (1&#x3D;Logged In, 2&#x3D;Logged Out, 3&#x3D;Kicked)
507
508
  * @param {*} [options] Override http request option.
508
509
  * @throws {RequiredError}
509
510
  */
510
- listUsers: async (vbasoftwareDatabase: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
511
+ listUsers: async (vbasoftwareDatabase: string, loginStatus?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
511
512
  // verify required parameter 'vbasoftwareDatabase' is not null or undefined
512
513
  assertParamExists('listUsers', 'vbasoftwareDatabase', vbasoftwareDatabase)
513
514
  const localVarPath = `/users`;
@@ -529,6 +530,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
529
530
  // http bearer authentication required
530
531
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
531
532
 
533
+ if (loginStatus !== undefined) {
534
+ localVarQueryParameter['loginStatus'] = loginStatus;
535
+ }
536
+
532
537
 
533
538
 
534
539
  if (vbasoftwareDatabase != null) {
@@ -1126,14 +1131,15 @@ export const UserApiFp = function(configuration?: Configuration) {
1126
1131
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1127
1132
  },
1128
1133
  /**
1129
- * Lists all Users
1134
+ * Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
1130
1135
  * @summary List Users
1131
1136
  * @param {string} vbasoftwareDatabase Target database
1137
+ * @param {number} [loginStatus] Optional filter for login status (1&#x3D;Logged In, 2&#x3D;Logged Out, 3&#x3D;Kicked)
1132
1138
  * @param {*} [options] Override http request option.
1133
1139
  * @throws {RequiredError}
1134
1140
  */
1135
- async listUsers(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersListVBAResponse>> {
1136
- const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(vbasoftwareDatabase, options);
1141
+ async listUsers(vbasoftwareDatabase: string, loginStatus?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersListVBAResponse>> {
1142
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(vbasoftwareDatabase, loginStatus, options);
1137
1143
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1138
1144
  const localVarOperationServerBasePath = operationServerMap['UserApi.listUsers']?.[localVarOperationServerIndex]?.url;
1139
1145
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1376,14 +1382,15 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1376
1382
  return localVarFp.getUser(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
1377
1383
  },
1378
1384
  /**
1379
- * Lists all Users
1385
+ * Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
1380
1386
  * @summary List Users
1381
1387
  * @param {string} vbasoftwareDatabase Target database
1388
+ * @param {number} [loginStatus] Optional filter for login status (1&#x3D;Logged In, 2&#x3D;Logged Out, 3&#x3D;Kicked)
1382
1389
  * @param {*} [options] Override http request option.
1383
1390
  * @throws {RequiredError}
1384
1391
  */
1385
- listUsers(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<UsersListVBAResponse> {
1386
- return localVarFp.listUsers(vbasoftwareDatabase, options).then((request) => request(axios, basePath));
1392
+ listUsers(vbasoftwareDatabase: string, loginStatus?: number, options?: RawAxiosRequestConfig): AxiosPromise<UsersListVBAResponse> {
1393
+ return localVarFp.listUsers(vbasoftwareDatabase, loginStatus, options).then((request) => request(axios, basePath));
1387
1394
  },
1388
1395
  /**
1389
1396
  * Uses the Refresh Token to obtain new JWT tokens to extend the user\'s session.
@@ -1598,14 +1605,15 @@ export interface UserApiInterface {
1598
1605
  getUser(vbasoftwareDatabase: string, userID: string, options?: RawAxiosRequestConfig): AxiosPromise<UsersVBAResponse>;
1599
1606
 
1600
1607
  /**
1601
- * Lists all Users
1608
+ * Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
1602
1609
  * @summary List Users
1603
1610
  * @param {string} vbasoftwareDatabase Target database
1611
+ * @param {number} [loginStatus] Optional filter for login status (1&#x3D;Logged In, 2&#x3D;Logged Out, 3&#x3D;Kicked)
1604
1612
  * @param {*} [options] Override http request option.
1605
1613
  * @throws {RequiredError}
1606
1614
  * @memberof UserApiInterface
1607
1615
  */
1608
- listUsers(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<UsersListVBAResponse>;
1616
+ listUsers(vbasoftwareDatabase: string, loginStatus?: number, options?: RawAxiosRequestConfig): AxiosPromise<UsersListVBAResponse>;
1609
1617
 
1610
1618
  /**
1611
1619
  * Uses the Refresh Token to obtain new JWT tokens to extend the user\'s session.
@@ -1838,15 +1846,16 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1838
1846
  }
1839
1847
 
1840
1848
  /**
1841
- * Lists all Users
1849
+ * Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
1842
1850
  * @summary List Users
1843
1851
  * @param {string} vbasoftwareDatabase Target database
1852
+ * @param {number} [loginStatus] Optional filter for login status (1&#x3D;Logged In, 2&#x3D;Logged Out, 3&#x3D;Kicked)
1844
1853
  * @param {*} [options] Override http request option.
1845
1854
  * @throws {RequiredError}
1846
1855
  * @memberof UserApi
1847
1856
  */
1848
- public listUsers(vbasoftwareDatabase: string, options?: RawAxiosRequestConfig) {
1849
- return UserApiFp(this.configuration).listUsers(vbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
1857
+ public listUsers(vbasoftwareDatabase: string, loginStatus?: number, options?: RawAxiosRequestConfig) {
1858
+ return UserApiFp(this.configuration).listUsers(vbasoftwareDatabase, loginStatus, options).then((request) => request(this.axios, this.basePath));
1850
1859
  }
1851
1860
 
1852
1861
  /**
@@ -0,0 +1,34 @@
1
+ # AdjudicationSummary
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **received_Month** | **number** | | [optional] [default to undefined]
9
+ **received_Year** | **number** | | [optional] [default to undefined]
10
+ **received_Month_Name** | **string** | | [optional] [default to undefined]
11
+ **claim_Count** | **number** | | [optional] [default to undefined]
12
+ **claim_Billed** | **number** | | [optional] [default to undefined]
13
+ **claim_Paid** | **number** | | [optional] [default to undefined]
14
+ **auto_Adjudicate_Rate** | **number** | | [optional] [default to undefined]
15
+ **average_Adjudicate_Duration** | **number** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { AdjudicationSummary } from './api';
21
+
22
+ const instance: AdjudicationSummary = {
23
+ received_Month,
24
+ received_Year,
25
+ received_Month_Name,
26
+ claim_Count,
27
+ claim_Billed,
28
+ claim_Paid,
29
+ auto_Adjudicate_Rate,
30
+ average_Adjudicate_Duration,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,6 +5,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**kickLongestSessionUser**](#kicklongestsessionuser) | **POST** /kick | Forcefully terminate the longest active user session|
8
+ |[**kickUser**](#kickuser) | **POST** /kick/{userId} | Forcefully terminate a user session|
8
9
  |[**logoutUser**](#logoutuser) | **POST** /logout | Log out user|
9
10
 
10
11
  # **kickLongestSessionUser**
@@ -59,6 +60,61 @@ void (empty response body)
59
60
 
60
61
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
61
62
 
63
+ # **kickUser**
64
+ > kickUser()
65
+
66
+ Ends the session of the specified user.
67
+
68
+ ### Example
69
+
70
+ ```typescript
71
+ import {
72
+ AuthenticationApi,
73
+ Configuration
74
+ } from './api';
75
+
76
+ const configuration = new Configuration();
77
+ const apiInstance = new AuthenticationApi(configuration);
78
+
79
+ let vbasoftwareDatabase: string; //Target database (default to undefined)
80
+ let userId: string; //User ID to kick (default to undefined)
81
+
82
+ const { status, data } = await apiInstance.kickUser(
83
+ vbasoftwareDatabase,
84
+ userId
85
+ );
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ |Name | Type | Description | Notes|
91
+ |------------- | ------------- | ------------- | -------------|
92
+ | **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
93
+ | **userId** | [**string**] | User ID to kick | defaults to undefined|
94
+
95
+
96
+ ### Return type
97
+
98
+ void (empty response body)
99
+
100
+ ### Authorization
101
+
102
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
103
+
104
+ ### HTTP request headers
105
+
106
+ - **Content-Type**: Not defined
107
+ - **Accept**: Not defined
108
+
109
+
110
+ ### HTTP response details
111
+ | Status code | Description | Response headers |
112
+ |-------------|-------------|------------------|
113
+ |**204** | User session terminated successfully | - |
114
+ |**401** | Unauthorized | - |
115
+
116
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
117
+
62
118
  # **logoutUser**
63
119
  > logoutUser()
64
120
 
@@ -5,6 +5,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getCompanyData**](#getcompanydata) | **GET** /company-data/{keyValue} | Get CompanyData|
8
+ |[**getCompanySummary**](#getcompanysummary) | **GET** /company-summary | Get a Company Summary|
8
9
  |[**listCompanyData**](#listcompanydata) | **GET** /company-data | List CompanyData|
9
10
  |[**updateCompanyData**](#updatecompanydata) | **PUT** /company-data/{keyValue} | Update CompanyData|
10
11
 
@@ -55,6 +56,58 @@ const { status, data } = await apiInstance.getCompanyData(
55
56
  - **Accept**: text/plain, application/json, text/json
56
57
 
57
58
 
59
+ ### HTTP response details
60
+ | Status code | Description | Response headers |
61
+ |-------------|-------------|------------------|
62
+ |**200** | Success | - |
63
+ |**401** | Unauthorized | - |
64
+
65
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
66
+
67
+ # **getCompanySummary**
68
+ > VBAClientSummaryVBAResponse getCompanySummary()
69
+
70
+ Get a system wide summary of various functions and information.
71
+
72
+ ### Example
73
+
74
+ ```typescript
75
+ import {
76
+ CompanyDataApi,
77
+ Configuration
78
+ } from './api';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new CompanyDataApi(configuration);
82
+
83
+ let vbasoftwareDatabase: string; //Target database (default to undefined)
84
+
85
+ const { status, data } = await apiInstance.getCompanySummary(
86
+ vbasoftwareDatabase
87
+ );
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ |Name | Type | Description | Notes|
93
+ |------------- | ------------- | ------------- | -------------|
94
+ | **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
95
+
96
+
97
+ ### Return type
98
+
99
+ **VBAClientSummaryVBAResponse**
100
+
101
+ ### Authorization
102
+
103
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: Not defined
108
+ - **Accept**: text/plain, application/json, text/json
109
+
110
+
58
111
  ### HTTP response details
59
112
  | Status code | Description | Response headers |
60
113
  |-------------|-------------|------------------|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **subscriber_ID** | **string** | References Members.Subscriber_ID value on the parent record. | [default to undefined]
9
9
  **member_Seq** | **string** | References Members.Member_Seq value on the parent record. | [default to undefined]
10
- **beneficiary_ID** | **string** | Unique identifier for this beneficiary on this member. | [default to undefined]
10
+ **beneficiary_ID** | **string** | Unique identifier for this beneficiary on this member. | [optional] [default to undefined]
11
11
  **address** | **string** | Primary address of the Beneficiary. | [optional] [default to undefined]
12
12
  **address2** | **string** | Address line 2 of the Beneficiary\&#39;s primary address. | [optional] [default to undefined]
13
13
  **assignment** | **number** | A set amount paid to a beneficiary. | [optional] [default to undefined]
package/docs/UserApi.md CHANGED
@@ -536,7 +536,7 @@ const { status, data } = await apiInstance.getUser(
536
536
  # **listUsers**
537
537
  > UsersListVBAResponse listUsers()
538
538
 
539
- Lists all Users
539
+ Lists all Users with an optional filter for login status. Login status values: 1=Logged In, 2=Logged Out, 3=Kicked.
540
540
 
541
541
  ### Example
542
542
 
@@ -550,9 +550,11 @@ const configuration = new Configuration();
550
550
  const apiInstance = new UserApi(configuration);
551
551
 
552
552
  let vbasoftwareDatabase: string; //Target database (default to undefined)
553
+ let loginStatus: number; //Optional filter for login status (1=Logged In, 2=Logged Out, 3=Kicked) (optional) (default to undefined)
553
554
 
554
555
  const { status, data } = await apiInstance.listUsers(
555
- vbasoftwareDatabase
556
+ vbasoftwareDatabase,
557
+ loginStatus
556
558
  );
557
559
  ```
558
560
 
@@ -561,6 +563,7 @@ const { status, data } = await apiInstance.listUsers(
561
563
  |Name | Type | Description | Notes|
562
564
  |------------- | ------------- | ------------- | -------------|
563
565
  | **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
566
+ | **loginStatus** | [**number**] | Optional filter for login status (1&#x3D;Logged In, 2&#x3D;Logged Out, 3&#x3D;Kicked) | (optional) defaults to undefined|
564
567
 
565
568
 
566
569
  ### Return type
@@ -0,0 +1,48 @@
1
+ # VBAClientSummary
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **active_Group_Count** | **number** | | [optional] [default to undefined]
9
+ **active_Subscriber_Count** | **number** | | [optional] [default to undefined]
10
+ **active_Member_Count** | **number** | | [optional] [default to undefined]
11
+ **total_Users** | **number** | | [optional] [default to undefined]
12
+ **logged_In_Users** | **number** | | [optional] [default to undefined]
13
+ **total_Claim_Count** | **number** | | [optional] [default to undefined]
14
+ **total_Billed** | **number** | | [optional] [default to undefined]
15
+ **total_Paid** | **number** | | [optional] [default to undefined]
16
+ **reinsurance_Contract_Count** | **number** | | [optional] [default to undefined]
17
+ **premium_Invoice_Count** | **number** | | [optional] [default to undefined]
18
+ **premium_Rate_Count** | **number** | | [optional] [default to undefined]
19
+ **commission_Count** | **number** | | [optional] [default to undefined]
20
+ **callTracking_Count** | **number** | | [optional] [default to undefined]
21
+ **note_Count** | **number** | | [optional] [default to undefined]
22
+ **adjudicationSummaries** | [**Array&lt;AdjudicationSummary&gt;**](AdjudicationSummary.md) | | [optional] [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { VBAClientSummary } from './api';
28
+
29
+ const instance: VBAClientSummary = {
30
+ active_Group_Count,
31
+ active_Subscriber_Count,
32
+ active_Member_Count,
33
+ total_Users,
34
+ logged_In_Users,
35
+ total_Claim_Count,
36
+ total_Billed,
37
+ total_Paid,
38
+ reinsurance_Contract_Count,
39
+ premium_Invoice_Count,
40
+ premium_Rate_Count,
41
+ commission_Count,
42
+ callTracking_Count,
43
+ note_Count,
44
+ adjudicationSummaries,
45
+ };
46
+ ```
47
+
48
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # VBAClientSummaryVBAResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**VBAClientSummary**](VBAClientSummary.md) | | [optional] [default to undefined]
9
+ **error** | [**VBAProblemDetails**](VBAProblemDetails.md) | | [optional] [default to undefined]
10
+ **debug** | [**Debug**](Debug.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { VBAClientSummaryVBAResponse } from './api';
16
+
17
+ const instance: VBAClientSummaryVBAResponse = {
18
+ data,
19
+ error,
20
+ debug,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,15 +5,15 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **payment_File_Format_Key** | **number** | Used in both Rate Copy and Rate Change | [optional] [default to undefined]
9
- **payment_File** | **string** | This MUST be a .csv file with the following columns (Include Headers with field name): &lt;div&gt; Payment_Type - Use a value from the PremPaymentType table (can be null) Payment_Batch - Source system indicator for the payment batch (can be null) Payment_Batch_Seq - Source system indicator for the payment batch sequence (can be null) Payment_Account - The name of the account that the payment is being made from - required Payment_ID - The unique identifier for the payment - required Payment_Date - The date the payment was made in YYYY-MM-DD format - required Payment_Amount - The amount of the payment - required Payment_Name - The name of the person or entity making the payment - required Group_ID - If this payment is for the entire group, this should be the Group_ID - can be null Division_ID - If this payment is for the entire division, this should be the Division_ID - can be null Subscriber_ID - If this payment is for a specific subscriber, this should be the Subscriber_ID - can be null Payor_ID - The Payor_ID to be set on the created payments - required Account_Key - The Account_Key to be set on the created payments - required Invoice_Key - If this payment is to be applied to a specific invoice, this should be the Invoice_Key - can be null PremRate_Key - If this payment is to be applied to a specific rate, this should be the PremRate_Key - can be null PremPayment_Key - If this payment is to be applied to a specific payment, this should be the PremPayment_Key - can be null&lt;/div&gt; | [optional] [default to undefined]
10
- **payor_ID** | **string** | The Payor to be set on the created payments | [optional] [default to undefined]
11
- **account_Key** | **number** | The Account to be set on the created payments | [optional] [default to undefined]
12
- **create_Invoice_Payments** | **boolean** | Indicates that payments should be created from the payment file | [optional] [default to undefined]
13
- **apply_Payments** | **boolean** | Indicates that payments should be applied to invoices | [optional] [default to undefined]
14
- **close_Invoices** | **boolean** | Indicates that invoices should be closed after payment is applied | [optional] [default to undefined]
15
- **only_Close_Satisfied_Invoices** | **boolean** | Indicates that only fully satisfied invoices should be closed | [optional] [default to undefined]
16
- **user_ID** | **string** | User ID performing the Payment File import | [optional] [default to undefined]
8
+ **payment_File_Format_Key** | **number** | Used in both Rate Copy and Rate Change operations. | [optional] [default to undefined]
9
+ **payment_File** | **string** | A .csv file with headers and the following columns: - **Payment_Type**: Value from the PremPaymentType table (optional) - **Payment_Batch**: Source system batch indicator (optional) - **Payment_Batch_Seq**: Source system batch sequence (optional) - **Payment_Account**: Name of the paying account (required) - **Payment_ID**: Unique identifier for the payment (required) - **Payment_Date**: Date of payment in YYYY-MM-DD format (required) - **Payment_Amount**: Amount of the payment (required) - **Payment_Name**: Name of the payer (required) - **Group_ID**: Group identifier if applicable (optional) - **Division_ID**: Division identifier if applicable (optional) - **Subscriber_ID**: Subscriber identifier if applicable (optional) - **Payor_ID**: Payor ID for created payments (required) - **Account_Key**: Account key for created payments (required) - **Invoice_Key**: Invoice key to apply the payment to (optional) - **PremRate_Key**: Rate key to apply the payment to (optional) - **PremPayment_Key**: Existing payment key to apply the payment to (optional) | [optional] [default to undefined]
10
+ **payor_ID** | **string** | The Payor ID to assign to the created payments. | [optional] [default to undefined]
11
+ **account_Key** | **number** | The Account Key to be assign to the created payments. | [optional] [default to undefined]
12
+ **create_Invoice_Payments** | **boolean** | Set to true to create invoice payments from the file. | [optional] [default to undefined]
13
+ **apply_Payments** | **boolean** | Set to true to apply payments to matching invoices. | [optional] [default to undefined]
14
+ **close_Invoices** | **boolean** | Set to true to close invoices after payment is applied. | [optional] [default to undefined]
15
+ **only_Close_Satisfied_Invoices** | **boolean** | If true, only fully satisfied invoices will be closed. | [optional] [default to undefined]
16
+ **user_ID** | **string** | ID of the user performing the Payment File import. | [optional] [default to undefined]
17
17
 
18
18
  ## Example
19
19
 
@@ -0,0 +1,72 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * VBASoftware
5
+ * APIs for VBASoftware
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface AdjudicationSummary
21
+ */
22
+ export interface AdjudicationSummary {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof AdjudicationSummary
27
+ */
28
+ 'received_Month'?: number | null;
29
+ /**
30
+ *
31
+ * @type {number}
32
+ * @memberof AdjudicationSummary
33
+ */
34
+ 'received_Year'?: number | null;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof AdjudicationSummary
39
+ */
40
+ 'received_Month_Name'?: string | null;
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof AdjudicationSummary
45
+ */
46
+ 'claim_Count'?: number | null;
47
+ /**
48
+ *
49
+ * @type {number}
50
+ * @memberof AdjudicationSummary
51
+ */
52
+ 'claim_Billed'?: number | null;
53
+ /**
54
+ *
55
+ * @type {number}
56
+ * @memberof AdjudicationSummary
57
+ */
58
+ 'claim_Paid'?: number | null;
59
+ /**
60
+ *
61
+ * @type {number}
62
+ * @memberof AdjudicationSummary
63
+ */
64
+ 'auto_Adjudicate_Rate'?: number | null;
65
+ /**
66
+ *
67
+ * @type {number}
68
+ * @memberof AdjudicationSummary
69
+ */
70
+ 'average_Adjudicate_Duration'?: number | null;
71
+ }
72
+
package/models/index.ts CHANGED
@@ -21,6 +21,7 @@ export * from './active-subscriber-list-vbaresponse';
21
21
  export * from './add-enrollment-request';
22
22
  export * from './adjudicate-benefit-match-detail';
23
23
  export * from './adjudicate-benefit-match-detail-list-vbaresponse';
24
+ export * from './adjudication-summary';
24
25
  export * from './admission-type-place';
25
26
  export * from './admission-type-place-list-vbaresponse';
26
27
  export * from './admission-type-place-vbaresponse';
@@ -2543,6 +2544,8 @@ export * from './vbaclient';
2543
2544
  export * from './vbaclient-environment';
2544
2545
  export * from './vbaclient-environment-list-vbaresponse';
2545
2546
  export * from './vbaclient-list-vbaresponse';
2547
+ export * from './vbaclient-summary';
2548
+ export * from './vbaclient-summary-vbaresponse';
2546
2549
  export * from './vbaclient-vbaresponse';
2547
2550
  export * from './vbacommission-rate-subscriber';
2548
2551
  export * from './vbacommission-rate-subscriber-list-vbaresponse';
@@ -37,7 +37,7 @@ export interface MemberBeneficiary {
37
37
  * @type {string}
38
38
  * @memberof MemberBeneficiary
39
39
  */
40
- 'beneficiary_ID': string;
40
+ 'beneficiary_ID'?: string | null;
41
41
  /**
42
42
  * Primary address of the Beneficiary.
43
43
  * @type {string}
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * VBASoftware
5
+ * APIs for VBASoftware
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { Debug } from './debug';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { VBAClientSummary } from './vbaclient-summary';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import type { VBAProblemDetails } from './vbaproblem-details';
25
+
26
+ /**
27
+ *
28
+ * @export
29
+ * @interface VBAClientSummaryVBAResponse
30
+ */
31
+ export interface VBAClientSummaryVBAResponse {
32
+ /**
33
+ *
34
+ * @type {VBAClientSummary}
35
+ * @memberof VBAClientSummaryVBAResponse
36
+ */
37
+ 'data'?: VBAClientSummary;
38
+ /**
39
+ *
40
+ * @type {VBAProblemDetails}
41
+ * @memberof VBAClientSummaryVBAResponse
42
+ */
43
+ 'error'?: VBAProblemDetails;
44
+ /**
45
+ *
46
+ * @type {Debug}
47
+ * @memberof VBAClientSummaryVBAResponse
48
+ */
49
+ 'debug'?: Debug;
50
+ }
51
+
@@ -0,0 +1,117 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * VBASoftware
5
+ * APIs for VBASoftware
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { AdjudicationSummary } from './adjudication-summary';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface VBAClientSummary
24
+ */
25
+ export interface VBAClientSummary {
26
+ /**
27
+ *
28
+ * @type {number}
29
+ * @memberof VBAClientSummary
30
+ */
31
+ 'active_Group_Count'?: number | null;
32
+ /**
33
+ *
34
+ * @type {number}
35
+ * @memberof VBAClientSummary
36
+ */
37
+ 'active_Subscriber_Count'?: number | null;
38
+ /**
39
+ *
40
+ * @type {number}
41
+ * @memberof VBAClientSummary
42
+ */
43
+ 'active_Member_Count'?: number | null;
44
+ /**
45
+ *
46
+ * @type {number}
47
+ * @memberof VBAClientSummary
48
+ */
49
+ 'total_Users'?: number | null;
50
+ /**
51
+ *
52
+ * @type {number}
53
+ * @memberof VBAClientSummary
54
+ */
55
+ 'logged_In_Users'?: number | null;
56
+ /**
57
+ *
58
+ * @type {number}
59
+ * @memberof VBAClientSummary
60
+ */
61
+ 'total_Claim_Count'?: number | null;
62
+ /**
63
+ *
64
+ * @type {number}
65
+ * @memberof VBAClientSummary
66
+ */
67
+ 'total_Billed'?: number | null;
68
+ /**
69
+ *
70
+ * @type {number}
71
+ * @memberof VBAClientSummary
72
+ */
73
+ 'total_Paid'?: number | null;
74
+ /**
75
+ *
76
+ * @type {number}
77
+ * @memberof VBAClientSummary
78
+ */
79
+ 'reinsurance_Contract_Count'?: number | null;
80
+ /**
81
+ *
82
+ * @type {number}
83
+ * @memberof VBAClientSummary
84
+ */
85
+ 'premium_Invoice_Count'?: number | null;
86
+ /**
87
+ *
88
+ * @type {number}
89
+ * @memberof VBAClientSummary
90
+ */
91
+ 'premium_Rate_Count'?: number | null;
92
+ /**
93
+ *
94
+ * @type {number}
95
+ * @memberof VBAClientSummary
96
+ */
97
+ 'commission_Count'?: number | null;
98
+ /**
99
+ *
100
+ * @type {number}
101
+ * @memberof VBAClientSummary
102
+ */
103
+ 'callTracking_Count'?: number | null;
104
+ /**
105
+ *
106
+ * @type {number}
107
+ * @memberof VBAClientSummary
108
+ */
109
+ 'note_Count'?: number | null;
110
+ /**
111
+ *
112
+ * @type {Array<AdjudicationSummary>}
113
+ * @memberof VBAClientSummary
114
+ */
115
+ 'adjudicationSummaries'?: Array<AdjudicationSummary> | null;
116
+ }
117
+
@@ -21,55 +21,55 @@
21
21
  */
22
22
  export interface VBAProcessPaymentFile {
23
23
  /**
24
- * Used in both Rate Copy and Rate Change
24
+ * Used in both Rate Copy and Rate Change operations.
25
25
  * @type {number}
26
26
  * @memberof VBAProcessPaymentFile
27
27
  */
28
28
  'payment_File_Format_Key'?: number;
29
29
  /**
30
- * This MUST be a .csv file with the following columns (Include Headers with field name): <div> Payment_Type - Use a value from the PremPaymentType table (can be null) Payment_Batch - Source system indicator for the payment batch (can be null) Payment_Batch_Seq - Source system indicator for the payment batch sequence (can be null) Payment_Account - The name of the account that the payment is being made from - required Payment_ID - The unique identifier for the payment - required Payment_Date - The date the payment was made in YYYY-MM-DD format - required Payment_Amount - The amount of the payment - required Payment_Name - The name of the person or entity making the payment - required Group_ID - If this payment is for the entire group, this should be the Group_ID - can be null Division_ID - If this payment is for the entire division, this should be the Division_ID - can be null Subscriber_ID - If this payment is for a specific subscriber, this should be the Subscriber_ID - can be null Payor_ID - The Payor_ID to be set on the created payments - required Account_Key - The Account_Key to be set on the created payments - required Invoice_Key - If this payment is to be applied to a specific invoice, this should be the Invoice_Key - can be null PremRate_Key - If this payment is to be applied to a specific rate, this should be the PremRate_Key - can be null PremPayment_Key - If this payment is to be applied to a specific payment, this should be the PremPayment_Key - can be null</div>
30
+ * A .csv file with headers and the following columns: - **Payment_Type**: Value from the PremPaymentType table (optional) - **Payment_Batch**: Source system batch indicator (optional) - **Payment_Batch_Seq**: Source system batch sequence (optional) - **Payment_Account**: Name of the paying account (required) - **Payment_ID**: Unique identifier for the payment (required) - **Payment_Date**: Date of payment in YYYY-MM-DD format (required) - **Payment_Amount**: Amount of the payment (required) - **Payment_Name**: Name of the payer (required) - **Group_ID**: Group identifier if applicable (optional) - **Division_ID**: Division identifier if applicable (optional) - **Subscriber_ID**: Subscriber identifier if applicable (optional) - **Payor_ID**: Payor ID for created payments (required) - **Account_Key**: Account key for created payments (required) - **Invoice_Key**: Invoice key to apply the payment to (optional) - **PremRate_Key**: Rate key to apply the payment to (optional) - **PremPayment_Key**: Existing payment key to apply the payment to (optional)
31
31
  * @type {string}
32
32
  * @memberof VBAProcessPaymentFile
33
33
  */
34
34
  'payment_File'?: string | null;
35
35
  /**
36
- * The Payor to be set on the created payments
36
+ * The Payor ID to assign to the created payments.
37
37
  * @type {string}
38
38
  * @memberof VBAProcessPaymentFile
39
39
  */
40
40
  'payor_ID'?: string | null;
41
41
  /**
42
- * The Account to be set on the created payments
42
+ * The Account Key to be assign to the created payments.
43
43
  * @type {number}
44
44
  * @memberof VBAProcessPaymentFile
45
45
  */
46
46
  'account_Key'?: number;
47
47
  /**
48
- * Indicates that payments should be created from the payment file
48
+ * Set to true to create invoice payments from the file.
49
49
  * @type {boolean}
50
50
  * @memberof VBAProcessPaymentFile
51
51
  */
52
52
  'create_Invoice_Payments'?: boolean;
53
53
  /**
54
- * Indicates that payments should be applied to invoices
54
+ * Set to true to apply payments to matching invoices.
55
55
  * @type {boolean}
56
56
  * @memberof VBAProcessPaymentFile
57
57
  */
58
58
  'apply_Payments'?: boolean;
59
59
  /**
60
- * Indicates that invoices should be closed after payment is applied
60
+ * Set to true to close invoices after payment is applied.
61
61
  * @type {boolean}
62
62
  * @memberof VBAProcessPaymentFile
63
63
  */
64
64
  'close_Invoices'?: boolean;
65
65
  /**
66
- * Indicates that only fully satisfied invoices should be closed
66
+ * If true, only fully satisfied invoices will be closed.
67
67
  * @type {boolean}
68
68
  * @memberof VBAProcessPaymentFile
69
69
  */
70
70
  'only_Close_Satisfied_Invoices'?: boolean;
71
71
  /**
72
- * User ID performing the Payment File import
72
+ * ID of the user performing the Payment File import.
73
73
  * @type {string}
74
74
  * @memberof VBAProcessPaymentFile
75
75
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vbasoftware/vbapi-vbasoftware-typescript-axios",
3
- "version": "1.20250502.1",
3
+ "version": "1.20250509.1",
4
4
  "main": "index.js",
5
5
  "directories": {
6
6
  "doc": "docs"