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

package/api/client-config-api.ts

@@ -31,6 +31,8 @@ import { SSOConfigVBAResponse } from '../models';
 // @ts-ignore
 import { UserAuthenticationResponseVBAResponse } from '../models';
 // @ts-ignore
+import { VBAAppInfoVBAResponse } from '../models';
+// @ts-ignore
 import { VBAClientEnvironmentListVBAResponse } from '../models';
 /**
  * ClientConfigApi - axios parameter creator
@@ -127,6 +129,57 @@ export const ClientConfigApiAxiosParamCreator = function (configuration?: Config
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns the latest application information including version, file details, release notes, and release date in JSON format.
+         * @summary Get Application Information
+         * @param {string} vbasoftwareClientId Client ID
+         * @param {string} vbasoftwareClientCode Client Code
+         * @param {string} environment environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAppInfo: async (vbasoftwareClientId: string, vbasoftwareClientCode: string, environment: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareClientId' is not null or undefined
+            assertParamExists('getAppInfo', 'vbasoftwareClientId', vbasoftwareClientId)
+            // verify required parameter 'vbasoftwareClientCode' is not null or undefined
+            assertParamExists('getAppInfo', 'vbasoftwareClientCode', vbasoftwareClientCode)
+            // verify required parameter 'environment' is not null or undefined
+            assertParamExists('getAppInfo', 'environment', environment)
+            const localVarPath = `/app-info/{environment}`
+                .replace(`{${"environment"}}`, encodeURIComponent(String(environment)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (vbasoftwareClientId !== undefined && vbasoftwareClientId !== null) {
+                localVarHeaderParameter['vbasoftware-client-id'] = String(vbasoftwareClientId);
+            }
+
+            if (vbasoftwareClientCode !== undefined && vbasoftwareClientCode !== null) {
+                localVarHeaderParameter['vbasoftware-client-code'] = String(vbasoftwareClientCode);
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -475,6 +528,19 @@ export const ClientConfigApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSSOConfig(vbasoftwareDatabase, sSOConfigID, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Returns the latest application information including version, file details, release notes, and release date in JSON format.
+         * @summary Get Application Information
+         * @param {string} vbasoftwareClientId Client ID
+         * @param {string} vbasoftwareClientCode Client Code
+         * @param {string} environment environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getAppInfo(vbasoftwareClientId: string, vbasoftwareClientCode: string, environment: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAAppInfoVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getAppInfo(vbasoftwareClientId, vbasoftwareClientCode, environment, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Gets SSOConfig
          * @summary Get SSOConfig
@@ -582,6 +648,18 @@ export const ClientConfigApiFactory = function (configuration?: Configuration, b
         deleteSSOConfig(vbasoftwareDatabase: string, sSOConfigID: string, options?: any): AxiosPromise<void> {
             return localVarFp.deleteSSOConfig(vbasoftwareDatabase, sSOConfigID, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns the latest application information including version, file details, release notes, and release date in JSON format.
+         * @summary Get Application Information
+         * @param {string} vbasoftwareClientId Client ID
+         * @param {string} vbasoftwareClientCode Client Code
+         * @param {string} environment environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAppInfo(vbasoftwareClientId: string, vbasoftwareClientCode: string, environment: string, options?: any): AxiosPromise<VBAAppInfoVBAResponse> {
+            return localVarFp.getAppInfo(vbasoftwareClientId, vbasoftwareClientCode, environment, options).then((request) => request(axios, basePath));
+        },
         /**
          * Gets SSOConfig
          * @summary Get SSOConfig
@@ -682,6 +760,18 @@ export interface ClientConfigApiInterface {
      */
     deleteSSOConfig(vbasoftwareDatabase: string, sSOConfigID: string, options?: AxiosRequestConfig): AxiosPromise<void>;
 
