ch-admin-api-client-typescript/lib/api/ai-prompts-api.d.ts

Openapi generated typescript-axios client for CloudHospital admin

/**
 * CloudHospital Admin Api
 * CloudHospital application with Swagger, Swashbuckle, and API versioning.
 *
 * The version of the OpenAPI document: 1
 * 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 { AiPromptExecutionResultModel } from '../models';
import { AiPromptWithContentModel } from '../models';
import { AiPromptsModel } from '../models';
import { CreateAiPromptCommand } from '../models';
import { ExecuteAiPromptCommand } from '../models';
import { UpdateAiPromptCommand } from '../models';
/**
 * AiPromptsApi - axios parameter creator
 * @export
 */
export declare const AiPromptsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdDelete: (aiPromptId: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdGet: (aiPromptId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Execute AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {ExecuteAiPromptCommand} [executeAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdPost: (aiPromptId: string, executeAiPromptCommand?: ExecuteAiPromptCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {UpdateAiPromptCommand} [updateAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdPut: (aiPromptId: string, updateAiPromptCommand?: UpdateAiPromptCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reactivate AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdReactivatePut: (aiPromptId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get AiPrompts (Auth policies: RequireDoctorRole)
     * @param {string} [name]
     * @param {boolean} [showHidden]
     * @param {Set<string>} [tags]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsGet: (name?: string, showHidden?: boolean, tags?: Set<string>, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create AiPrompt (Auth policies: RequireDoctorRole)
     * @param {CreateAiPromptCommand} [createAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsPost: (createAiPromptCommand?: CreateAiPromptCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AiPromptsApi - functional programming interface
 * @export
 */
export declare const AiPromptsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdDelete(aiPromptId: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdGet(aiPromptId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPromptWithContentModel>>;
    /**
     *
     * @summary Execute AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {ExecuteAiPromptCommand} [executeAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdPost(aiPromptId: string, executeAiPromptCommand?: ExecuteAiPromptCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPromptExecutionResultModel>>;
    /**
     *
     * @summary Update AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {UpdateAiPromptCommand} [updateAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdPut(aiPromptId: string, updateAiPromptCommand?: UpdateAiPromptCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPromptWithContentModel>>;
    /**
     *
     * @summary Reactivate AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdReactivatePut(aiPromptId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPromptWithContentModel>>;
    /**
     *
     * @summary Get AiPrompts (Auth policies: RequireDoctorRole)
     * @param {string} [name]
     * @param {boolean} [showHidden]
     * @param {Set<string>} [tags]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsGet(name?: string, showHidden?: boolean, tags?: Set<string>, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPromptsModel>>;
    /**
     *
     * @summary Create AiPrompt (Auth policies: RequireDoctorRole)
     * @param {CreateAiPromptCommand} [createAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsPost(createAiPromptCommand?: CreateAiPromptCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPromptWithContentModel>>;
};
/**
 * AiPromptsApi - factory interface
 * @export
 */
export declare const AiPromptsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdDelete(aiPromptId: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdGet(aiPromptId: string, options?: any): AxiosPromise<AiPromptWithContentModel>;
    /**
     *
     * @summary Execute AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {ExecuteAiPromptCommand} [executeAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdPost(aiPromptId: string, executeAiPromptCommand?: ExecuteAiPromptCommand, options?: any): AxiosPromise<AiPromptExecutionResultModel>;
    /**
     *
     * @summary Update AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {UpdateAiPromptCommand} [updateAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdPut(aiPromptId: string, updateAiPromptCommand?: UpdateAiPromptCommand, options?: any): AxiosPromise<AiPromptWithContentModel>;
    /**
     *
     * @summary Reactivate AiPrompt (Auth policies: RequireDoctorRole)
     * @param {string} aiPromptId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsAiPromptIdReactivatePut(aiPromptId: string, options?: any): AxiosPromise<AiPromptWithContentModel>;
    /**
     *
     * @summary Get AiPrompts (Auth policies: RequireDoctorRole)
     * @param {string} [name]
     * @param {boolean} [showHidden]
     * @param {Set<string>} [tags]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsGet(name?: string, showHidden?: boolean, tags?: Set<string>, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<AiPromptsModel>;
    /**
     *
     * @summary Create AiPrompt (Auth policies: RequireDoctorRole)
     * @param {CreateAiPromptCommand} [createAiPromptCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1AipromptsPost(createAiPromptCommand?: CreateAiPromptCommand, options?: any): AxiosPromise<AiPromptWithContentModel>;
};
/**
 * Request parameters for apiV1AipromptsAiPromptIdDelete operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsAiPromptIdDeleteRequest
 */
export interface AiPromptsApiApiV1AipromptsAiPromptIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdDelete
     */
    readonly aiPromptId: string;
    /**
     *
     * @type {boolean}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdDelete
     */
    readonly isPermanent?: boolean;
}
/**
 * Request parameters for apiV1AipromptsAiPromptIdGet operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsAiPromptIdGetRequest
 */
export interface AiPromptsApiApiV1AipromptsAiPromptIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdGet
     */
    readonly aiPromptId: string;
}
/**
 * Request parameters for apiV1AipromptsAiPromptIdPost operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsAiPromptIdPostRequest
 */
export interface AiPromptsApiApiV1AipromptsAiPromptIdPostRequest {
    /**
     *
     * @type {string}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdPost
     */
    readonly aiPromptId: string;
    /**
     *
     * @type {ExecuteAiPromptCommand}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdPost
     */
    readonly executeAiPromptCommand?: ExecuteAiPromptCommand;
}
/**
 * Request parameters for apiV1AipromptsAiPromptIdPut operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsAiPromptIdPutRequest
 */
export interface AiPromptsApiApiV1AipromptsAiPromptIdPutRequest {
    /**
     *
     * @type {string}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdPut
     */
    readonly aiPromptId: string;
    /**
     *
     * @type {UpdateAiPromptCommand}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdPut
     */
    readonly updateAiPromptCommand?: UpdateAiPromptCommand;
}
/**
 * Request parameters for apiV1AipromptsAiPromptIdReactivatePut operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsAiPromptIdReactivatePutRequest
 */
export interface AiPromptsApiApiV1AipromptsAiPromptIdReactivatePutRequest {
    /**
     *
     * @type {string}
     * @memberof AiPromptsApiApiV1AipromptsAiPromptIdReactivatePut
     */
    readonly aiPromptId: string;
}
/**
 * Request parameters for apiV1AipromptsGet operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsGetRequest
 */
export interface AiPromptsApiApiV1AipromptsGetRequest {
    /**
     *
     * @type {string}
     * @memberof AiPromptsApiApiV1AipromptsGet
     */
    readonly name?: string;
    /**
     *
     * @type {boolean}
     * @memberof AiPromptsApiApiV1AipromptsGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {Set<string>}
     * @memberof AiPromptsApiApiV1AipromptsGet
     */
    readonly tags?: Set<string>;
    /**
     *
     * @type {number}
     * @memberof AiPromptsApiApiV1AipromptsGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof AiPromptsApiApiV1AipromptsGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof AiPromptsApiApiV1AipromptsGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV1AipromptsPost operation in AiPromptsApi.
 * @export
 * @interface AiPromptsApiApiV1AipromptsPostRequest
 */
export interface AiPromptsApiApiV1AipromptsPostRequest {
    /**
     *
     * @type {CreateAiPromptCommand}
     * @memberof AiPromptsApiApiV1AipromptsPost
     */
    readonly createAiPromptCommand?: CreateAiPromptCommand;
}
/**
 * AiPromptsApi - object-oriented interface
 * @export
 * @class AiPromptsApi
 * @extends {BaseAPI}
 */
export declare class AiPromptsApi extends BaseAPI {
    /**
     *
     * @summary Delete AiPrompt (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsAiPromptIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsAiPromptIdDelete(requestParameters: AiPromptsApiApiV1AipromptsAiPromptIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get AiPrompt (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsAiPromptIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsAiPromptIdGet(requestParameters: AiPromptsApiApiV1AipromptsAiPromptIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPromptWithContentModel, any>>;
    /**
     *
     * @summary Execute AiPrompt (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsAiPromptIdPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsAiPromptIdPost(requestParameters: AiPromptsApiApiV1AipromptsAiPromptIdPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPromptExecutionResultModel, any>>;
    /**
     *
     * @summary Update AiPrompt (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsAiPromptIdPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsAiPromptIdPut(requestParameters: AiPromptsApiApiV1AipromptsAiPromptIdPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPromptWithContentModel, any>>;
    /**
     *
     * @summary Reactivate AiPrompt (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsAiPromptIdReactivatePutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsAiPromptIdReactivatePut(requestParameters: AiPromptsApiApiV1AipromptsAiPromptIdReactivatePutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPromptWithContentModel, any>>;
    /**
     *
     * @summary Get AiPrompts (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsGet(requestParameters?: AiPromptsApiApiV1AipromptsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPromptsModel, any>>;
    /**
     *
     * @summary Create AiPrompt (Auth policies: RequireDoctorRole)
     * @param {AiPromptsApiApiV1AipromptsPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AiPromptsApi
     */
    apiV1AipromptsPost(requestParameters?: AiPromptsApiApiV1AipromptsPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPromptWithContentModel, any>>;
}
//# sourceMappingURL=ai-prompts-api.d.ts.map