/** * School Reporting Systems API * School Reporting Systems. * * The version of the OpenAPI document: 1.0 * Contact: tony.henderson@elevenfiftynine.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { SchoolCohortRequest } from '../model'; import { SchoolCohortResponse } from '../model'; import { SchoolDesignatedContactRequest } from '../model'; import { SchoolDesignatedContactResponse } from '../model'; import { SchoolInformationRequest } from '../model'; import { SchoolInformationResponse } from '../model'; import { SchoolRequest } from '../model'; import { SchoolResponse } from '../model'; /** * SchoolsApi - axios parameter creator * @export */ export declare const SchoolsApiAxiosParamCreator: (configuration?: Configuration) => { /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolCohortRequest} [schoolCohortRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolCohortGetSchoolCohortsBySchoolCodePost: (apiVersion?: string, schoolCohortRequest?: SchoolCohortRequest, options?: any) => Promise; /** * [BX_CREATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactCreatePost: (apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any) => Promise; /** * [BX_DELETE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactDeletePost: (apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any) => Promise; /** * [BX_GET_ALL] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactGetSchoolDesignatedContactBySchoolCodePost: (apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any) => Promise; /** * [BX_UPDATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactUpdatePost: (apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any) => Promise; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolGetSchoolBySchoolCodePost: (apiVersion?: string, schoolRequest?: SchoolRequest, options?: any) => Promise; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolGetSchoolsByUserEmailPost: (apiVersion?: string, schoolRequest?: SchoolRequest, options?: any) => Promise; /** * [BX_CREATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationCreatePost: (apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any) => Promise; /** * [BX_GET_ALL] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationGetSchoolInformationBySchoolCodePost: (apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any) => Promise; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationUpdatePost: (apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any) => Promise; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolUpdatePost: (apiVersion?: string, schoolRequest?: SchoolRequest, options?: any) => Promise; }; /** * SchoolsApi - functional programming interface * @export */ export declare const SchoolsApiFp: (configuration?: Configuration) => { /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolCohortRequest} [schoolCohortRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolCohortGetSchoolCohortsBySchoolCodePost(apiVersion?: string, schoolCohortRequest?: SchoolCohortRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_CREATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactCreatePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_DELETE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactDeletePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_GET_ALL] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactGetSchoolDesignatedContactBySchoolCodePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_UPDATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactUpdatePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolGetSchoolBySchoolCodePost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolGetSchoolsByUserEmailPost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_CREATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationCreatePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_GET_ALL] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationGetSchoolInformationBySchoolCodePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationUpdatePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolUpdatePost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SchoolsApi - factory interface * @export */ export declare const SchoolsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolCohortRequest} [schoolCohortRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolCohortGetSchoolCohortsBySchoolCodePost(apiVersion?: string, schoolCohortRequest?: SchoolCohortRequest, options?: any): AxiosPromise; /** * [BX_CREATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactCreatePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): AxiosPromise; /** * [BX_DELETE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactDeletePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): AxiosPromise; /** * [BX_GET_ALL] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactGetSchoolDesignatedContactBySchoolCodePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): AxiosPromise; /** * [BX_UPDATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolDesignatedContactUpdatePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): AxiosPromise; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolGetSchoolBySchoolCodePost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): AxiosPromise; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolGetSchoolsByUserEmailPost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): AxiosPromise; /** * [BX_CREATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationCreatePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): AxiosPromise; /** * [BX_GET_ALL] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationGetSchoolInformationBySchoolCodePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): AxiosPromise; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolInformationUpdatePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): AxiosPromise; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiSchoolUpdatePost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): AxiosPromise; }; /** * SchoolsApi - object-oriented interface * @export * @class SchoolsApi * @extends {BaseAPI} */ export declare class SchoolsApi extends BaseAPI { /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolCohortRequest} [schoolCohortRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolCohortGetSchoolCohortsBySchoolCodePost(apiVersion?: string, schoolCohortRequest?: SchoolCohortRequest, options?: any): Promise>; /** * [BX_CREATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolDesignatedContactCreatePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise>; /** * [BX_DELETE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolDesignatedContactDeletePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise>; /** * [BX_GET_ALL] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolDesignatedContactGetSchoolDesignatedContactBySchoolCodePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise>; /** * [BX_UPDATE] * @summary POST SchoolDesignatedContactRequest * @param {string} [apiVersion] The requested API version * @param {SchoolDesignatedContactRequest} [schoolDesignatedContactRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolDesignatedContactUpdatePost(apiVersion?: string, schoolDesignatedContactRequest?: SchoolDesignatedContactRequest, options?: any): Promise>; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolGetSchoolBySchoolCodePost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): Promise>; /** * [BX_GET] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolGetSchoolsByUserEmailPost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): Promise>; /** * [BX_CREATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolInformationCreatePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): Promise>; /** * [BX_GET_ALL] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolInformationGetSchoolInformationBySchoolCodePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): Promise>; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolInformationRequest} [schoolInformationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolInformationUpdatePost(apiVersion?: string, schoolInformationRequest?: SchoolInformationRequest, options?: any): Promise>; /** * [BX_UPDATE] * @param {string} [apiVersion] The requested API version * @param {SchoolRequest} [schoolRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ apiSchoolUpdatePost(apiVersion?: string, schoolRequest?: SchoolRequest, options?: any): Promise>; }