@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240120.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 (213) hide show
  1. package/.openapi-generator/FILES +162 -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/adv-workflow-api.ts +456 -0
  8. package/api/benefits-api.ts +122 -0
  9. package/api/billing-api.ts +165 -0
  10. package/api/claim-batch-api.ts +121 -0
  11. package/api/claim-batch-details-api.ts +140 -0
  12. package/api/client-config-api.ts +869 -0
  13. package/api/commission-rate-cluster-agency-rep-api.ts +677 -0
  14. package/api/commission-rates-api.ts +8 -18
  15. package/api/disability-event-case-changes-api.ts +677 -0
  16. package/api/disability-event-deduction-changes-api.ts +677 -0
  17. package/api/disability-event-field-changes-api.ts +677 -0
  18. package/api/disability-event-fields-api.ts +677 -0
  19. package/api/disability-event-groups-api.ts +677 -0
  20. package/api/disaster-locations-api.ts +677 -0
  21. package/api/disasters-api.ts +677 -0
  22. package/api/fee-schedules-api.ts +163 -0
  23. package/api/group-achpulls-api.ts +725 -0
  24. package/api/group-bill-cycle-payment-methods-api.ts +677 -0
  25. package/api/group-network-criterias-api.ts +31 -13
  26. package/api/group-ucpercent-criterias-api.ts +677 -0
  27. package/api/member-address-history-api.ts +773 -0
  28. package/api/member-pre-ex-disclosed-diags-api.ts +773 -0
  29. package/api/payment-methods-api.ts +772 -0
  30. package/api/premium-distributions-api.ts +222 -0
  31. package/api/premium-invoice-subscribers-api.ts +291 -0
  32. package/api/premium-invoices-api.ts +1577 -219
  33. package/api/premium-rate-add-ons-api.ts +725 -0
  34. package/api/premium-rates-api.ts +119 -0
  35. package/api/process-automation-api.ts +365 -0
  36. package/api/security-field-set-details-api.ts +733 -0
  37. package/api/security-field-sets-api.ts +677 -0
  38. package/api/security-field-user-groups-api.ts +677 -0
  39. package/api/security-field-users-api.ts +677 -0
  40. package/api/security-fields-api.ts +677 -0
  41. package/api/subscriber-enrollments-api.ts +111 -0
  42. package/api/subscriber-sponsors-api.ts +677 -0
  43. package/api/subscriber-writing-agents-api.ts +725 -0
  44. package/api/subscribers-api.ts +315 -0
  45. package/api/support-api.ts +532 -0
  46. package/api/tolerances-api.ts +677 -0
  47. package/api/user-api.ts +520 -71
  48. package/api/user-field-security-api.ts +191 -0
  49. package/api/user-group-mappings-api.ts +101 -5
  50. package/api/vbareports-api.ts +155 -0
  51. package/api.ts +33 -0
  52. package/models/adjudicate-benefit-match-detail-list-vbaresponse.ts +45 -0
  53. package/models/adjudicate-benefit-match-detail.ts +198 -0
  54. package/models/auth.ts +29 -5
  55. package/models/billing-refund.ts +126 -0
  56. package/models/call-tracking-diag-codes.ts +1 -1
  57. package/models/callback-dto.ts +43 -0
  58. package/models/check-batch.ts +1 -1
  59. package/models/claim-adjustment-config.ts +121 -0
  60. package/models/claim-custom-ex-code-rule.ts +50 -20
  61. package/models/cobraplan-criteria.ts +36 -0
  62. package/models/commission-rate-cluster-agency-rep-list-vbaresponse.ts +45 -0
  63. package/models/commission-rate-cluster-agency-rep-vbaresponse.ts +45 -0
  64. package/models/commission-rate-cluster-agency-rep.ts +102 -0
  65. package/models/company-data.ts +112 -82
  66. package/models/copy-group-division.ts +4 -10
  67. package/models/criteria-detail.ts +1 -1
  68. package/models/database-connection.ts +36 -0
  69. package/models/disability-event-case-changed-list-vbaresponse.ts +45 -0
  70. package/models/disability-event-case-changed-vbaresponse.ts +45 -0
  71. package/models/disability-event-case-changed.ts +78 -0
  72. package/models/disability-event-deduction-changed-list-vbaresponse.ts +45 -0
  73. package/models/disability-event-deduction-changed-vbaresponse.ts +45 -0
  74. package/models/disability-event-deduction-changed.ts +72 -0
  75. package/models/disability-event-field-changed-list-vbaresponse.ts +45 -0
  76. package/models/disability-event-field-changed-vbaresponse.ts +45 -0
  77. package/models/disability-event-field-changed.ts +72 -0
  78. package/models/disability-event-field-list-vbaresponse.ts +45 -0
  79. package/models/disability-event-field-vbaresponse.ts +45 -0
  80. package/models/disability-event-field.ts +60 -0
  81. package/models/disability-event-group-list-vbaresponse.ts +45 -0
  82. package/models/disability-event-group-vbaresponse.ts +45 -0
  83. package/models/disability-event-group.ts +78 -0
  84. package/models/disaster-list-vbaresponse.ts +45 -0
  85. package/models/disaster-location-list-vbaresponse.ts +45 -0
  86. package/models/disaster-location-vbaresponse.ts +45 -0
  87. package/models/disaster-location.ts +78 -0
  88. package/models/disaster-vbaresponse.ts +45 -0
  89. package/models/disaster.ts +84 -0
  90. package/models/email-report-dto.ts +103 -0
  91. package/models/enrollment-reenroll.ts +13 -0
  92. package/models/enrollment-waiting-period-by-hire-date-list-vbaresponse.ts +45 -0
  93. package/models/enrollment-waiting-period-by-hire-date.ts +48 -0
  94. package/models/fax-report-dto.ts +85 -0
  95. package/models/fee-sched-detail.ts +1 -1
  96. package/models/fee-sched-modifier-discount.ts +1 -1
  97. package/models/fee-sched-procedure-group-adjust.ts +1 -1
  98. package/models/fee-sched-provider-type-discount.ts +1 -1
  99. package/models/funding-process-claim-refund.ts +66 -0
  100. package/models/funding-request.ts +1 -1
  101. package/models/generate-authenticator-qrcode-request.ts +30 -0
  102. package/models/generate-authenticator-qrcode-response-vbaresponse.ts +45 -0
  103. package/models/generate-authenticator-qrcode-response.ts +36 -0
  104. package/models/generate-prem-invoice.ts +90 -0
  105. package/models/get-prem-invoice-subscriber-list-result-list-vbaresponse.ts +45 -0
  106. package/models/get-prem-invoice-subscriber-list-result.ts +102 -0
  107. package/models/group-achpull-list-vbaresponse.ts +45 -0
  108. package/models/group-achpull-vbaresponse.ts +45 -0
  109. package/models/group-achpull.ts +60 -0
  110. package/models/group-bill-cycle-payment-method-list-vbaresponse.ts +45 -0
  111. package/models/group-bill-cycle-payment-method-vbaresponse.ts +45 -0
  112. package/models/group-bill-cycle-payment-method.ts +78 -0
  113. package/models/group-change-coverage-start.ts +6 -0
  114. package/models/group-ucpercent-criteria-list-vbaresponse.ts +45 -0
  115. package/models/group-ucpercent-criteria-vbaresponse.ts +45 -0
  116. package/models/group-ucpercent-criteria.ts +84 -0
  117. package/models/groups.ts +6 -0
  118. package/models/idcode-type.ts +6 -0
  119. package/models/index.ts +129 -0
  120. package/models/json-node-options.ts +30 -0
  121. package/models/json-node.ts +43 -0
  122. package/models/json-value.ts +44 -0
  123. package/models/life-claim-advisor.ts +256 -0
  124. package/models/mem-enrollment-plan.ts +3 -3
  125. package/models/mem-enrollment-rider.ts +4 -4
  126. package/models/member-address-history-list-vbaresponse.ts +45 -0
  127. package/models/member-address-history-vbaresponse.ts +45 -0
  128. package/models/member-address-history.ts +216 -0
  129. package/models/member-pre-ex-disclosed-diag-list-vbaresponse.ts +45 -0
  130. package/models/member-pre-ex-disclosed-diag-vbaresponse.ts +45 -0
  131. package/models/member-pre-ex-disclosed-diag.ts +90 -0
  132. package/models/network-procedure-cluster.ts +1 -1
  133. package/models/note-note-attachment.ts +38 -0
  134. package/models/payment-method-list-vbaresponse.ts +45 -0
  135. package/models/payment-method-vbaresponse.ts +45 -0
  136. package/models/payment-method.ts +72 -0
  137. package/models/plan-benefit-rate.ts +1 -1
  138. package/models/prem-invoice-apply-payment.ts +78 -0
  139. package/models/prem-invoice-generate-inv-list-list-vbaresponse.ts +45 -0
  140. package/models/prem-invoice-generate-inv-list-result-list-vbaresponse.ts +45 -0
  141. package/models/prem-invoice-generate-inv-list-result.ts +138 -0
  142. package/models/prem-invoice-generate-inv-list.ts +138 -0
  143. package/models/prem-invoice-generate-self-admin-inv-list-list-vbaresponse.ts +45 -0
  144. package/models/prem-invoice-generate-self-admin-inv-list.ts +144 -0
  145. package/models/prem-rate-add-on-list-vbaresponse.ts +45 -0
  146. package/models/prem-rate-add-on-vbaresponse.ts +45 -0
  147. package/models/prem-rate-add-on.ts +78 -0
  148. package/models/prem-rate.ts +24 -12
  149. package/models/register-mfadevice-request.ts +42 -0
  150. package/models/register-mfadevice-response-vbaresponse.ts +45 -0
  151. package/models/register-mfadevice-response.ts +30 -0
  152. package/models/report-series-step.ts +6 -0
  153. package/models/security-field-list-vbaresponse.ts +45 -0
  154. package/models/security-field-set-detail-list-vbaresponse.ts +45 -0
  155. package/models/security-field-set-detail-vbaresponse.ts +45 -0
  156. package/models/security-field-set-detail.ts +72 -0
  157. package/models/security-field-set-list-vbaresponse.ts +45 -0
  158. package/models/security-field-set-vbaresponse.ts +45 -0
  159. package/models/security-field-set.ts +66 -0
  160. package/models/security-field-user-group-list-vbaresponse.ts +45 -0
  161. package/models/security-field-user-group-vbaresponse.ts +45 -0
  162. package/models/security-field-user-group.ts +84 -0
  163. package/models/security-field-user-list-vbaresponse.ts +45 -0
  164. package/models/security-field-user-vbaresponse.ts +45 -0
  165. package/models/security-field-user.ts +84 -0
  166. package/models/security-field-vbaresponse.ts +45 -0
  167. package/models/security-field.ts +72 -0
  168. package/models/smsdto.ts +67 -0
  169. package/models/ssoconfig-list-vbaresponse.ts +45 -0
  170. package/models/ssoconfig-vbaresponse.ts +45 -0
  171. package/models/ssoconfig.ts +84 -0
  172. package/models/sub-enrollment-plan.ts +3 -3
  173. package/models/sub-enrollment-rider.ts +4 -4
  174. package/models/sub-enrollment.ts +2 -2
  175. package/models/sub-payment-method.ts +1 -1
  176. package/models/submit-mfacode-request.ts +42 -0
  177. package/models/subscriber-forfeiture-status.ts +1 -1
  178. package/models/subscriber-sponsor-list-vbaresponse.ts +45 -0
  179. package/models/subscriber-sponsor-vbaresponse.ts +45 -0
  180. package/models/subscriber-sponsor.ts +84 -0
  181. package/models/subscriber-writing-agent-list-vbaresponse.ts +45 -0
  182. package/models/subscriber-writing-agent-vbaresponse.ts +45 -0
  183. package/models/subscriber-writing-agent.ts +90 -0
  184. package/models/suspense-claim-list.ts +228 -0
  185. package/models/tolerance-list-vbaresponse.ts +45 -0
  186. package/models/tolerance-vbaresponse.ts +45 -0
  187. package/models/tolerance.ts +72 -0
  188. package/models/userfieldsecurity.ts +66 -0
  189. package/models/userfieldsecuritylist-vbaresponse.ts +45 -0
  190. package/models/users.ts +13 -1
  191. package/models/usual-customary-rate-all-percentile-list-vbaresponse.ts +45 -0
  192. package/models/usual-customary-rate-all-percentile.ts +120 -0
  193. package/models/vbaclient-environment-list-vbaresponse.ts +45 -0
  194. package/models/vbaclient-environment.ts +37 -0
  195. package/models/vbaclient-list-vbaresponse.ts +45 -0
  196. package/models/vbaclient-vbaresponse.ts +45 -0
  197. package/models/vbaclient.ts +55 -0
  198. package/models/vbainterface-idcode.ts +31 -1
  199. package/models/vbainterface-map-type.ts +31 -1
  200. package/models/vbainterface.ts +43 -1
  201. package/models/vbaprem-invoice-subscriber-detail-adjustment-list-vbaresponse.ts +45 -0
  202. package/models/vbaprem-invoice-subscriber-detail-adjustment.ts +180 -0
  203. package/models/vbaprem-invoice-subscriber-detail-list-vbaresponse.ts +45 -0
  204. package/models/vbaprem-invoice-subscriber-detail.ts +180 -0
  205. package/models/vbareport-list-vbaresponse.ts +45 -0
  206. package/models/vbareport.ts +60 -0
  207. package/models/vbassologin-config.ts +42 -0
  208. package/models/workflow-auth.ts +54 -0
  209. package/models/workflow-check.ts +54 -0
  210. package/models/workflow-claim.ts +60 -0
  211. package/models/workflow-enrollment.ts +60 -0
  212. package/models/workflow-processing.ts +70 -0
  213. package/package.json +3 -3
