@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240302.1 → 1.20240531.2

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 (179) hide show
  1. package/.openapi-generator/FILES +132 -0
  2. package/api/accounting-api.ts +165 -0
  3. package/api/adv-accounting-api.ts +99 -0
  4. package/api/adv-billing-api.ts +1973 -0
  5. package/api/adv-claim-api.ts +731 -0
  6. package/api/adv-enrollment-api.ts +377 -0
  7. package/api/billing-api.ts +165 -0
  8. package/api/claim-batch-api.ts +121 -0
  9. package/api/claim-batch-details-api.ts +140 -0
  10. package/api/commission-rate-cluster-agency-rep-api.ts +677 -0
  11. package/api/disability-event-case-changes-api.ts +677 -0
  12. package/api/disability-event-deduction-changes-api.ts +677 -0
  13. package/api/disability-event-field-changes-api.ts +677 -0
  14. package/api/disability-event-fields-api.ts +677 -0
  15. package/api/disability-event-groups-api.ts +677 -0
  16. package/api/disaster-locations-api.ts +677 -0
  17. package/api/disasters-api.ts +677 -0
  18. package/api/fee-schedules-api.ts +163 -0
  19. package/api/group-achpulls-api.ts +725 -0
  20. package/api/group-bill-cycle-payment-methods-api.ts +677 -0
  21. package/api/group-network-criterias-api.ts +31 -13
  22. package/api/member-address-history-api.ts +773 -0
  23. package/api/member-pre-ex-disclosed-diags-api.ts +773 -0
  24. package/api/payment-methods-api.ts +772 -0
  25. package/api/premium-distributions-api.ts +222 -0
  26. package/api/premium-invoice-subscribers-api.ts +291 -0
  27. package/api/premium-invoices-api.ts +1577 -219
  28. package/api/premium-rate-add-ons-api.ts +725 -0
  29. package/api/premium-rates-api.ts +119 -0
  30. package/api/security-field-set-details-api.ts +733 -0
  31. package/api/security-field-sets-api.ts +677 -0
  32. package/api/security-field-user-groups-api.ts +677 -0
  33. package/api/security-field-users-api.ts +677 -0
  34. package/api/security-fields-api.ts +677 -0
  35. package/api/subscriber-enrollments-api.ts +111 -0
  36. package/api/subscriber-sponsors-api.ts +677 -0
  37. package/api/subscriber-writing-agents-api.ts +725 -0
  38. package/api/subscribers-api.ts +315 -0
  39. package/api/tolerances-api.ts +677 -0
  40. package/api/user-api.ts +545 -0
  41. package/api/user-field-security-api.ts +191 -0
  42. package/api/user-group-mappings-api.ts +101 -5
  43. package/api.ts +27 -0
  44. package/models/adjudicate-benefit-match-detail-list-vbaresponse.ts +45 -0
  45. package/models/adjudicate-benefit-match-detail.ts +198 -0
  46. package/models/billing-refund.ts +126 -0
  47. package/models/call-tracking-diag-codes.ts +1 -1
  48. package/models/check-batch.ts +1 -1
  49. package/models/claim-adjustment-config.ts +121 -0
  50. package/models/claim-custom-ex-code-rule.ts +50 -20
  51. package/models/cobraplan-criteria.ts +36 -0
  52. package/models/commission-rate-cluster-agency-rep-list-vbaresponse.ts +45 -0
  53. package/models/commission-rate-cluster-agency-rep-vbaresponse.ts +45 -0
  54. package/models/commission-rate-cluster-agency-rep.ts +102 -0
  55. package/models/company-data.ts +98 -80
  56. package/models/copy-group-division.ts +4 -10
  57. package/models/criteria-detail.ts +1 -1
  58. package/models/disability-event-case-changed-list-vbaresponse.ts +45 -0
  59. package/models/disability-event-case-changed-vbaresponse.ts +45 -0
  60. package/models/disability-event-case-changed.ts +78 -0
  61. package/models/disability-event-deduction-changed-list-vbaresponse.ts +45 -0
  62. package/models/disability-event-deduction-changed-vbaresponse.ts +45 -0
  63. package/models/disability-event-deduction-changed.ts +72 -0
  64. package/models/disability-event-field-changed-list-vbaresponse.ts +45 -0
  65. package/models/disability-event-field-changed-vbaresponse.ts +45 -0
  66. package/models/disability-event-field-changed.ts +72 -0
  67. package/models/disability-event-field-list-vbaresponse.ts +45 -0
  68. package/models/disability-event-field-vbaresponse.ts +45 -0
  69. package/models/disability-event-field.ts +60 -0
  70. package/models/disability-event-group-list-vbaresponse.ts +45 -0
  71. package/models/disability-event-group-vbaresponse.ts +45 -0
  72. package/models/disability-event-group.ts +78 -0
  73. package/models/disaster-list-vbaresponse.ts +45 -0
  74. package/models/disaster-location-list-vbaresponse.ts +45 -0
  75. package/models/disaster-location-vbaresponse.ts +45 -0
  76. package/models/disaster-location.ts +78 -0
  77. package/models/disaster-vbaresponse.ts +45 -0
  78. package/models/disaster.ts +84 -0
  79. package/models/enrollment-reenroll.ts +13 -0
  80. package/models/enrollment-waiting-period-by-hire-date-list-vbaresponse.ts +45 -0
  81. package/models/enrollment-waiting-period-by-hire-date.ts +48 -0
  82. package/models/fee-sched-detail.ts +1 -1
  83. package/models/fee-sched-modifier-discount.ts +1 -1
  84. package/models/fee-sched-procedure-group-adjust.ts +1 -1
  85. package/models/fee-sched-provider-type-discount.ts +1 -1
  86. package/models/funding-process-claim-refund.ts +66 -0
  87. package/models/funding-request.ts +1 -1
  88. package/models/generate-authenticator-qrcode-request.ts +30 -0
  89. package/models/generate-authenticator-qrcode-response-vbaresponse.ts +45 -0
  90. package/models/generate-authenticator-qrcode-response.ts +36 -0
  91. package/models/generate-prem-invoice.ts +90 -0
  92. package/models/get-prem-invoice-subscriber-list-result-list-vbaresponse.ts +45 -0
  93. package/models/get-prem-invoice-subscriber-list-result.ts +102 -0
  94. package/models/group-achpull-list-vbaresponse.ts +45 -0
  95. package/models/group-achpull-vbaresponse.ts +45 -0
  96. package/models/group-achpull.ts +60 -0
  97. package/models/group-bill-cycle-payment-method-list-vbaresponse.ts +45 -0
  98. package/models/group-bill-cycle-payment-method-vbaresponse.ts +45 -0
  99. package/models/group-bill-cycle-payment-method.ts +78 -0
  100. package/models/group-change-coverage-start.ts +6 -0
  101. package/models/idcode-type.ts +6 -0
  102. package/models/index.ts +105 -0
  103. package/models/life-claim-advisor.ts +256 -0
  104. package/models/mem-enrollment-plan.ts +3 -3
  105. package/models/mem-enrollment-rider.ts +4 -4
  106. package/models/member-address-history-list-vbaresponse.ts +45 -0
  107. package/models/member-address-history-vbaresponse.ts +45 -0
  108. package/models/member-address-history.ts +216 -0
  109. package/models/member-pre-ex-disclosed-diag-list-vbaresponse.ts +45 -0
  110. package/models/member-pre-ex-disclosed-diag-vbaresponse.ts +45 -0
  111. package/models/member-pre-ex-disclosed-diag.ts +90 -0
  112. package/models/network-procedure-cluster.ts +1 -1
  113. package/models/note-note-attachment.ts +38 -0
  114. package/models/payment-method-list-vbaresponse.ts +45 -0
  115. package/models/payment-method-vbaresponse.ts +45 -0
  116. package/models/payment-method.ts +72 -0
  117. package/models/plan-benefit-rate.ts +1 -1
  118. package/models/prem-invoice-apply-payment.ts +78 -0
  119. package/models/prem-invoice-generate-inv-list-list-vbaresponse.ts +45 -0
  120. package/models/prem-invoice-generate-inv-list-result-list-vbaresponse.ts +45 -0
  121. package/models/prem-invoice-generate-inv-list-result.ts +138 -0
  122. package/models/prem-invoice-generate-inv-list.ts +138 -0
  123. package/models/prem-invoice-generate-self-admin-inv-list-list-vbaresponse.ts +45 -0
  124. package/models/prem-invoice-generate-self-admin-inv-list.ts +144 -0
  125. package/models/prem-rate-add-on-list-vbaresponse.ts +45 -0
  126. package/models/prem-rate-add-on-vbaresponse.ts +45 -0
  127. package/models/prem-rate-add-on.ts +78 -0
  128. package/models/prem-rate.ts +24 -12
  129. package/models/register-mfadevice-request.ts +42 -0
  130. package/models/register-mfadevice-response-vbaresponse.ts +45 -0
  131. package/models/register-mfadevice-response.ts +30 -0
  132. package/models/security-field-list-vbaresponse.ts +45 -0
  133. package/models/security-field-set-detail-list-vbaresponse.ts +45 -0
  134. package/models/security-field-set-detail-vbaresponse.ts +45 -0
  135. package/models/security-field-set-detail.ts +72 -0
  136. package/models/security-field-set-list-vbaresponse.ts +45 -0
  137. package/models/security-field-set-vbaresponse.ts +45 -0
  138. package/models/security-field-set.ts +66 -0
  139. package/models/security-field-user-group-list-vbaresponse.ts +45 -0
  140. package/models/security-field-user-group-vbaresponse.ts +45 -0
  141. package/models/security-field-user-group.ts +84 -0
  142. package/models/security-field-user-list-vbaresponse.ts +45 -0
  143. package/models/security-field-user-vbaresponse.ts +45 -0
  144. package/models/security-field-user.ts +84 -0
  145. package/models/security-field-vbaresponse.ts +45 -0
  146. package/models/security-field.ts +72 -0
  147. package/models/sub-enrollment-plan.ts +3 -3
  148. package/models/sub-enrollment-rider.ts +4 -4
  149. package/models/sub-enrollment.ts +2 -2
  150. package/models/sub-payment-method.ts +1 -1
  151. package/models/submit-mfacode-request.ts +42 -0
  152. package/models/subscriber-forfeiture-status.ts +1 -1
  153. package/models/subscriber-sponsor-list-vbaresponse.ts +45 -0
  154. package/models/subscriber-sponsor-vbaresponse.ts +45 -0
  155. package/models/subscriber-sponsor.ts +84 -0
  156. package/models/subscriber-writing-agent-list-vbaresponse.ts +45 -0
  157. package/models/subscriber-writing-agent-vbaresponse.ts +45 -0
  158. package/models/subscriber-writing-agent.ts +90 -0
  159. package/models/suspense-claim-list.ts +228 -0
  160. package/models/tolerance-list-vbaresponse.ts +45 -0
  161. package/models/tolerance-vbaresponse.ts +45 -0
  162. package/models/tolerance.ts +72 -0
  163. package/models/userfieldsecurity.ts +66 -0
  164. package/models/userfieldsecuritylist-vbaresponse.ts +45 -0
  165. package/models/users.ts +2 -2
  166. package/models/usual-customary-rate-all-percentile-list-vbaresponse.ts +45 -0
  167. package/models/usual-customary-rate-all-percentile.ts +120 -0
  168. package/models/vbainterface-idcode.ts +31 -1
  169. package/models/vbainterface-map-type.ts +31 -1
  170. package/models/vbainterface.ts +43 -1
  171. package/models/vbaprem-invoice-subscriber-detail-adjustment-list-vbaresponse.ts +45 -0
  172. package/models/vbaprem-invoice-subscriber-detail-adjustment.ts +180 -0
  173. package/models/vbaprem-invoice-subscriber-detail-list-vbaresponse.ts +45 -0
  174. package/models/vbaprem-invoice-subscriber-detail.ts +180 -0
  175. package/models/workflow-auth.ts +54 -0
  176. package/models/workflow-check.ts +54 -0
  177. package/models/workflow-enrollment.ts +60 -0
  178. package/models/workflow-processing.ts +21 -0
  179. package/package.json +3 -3