+    /**
+     * Returns the latest application information including version, file details, release notes, and release date in JSON format.
+     * @summary Get Application Information
+     * @param {string} vbasoftwareClientId Client ID
+     * @param {string} vbasoftwareClientCode Client Code
+     * @param {string} environment environment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientConfigApiInterface
+     */
+    getAppInfo(vbasoftwareClientId: string, vbasoftwareClientCode: string, environment: string, options?: AxiosRequestConfig): AxiosPromise<VBAAppInfoVBAResponse>;
+
     /**
      * Gets SSOConfig
      * @summary Get SSOConfig
@@ -786,6 +876,20 @@ export class ClientConfigApi extends BaseAPI implements ClientConfigApiInterface
         return ClientConfigApiFp(this.configuration).deleteSSOConfig(vbasoftwareDatabase, sSOConfigID, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Returns the latest application information including version, file details, release notes, and release date in JSON format.
+     * @summary Get Application Information
+     * @param {string} vbasoftwareClientId Client ID
+     * @param {string} vbasoftwareClientCode Client Code
+     * @param {string} environment environment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClientConfigApi
+     */
+    public getAppInfo(vbasoftwareClientId: string, vbasoftwareClientCode: string, environment: string, options?: AxiosRequestConfig) {
+        return ClientConfigApiFp(this.configuration).getAppInfo(vbasoftwareClientId, vbasoftwareClientCode, environment, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Gets SSOConfig
      * @summary Get SSOConfig

package/api/criteria-api.ts

@@ -28,6 +28,8 @@ import { CriteriaListVBAResponse } from '../models';
 import { CriteriaVBAResponse } from '../models';
 // @ts-ignore
 import { MultiCodeResponseListVBAResponse } from '../models';
+// @ts-ignore
+import { StringVBAResponse } from '../models';
 /**
  * CriteriaApi - axios parameter creator
  * @export
@@ -221,6 +223,54 @@ export const CriteriaApiAxiosParamCreator = function (configuration?: Configurat
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Helper function to take an existing list of Criteria Detail and merge it all together into a single WHERE Clause to be used with other services.
+         * @summary Get this Criteria Where Clause
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} criteriaKey Criteria Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCriteriaWhereClause: async (vbasoftwareDatabase: string, criteriaKey: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('getCriteriaWhereClause', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'criteriaKey' is not null or undefined
+            assertParamExists('getCriteriaWhereClause', 'criteriaKey', criteriaKey)
+            const localVarPath = `/criterias-where-clause/{criteriaKey}`
+                .replace(`{${"criteriaKey"}}`, encodeURIComponent(String(criteriaKey)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -411,6 +461,18 @@ export const CriteriaApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getCriteria(vbasoftwareDatabase, criteriaKey, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Helper function to take an existing list of Criteria Detail and merge it all together into a single WHERE Clause to be used with other services.
+         * @summary Get this Criteria Where Clause
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} criteriaKey Criteria Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getCriteriaWhereClause(vbasoftwareDatabase: string, criteriaKey: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StringVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCriteriaWhereClause(vbasoftwareDatabase, criteriaKey, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * List Criteria. Optional 
          * @summary List Criteria
@@ -494,6 +556,17 @@ export const CriteriaApiFactory = function (configuration?: Configuration, baseP
         getCriteria(vbasoftwareDatabase: string, criteriaKey: number, options?: any): AxiosPromise<CriteriaVBAResponse> {
             return localVarFp.getCriteria(vbasoftwareDatabase, criteriaKey, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Helper function to take an existing list of Criteria Detail and merge it all together into a single WHERE Clause to be used with other services.
+         * @summary Get this Criteria Where Clause
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} criteriaKey Criteria Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCriteriaWhereClause(vbasoftwareDatabase: string, criteriaKey: number, options?: any): AxiosPromise<StringVBAResponse> {
+            return localVarFp.getCriteriaWhereClause(vbasoftwareDatabase, criteriaKey, options).then((request) => request(axios, basePath));
+        },
         /**
          * List Criteria. Optional 
          * @summary List Criteria
@@ -574,6 +647,17 @@ export interface CriteriaApiInterface {
      */
     getCriteria(vbasoftwareDatabase: string, criteriaKey: number, options?: AxiosRequestConfig): AxiosPromise<CriteriaVBAResponse>;
 
+    /**
+     * Helper function to take an existing list of Criteria Detail and merge it all together into a single WHERE Clause to be used with other services.
+     * @summary Get this Criteria Where Clause
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} criteriaKey Criteria Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CriteriaApiInterface
+     */
+    getCriteriaWhereClause(vbasoftwareDatabase: string, criteriaKey: number, options?: AxiosRequestConfig): AxiosPromise<StringVBAResponse>;
+
     /**
      * List Criteria. Optional 
      * @summary List Criteria
@@ -662,6 +746,19 @@ export class CriteriaApi extends BaseAPI implements CriteriaApiInterface {
         return CriteriaApiFp(this.configuration).getCriteria(vbasoftwareDatabase, criteriaKey, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Helper function to take an existing list of Criteria Detail and merge it all together into a single WHERE Clause to be used with other services.
+     * @summary Get this Criteria Where Clause
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} criteriaKey Criteria Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CriteriaApi
+     */
+    public getCriteriaWhereClause(vbasoftwareDatabase: string, criteriaKey: number, options?: AxiosRequestConfig) {
+        return CriteriaApiFp(this.configuration).getCriteriaWhereClause(vbasoftwareDatabase, criteriaKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List Criteria. Optional 
      * @summary List Criteria

package/api/enrollment-waiting-period-subscribers-api.ts

@@ -184,13 +184,14 @@ export const EnrollmentWaitingPeriodSubscribersApiAxiosParamCreator = function (
          * Lists all EnrollmentWaitingPeriodSubscriber
          * @summary List EnrollmentWaitingPeriodSubscriber
          * @param {string} vbasoftwareDatabase Target database
+         * @param {string} [subscriberID] Subscriber_ID
          * @param {number} [page] Page
          * @param {number} [pageSize] Page Size
          * @param {string} [sortBy] Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listEnrollmentWaitingPeriodSubscriber: async (vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listEnrollmentWaitingPeriodSubscriber: async (vbasoftwareDatabase: string, subscriberID?: string, page?: number, pageSize?: number, sortBy?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'vbasoftwareDatabase' is not null or undefined
             assertParamExists('listEnrollmentWaitingPeriodSubscriber', 'vbasoftwareDatabase', vbasoftwareDatabase)
             const localVarPath = `/enrollment-waiting-period-subscribers`;
@@ -212,6 +213,10 @@ export const EnrollmentWaitingPeriodSubscribersApiAxiosParamCreator = function (
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (subscriberID !== undefined) {
+                localVarQueryParameter['subscriberID'] = subscriberID;
+            }
+
             if (page !== undefined) {
                 localVarQueryParameter['page'] = page;
             }
@@ -393,14 +398,15 @@ export const EnrollmentWaitingPeriodSubscribersApiFp = function(configuration?:
          * Lists all EnrollmentWaitingPeriodSubscriber
          * @summary List EnrollmentWaitingPeriodSubscriber
          * @param {string} vbasoftwareDatabase Target database
+         * @param {string} [subscriberID] Subscriber_ID
          * @param {number} [page] Page
          * @param {number} [pageSize] Page Size
          * @param {string} [sortBy] Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \&#39;Property1:desc,Property2:asc,Property3:asc\&#39; sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnrollmentWaitingPeriodSubscriberListVBAResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase, page, pageSize, sortBy, options);
+        async listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, subscriberID?: string, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnrollmentWaitingPeriodSubscriberListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase, subscriberID, page, pageSize, sortBy, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -475,14 +481,15 @@ export const EnrollmentWaitingPeriodSubscribersApiFactory = function (configurat
          * Lists all EnrollmentWaitingPeriodSubscriber
          * @summary List EnrollmentWaitingPeriodSubscriber
          * @param {string} vbasoftwareDatabase Target database
+         * @param {string} [subscriberID] Subscriber_ID
          * @param {number} [page] Page
          * @param {number} [pageSize] Page Size
          * @param {string} [sortBy] Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \&#39;Property1:desc,Property2:asc,Property3:asc\&#39; sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options?: any): AxiosPromise<EnrollmentWaitingPeriodSubscriberListVBAResponse> {
-            return localVarFp.listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase, page, pageSize, sortBy, options).then((request) => request(axios, basePath));
+        listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, subscriberID?: string, page?: number, pageSize?: number, sortBy?: string, options?: any): AxiosPromise<EnrollmentWaitingPeriodSubscriberListVBAResponse> {
+            return localVarFp.listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase, subscriberID, page, pageSize, sortBy, options).then((request) => request(axios, basePath));
         },
         /**
          * Create or Update multiple EnrollmentWaitingPeriodSubscriber at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
@@ -553,6 +560,7 @@ export interface EnrollmentWaitingPeriodSubscribersApiInterface {
      * Lists all EnrollmentWaitingPeriodSubscriber
      * @summary List EnrollmentWaitingPeriodSubscriber
      * @param {string} vbasoftwareDatabase Target database
+     * @param {string} [subscriberID] Subscriber_ID
      * @param {number} [page] Page
      * @param {number} [pageSize] Page Size
      * @param {string} [sortBy] Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \&#39;Property1:desc,Property2:asc,Property3:asc\&#39; sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.
@@ -560,7 +568,7 @@ export interface EnrollmentWaitingPeriodSubscribersApiInterface {
      * @throws {RequiredError}
      * @memberof EnrollmentWaitingPeriodSubscribersApiInterface
      */
-    listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig): AxiosPromise<EnrollmentWaitingPeriodSubscriberListVBAResponse>;
+    listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, subscriberID?: string, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig): AxiosPromise<EnrollmentWaitingPeriodSubscriberListVBAResponse>;
 
     /**
      * Create or Update multiple EnrollmentWaitingPeriodSubscriber at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
@@ -637,6 +645,7 @@ export class EnrollmentWaitingPeriodSubscribersApi extends BaseAPI implements En
      * Lists all EnrollmentWaitingPeriodSubscriber
      * @summary List EnrollmentWaitingPeriodSubscriber
      * @param {string} vbasoftwareDatabase Target database
+     * @param {string} [subscriberID] Subscriber_ID
      * @param {number} [page] Page
      * @param {number} [pageSize] Page Size
      * @param {string} [sortBy] Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \&#39;Property1:desc,Property2:asc,Property3:asc\&#39; sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.
@@ -644,8 +653,8 @@ export class EnrollmentWaitingPeriodSubscribersApi extends BaseAPI implements En
      * @throws {RequiredError}
      * @memberof EnrollmentWaitingPeriodSubscribersApi
      */
-    public listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig) {
-        return EnrollmentWaitingPeriodSubscribersApiFp(this.configuration).listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase, page, pageSize, sortBy, options).then((request) => request(this.axios, this.basePath));
+    public listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase: string, subscriberID?: string, page?: number, pageSize?: number, sortBy?: string, options?: AxiosRequestConfig) {
+        return EnrollmentWaitingPeriodSubscribersApiFp(this.configuration).listEnrollmentWaitingPeriodSubscriber(vbasoftwareDatabase, subscriberID, page, pageSize, sortBy, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**