package/api/user-api.ts CHANGED
@@ -21,12 +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
26
- import { StringListVBAResponse } from '../models';
30
+ import { RegisterMFADeviceRequest } from '../models';
31
+ // @ts-ignore
32
+ import { RegisterMFADeviceResponseVBAResponse } from '../models';
27
33
  // @ts-ignore
28
34
  import { StringVBAResponse } from '../models';
29
35
  // @ts-ignore
36
+ import { SubmitMFACodeRequest } from '../models';
37
+ // @ts-ignore
30
38
  import { UserAuthenticationResponseVBAResponse } from '../models';
31
39
  // @ts-ignore
32
40
  import { UserChangeTempPasswordRequest } from '../models';
@@ -141,6 +149,102 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
141
149
 
142
150
 
143
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
+
144
248
  setSearchParams(localVarUrlObj, localVarQueryParameter);
145
249
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
146
250
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -369,20 +473,25 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
369
473
  };
370
474
  },
371
475
  /**
372
- * Gets a User by ID
373
- * @summary Get User
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
374
480
  * @param {string} vbasoftwareDatabase Target database
375
- * @param {string} userID User ID
481
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
376
482
  * @param {*} [options] Override http request option.
377
483
  * @throws {RequiredError}
378
484
  */
379
- getUser: async (vbasoftwareDatabase: string, userID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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)
380
490
  // verify required parameter 'vbasoftwareDatabase' is not null or undefined