package/api/user-api.ts CHANGED
@@ -21,10 +21,20 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { GenerateAuthenticatorQRCodeRequest } from '../models';
25
+ // @ts-ignore
26
+ import { GenerateAuthenticatorQRCodeResponseVBAResponse } from '../models';
27
+ // @ts-ignore
24
28
  import { MultiCodeResponseListVBAResponse } from '../models';
25
29
  // @ts-ignore
30
+ import { RegisterMFADeviceRequest } from '../models';
31
+ // @ts-ignore
32
+ import { RegisterMFADeviceResponseVBAResponse } from '../models';
33
+ // @ts-ignore
26
34
  import { StringVBAResponse } from '../models';
27
35
  // @ts-ignore
36
+ import { SubmitMFACodeRequest } from '../models';
37
+ // @ts-ignore
28
38
  import { UserAuthenticationResponseVBAResponse } from '../models';
29
39
  // @ts-ignore
30
40
  import { UserChangeTempPasswordRequest } from '../models';
@@ -139,6 +149,102 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
139
149
 
140
150
 
141
151
 
152
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
153
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
154
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
155
+
156
+ return {
157
+ url: toPathString(localVarUrlObj),
158
+ options: localVarRequestOptions,
159
+ };
160
+ },
161
+ /**
162
+ * Resends a User a confirmation code.
163
+ * @summary Admin Resend Confirmation Code
164
+ * @param {string} vbasoftwareDatabase Target database
165
+ * @param {string} userID User ID
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ adminResendConfirmationCode: async (vbasoftwareDatabase: string, userID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
170
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
171
+ assertParamExists('adminResendConfirmationCode', 'vbasoftwareDatabase', vbasoftwareDatabase)
172
+ // verify required parameter 'userID' is not null or undefined
173
+ assertParamExists('adminResendConfirmationCode', 'userID', userID)
174
+ const localVarPath = `/users/{userID}/resend-confirmation-code`
175
+ .replace(`{${"userID"}}`, encodeURIComponent(String(userID)));
176
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
177
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
178
+ let baseOptions;
179
+ if (configuration) {
180
+ baseOptions = configuration.baseOptions;
181
+ }
182
+
183
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
184
+ const localVarHeaderParameter = {} as any;
185
+ const localVarQueryParameter = {} as any;
186
+
187
+ // authentication apiKeyAuth required
188
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
189
+
190
+ // authentication bearerAuth required
191
+ // http bearer authentication required
192
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
193
+
194
+ if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
195
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
196
+ }
197
+
198
+
199
+
200
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
201
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
202
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
203
+
204
+ return {
205
+ url: toPathString(localVarUrlObj),
206
+ options: localVarRequestOptions,
207
+ };
208
+ },
209
+ /**
210
+ * Resends the invitation message to a user that already exists and resets the expiration on the user\'s sign-up window.
211
+ * @summary Admin Resend Welcome Message
212
+ * @param {string} vbasoftwareDatabase Target database
213
+ * @param {string} userID User ID
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ */
217
+ adminResendWelcomeMesasge: async (vbasoftwareDatabase: string, userID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
218
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
219
+ assertParamExists('adminResendWelcomeMesasge', 'vbasoftwareDatabase', vbasoftwareDatabase)
220
+ // verify required parameter 'userID' is not null or undefined
221
+ assertParamExists('adminResendWelcomeMesasge', 'userID', userID)
222
+ const localVarPath = `/users/{userID}/resend-welcome-message`
223
+ .replace(`{${"userID"}}`, encodeURIComponent(String(userID)));
224
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
225
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
226
+ let baseOptions;
227
+ if (configuration) {
228
+ baseOptions = configuration.baseOptions;
229
+ }
230
+
231
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
232
+ const localVarHeaderParameter = {} as any;
233
+ const localVarQueryParameter = {} as any;
234
+
235
+ // authentication apiKeyAuth required
236
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
237
+
238
+ // authentication bearerAuth required
239
+ // http bearer authentication required
240
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
241
+
242
+ if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
243
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
244
+ }
245
+
246
+
247
+
142
248
  setSearchParams(localVarUrlObj, localVarQueryParameter);
