@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20220630.2 → 1.20220719.1

package/api/colleges-api.ts

@@ -0,0 +1,824 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { College } from '../models';
+// @ts-ignore
+import { CollegeListVBAResponse } from '../models';
+// @ts-ignore
+import { CollegeVBAResponse } from '../models';
+// @ts-ignore
+import { MultiCodeResponseListVBAResponse } from '../models';
+/**
+ * CollegesApi - axios parameter creator
+ * @export
+ */
+export const CollegesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Creates a new College
+         * @summary Create College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {College} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollege: async (vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: College, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbapiClientCode' is not null or undefined
+            assertParamExists('createCollege', 'vbapiClientCode', vbapiClientCode)
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('createCollege', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbasoftwareUser' is not null or undefined
+            assertParamExists('createCollege', 'vbasoftwareUser', vbasoftwareUser)
+            // verify required parameter 'clientId' is not null or undefined
+            assertParamExists('createCollege', 'clientId', clientId)
+            // verify required parameter 'college' is not null or undefined
+            assertParamExists('createCollege', 'college', college)
+            const localVarPath = `/clients/{clientId}/colleges`
+                .replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication VBAPIKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (vbapiClientCode !== undefined && vbapiClientCode !== null) {
+                localVarHeaderParameter['vbapi-client-code'] = String(vbapiClientCode);
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+            if (vbasoftwareUser !== undefined && vbasoftwareUser !== null) {
+                localVarHeaderParameter['vbasoftware-user'] = String(vbasoftwareUser);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(college, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Deletes an College
+         * @summary Delete College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteCollege: async (vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbapiClientCode' is not null or undefined
+            assertParamExists('deleteCollege', 'vbapiClientCode', vbapiClientCode)
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('deleteCollege', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbasoftwareUser' is not null or undefined
+            assertParamExists('deleteCollege', 'vbasoftwareUser', vbasoftwareUser)
+            // verify required parameter 'clientId' is not null or undefined
+            assertParamExists('deleteCollege', 'clientId', clientId)
+            // verify required parameter 'collegeKey' is not null or undefined
+            assertParamExists('deleteCollege', 'collegeKey', collegeKey)
+            const localVarPath = `/clients/{clientId}/colleges/{collegeKey}`
+                .replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)))
+                .replace(`{${"collegeKey"}}`, encodeURIComponent(String(collegeKey)));
+            // 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: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication VBAPIKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (vbapiClientCode !== undefined && vbapiClientCode !== null) {
+                localVarHeaderParameter['vbapi-client-code'] = String(vbapiClientCode);
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+            if (vbasoftwareUser !== undefined && vbasoftwareUser !== null) {
+                localVarHeaderParameter['vbasoftware-user'] = String(vbasoftwareUser);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Gets College
+         * @summary Get College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCollege: async (vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbapiClientCode' is not null or undefined
+            assertParamExists('getCollege', 'vbapiClientCode', vbapiClientCode)
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('getCollege', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbasoftwareUser' is not null or undefined
+            assertParamExists('getCollege', 'vbasoftwareUser', vbasoftwareUser)
+            // verify required parameter 'clientId' is not null or undefined
+            assertParamExists('getCollege', 'clientId', clientId)
+            // verify required parameter 'collegeKey' is not null or undefined
+            assertParamExists('getCollege', 'collegeKey', collegeKey)
+            const localVarPath = `/clients/{clientId}/colleges/{collegeKey}`
+                .replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)))
+                .replace(`{${"collegeKey"}}`, encodeURIComponent(String(collegeKey)));
+            // 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 VBAPIKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (vbapiClientCode !== undefined && vbapiClientCode !== null) {
+                localVarHeaderParameter['vbapi-client-code'] = String(vbapiClientCode);
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+            if (vbasoftwareUser !== undefined && vbasoftwareUser !== null) {
+                localVarHeaderParameter['vbasoftware-user'] = String(vbasoftwareUser);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lists all College
+         * @summary List College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listCollege: async (vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, page?: number, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbapiClientCode' is not null or undefined
+            assertParamExists('listCollege', 'vbapiClientCode', vbapiClientCode)
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listCollege', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbasoftwareUser' is not null or undefined
+            assertParamExists('listCollege', 'vbasoftwareUser', vbasoftwareUser)
+            // verify required parameter 'clientId' is not null or undefined
+            assertParamExists('listCollege', 'clientId', clientId)
+            const localVarPath = `/clients/{clientId}/colleges`
+                .replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
+            // 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 VBAPIKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (vbapiClientCode !== undefined && vbapiClientCode !== null) {
+                localVarHeaderParameter['vbapi-client-code'] = String(vbapiClientCode);
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+            if (vbasoftwareUser !== undefined && vbasoftwareUser !== null) {
+                localVarHeaderParameter['vbasoftware-user'] = String(vbasoftwareUser);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Create or Update multiple College at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+         * @summary Create or Update Batch College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {Array<College>} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateBatchCollege: async (vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: Array<College>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbapiClientCode' is not null or undefined
+            assertParamExists('updateBatchCollege', 'vbapiClientCode', vbapiClientCode)
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('updateBatchCollege', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbasoftwareUser' is not null or undefined
+            assertParamExists('updateBatchCollege', 'vbasoftwareUser', vbasoftwareUser)
+            // verify required parameter 'clientId' is not null or undefined
+            assertParamExists('updateBatchCollege', 'clientId', clientId)
+            // verify required parameter 'college' is not null or undefined
+            assertParamExists('updateBatchCollege', 'college', college)
+            const localVarPath = `/clients/{clientId}/colleges-batch`
+                .replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
+            // 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: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication VBAPIKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (vbapiClientCode !== undefined && vbapiClientCode !== null) {
+                localVarHeaderParameter['vbapi-client-code'] = String(vbapiClientCode);
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+            if (vbasoftwareUser !== undefined && vbasoftwareUser !== null) {
+                localVarHeaderParameter['vbasoftware-user'] = String(vbasoftwareUser);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(college, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Updates a specific College.
+         * @summary Update College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {College} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateCollege: async (vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, college: College, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbapiClientCode' is not null or undefined
+            assertParamExists('updateCollege', 'vbapiClientCode', vbapiClientCode)
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('updateCollege', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'vbasoftwareUser' is not null or undefined
+            assertParamExists('updateCollege', 'vbasoftwareUser', vbasoftwareUser)
+            // verify required parameter 'clientId' is not null or undefined
+            assertParamExists('updateCollege', 'clientId', clientId)
+            // verify required parameter 'collegeKey' is not null or undefined
+            assertParamExists('updateCollege', 'collegeKey', collegeKey)
+            // verify required parameter 'college' is not null or undefined
+            assertParamExists('updateCollege', 'college', college)
+            const localVarPath = `/clients/{clientId}/colleges/{collegeKey}`
+                .replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)))
+                .replace(`{${"collegeKey"}}`, encodeURIComponent(String(collegeKey)));
+            // 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: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication VBAPIKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            if (vbapiClientCode !== undefined && vbapiClientCode !== null) {
+                localVarHeaderParameter['vbapi-client-code'] = String(vbapiClientCode);
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+            if (vbasoftwareUser !== undefined && vbasoftwareUser !== null) {
+                localVarHeaderParameter['vbasoftware-user'] = String(vbasoftwareUser);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(college, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * CollegesApi - functional programming interface
+ * @export
+ */
+export const CollegesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = CollegesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Creates a new College
+         * @summary Create College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {College} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: College, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollegeVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, college, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Deletes an College
+         * @summary Delete College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Gets College
+         * @summary Get College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollegeVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Lists all College
+         * @summary List College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, page?: number, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollegeListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, page, pageSize, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Create or Update multiple College at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+         * @summary Create or Update Batch College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {Array<College>} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateBatchCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: Array<College>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MultiCodeResponseListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateBatchCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, college, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Updates a specific College.
+         * @summary Update College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {College} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, college: College, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollegeVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, college, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * CollegesApi - factory interface
+ * @export
+ */
+export const CollegesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = CollegesApiFp(configuration)
+    return {
+        /**
+         * Creates a new College
+         * @summary Create College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {College} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: College, options?: any): AxiosPromise<CollegeVBAResponse> {
+            return localVarFp.createCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, college, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Deletes an College
+         * @summary Delete College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: any): AxiosPromise<void> {
+            return localVarFp.deleteCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Gets College
+         * @summary Get College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: any): AxiosPromise<CollegeVBAResponse> {
+            return localVarFp.getCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists all College
+         * @summary List College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, page?: number, pageSize?: number, options?: any): AxiosPromise<CollegeListVBAResponse> {
+            return localVarFp.listCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, page, pageSize, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Create or Update multiple College at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+         * @summary Create or Update Batch College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {Array<College>} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateBatchCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: Array<College>, options?: any): AxiosPromise<MultiCodeResponseListVBAResponse> {
+            return localVarFp.updateBatchCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, college, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates a specific College.
+         * @summary Update College
+         * @param {string} vbapiClientCode Client code
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {string} vbasoftwareUser User ID of the person performing this request
+         * @param {string} clientId Client ID
+         * @param {number} collegeKey College Key
+         * @param {College} college 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, college: College, options?: any): AxiosPromise<CollegeVBAResponse> {
+            return localVarFp.updateCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, college, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * CollegesApi - interface
+ * @export
+ * @interface CollegesApi
+ */
+export interface CollegesApiInterface {
+    /**
+     * Creates a new College
+     * @summary Create College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {College} college 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApiInterface
+     */
+    createCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: College, options?: AxiosRequestConfig): AxiosPromise<CollegeVBAResponse>;
+
+    /**
+     * Deletes an College
+     * @summary Delete College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} collegeKey College Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApiInterface
+     */
+    deleteCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: AxiosRequestConfig): AxiosPromise<void>;
+
+    /**
+     * Gets College
+     * @summary Get College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} collegeKey College Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApiInterface
+     */
+    getCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: AxiosRequestConfig): AxiosPromise<CollegeVBAResponse>;
+
+    /**
+     * Lists all College
+     * @summary List College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} [page] Page
+     * @param {number} [pageSize] Page Size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApiInterface
+     */
+    listCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, page?: number, pageSize?: number, options?: AxiosRequestConfig): AxiosPromise<CollegeListVBAResponse>;
+
+    /**
+     * Create or Update multiple College at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+     * @summary Create or Update Batch College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {Array<College>} college 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApiInterface
+     */
+    updateBatchCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: Array<College>, options?: AxiosRequestConfig): AxiosPromise<MultiCodeResponseListVBAResponse>;
+
+    /**
+     * Updates a specific College.
+     * @summary Update College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} collegeKey College Key
+     * @param {College} college 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApiInterface
+     */
+    updateCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, college: College, options?: AxiosRequestConfig): AxiosPromise<CollegeVBAResponse>;
+
+}
+
+/**
+ * CollegesApi - object-oriented interface
+ * @export
+ * @class CollegesApi
+ * @extends {BaseAPI}
+ */
+export class CollegesApi extends BaseAPI implements CollegesApiInterface {
+    /**
+     * Creates a new College
+     * @summary Create College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {College} college 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApi
+     */
+    public createCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: College, options?: AxiosRequestConfig) {
+        return CollegesApiFp(this.configuration).createCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, college, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Deletes an College
+     * @summary Delete College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} collegeKey College Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApi
+     */
+    public deleteCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: AxiosRequestConfig) {
+        return CollegesApiFp(this.configuration).deleteCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Gets College
+     * @summary Get College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} collegeKey College Key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApi
+     */
+    public getCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, options?: AxiosRequestConfig) {
+        return CollegesApiFp(this.configuration).getCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Lists all College
+     * @summary List College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} [page] Page
+     * @param {number} [pageSize] Page Size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApi
+     */
+    public listCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, page?: number, pageSize?: number, options?: AxiosRequestConfig) {
+        return CollegesApiFp(this.configuration).listCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, page, pageSize, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Create or Update multiple College at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+     * @summary Create or Update Batch College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {Array<College>} college 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApi
+     */
+    public updateBatchCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, college: Array<College>, options?: AxiosRequestConfig) {
+        return CollegesApiFp(this.configuration).updateBatchCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, college, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Updates a specific College.
+     * @summary Update College
+     * @param {string} vbapiClientCode Client code
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {string} vbasoftwareUser User ID of the person performing this request
+     * @param {string} clientId Client ID
+     * @param {number} collegeKey College Key
+     * @param {College} college 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollegesApi
+     */
+    public updateCollege(vbapiClientCode: string, vbasoftwareDatabase: string, vbasoftwareUser: string, clientId: string, collegeKey: number, college: College, options?: AxiosRequestConfig) {
+        return CollegesApiFp(this.configuration).updateCollege(vbapiClientCode, vbasoftwareDatabase, vbasoftwareUser, clientId, collegeKey, college, options).then((request) => request(this.axios, this.basePath));
+    }
+}