381
- assertParamExists('getUser', 'vbasoftwareDatabase', vbasoftwareDatabase)
382
- // verify required parameter 'userID' is not null or undefined
383
- assertParamExists('getUser', 'userID', userID)
384
- const localVarPath = `/users/{userID}`
385
- .replace(`{${"userID"}}`, encodeURIComponent(String(userID)));
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`;
386
495
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
387
496
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
388
497
  let baseOptions;
@@ -390,16 +499,20 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
390
499
  baseOptions = configuration.baseOptions;
391
500
  }
392
501
 
393
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
502
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
394
503
  const localVarHeaderParameter = {} as any;
395
504
  const localVarQueryParameter = {} as any;
396
505
 
397
506
  // authentication apiKeyAuth required
398
507
  await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
399
508
 
400
- // authentication bearerAuth required
401
- // http bearer authentication required
402
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
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
+ }
403
516
 
404
517
  if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
405
518
  localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
@@ -407,9 +520,12 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
407
520
 
408
521
 
409
522
 
523
+ localVarHeaderParameter['Content-Type'] = 'application/json';
524
+
410
525
  setSearchParams(localVarUrlObj, localVarQueryParameter);
411
526
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
412
527
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
528
+ localVarRequestOptions.data = serializeDataIfNeeded(generateAuthenticatorQRCodeRequest, localVarRequestOptions, configuration)
413
529
 
414
530
  return {
415
531
  url: toPathString(localVarUrlObj),
@@ -417,19 +533,20 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
417
533
  };
418
534
  },
419
535
  /**
420
- * Lists the databases that are available for API access for the given client id and client code.
421
- * @summary List Databases
422
- * @param {string} vbasoftwareClientId Client ID
423
- * @param {string} vbasoftwareClientCode Client Code
536
+ * Gets a User by ID
537
+ * @summary Get User
538
+ * @param {string} vbasoftwareDatabase Target database
539
+ * @param {string} userID User ID
424
540
  * @param {*} [options] Override http request option.
425
541
  * @throws {RequiredError}
426
542
  */
427
- listDatabases: async (vbasoftwareClientId: string, vbasoftwareClientCode: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
428
- // verify required parameter 'vbasoftwareClientId' is not null or undefined
429
- assertParamExists('listDatabases', 'vbasoftwareClientId', vbasoftwareClientId)
430
- // verify required parameter 'vbasoftwareClientCode' is not null or undefined
431
- assertParamExists('listDatabases', 'vbasoftwareClientCode', vbasoftwareClientCode)
432
- const localVarPath = `/databases`;
543
+ getUser: async (vbasoftwareDatabase: string, userID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
544
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
545
+ assertParamExists('getUser', 'vbasoftwareDatabase', vbasoftwareDatabase)
546
+ // verify required parameter 'userID' is not null or undefined
547
+ assertParamExists('getUser', 'userID', userID)
548
+ const localVarPath = `/users/{userID}`
549
+ .replace(`{${"userID"}}`, encodeURIComponent(String(userID)));
433
550
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
434
551
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
435
552
  let baseOptions;
@@ -444,12 +561,12 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
444
561
  // authentication apiKeyAuth required
445
562
  await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
446
563
 
447
- if (vbasoftwareClientId !== undefined && vbasoftwareClientId !== null) {
448
- localVarHeaderParameter['vbasoftware-client-id'] = String(vbasoftwareClientId);
449
- }
564
+ // authentication bearerAuth required
565
+ // http bearer authentication required
566
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
450
567
 
451
- if (vbasoftwareClientCode !== undefined && vbasoftwareClientCode !== null) {
452
- localVarHeaderParameter['vbasoftware-client-code'] = String(vbasoftwareClientCode);
568
+ if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
569
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
453
570
  }
454
571
 
455
572
 
@@ -575,6 +692,126 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
575
692
  options: localVarRequestOptions,
576
693
  };
577
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
+ },
578
815
  /**
579
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.
580
817
  * @summary Create or Update Batch Users
@@ -933,6 +1170,30 @@ export const UserApiFp = function(configuration?: Configuration) {
933
1170
  const localVarAxiosArgs = await localVarAxiosParamCreator.adminEnableUser(vbasoftwareDatabase, userID, options);
934
1171
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
935
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
+ },
936
1197
  /**
937
1198
  * Allows a user to enter a confirmation code to reset a forgotten password.
938
1199
  * @summary Confirm Forgot Password
@@ -986,27 +1247,29 @@ export const UserApiFp = function(configuration?: Configuration) {
986
1247
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
987
1248
  },
988
1249
  /**
989
- * Gets a User by ID
990
- * @summary Get User
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
991
1254
  * @param {string} vbasoftwareDatabase Target database
992
- * @param {string} userID User ID
1255
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
993
1256
  * @param {*} [options] Override http request option.
994
1257
  * @throws {RequiredError}
995
1258
  */
996
- async getUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersVBAResponse>> {
997
- const localVarAxiosArgs = await localVarAxiosParamCreator.getUser(vbasoftwareDatabase, userID, options);
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);
998
1261
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
999
1262
  },
1000
1263
  /**
1001
- * Lists the databases that are available for API access for the given client id and client code.
1002
- * @summary List Databases
1003
- * @param {string} vbasoftwareClientId Client ID
1004
- * @param {string} vbasoftwareClientCode Client Code
1264
+ * Gets a User by ID
1265
+ * @summary Get User
1266
+ * @param {string} vbasoftwareDatabase Target database
1267
+ * @param {string} userID User ID
1005
1268
  * @param {*} [options] Override http request option.
1006
1269
  * @throws {RequiredError}
1007
1270
  */
1008
- async listDatabases(vbasoftwareClientId: string, vbasoftwareClientCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringListVBAResponse>> {
1009
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDatabases(vbasoftwareClientId, vbasoftwareClientCode, options);
1271
+ async getUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersVBAResponse>> {
1272
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getUser(vbasoftwareDatabase, userID, options);
1010
1273
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1011
1274
  },
1012
1275
  /**
@@ -1035,6 +1298,34 @@ export const UserApiFp = function(configuration?: Configuration) {
1035
1298
  const localVarAxiosArgs = await localVarAxiosParamCreator.refreshUserTokens(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, expiredIdToken, refreshToken, options);
1036
1299
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1037
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
+ },
1038
1329
  /**
1039
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.
1040
1331
  * @summary Create or Update Batch Users
@@ -1144,6 +1435,28 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1144
1435
  adminEnableUser(vbasoftwareDatabase: string, userID: string, options?: any): AxiosPromise<StringVBAResponse> {
1145
1436
  return localVarFp.adminEnableUser(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
1146
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
+ },
1147
1460
  /**
1148
1461
  * Allows a user to enter a confirmation code to reset a forgotten password.
1149
1462
  * @summary Confirm Forgot Password
@@ -1193,26 +1506,28 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1193
1506
  return localVarFp.forgotPassword(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, userForgotPasswordRequest, options).then((request) => request(axios, basePath));
1194
1507
  },
1195
1508
  /**
1196
- * Gets a User by ID
1197
- * @summary Get User
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
1198
1513
  * @param {string} vbasoftwareDatabase Target database
1199
- * @param {string} userID User ID
1514
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
1200
1515
  * @param {*} [options] Override http request option.
1201
1516
  * @throws {RequiredError}
1202
1517
  */
1203
- getUser(vbasoftwareDatabase: string, userID: string, options?: any): AxiosPromise<UsersVBAResponse> {
1204
- return localVarFp.getUser(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
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));
1205
1520
  },
1206
1521
  /**
1207
- * Lists the databases that are available for API access for the given client id and client code.
1208
- * @summary List Databases
1209
- * @param {string} vbasoftwareClientId Client ID
1210
- * @param {string} vbasoftwareClientCode Client Code
1522
+ * Gets a User by ID
1523
+ * @summary Get User
1524
+ * @param {string} vbasoftwareDatabase Target database
1525
+ * @param {string} userID User ID
1211
1526
  * @param {*} [options] Override http request option.
1212
1527
  * @throws {RequiredError}
1213
1528
  */
1214
- listDatabases(vbasoftwareClientId: string, vbasoftwareClientCode: string, options?: any): AxiosPromise<StringListVBAResponse> {
1215
- return localVarFp.listDatabases(vbasoftwareClientId, vbasoftwareClientCode, options).then((request) => request(axios, basePath));
1529
+ getUser(vbasoftwareDatabase: string, userID: string, options?: any): AxiosPromise<UsersVBAResponse> {
1530
+ return localVarFp.getUser(vbasoftwareDatabase, userID, options).then((request) => request(axios, basePath));
1216
1531
  },
1217
1532
  /**
1218
1533
  * Lists all Users
@@ -1238,6 +1553,32 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
1238
1553
  refreshUserTokens(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, expiredIdToken: string, refreshToken: string, options?: any): AxiosPromise<UserAuthenticationResponseVBAResponse> {
1239
1554
  return localVarFp.refreshUserTokens(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, expiredIdToken, refreshToken, options).then((request) => request(axios, basePath));
1240
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
+ },
1241
1582
  /**
1242
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.
1243
1584
  * @summary Create or Update Batch Users
@@ -1340,6 +1681,28 @@ export interface UserApiInterface {
1340
1681
  */
1341
1682
  adminEnableUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
1342
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
+
1343
1706
  /**
1344
1707
  * Allows a user to enter a confirmation code to reset a forgotten password.
1345
1708
  * @summary Confirm Forgot Password
@@ -1389,26 +1752,28 @@ export interface UserApiInterface {
1389
1752
  forgotPassword(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, userForgotPasswordRequest: UserForgotPasswordRequest, options?: AxiosRequestConfig): AxiosPromise<UserForgotPasswordResponseVBAResponse>;
1390
1753
 
1391
1754
  /**
1392
- * Gets a User by ID
1393
- * @summary Get User
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
1394
1759
  * @param {string} vbasoftwareDatabase Target database
1395
- * @param {string} userID User ID
1760
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
1396
1761
  * @param {*} [options] Override http request option.
1397
1762
  * @throws {RequiredError}
1398
1763
  * @memberof UserApiInterface
1399
1764
  */
1400
- getUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): AxiosPromise<UsersVBAResponse>;
1765
+ generateAuthenticatorQRCode(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, generateAuthenticatorQRCodeRequest: GenerateAuthenticatorQRCodeRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateAuthenticatorQRCodeResponseVBAResponse>;
1401
1766
 
1402
1767
  /**
1403
- * Lists the databases that are available for API access for the given client id and client code.
1404
- * @summary List Databases
1405
- * @param {string} vbasoftwareClientId Client ID
1406
- * @param {string} vbasoftwareClientCode Client Code
1768
+ * Gets a User by ID
1769
+ * @summary Get User
1770
+ * @param {string} vbasoftwareDatabase Target database
1771
+ * @param {string} userID User ID
1407
1772
  * @param {*} [options] Override http request option.
1408
1773
  * @throws {RequiredError}
1409
1774
  * @memberof UserApiInterface
1410
1775
  */
1411
- listDatabases(vbasoftwareClientId: string, vbasoftwareClientCode: string, options?: AxiosRequestConfig): AxiosPromise<StringListVBAResponse>;
1776
+ getUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig): AxiosPromise<UsersVBAResponse>;
1412
1777
 
1413
1778
  /**
1414
1779
  * Lists all Users
@@ -1434,6 +1799,32 @@ export interface UserApiInterface {
1434
1799
  */
1435
1800
  refreshUserTokens(vbasoftwareClientId: string, vbasoftwareClientCode: string, vbasoftwareDatabase: string, expiredIdToken: string, refreshToken: string, options?: AxiosRequestConfig): AxiosPromise<UserAuthenticationResponseVBAResponse>;
1436
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
+
1437
1828
  /**
1438
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.
1439
1830
  * @summary Create or Update Batch Users
@@ -1540,6 +1931,32 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1540
1931
  return UserApiFp(this.configuration).adminEnableUser(vbasoftwareDatabase, userID, options).then((request) => request(this.axios, this.basePath));
1541
1932
  }
1542
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
+
1543
1960
  /**
1544
1961
  * Allows a user to enter a confirmation code to reset a forgotten password.
1545
1962
  * @summary Confirm Forgot Password
@@ -1597,29 +2014,31 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1597
2014
  }
1598
2015
 
1599
2016
  /**
1600
- * Gets a User by ID
1601
- * @summary Get User
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
1602
2021
  * @param {string} vbasoftwareDatabase Target database
1603
- * @param {string} userID User ID
2022
+ * @param {GenerateAuthenticatorQRCodeRequest} generateAuthenticatorQRCodeRequest
1604
2023
  * @param {*} [options] Override http request option.
1605
2024
  * @throws {RequiredError}
1606
2025
  * @memberof UserApi
1607
2026
  */
1608
- public getUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig) {
1609
- return UserApiFp(this.configuration).getUser(vbasoftwareDatabase, userID, options).then((request) => request(this.axios, this.basePath));
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));
1610
2029
  }
1611
2030
 
1612
2031
  /**
1613
- * Lists the databases that are available for API access for the given client id and client code.
1614
- * @summary List Databases
1615
- * @param {string} vbasoftwareClientId Client ID
1616
- * @param {string} vbasoftwareClientCode Client Code
2032
+ * Gets a User by ID
2033
+ * @summary Get User
2034
+ * @param {string} vbasoftwareDatabase Target database
2035
+ * @param {string} userID User ID
1617
2036
  * @param {*} [options] Override http request option.
1618
2037
  * @throws {RequiredError}
1619
2038
  * @memberof UserApi
1620
2039
  */
1621
- public listDatabases(vbasoftwareClientId: string, vbasoftwareClientCode: string, options?: AxiosRequestConfig) {
1622
- return UserApiFp(this.configuration).listDatabases(vbasoftwareClientId, vbasoftwareClientCode, options).then((request) => request(this.axios, this.basePath));
2040
+ public getUser(vbasoftwareDatabase: string, userID: string, options?: AxiosRequestConfig) {
2041
+ return UserApiFp(this.configuration).getUser(vbasoftwareDatabase, userID, options).then((request) => request(this.axios, this.basePath));
1623
2042
  }
1624
2043
 
1625
2044
  /**
@@ -1650,6 +2069,36 @@ export class UserApi extends BaseAPI implements UserApiInterface {
1650
2069
  return UserApiFp(this.configuration).refreshUserTokens(vbasoftwareClientId, vbasoftwareClientCode, vbasoftwareDatabase, expiredIdToken, refreshToken, options).then((request) => request(this.axios, this.basePath));
1651
2070
  }
1652
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
+
1653
2102
  /**
1654
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.
1655
2104
  * @summary Create or Update Batch Users