@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250124.1 → 1.20250207.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,6 +37,59 @@ import type { PlansListVBAResponse } from '../models';
37
37
  */
38
38
  export const GroupContractPlansApiAxiosParamCreator = function (configuration?: Configuration) {
39
39
  return {
40
+ /**
41
+ * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
42
+ * @summary Cascade Plan Update to GroupContractPlan
43
+ * @param {string} vbasoftwareDatabase Target database
44
+ * @param {string} planId Plan ID
45
+ * @param {GroupContractPlan} groupContractPlan
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ cascadeUpdateGroupContractPlan: async (vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
51
+ assertParamExists('cascadeUpdateGroupContractPlan', 'vbasoftwareDatabase', vbasoftwareDatabase)
52
+ // verify required parameter 'planId' is not null or undefined
53
+ assertParamExists('cascadeUpdateGroupContractPlan', 'planId', planId)
54
+ // verify required parameter 'groupContractPlan' is not null or undefined
55
+ assertParamExists('cascadeUpdateGroupContractPlan', 'groupContractPlan', groupContractPlan)
56
+ const localVarPath = `/group-contract-plan-cascade-update/{planId}`
57
+ .replace(`{${"planId"}}`, encodeURIComponent(String(planId)));
58
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
59
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
60
+ let baseOptions;
61
+ if (configuration) {
62
+ baseOptions = configuration.baseOptions;
63
+ }
64
+
65
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
66
+ const localVarHeaderParameter = {} as any;
67
+ const localVarQueryParameter = {} as any;
68
+
69
+ // authentication apiKeyAuth required
70
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
71
+
72
+ // authentication bearerAuth required
73
+ // http bearer authentication required
74
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
75
+
76
+
77
+
78
+ localVarHeaderParameter['Content-Type'] = 'application/json';
79
+
80
+ if (vbasoftwareDatabase != null) {
81
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
82
+ }
83
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
84
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
85
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
86
+ localVarRequestOptions.data = serializeDataIfNeeded(groupContractPlan, localVarRequestOptions, configuration)
87
+
88
+ return {
89
+ url: toPathString(localVarUrlObj),
90
+ options: localVarRequestOptions,
91
+ };
92
+ },
40
93
  /**
41
94
  * Creates a new GroupContractPlan
42
95
  * @summary Create GroupContractPlan
@@ -473,6 +526,21 @@ export const GroupContractPlansApiAxiosParamCreator = function (configuration?:
473
526
  export const GroupContractPlansApiFp = function(configuration?: Configuration) {
474
527
  const localVarAxiosParamCreator = GroupContractPlansApiAxiosParamCreator(configuration)
475
528
  return {
529
+ /**
530
+ * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
531
+ * @summary Cascade Plan Update to GroupContractPlan
532
+ * @param {string} vbasoftwareDatabase Target database
533
+ * @param {string} planId Plan ID
534
+ * @param {GroupContractPlan} groupContractPlan
535
+ * @param {*} [options] Override http request option.
536
+ * @throws {RequiredError}
537
+ */
538
+ async cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupContractPlanVBAResponse>> {
539
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cascadeUpdateGroupContractPlan(vbasoftwareDatabase, planId, groupContractPlan, options);
540
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
541
+ const localVarOperationServerBasePath = operationServerMap['GroupContractPlansApi.cascadeUpdateGroupContractPlan']?.[localVarOperationServerIndex]?.url;
542
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
543
+ },
476
544
  /**
477
545
  * Creates a new GroupContractPlan
478
546
  * @summary Create GroupContractPlan
@@ -603,6 +671,18 @@ export const GroupContractPlansApiFp = function(configuration?: Configuration) {
603
671
  export const GroupContractPlansApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
604
672
  const localVarFp = GroupContractPlansApiFp(configuration)
605
673
  return {
674
+ /**
675
+ * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
676
+ * @summary Cascade Plan Update to GroupContractPlan
677
+ * @param {string} vbasoftwareDatabase Target database
678
+ * @param {string} planId Plan ID
679
+ * @param {GroupContractPlan} groupContractPlan
680
+ * @param {*} [options] Override http request option.
681
+ * @throws {RequiredError}
682
+ */
683
+ cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig): AxiosPromise<GroupContractPlanVBAResponse> {
684
+ return localVarFp.cascadeUpdateGroupContractPlan(vbasoftwareDatabase, planId, groupContractPlan, options).then((request) => request(axios, basePath));
685
+ },
606
686
  /**
607
687
  * Creates a new GroupContractPlan
608
688
  * @summary Create GroupContractPlan
@@ -711,6 +791,18 @@ export const GroupContractPlansApiFactory = function (configuration?: Configurat
711
791
  * @interface GroupContractPlansApi
712
792
  */
713
793
  export interface GroupContractPlansApiInterface {
794
+ /**
795
+ * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
796
+ * @summary Cascade Plan Update to GroupContractPlan
797
+ * @param {string} vbasoftwareDatabase Target database
798
+ * @param {string} planId Plan ID
799
+ * @param {GroupContractPlan} groupContractPlan
800
+ * @param {*} [options] Override http request option.
801
+ * @throws {RequiredError}
802
+ * @memberof GroupContractPlansApiInterface
803
+ */
804
+ cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig): AxiosPromise<GroupContractPlanVBAResponse>;
805
+
714
806
  /**
715
807
  * Creates a new GroupContractPlan
716
808
  * @summary Create GroupContractPlan
@@ -819,6 +911,20 @@ export interface GroupContractPlansApiInterface {
819
911
  * @extends {BaseAPI}
820
912
  */
821
913
  export class GroupContractPlansApi extends BaseAPI implements GroupContractPlansApiInterface {
914
+ /**
915
+ * Using an existing GroupContractPlan, pass in a Plan ID to be updated that then updates downstream SubenrollmentPlan and MemenrollmentPlan records.
916
+ * @summary Cascade Plan Update to GroupContractPlan
917
+ * @param {string} vbasoftwareDatabase Target database
918
+ * @param {string} planId Plan ID
919
+ * @param {GroupContractPlan} groupContractPlan
920
+ * @param {*} [options] Override http request option.
921
+ * @throws {RequiredError}
922
+ * @memberof GroupContractPlansApi
923
+ */
924
+ public cascadeUpdateGroupContractPlan(vbasoftwareDatabase: string, planId: string, groupContractPlan: GroupContractPlan, options?: RawAxiosRequestConfig) {
925
+ return GroupContractPlansApiFp(this.configuration).cascadeUpdateGroupContractPlan(vbasoftwareDatabase, planId, groupContractPlan, options).then((request) => request(this.axios, this.basePath));
926
+ }
927
+
822
928
  /**
823
929
  * Creates a new GroupContractPlan
824
930
  * @summary Create GroupContractPlan
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
+ import type { BooleanVBAResponse } from '../models';
26
+ // @ts-ignore
25
27
  import type { MultiCodeResponseListVBAResponse } from '../models';
26
28
  // @ts-ignore
27
29
  import type { PremApplyPaymentCategoryResultListVBAResponse } from '../models';
@@ -301,6 +303,67 @@ export const PremiumPaymentsApiAxiosParamCreator = function (configuration?: Con
301
303
 
302
304
 
303
305
 
306
+ if (vbasoftwareDatabase != null) {
307
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
308
+ }
309
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
310
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
311
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
312
+
313
+ return {
314
+ url: toPathString(localVarUrlObj),
315
+ options: localVarRequestOptions,
316
+ };
317
+ },
318
+ /**
319
+ * Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.
320
+ * @summary Process or Check Invoice Tolerance
321
+ * @param {string} vbasoftwareDatabase Target database
322
+ * @param {number} invoiceKey Invoice Key
323
+ * @param {number} amountDue Amount Due
324
+ * @param {boolean} verifyOnly Verify Only
325
+ * @param {*} [options] Override http request option.
326
+ * @throws {RequiredError}
327
+ */
328
+ processInvoiceTolerance: async (vbasoftwareDatabase: string, invoiceKey: number, amountDue: number, verifyOnly: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
329
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
330
+ assertParamExists('processInvoiceTolerance', 'vbasoftwareDatabase', vbasoftwareDatabase)
331
+ // verify required parameter 'invoiceKey' is not null or undefined
332
+ assertParamExists('processInvoiceTolerance', 'invoiceKey', invoiceKey)
333
+ // verify required parameter 'amountDue' is not null or undefined
334
+ assertParamExists('processInvoiceTolerance', 'amountDue', amountDue)
335
+ // verify required parameter 'verifyOnly' is not null or undefined
336
+ assertParamExists('processInvoiceTolerance', 'verifyOnly', verifyOnly)
337
+ const localVarPath = `/process-invoice-tolerance/{invoiceKey}`
338
+ .replace(`{${"invoiceKey"}}`, encodeURIComponent(String(invoiceKey)));
339
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
340
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
341
+ let baseOptions;
342
+ if (configuration) {
343
+ baseOptions = configuration.baseOptions;
344
+ }
345
+
346
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
347
+ const localVarHeaderParameter = {} as any;
348
+ const localVarQueryParameter = {} as any;
349
+
350
+ // authentication apiKeyAuth required
351
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
352
+
353
+ // authentication bearerAuth required
354
+ // http bearer authentication required
355
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
356
+
357
+ if (amountDue !== undefined) {
358
+ localVarQueryParameter['amountDue'] = amountDue;
359
+ }
360
+
361
+ if (verifyOnly !== undefined) {
362
+ localVarQueryParameter['verifyOnly'] = verifyOnly;
363
+ }
364
+
365
+
366
+
304
367
  if (vbasoftwareDatabase != null) {
305
368
  localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
306
369
  }
@@ -549,6 +612,22 @@ export const PremiumPaymentsApiFp = function(configuration?: Configuration) {
549
612
  const localVarOperationServerBasePath = operationServerMap['PremiumPaymentsApi.listPremPayment']?.[localVarOperationServerIndex]?.url;
550
613
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
551
614
  },
615
+ /**
616
+ * Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.
617
+ * @summary Process or Check Invoice Tolerance
618
+ * @param {string} vbasoftwareDatabase Target database
619
+ * @param {number} invoiceKey Invoice Key
620
+ * @param {number} amountDue Amount Due
621
+ * @param {boolean} verifyOnly Verify Only
622
+ * @param {*} [options] Override http request option.
623
+ * @throws {RequiredError}
624
+ */
625
+ async processInvoiceTolerance(vbasoftwareDatabase: string, invoiceKey: number, amountDue: number, verifyOnly: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BooleanVBAResponse>> {
626
+ const localVarAxiosArgs = await localVarAxiosParamCreator.processInvoiceTolerance(vbasoftwareDatabase, invoiceKey, amountDue, verifyOnly, options);
627
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
628
+ const localVarOperationServerBasePath = operationServerMap['PremiumPaymentsApi.processInvoiceTolerance']?.[localVarOperationServerIndex]?.url;
629
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
630
+ },
552
631
  /**
553
632
  * Import a defined Payment File in .csv format to then have payments created and, optionally, attached to invoices.
554
633
  * @summary Process Payment File
@@ -662,6 +741,19 @@ export const PremiumPaymentsApiFactory = function (configuration?: Configuration
662
741
  listPremPayment(vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<PremPaymentListVBAResponse> {
663
742
  return localVarFp.listPremPayment(vbasoftwareDatabase, page, pageSize, sortBy, options).then((request) => request(axios, basePath));
664
743
  },
744
+ /**
745
+ * Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.
746
+ * @summary Process or Check Invoice Tolerance
747
+ * @param {string} vbasoftwareDatabase Target database
748
+ * @param {number} invoiceKey Invoice Key
749
+ * @param {number} amountDue Amount Due
750
+ * @param {boolean} verifyOnly Verify Only
751
+ * @param {*} [options] Override http request option.
752
+ * @throws {RequiredError}
753
+ */
754
+ processInvoiceTolerance(vbasoftwareDatabase: string, invoiceKey: number, amountDue: number, verifyOnly: boolean, options?: RawAxiosRequestConfig): AxiosPromise<BooleanVBAResponse> {
755
+ return localVarFp.processInvoiceTolerance(vbasoftwareDatabase, invoiceKey, amountDue, verifyOnly, options).then((request) => request(axios, basePath));
756
+ },
665
757
  /**
666
758
  * Import a defined Payment File in .csv format to then have payments created and, optionally, attached to invoices.
667
759
  * @summary Process Payment File
@@ -765,6 +857,19 @@ export interface PremiumPaymentsApiInterface {
765
857
  */
766
858
  listPremPayment(vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<PremPaymentListVBAResponse>;
767
859
 
860
+ /**
861
+ * Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.
862
+ * @summary Process or Check Invoice Tolerance
863
+ * @param {string} vbasoftwareDatabase Target database
864
+ * @param {number} invoiceKey Invoice Key
865
+ * @param {number} amountDue Amount Due
866
+ * @param {boolean} verifyOnly Verify Only
867
+ * @param {*} [options] Override http request option.
868
+ * @throws {RequiredError}
869
+ * @memberof PremiumPaymentsApiInterface
870
+ */
871
+ processInvoiceTolerance(vbasoftwareDatabase: string, invoiceKey: number, amountDue: number, verifyOnly: boolean, options?: RawAxiosRequestConfig): AxiosPromise<BooleanVBAResponse>;
872
+
768
873
  /**
769
874
  * Import a defined Payment File in .csv format to then have payments created and, optionally, attached to invoices.
770
875
  * @summary Process Payment File
@@ -878,6 +983,21 @@ export class PremiumPaymentsApi extends BaseAPI implements PremiumPaymentsApiInt
878
983
  return PremiumPaymentsApiFp(this.configuration).listPremPayment(vbasoftwareDatabase, page, pageSize, sortBy, options).then((request) => request(this.axios, this.basePath));
879
984
  }
880
985
 
986
+ /**
987
+ * Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.
988
+ * @summary Process or Check Invoice Tolerance
989
+ * @param {string} vbasoftwareDatabase Target database
990
+ * @param {number} invoiceKey Invoice Key
991
+ * @param {number} amountDue Amount Due
992
+ * @param {boolean} verifyOnly Verify Only
993
+ * @param {*} [options] Override http request option.
994
+ * @throws {RequiredError}
995
+ * @memberof PremiumPaymentsApi
996
+ */
997
+ public processInvoiceTolerance(vbasoftwareDatabase: string, invoiceKey: number, amountDue: number, verifyOnly: boolean, options?: RawAxiosRequestConfig) {
998
+ return PremiumPaymentsApiFp(this.configuration).processInvoiceTolerance(vbasoftwareDatabase, invoiceKey, amountDue, verifyOnly, options).then((request) => request(this.axios, this.basePath));
999
+ }
1000
+
881
1001
  /**
882
1002
  * Import a defined Payment File in .csv format to then have payments created and, optionally, attached to invoices.
883
1003
  * @summary Process Payment File
@@ -56,7 +56,7 @@ export const SupportApiAxiosParamCreator = function (configuration?: Configurati
56
56
  assertParamExists('createSupportUser', 'targetVbasoftwareClientCode', targetVbasoftwareClientCode)
57
57
  // verify required parameter 'targetVbasoftwareDatabase' is not null or undefined
58
58
  assertParamExists('createSupportUser', 'targetVbasoftwareDatabase', targetVbasoftwareDatabase)
59
- const localVarPath = `/support/client-users`;
59
+ const localVarPath = `/support/client-users/add-me`;
60
60
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
61
61
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
62
62
  let baseOptions;
@@ -85,6 +85,67 @@ export const SupportApiAxiosParamCreator = function (configuration?: Configurati
85
85
 
86
86
 
87
87
 
88
+ if (vbasoftwareDatabase != null) {
89
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
90
+ }
91
+ if (targetVbasoftwareClientId != null) {
92
+ localVarHeaderParameter['target-vbasoftware-client-id'] = String(targetVbasoftwareClientId);
93
+ }
94
+ if (targetVbasoftwareClientCode != null) {
95
+ localVarHeaderParameter['target-vbasoftware-client-code'] = String(targetVbasoftwareClientCode);
96
+ }
97
+ if (targetVbasoftwareDatabase != null) {
98
+ localVarHeaderParameter['target-vbasoftware-database'] = String(targetVbasoftwareDatabase);
99
+ }
100
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
101
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
102
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
103
+
104
+ return {
105
+ url: toPathString(localVarUrlObj),
106
+ options: localVarRequestOptions,
107
+ };
108
+ },
109
+ /**
110
+ * This endpoint allows you to disable the currently authenticated Support user within the client\'s environment instead of deleting them.
111
+ * @summary Disables the Support User in a client environment
112
+ * @param {string} vbasoftwareDatabase Support Database
113
+ * @param {string} targetVbasoftwareClientId Target Client ID
114
+ * @param {string} targetVbasoftwareClientCode Target Client Code
115
+ * @param {string} targetVbasoftwareDatabase Target Client Database
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ disableSupportUser: async (vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
120
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
121
+ assertParamExists('disableSupportUser', 'vbasoftwareDatabase', vbasoftwareDatabase)
122
+ // verify required parameter 'targetVbasoftwareClientId' is not null or undefined
123
+ assertParamExists('disableSupportUser', 'targetVbasoftwareClientId', targetVbasoftwareClientId)
124
+ // verify required parameter 'targetVbasoftwareClientCode' is not null or undefined
125
+ assertParamExists('disableSupportUser', 'targetVbasoftwareClientCode', targetVbasoftwareClientCode)
126
+ // verify required parameter 'targetVbasoftwareDatabase' is not null or undefined
127
+ assertParamExists('disableSupportUser', 'targetVbasoftwareDatabase', targetVbasoftwareDatabase)
128
+ const localVarPath = `/support/client-users/disable-me`;
129
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
130
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
131
+ let baseOptions;
132
+ if (configuration) {
133
+ baseOptions = configuration.baseOptions;
134
+ }
135
+
136
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
137
+ const localVarHeaderParameter = {} as any;
138
+ const localVarQueryParameter = {} as any;
139
+
140
+ // authentication apiKeyAuth required
141
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
142
+
143
+ // authentication bearerAuth required
144
+ // http bearer authentication required
145
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
146
+
147
+
148
+
88
149
  if (vbasoftwareDatabase != null) {
89
150
  localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
90
151
  }
@@ -295,6 +356,22 @@ export const SupportApiFp = function(configuration?: Configuration) {
295
356
  const localVarOperationServerBasePath = operationServerMap['SupportApi.createSupportUser']?.[localVarOperationServerIndex]?.url;
296
357
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
297
358
  },
359
+ /**
360
+ * This endpoint allows you to disable the currently authenticated Support user within the client\'s environment instead of deleting them.
361
+ * @summary Disables the Support User in a client environment
362
+ * @param {string} vbasoftwareDatabase Support Database
363
+ * @param {string} targetVbasoftwareClientId Target Client ID
364
+ * @param {string} targetVbasoftwareClientCode Target Client Code
365
+ * @param {string} targetVbasoftwareDatabase Target Client Database
366
+ * @param {*} [options] Override http request option.
367
+ * @throws {RequiredError}
368
+ */
369
+ async disableSupportUser(vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
370
+ const localVarAxiosArgs = await localVarAxiosParamCreator.disableSupportUser(vbasoftwareDatabase, targetVbasoftwareClientId, targetVbasoftwareClientCode, targetVbasoftwareDatabase, options);
371
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
372
+ const localVarOperationServerBasePath = operationServerMap['SupportApi.disableSupportUser']?.[localVarOperationServerIndex]?.url;
373
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
374
+ },
298
375
  /**
299
376
  * Gets the client details for the given client id and client code.
300
377
  * @summary Get Client
@@ -364,6 +441,19 @@ export const SupportApiFactory = function (configuration?: Configuration, basePa
364
441
  createSupportUser(vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, userIdToClone?: string, makeAdmin?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<UsersVBAResponse> {
365
442
  return localVarFp.createSupportUser(vbasoftwareDatabase, targetVbasoftwareClientId, targetVbasoftwareClientCode, targetVbasoftwareDatabase, userIdToClone, makeAdmin, options).then((request) => request(axios, basePath));
366
443
  },
444
+ /**
445
+ * This endpoint allows you to disable the currently authenticated Support user within the client\'s environment instead of deleting them.
446
+ * @summary Disables the Support User in a client environment
447
+ * @param {string} vbasoftwareDatabase Support Database
448
+ * @param {string} targetVbasoftwareClientId Target Client ID
449
+ * @param {string} targetVbasoftwareClientCode Target Client Code
450
+ * @param {string} targetVbasoftwareDatabase Target Client Database
451
+ * @param {*} [options] Override http request option.
452
+ * @throws {RequiredError}
453
+ */
454
+ disableSupportUser(vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
455
+ return localVarFp.disableSupportUser(vbasoftwareDatabase, targetVbasoftwareClientId, targetVbasoftwareClientCode, targetVbasoftwareDatabase, options).then((request) => request(axios, basePath));
456
+ },
367
457
  /**
368
458
  * Gets the client details for the given client id and client code.
369
459
  * @summary Get Client
@@ -423,6 +513,19 @@ export interface SupportApiInterface {
423
513
  */
424
514
  createSupportUser(vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, userIdToClone?: string, makeAdmin?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<UsersVBAResponse>;
425
515
 
516
+ /**
517
+ * This endpoint allows you to disable the currently authenticated Support user within the client\'s environment instead of deleting them.
518
+ * @summary Disables the Support User in a client environment
519
+ * @param {string} vbasoftwareDatabase Support Database
520
+ * @param {string} targetVbasoftwareClientId Target Client ID
521
+ * @param {string} targetVbasoftwareClientCode Target Client Code
522
+ * @param {string} targetVbasoftwareDatabase Target Client Database
523
+ * @param {*} [options] Override http request option.
524
+ * @throws {RequiredError}
525
+ * @memberof SupportApiInterface
526
+ */
527
+ disableSupportUser(vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
528
+
426
529
  /**
427
530
  * Gets the client details for the given client id and client code.
428
531
  * @summary Get Client
@@ -484,6 +587,21 @@ export class SupportApi extends BaseAPI implements SupportApiInterface {
484
587
  return SupportApiFp(this.configuration).createSupportUser(vbasoftwareDatabase, targetVbasoftwareClientId, targetVbasoftwareClientCode, targetVbasoftwareDatabase, userIdToClone, makeAdmin, options).then((request) => request(this.axios, this.basePath));
485
588
  }
486
589
 
590
+ /**
591
+ * This endpoint allows you to disable the currently authenticated Support user within the client\'s environment instead of deleting them.
592
+ * @summary Disables the Support User in a client environment
593
+ * @param {string} vbasoftwareDatabase Support Database
594
+ * @param {string} targetVbasoftwareClientId Target Client ID
595
+ * @param {string} targetVbasoftwareClientCode Target Client Code
596
+ * @param {string} targetVbasoftwareDatabase Target Client Database
597
+ * @param {*} [options] Override http request option.
598
+ * @throws {RequiredError}
599
+ * @memberof SupportApi
600
+ */
601
+ public disableSupportUser(vbasoftwareDatabase: string, targetVbasoftwareClientId: string, targetVbasoftwareClientCode: string, targetVbasoftwareDatabase: string, options?: RawAxiosRequestConfig) {
602
+ return SupportApiFp(this.configuration).disableSupportUser(vbasoftwareDatabase, targetVbasoftwareClientId, targetVbasoftwareClientCode, targetVbasoftwareDatabase, options).then((request) => request(this.axios, this.basePath));
603
+ }
604
+
487
605
  /**
488
606
  * Gets the client details for the given client id and client code.
489
607
  * @summary Get Client
@@ -31,6 +31,8 @@ import type { MessageThreadVBAResponse } from '../models';
31
31
  import type { Messages } from '../models';
32
32
  // @ts-ignore
33
33
  import type { MessagesVBAResponse } from '../models';
34
+ // @ts-ignore
35
+ import type { TransposeRequestMetaDataResultListVBAResponse } from '../models';
34
36
  /**
35
37
  * VBAGatewayMessagingApi - axios parameter creator
36
38
  * @export
@@ -232,6 +234,53 @@ export const VBAGatewayMessagingApiAxiosParamCreator = function (configuration?:
232
234
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
233
235
  localVarRequestOptions.data = serializeDataIfNeeded(messageThread, localVarRequestOptions, configuration)
234
236
 
237
+ return {
238
+ url: toPathString(localVarUrlObj),
239
+ options: localVarRequestOptions,
240
+ };
241
+ },
242
+ /**
243
+ * Gets VBAGateway Request in real-time and converts the request into key/value pairs. VBAGateway requests may have different keys based on the request type.
244
+ * @summary Get VBAGateway Request and Transpose to key/value pairs
245
+ * @param {string} vbasoftwareDatabase Target database
246
+ * @param {number} requestKey Request_Key
247
+ * @param {*} [options] Override http request option.
248
+ * @throws {RequiredError}
249
+ */
250
+ vBAGatewayTransposeRequest: async (vbasoftwareDatabase: string, requestKey: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
251
+ // verify required parameter 'vbasoftwareDatabase' is not null or undefined
252
+ assertParamExists('vBAGatewayTransposeRequest', 'vbasoftwareDatabase', vbasoftwareDatabase)
253
+ // verify required parameter 'requestKey' is not null or undefined
254
+ assertParamExists('vBAGatewayTransposeRequest', 'requestKey', requestKey)
255
+ const localVarPath = `/vbagateway-requests/{Request_Key}/transpose`
256
+ .replace(`{${"Request_Key"}}`, encodeURIComponent(String(requestKey)));
257
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
258
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
259
+ let baseOptions;
260
+ if (configuration) {
261
+ baseOptions = configuration.baseOptions;
262
+ }
263
+
264
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
265
+ const localVarHeaderParameter = {} as any;
266
+ const localVarQueryParameter = {} as any;
267
+
268
+ // authentication apiKeyAuth required
269
+ await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
270
+
271
+ // authentication bearerAuth required
272
+ // http bearer authentication required
273
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
274
+
275
+
276
+
277
+ if (vbasoftwareDatabase != null) {
278
+ localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
279
+ }
280
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
281
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
282
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
283
+
235
284
  return {
236
285
  url: toPathString(localVarUrlObj),
237
286
  options: localVarRequestOptions,
@@ -305,6 +354,20 @@ export const VBAGatewayMessagingApiFp = function(configuration?: Configuration)
305
354
  const localVarOperationServerBasePath = operationServerMap['VBAGatewayMessagingApi.updateVBAGatewayMessageThread']?.[localVarOperationServerIndex]?.url;
306
355
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
307
356
  },
357
+ /**
358
+ * Gets VBAGateway Request in real-time and converts the request into key/value pairs. VBAGateway requests may have different keys based on the request type.
359
+ * @summary Get VBAGateway Request and Transpose to key/value pairs
360
+ * @param {string} vbasoftwareDatabase Target database
361
+ * @param {number} requestKey Request_Key
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ async vBAGatewayTransposeRequest(vbasoftwareDatabase: string, requestKey: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransposeRequestMetaDataResultListVBAResponse>> {
366
+ const localVarAxiosArgs = await localVarAxiosParamCreator.vBAGatewayTransposeRequest(vbasoftwareDatabase, requestKey, options);
367
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
368
+ const localVarOperationServerBasePath = operationServerMap['VBAGatewayMessagingApi.vBAGatewayTransposeRequest']?.[localVarOperationServerIndex]?.url;
369
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
370
+ },
308
371
  }
309
372
  };
310
373
 
@@ -361,6 +424,17 @@ export const VBAGatewayMessagingApiFactory = function (configuration?: Configura
361
424
  updateVBAGatewayMessageThread(vbasoftwareDatabase: string, messageThreadKey: number, messageThread: MessageThread, options?: RawAxiosRequestConfig): AxiosPromise<MessageThreadVBAResponse> {
362
425
  return localVarFp.updateVBAGatewayMessageThread(vbasoftwareDatabase, messageThreadKey, messageThread, options).then((request) => request(axios, basePath));
363
426
  },
427
+ /**
428
+ * Gets VBAGateway Request in real-time and converts the request into key/value pairs. VBAGateway requests may have different keys based on the request type.
429
+ * @summary Get VBAGateway Request and Transpose to key/value pairs
430
+ * @param {string} vbasoftwareDatabase Target database
431
+ * @param {number} requestKey Request_Key
432
+ * @param {*} [options] Override http request option.
433
+ * @throws {RequiredError}
434
+ */
435
+ vBAGatewayTransposeRequest(vbasoftwareDatabase: string, requestKey: number, options?: RawAxiosRequestConfig): AxiosPromise<TransposeRequestMetaDataResultListVBAResponse> {
436
+ return localVarFp.vBAGatewayTransposeRequest(vbasoftwareDatabase, requestKey, options).then((request) => request(axios, basePath));
437
+ },
364
438
  };
365
439
  };
366
440
 
@@ -416,6 +490,17 @@ export interface VBAGatewayMessagingApiInterface {
416
490
  */
417
491
  updateVBAGatewayMessageThread(vbasoftwareDatabase: string, messageThreadKey: number, messageThread: MessageThread, options?: RawAxiosRequestConfig): AxiosPromise<MessageThreadVBAResponse>;
418
492
 
493
+ /**
494
+ * Gets VBAGateway Request in real-time and converts the request into key/value pairs. VBAGateway requests may have different keys based on the request type.
495
+ * @summary Get VBAGateway Request and Transpose to key/value pairs
496
+ * @param {string} vbasoftwareDatabase Target database
497
+ * @param {number} requestKey Request_Key
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ * @memberof VBAGatewayMessagingApiInterface
501
+ */
502
+ vBAGatewayTransposeRequest(vbasoftwareDatabase: string, requestKey: number, options?: RawAxiosRequestConfig): AxiosPromise<TransposeRequestMetaDataResultListVBAResponse>;
503
+
419
504
  }
420
505
 
421
506
  /**
@@ -478,5 +563,18 @@ export class VBAGatewayMessagingApi extends BaseAPI implements VBAGatewayMessagi
478
563
  public updateVBAGatewayMessageThread(vbasoftwareDatabase: string, messageThreadKey: number, messageThread: MessageThread, options?: RawAxiosRequestConfig) {
479
564
  return VBAGatewayMessagingApiFp(this.configuration).updateVBAGatewayMessageThread(vbasoftwareDatabase, messageThreadKey, messageThread, options).then((request) => request(this.axios, this.basePath));
480
565
  }
566
+
567
+ /**
568
+ * Gets VBAGateway Request in real-time and converts the request into key/value pairs. VBAGateway requests may have different keys based on the request type.
569
+ * @summary Get VBAGateway Request and Transpose to key/value pairs
570
+ * @param {string} vbasoftwareDatabase Target database
571
+ * @param {number} requestKey Request_Key
572
+ * @param {*} [options] Override http request option.
573
+ * @throws {RequiredError}
574
+ * @memberof VBAGatewayMessagingApi
575
+ */
576
+ public vBAGatewayTransposeRequest(vbasoftwareDatabase: string, requestKey: number, options?: RawAxiosRequestConfig) {
577
+ return VBAGatewayMessagingApiFp(this.configuration).vBAGatewayTransposeRequest(vbasoftwareDatabase, requestKey, options).then((request) => request(this.axios, this.basePath));
578
+ }
481
579
  }
482
580
 
package/api.ts CHANGED
@@ -54,6 +54,7 @@ export * from './api/auth-review-type-api';
54
54
  export * from './api/auth-review-urgency-type-api';
55
55
  export * from './api/auth-type-places-api';
56
56
  export * from './api/auth-types-api';
57
+ export * from './api/authentication-api';
57
58
  export * from './api/benefit-categories-api';
58
59
  export * from './api/benefit-diagnostic-codes-api';
59
60
  export * from './api/benefit-places-api';
@@ -15,19 +15,19 @@
15
15
 
16
16
 
17
17
  /**
18
- *
18
+ * Represents a connection to a database for the client.
19
19
  * @export
20
20
  * @interface DatabaseConnection
21
21
  */
22
22
  export interface DatabaseConnection {
23
23
  /**
24
- *
24
+ * Name of the database.
25
25
  * @type {string}
26
26
  * @memberof DatabaseConnection
27
27
  */
28
28
  'databaseName'?: string | null;
29
29
  /**
30
- *
30
+ * Connection string used to access the database.
31
31
  * @type {string}
32
32
  * @memberof DatabaseConnection
33
33
  */
package/models/index.ts CHANGED
@@ -2428,6 +2428,8 @@ export * from './tooth-quadrant';
2428
2428
  export * from './tooth-quadrant-list-vbaresponse';
2429
2429
  export * from './tooth-quadrant-vbaresponse';
2430
2430
  export * from './tooth-vbaresponse';
2431
+ export * from './transpose-request-meta-data-result';
2432
+ export * from './transpose-request-meta-data-result-list-vbaresponse';
2431
2433
  export * from './treatment-type';
2432
2434
  export * from './treatment-type-list-vbaresponse';
2433
2435
  export * from './treatment-type-vbaresponse';