ch-api-client-typescript2/lib/api/form-results-api.d.ts

Openapi generated typescript-axios client for CloudHospital

/**
 * CloudHospital Api
 * CloudHospital application with Swagger, Swashbuckle, and API versioning.
 *
 * The version of the OpenAPI document: 2
 * Contact: developer@icloudhospital.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, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { CreateFormResultCommand } from '../models';
import { FormResultModel } from '../models';
import { FormResultStatus } from '../models';
import { FormResultsModel } from '../models';
import { FormTemplateType } from '../models';
/**
 * FormResultsApi - axios parameter creator
 * @export
 */
export declare const FormResultsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete formResult
     * @param {string} formResultId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsFormResultIdDelete: (formResultId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get formResult
     * @param {string} formResultId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsFormResultIdGet: (formResultId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get formResults
     * @param {string} [hospitalId]
     * @param {boolean} [noHospitalOnly]
     * @param {string} [languageCode]
     * @param {Date} [startDate]
     * @param {Date} [endDate]
     * @param {FormTemplateType} [formTemplateType]
     * @param {FormResultStatus} [status]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsGet: (hospitalId?: string, noHospitalOnly?: boolean, languageCode?: string, startDate?: Date, endDate?: Date, formTemplateType?: FormTemplateType, status?: FormResultStatus, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create formResult
     * @param {CreateFormResultCommand} [createFormResultCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsPost: (createFormResultCommand?: CreateFormResultCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FormResultsApi - functional programming interface
 * @export
 */
export declare const FormResultsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete formResult
     * @param {string} formResultId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsFormResultIdDelete(formResultId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Get formResult
     * @param {string} formResultId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsFormResultIdGet(formResultId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FormResultModel>>;
    /**
     *
     * @summary Get formResults
     * @param {string} [hospitalId]
     * @param {boolean} [noHospitalOnly]
     * @param {string} [languageCode]
     * @param {Date} [startDate]
     * @param {Date} [endDate]
     * @param {FormTemplateType} [formTemplateType]
     * @param {FormResultStatus} [status]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsGet(hospitalId?: string, noHospitalOnly?: boolean, languageCode?: string, startDate?: Date, endDate?: Date, formTemplateType?: FormTemplateType, status?: FormResultStatus, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FormResultsModel>>;
    /**
     *
     * @summary Create formResult
     * @param {CreateFormResultCommand} [createFormResultCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsPost(createFormResultCommand?: CreateFormResultCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
 * FormResultsApi - factory interface
 * @export
 */
export declare const FormResultsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete formResult
     * @param {string} formResultId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsFormResultIdDelete(formResultId: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Get formResult
     * @param {string} formResultId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsFormResultIdGet(formResultId: string, languageCode?: string, options?: any): AxiosPromise<FormResultModel>;
    /**
     *
     * @summary Get formResults
     * @param {string} [hospitalId]
     * @param {boolean} [noHospitalOnly]
     * @param {string} [languageCode]
     * @param {Date} [startDate]
     * @param {Date} [endDate]
     * @param {FormTemplateType} [formTemplateType]
     * @param {FormResultStatus} [status]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsGet(hospitalId?: string, noHospitalOnly?: boolean, languageCode?: string, startDate?: Date, endDate?: Date, formTemplateType?: FormTemplateType, status?: FormResultStatus, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<FormResultsModel>;
    /**
     *
     * @summary Create formResult
     * @param {CreateFormResultCommand} [createFormResultCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2FormresultsPost(createFormResultCommand?: CreateFormResultCommand, options?: any): AxiosPromise<string>;
};
/**
 * Request parameters for apiV2FormresultsFormResultIdDelete operation in FormResultsApi.
 * @export
 * @interface FormResultsApiApiV2FormresultsFormResultIdDeleteRequest
 */
export interface FormResultsApiApiV2FormresultsFormResultIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof FormResultsApiApiV2FormresultsFormResultIdDelete
     */
    readonly formResultId: string;
}
/**
 * Request parameters for apiV2FormresultsFormResultIdGet operation in FormResultsApi.
 * @export
 * @interface FormResultsApiApiV2FormresultsFormResultIdGetRequest
 */
export interface FormResultsApiApiV2FormresultsFormResultIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof FormResultsApiApiV2FormresultsFormResultIdGet
     */
    readonly formResultId: string;
    /**
     *
     * @type {string}
     * @memberof FormResultsApiApiV2FormresultsFormResultIdGet
     */
    readonly languageCode?: string;
}
/**
 * Request parameters for apiV2FormresultsGet operation in FormResultsApi.
 * @export
 * @interface FormResultsApiApiV2FormresultsGetRequest
 */
export interface FormResultsApiApiV2FormresultsGetRequest {
    /**
     *
     * @type {string}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly hospitalId?: string;
    /**
     *
     * @type {boolean}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly noHospitalOnly?: boolean;
    /**
     *
     * @type {string}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {Date}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly startDate?: Date;
    /**
     *
     * @type {Date}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly endDate?: Date;
    /**
     *
     * @type {FormTemplateType}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly formTemplateType?: FormTemplateType;
    /**
     *
     * @type {FormResultStatus}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly status?: FormResultStatus;
    /**
     *
     * @type {number}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof FormResultsApiApiV2FormresultsGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV2FormresultsPost operation in FormResultsApi.
 * @export
 * @interface FormResultsApiApiV2FormresultsPostRequest
 */
export interface FormResultsApiApiV2FormresultsPostRequest {
    /**
     *
     * @type {CreateFormResultCommand}
     * @memberof FormResultsApiApiV2FormresultsPost
     */
    readonly createFormResultCommand?: CreateFormResultCommand;
}
/**
 * FormResultsApi - object-oriented interface
 * @export
 * @class FormResultsApi
 * @extends {BaseAPI}
 */
export declare class FormResultsApi extends BaseAPI {
    /**
     *
     * @summary Delete formResult
     * @param {FormResultsApiApiV2FormresultsFormResultIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FormResultsApi
     */
    apiV2FormresultsFormResultIdDelete(requestParameters: FormResultsApiApiV2FormresultsFormResultIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Get formResult
     * @param {FormResultsApiApiV2FormresultsFormResultIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FormResultsApi
     */
    apiV2FormresultsFormResultIdGet(requestParameters: FormResultsApiApiV2FormresultsFormResultIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FormResultModel, any>>;
    /**
     *
     * @summary Get formResults
     * @param {FormResultsApiApiV2FormresultsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FormResultsApi
     */
    apiV2FormresultsGet(requestParameters?: FormResultsApiApiV2FormresultsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FormResultsModel, any>>;
    /**
     *
     * @summary Create formResult
     * @param {FormResultsApiApiV2FormresultsPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FormResultsApi
     */
    apiV2FormresultsPost(requestParameters?: FormResultsApiApiV2FormresultsPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}
//# sourceMappingURL=form-results-api.d.ts.map