143
249
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
144
250
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -366,6 +472,66 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
366
472
  options: localVarRequestOptions,
367
473
  };
368
474
  },
475
+ /**
476
+ * Generates a QR code for setting up multi-factor authentication (MFA) with an authenticator app. The QR code contains the necessary information for the app to generate time-based one-time passwords (TOTP) for user authentication.
477
+ * @summary Generate a QRCode for Authenticator App
478
+ * @param {string} vbasoftwareClientId Client ID
479
+ * @param {string} vbasoftwareClientCode Client Code
480
+ * @param {string} vbasoftwareDatabase Target database
481
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
482
+ * @param {*} [options] Override http request option.
483
+ * @throws {RequiredError}
484
+ */
485
+ generateAuthenticatorQRCode: async (vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, generateAuthenticatorQRCodeRequest: GenerateAuthenticatorQRCodeRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
486
+ // verify required parameter 'vbasoftwareClientId' is not null or undefined
487
+ assertParamExists('generateAuthenticatorQRCode', 'vbasoftwareClientId', vbasoftwareClientId)
488
+ // verify required parameter 'vbasoftwareClientCode' is not null or undefined
489
+ assertParamExists('generateAuthenticatorQRCode', 'vbasoftwareClientCode', vbasoftwareClientCode)
490
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
491
+ assertParamExists('generateAuthenticatorQRCode', 'vbasoftwareDatabase', vbasoftwareDatabase)
492
+ // verify required parameter 'generateAuthenticatorQRCodeRequest' is not null or undefined
493
+ assertParamExists('generateAuthenticatorQRCode', 'generateAuthenticatorQRCodeRequest', generateAuthenticatorQRCodeRequest)
494
+ const localVarPath = `/generate-authenticator-qrcode`;
495
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
496
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
497
+ let baseOptions;
498
+ if (configuration) {
499
+ baseOptions = configuration.baseOptions;
500
+ }
501
+
502
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
503
+ const localVarHeaderParameter = {} as any;
504
+ const localVarQueryParameter = {} as any;
505
+
506
+ // authentication apiKeyAuth required
507
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
508
+
509
+ if (vbasoftwareClientId !== undefined && vbasoftwareClientId !== null) {
510
+ localVarHeaderParameter['vbasoftware-client-id'] = String(vbasoftwareClientId);
511
+ }
512
+
513
+ if (vbasoftwareClientCode !== undefined && vbasoftwareClientCode !== null) {
514
+ localVarHeaderParameter['vbasoftware-client-code'] = String(vbasoftwareClientCode);
515
+ }
516
+
517
+ if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
518
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
519
+ }
520
+
521
+
522
+
523
+ localVarHeaderParameter['Content-Type'] = 'application/json';
524
+
525
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
526
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
527
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
528
+ localVarRequestOptions.data = serializeDataIfNeeded(generateAuthenticatorQRCodeRequest, localVarRequestOptions, configuration)
529
+
530
+ return {
531
+ url: toPathString(localVarUrlObj),
532
+ options: localVarRequestOptions,
533
+ };
534
+ },
369
535
  /**
370
536
  * Gets a User by ID
371
537
  * @summary Get User
@@ -526,6 +692,126 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
526
692
  options: localVarRequestOptions,
527
693
  };
528
694
  },
695
+ /**
696
+ * Registers a multi-factor authentication (MFA) device for the user by verifying the software token and associating it with the user\'s account.
697
+ * @summary Register an MFA Device
698
+ * @param {string} vbasoftwareClientId Client ID
699
+ * @param {string} vbasoftwareClientCode Client Code
700
+ * @param {string} vbasoftwareDatabase Target database
701
+ * @param {RegisterMFADeviceRequest} registerMFADeviceRequest
702
+ * @param {*} [options] Override http request option.
703
+ * @throws {RequiredError}
704
+ */
705
+ registerMFADevice: async (vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, registerMFADeviceRequest: RegisterMFADeviceRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
706
+ // verify required parameter 'vbasoftwareClientId' is not null or undefined
707
+ assertParamExists('registerMFADevice', 'vbasoftwareClientId', vbasoftwareClientId)
708
+ // verify required parameter 'vbasoftwareClientCode' is not null or undefined
709
+ assertParamExists('registerMFADevice', 'vbasoftwareClientCode', vbasoftwareClientCode)
710
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
711
+ assertParamExists('registerMFADevice', 'vbasoftwareDatabase', vbasoftwareDatabase)
712
+ // verify required parameter 'registerMFADeviceRequest' is not null or undefined
713
+ assertParamExists('registerMFADevice', 'registerMFADeviceRequest', registerMFADeviceRequest)
714
+ const localVarPath = `/register-mfa-device`;
715
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
716
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
717
+ let baseOptions;
718
+ if (configuration) {
719
+ baseOptions = configuration.baseOptions;
720
+ }
721
+
722
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
723
+ const localVarHeaderParameter = {} as any;
724
+ const localVarQueryParameter = {} as any;
725
+
726
+ // authentication apiKeyAuth required
727
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
728
+
729
+ if (vbasoftwareClientId !== undefined && vbasoftwareClientId !== null) {
730
+ localVarHeaderParameter['vbasoftware-client-id'] = String(vbasoftwareClientId);
731
+ }
732
+
733
+ if (vbasoftwareClientCode !== undefined && vbasoftwareClientCode !== null) {
734
+ localVarHeaderParameter['vbasoftware-client-code'] = String(vbasoftwareClientCode);
735
+ }
736
+
737
+ if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
738
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
739
+ }
740
+
741
+
742
+
743
+ localVarHeaderParameter['Content-Type'] = 'application/json';
744
+
745
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
746
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
747
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
748
+ localVarRequestOptions.data = serializeDataIfNeeded(registerMFADeviceRequest, localVarRequestOptions, configuration)
749
+
750
+ return {
751
+ url: toPathString(localVarUrlObj),
752
+ options: localVarRequestOptions,
753
+ };
754
+ },
755
+ /**
756
+ * Verifies the multi-factor authentication (MFA) code provided by the user and completes the authentication process.
757
+ * @summary Submit MFA Code
758
+ * @param {string} vbasoftwareClientId Client ID
759
+ * @param {string} vbasoftwareClientCode Client Code
760
+ * @param {string} vbasoftwareDatabase Target database
761
+ * @param {SubmitMFACodeRequest} submitMFACodeRequest
762
+ * @param {*} [options] Override http request option.
763
+ * @throws {RequiredError}
764
+ */
765
+ submitMFACode: async (vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, submitMFACodeRequest: SubmitMFACodeRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
766
+ // verify required parameter 'vbasoftwareClientId' is not null or undefined
767
+ assertParamExists('submitMFACode', 'vbasoftwareClientId', vbasoftwareClientId)
768
+ // verify required parameter 'vbasoftwareClientCode' is not null or undefined
769
+ assertParamExists('submitMFACode', 'vbasoftwareClientCode', vbasoftwareClientCode)
770
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
771
+ assertParamExists('submitMFACode', 'vbasoftwareDatabase', vbasoftwareDatabase)
772
+ // verify required parameter 'submitMFACodeRequest' is not null or undefined
773
+ assertParamExists('submitMFACode', 'submitMFACodeRequest', submitMFACodeRequest)
774
+ const localVarPath = `/submit-mfa-code`;
775
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
776
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
777
+ let baseOptions;
778
+ if (configuration) {
779
+ baseOptions = configuration.baseOptions;
780
+ }
781
+
782
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
783
+ const localVarHeaderParameter = {} as any;
784
+ const localVarQueryParameter = {} as any;
785
+
786
+ // authentication apiKeyAuth required
787
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
788
+
789
+ if (vbasoftwareClientId !== undefined && vbasoftwareClientId !== null) {
790
+ localVarHeaderParameter['vbasoftware-client-id'] = String(vbasoftwareClientId);
791
+ }
792
+
793
+ if (vbasoftwareClientCode !== undefined && vbasoftwareClientCode !== null) {
794
+ localVarHeaderParameter['vbasoftware-client-code'] = String(vbasoftwareClientCode);
795
+ }
796
+
797
+ if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
798
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
799
+ }
800
+
801
+
802
+
803
+ localVarHeaderParameter['Content-Type'] = 'application/json';
804
+
805
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
806
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
807
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
808
+ localVarRequestOptions.data = serializeDataIfNeeded(submitMFACodeRequest, localVarRequestOptions, configuration)
809
+
810
+ return {
811
+ url: toPathString(localVarUrlObj),
812
+ options: localVarRequestOptions,
813
+ };
814
+ },
529
815
  /**
530
816
  * Create or Update multiple Users at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
531
817
  * @summary Create or Update Batch Users
@@ -884,6 +1170,30 @@ export const UserApiFp = function(configuration?: Configuration) {
884
1170
  const localVarAxiosArgs = await localVarAxiosParamCreator.adminEnableUser(vbasoftwareDatabase, userID, options);
885
1171
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
886
1172
  },
1173
+ /**
1174
+ * Resends a User a confirmation code.
1175
+ * @summary Admin Resend Confirmation Code
1176
+ * @param {string} vbasoftwareDatabase Target database
1177
+ * @param {string} userID User ID
1178
+ * @param {*} [options] Override http request option.
1179
+ * @throws {RequiredError}
1180
+ */
1181
+ async adminResendConfirmationCode(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
1182
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminResendConfirmationCode(vbasoftwareDatabase, userID, options);
1183
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1184
+ },
1185
+ /**
1186
+ * Resends the invitation message to a user that already exists and resets the expiration on the user\'s sign-up window.
1187
+ * @summary Admin Resend Welcome Message
1188
+ * @param {string} vbasoftwareDatabase Target database
1189
+ * @param {string} userID User ID
1190
+ * @param {*} [options] Override http request option.
1191
+ * @throws {RequiredError}
1192
+ */
1193
+ async adminResendWelcomeMesasge(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
1194
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminResendWelcomeMesasge(vbasoftwareDatabase, userID, options);
1195
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1196
+ },
887
1197
  /**
888
1198
  * Allows a user to enter a confirmation code to reset a forgotten password.
889
1199
  * @summary Confirm Forgot Password
@@ -936,6 +1246,20 @@ export const UserApiFp = function(configuration?: Configuration) {
936
1246
  const localVarAxiosArgs = await localVarAxiosParamCreator.forgotPassword(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, userForgotPasswordRequest, options);
937
1247
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
938
1248
  },
1249
+ /**
1250
+ * Generates a QR code for setting up multi-factor authentication (MFA) with an authenticator app. The QR code contains the necessary information for the app to generate time-based one-time passwords (TOTP) for user authentication.
1251
+ * @summary Generate a QRCode for Authenticator App
1252
+ * @param {string} vbasoftwareClientId Client ID
1253
+ * @param {string} vbasoftwareClientCode Client Code
1254
+ * @param {string} vbasoftwareDatabase Target database
1255
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
1256
+ * @param {*} [options] Override http request option.
1257
+ * @throws {RequiredError}
1258
+ */
1259
+ async generateAuthenticatorQRCode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, generateAuthenticatorQRCodeRequest: GenerateAuthenticatorQRCodeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateAuthenticatorQRCodeResponseVBAResponse>> {
1260
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generateAuthenticatorQRCode(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, generateAuthenticatorQRCodeRequest, options);
1261
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1262
+ },
939
1263
  /**
940
1264
  * Gets a User by ID
941
1265
  * @summary Get User
@@ -974,6 +1298,34 @@ export const UserApiFp = function(configuration?: Configuration) {
974
1298
  const localVarAxiosArgs = await localVarAxiosParamCreator.refreshUserTokens(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, expiredIdToken, refreshToken, options);
975
1299
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
976
1300
  },
1301
+ /**
1302
+ * Registers a multi-factor authentication (MFA) device for the user by verifying the software token and associating it with the user\'s account.
1303
+ * @summary Register an MFA Device
1304
+ * @param {string} vbasoftwareClientId Client ID
1305
+ * @param {string} vbasoftwareClientCode Client Code
1306
+ * @param {string} vbasoftwareDatabase Target database
1307
+ * @param {RegisterMFADeviceRequest} registerMFADeviceRequest
1308
+ * @param {*} [options] Override http request option.
1309
+ * @throws {RequiredError}
1310
+ */
1311
+ async registerMFADevice(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, registerMFADeviceRequest: RegisterMFADeviceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegisterMFADeviceResponseVBAResponse>> {
1312
+ const localVarAxiosArgs = await localVarAxiosParamCreator.registerMFADevice(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, registerMFADeviceRequest, options);
1313
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1314
+ },
1315
+ /**
1316
+ * Verifies the multi-factor authentication (MFA) code provided by the user and completes the authentication process.
1317
+ * @summary Submit MFA Code
1318
+ * @param {string} vbasoftwareClientId Client ID
1319
+ * @param {string} vbasoftwareClientCode Client Code
1320
+ * @param {string} vbasoftwareDatabase Target database
1321
+ * @param {SubmitMFACodeRequest} submitMFACodeRequest
1322
+ * @param {*} [options] Override http request option.
1323
+ * @throws {RequiredError}
1324
+ */
1325
+ async submitMFACode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, submitMFACodeRequest: SubmitMFACodeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserAuthenticationResponseVBAResponse>> {
1326
+ const localVarAxiosArgs = await localVarAxiosParamCreator.submitMFACode(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, submitMFACodeRequest, options);
1327
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1328
+ },
977
1329
  /**
978
1330
  * Create or Update multiple Users at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
979
1331
  * @summary Create or Update Batch Users
@@ -1083,6 +1435,28 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1083
1435
  adminEnableUser(vbasoftwareDatabase: string, userID: string, options?: any): AxiosPromise<StringVBAResponse> {
1084
1436
  return localVarFp.adminEnableUser(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
1085
1437
  },
1438
+ /**
1439
+ * Resends a User a confirmation code.
1440
+ * @summary Admin Resend Confirmation Code
1441
+ * @param {string} vbasoftwareDatabase Target database
1442
+ * @param {string} userID User ID
1443
+ * @param {*} [options] Override http request option.
1444
+ * @throws {RequiredError}
1445
+ */
1446
+ adminResendConfirmationCode(vbasoftwareDatabase: string, userID: string, options?: any): AxiosPromise<StringVBAResponse> {
1447
+ return localVarFp.adminResendConfirmationCode(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
1448
+ },
1449
+ /**
1450
+ * Resends the invitation message to a user that already exists and resets the expiration on the user\'s sign-up window.
1451
+ * @summary Admin Resend Welcome Message
1452
+ * @param {string} vbasoftwareDatabase Target database
1453
+ * @param {string} userID User ID
1454
+ * @param {*} [options] Override http request option.
1455
+ * @throws {RequiredError}
1456
+ */
1457
+ adminResendWelcomeMesasge(vbasoftwareDatabase: string, userID: string, options?: any): AxiosPromise<StringVBAResponse> {
1458
+ return localVarFp.adminResendWelcomeMesasge(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
1459
+ },
1086
1460
  /**
1087
1461
  * Allows a user to enter a confirmation code to reset a forgotten password.
1088
1462
  * @summary Confirm Forgot Password
@@ -1131,6 +1505,19 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1131
1505
  forgotPassword(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, userForgotPasswordRequest: UserForgotPasswordRequest, options?: any): AxiosPromise<UserForgotPasswordResponseVBAResponse> {
1132
1506
  return localVarFp.forgotPassword(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, userForgotPasswordRequest, options).then((request) => request(axios, basePath));
1133
1507
  },
1508
+ /**
1509
+ * Generates a QR code for setting up multi-factor authentication (MFA) with an authenticator app. The QR code contains the necessary information for the app to generate time-based one-time passwords (TOTP) for user authentication.
1510
+ * @summary Generate a QRCode for Authenticator App
1511
+ * @param {string} vbasoftwareClientId Client ID
1512
+ * @param {string} vbasoftwareClientCode Client Code
1513
+ * @param {string} vbasoftwareDatabase Target database
1514
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
1515
+ * @param {*} [options] Override http request option.
1516
+ * @throws {RequiredError}
1517
+ */
1518
+ generateAuthenticatorQRCode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, generateAuthenticatorQRCodeRequest: GenerateAuthenticatorQRCodeRequest, options?: any): AxiosPromise<GenerateAuthenticatorQRCodeResponseVBAResponse> {
1519
+ return localVarFp.generateAuthenticatorQRCode(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, generateAuthenticatorQRCodeRequest, options).then((request) => request(axios, basePath));
1520
+ },
1134
1521
  /**
1135
1522
  * Gets a User by ID
1136
1523
  * @summary Get User
@@ -1166,6 +1553,32 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1166
1553
  refreshUserTokens(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, expiredIdToken: string, refreshToken: string, options?: any): AxiosPromise<UserAuthenticationResponseVBAResponse> {
1167
1554
  return localVarFp.refreshUserTokens(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, expiredIdToken, refreshToken, options).then((request) => request(axios, basePath));
1168
1555
  },
1556
+ /**
1557
+ * Registers a multi-factor authentication (MFA) device for the user by verifying the software token and associating it with the user\'s account.
1558
+ * @summary Register an MFA Device
1559
+ * @param {string} vbasoftwareClientId Client ID
1560
+ * @param {string} vbasoftwareClientCode Client Code
1561
+ * @param {string} vbasoftwareDatabase Target database
1562
+ * @param {RegisterMFADeviceRequest} registerMFADeviceRequest
1563
+ * @param {*} [options] Override http request option.
1564
+ * @throws {RequiredError}
1565
+ */
1566
+ registerMFADevice(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, registerMFADeviceRequest: RegisterMFADeviceRequest, options?: any): AxiosPromise<RegisterMFADeviceResponseVBAResponse> {
1567
+ return localVarFp.registerMFADevice(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, registerMFADeviceRequest, options).then((request) => request(axios, basePath));
1568
+ },
1569
+ /**
1570
+ * Verifies the multi-factor authentication (MFA) code provided by the user and completes the authentication process.
1571
+ * @summary Submit MFA Code
1572
+ * @param {string} vbasoftwareClientId Client ID
1573
+ * @param {string} vbasoftwareClientCode Client Code
1574
+ * @param {string} vbasoftwareDatabase Target database
1575
+ * @param {SubmitMFACodeRequest} submitMFACodeRequest
1576
+ * @param {*} [options] Override http request option.
1577
+ * @throws {RequiredError}
1578
+ */
1579
+ submitMFACode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, submitMFACodeRequest: SubmitMFACodeRequest, options?: any): AxiosPromise<UserAuthenticationResponseVBAResponse> {
1580
+ return localVarFp.submitMFACode(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, submitMFACodeRequest, options).then((request) => request(axios, basePath));
1581
+ },
1169
1582
  /**
1170
1583
  * Create or Update multiple Users at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
1171
1584
  * @summary Create or Update Batch Users
@@ -1268,6 +1681,28 @@ export interface UserApiInterface {
1268
1681
  */
1269
1682
  adminEnableUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
1270
1683
 
1684
+ /**
1685
+ * Resends a User a confirmation code.
1686
+ * @summary Admin Resend Confirmation Code
1687
+ * @param {string} vbasoftwareDatabase Target database
1688
+ * @param {string} userID User ID
1689
+ * @param {*} [options] Override http request option.
1690
+ * @throws {RequiredError}
1691
+ * @memberof UserApiInterface
1692
+ */
1693
+ adminResendConfirmationCode(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
1694
+
1695
+ /**
1696
+ * Resends the invitation message to a user that already exists and resets the expiration on the user\'s sign-up window.
1697
+ * @summary Admin Resend Welcome Message
1698
+ * @param {string} vbasoftwareDatabase Target database
1699
+ * @param {string} userID User ID
1700
+ * @param {*} [options] Override http request option.
1701
+ * @throws {RequiredError}
1702
+ * @memberof UserApiInterface
1703
+ */
1704
+ adminResendWelcomeMesasge(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
1705
+
1271
1706
  /**
1272
1707
  * Allows a user to enter a confirmation code to reset a forgotten password.
1273
1708
  * @summary Confirm Forgot Password
@@ -1316,6 +1751,19 @@ export interface UserApiInterface {
1316
1751
  */
1317
1752
  forgotPassword(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, userForgotPasswordRequest: UserForgotPasswordRequest, options?: AxiosRequestConfig): AxiosPromise<UserForgotPasswordResponseVBAResponse>;
1318
1753
 
1754
+ /**
1755
+ * Generates a QR code for setting up multi-factor authentication (MFA) with an authenticator app. The QR code contains the necessary information for the app to generate time-based one-time passwords (TOTP) for user authentication.
1756
+ * @summary Generate a QRCode for Authenticator App
1757
+ * @param {string} vbasoftwareClientId Client ID
1758
+ * @param {string} vbasoftwareClientCode Client Code
1759
+ * @param {string} vbasoftwareDatabase Target database
1760
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
1761
+ * @param {*} [options] Override http request option.
1762
+ * @throws {RequiredError}
1763
+ * @memberof UserApiInterface
1764
+ */
1765
+ generateAuthenticatorQRCode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, generateAuthenticatorQRCodeRequest: GenerateAuthenticatorQRCodeRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateAuthenticatorQRCodeResponseVBAResponse>;
1766
+
1319
1767
  /**
1320
1768
  * Gets a User by ID
1321
1769
  * @summary Get User
@@ -1351,6 +1799,32 @@ export interface UserApiInterface {
1351
1799
  */
1352
1800
  refreshUserTokens(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, expiredIdToken: string, refreshToken: string, options?: AxiosRequestConfig): AxiosPromise<UserAuthenticationResponseVBAResponse>;
1353
1801
 
1802
+ /**
1803
+ * Registers a multi-factor authentication (MFA) device for the user by verifying the software token and associating it with the user\'s account.
1804
+ * @summary Register an MFA Device
1805
+ * @param {string} vbasoftwareClientId Client ID
1806
+ * @param {string} vbasoftwareClientCode Client Code
1807
+ * @param {string} vbasoftwareDatabase Target database
1808
+ * @param {RegisterMFADeviceRequest} registerMFADeviceRequest
1809
+ * @param {*} [options] Override http request option.
1810
+ * @throws {RequiredError}
1811
+ * @memberof UserApiInterface
1812
+ */
1813
+ registerMFADevice(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, registerMFADeviceRequest: RegisterMFADeviceRequest, options?: AxiosRequestConfig): AxiosPromise<RegisterMFADeviceResponseVBAResponse>;
1814
+
1815
+ /**
1816
+ * Verifies the multi-factor authentication (MFA) code provided by the user and completes the authentication process.
1817
+ * @summary Submit MFA Code
1818
+ * @param {string} vbasoftwareClientId Client ID
1819
+ * @param {string} vbasoftwareClientCode Client Code
1820
+ * @param {string} vbasoftwareDatabase Target database
1821
+ * @param {SubmitMFACodeRequest} submitMFACodeRequest
1822
+ * @param {*} [options] Override http request option.
1823
+ * @throws {RequiredError}
1824
+ * @memberof UserApiInterface
1825
+ */
1826
+ submitMFACode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, submitMFACodeRequest: SubmitMFACodeRequest, options?: AxiosRequestConfig): AxiosPromise<UserAuthenticationResponseVBAResponse>;
1827
+
1354
1828
  /**
1355
1829
  * Create or Update multiple Users at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
1356
1830
  * @summary Create or Update Batch Users
@@ -1457,6 +1931,32 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1457
1931
  return UserApiFp(this.configuration).adminEnableUser(vbasoftwareDatabase, userID, options).then((request) => request(this.axios, this.basePath));
1458
1932
  }
1459
1933
 
1934
+ /**
1935
+ * Resends a User a confirmation code.
1936
+ * @summary Admin Resend Confirmation Code
1937
+ * @param {string} vbasoftwareDatabase Target database
1938
+ * @param {string} userID User ID
1939
+ * @param {*} [options] Override http request option.
1940
+ * @throws {RequiredError}
1941
+ * @memberof UserApi
1942
+ */
1943
+ public adminResendConfirmationCode(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig) {
1944
+ return UserApiFp(this.configuration).adminResendConfirmationCode(vbasoftwareDatabase, userID, options).then((request) => request(this.axios, this.basePath));
1945
+ }
1946
+
1947
+ /**
1948
+ * Resends the invitation message to a user that already exists and resets the expiration on the user\'s sign-up window.
1949
+ * @summary Admin Resend Welcome Message
1950
+ * @param {string} vbasoftwareDatabase Target database
1951
+ * @param {string} userID User ID
1952
+ * @param {*} [options] Override http request option.
1953
+ * @throws {RequiredError}
1954
+ * @memberof UserApi
1955
+ */
1956
+ public adminResendWelcomeMesasge(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig) {
1957
+ return UserApiFp(this.configuration).adminResendWelcomeMesasge(vbasoftwareDatabase, userID, options).then((request) => request(this.axios, this.basePath));
1958
+ }
1959
+
1460
1960
  /**
1461
1961
  * Allows a user to enter a confirmation code to reset a forgotten password.
1462
1962
  * @summary Confirm Forgot Password
@@ -1513,6 +2013,21 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1513
2013
  return UserApiFp(this.configuration).forgotPassword(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, userForgotPasswordRequest, options).then((request) => request(this.axios, this.basePath));
1514
2014
  }
1515
2015
 
2016
+ /**
2017
+ * Generates a QR code for setting up multi-factor authentication (MFA) with an authenticator app. The QR code contains the necessary information for the app to generate time-based one-time passwords (TOTP) for user authentication.
2018
+ * @summary Generate a QRCode for Authenticator App
2019
+ * @param {string} vbasoftwareClientId Client ID
2020
+ * @param {string} vbasoftwareClientCode Client Code
2021
+ * @param {string} vbasoftwareDatabase Target database
2022
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
2023
+ * @param {*} [options] Override http request option.
2024
+ * @throws {RequiredError}
2025
+ * @memberof UserApi
2026
+ */
2027
+ public generateAuthenticatorQRCode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, generateAuthenticatorQRCodeRequest: GenerateAuthenticatorQRCodeRequest, options?: AxiosRequestConfig) {
2028
+ return UserApiFp(this.configuration).generateAuthenticatorQRCode(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, generateAuthenticatorQRCodeRequest, options).then((request) => request(this.axios, this.basePath));
2029
+ }
2030
+
1516
2031
  /**
1517
2032
  * Gets a User by ID
1518
2033
  * @summary Get User
@@ -1554,6 +2069,36 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1554
2069
  return UserApiFp(this.configuration).refreshUserTokens(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, expiredIdToken, refreshToken, options).then((request) => request(this.axios, this.basePath));
1555
2070
  }
1556
2071
 
2072
+ /**
2073
+ * Registers a multi-factor authentication (MFA) device for the user by verifying the software token and associating it with the user\'s account.
2074
+ * @summary Register an MFA Device
2075
+ * @param {string} vbasoftwareClientId Client ID
2076
+ * @param {string} vbasoftwareClientCode Client Code
2077
+ * @param {string} vbasoftwareDatabase Target database
2078
+ * @param {RegisterMFADeviceRequest} registerMFADeviceRequest
2079
+ * @param {*} [options] Override http request option.
2080
+ * @throws {RequiredError}
2081
+ * @memberof UserApi
2082
+ */
2083
+ public registerMFADevice(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, registerMFADeviceRequest: RegisterMFADeviceRequest, options?: AxiosRequestConfig) {
2084
+ return UserApiFp(this.configuration).registerMFADevice(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, registerMFADeviceRequest, options).then((request) => request(this.axios, this.basePath));
2085
+ }
2086
+
2087
+ /**
2088
+ * Verifies the multi-factor authentication (MFA) code provided by the user and completes the authentication process.
2089
+ * @summary Submit MFA Code
2090
+ * @param {string} vbasoftwareClientId Client ID
2091
+ * @param {string} vbasoftwareClientCode Client Code
2092
+ * @param {string} vbasoftwareDatabase Target database
2093
+ * @param {SubmitMFACodeRequest} submitMFACodeRequest
2094
+ * @param {*} [options] Override http request option.
2095
+ * @throws {RequiredError}
2096
+ * @memberof UserApi
2097
+ */
2098
+ public submitMFACode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, submitMFACodeRequest: SubmitMFACodeRequest, options?: AxiosRequestConfig) {
2099
+ return UserApiFp(this.configuration).submitMFACode(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, submitMFACodeRequest, options).then((request) => request(this.axios, this.basePath));
2100
+ }
2101
+
1557
2102
  /**
1558
2103
  * Create or Update multiple Users at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
1559
2104
  * @summary Create or Update Batch Users