ch-chat-api-typescript-axios
Version:
An OpenAPI generator tool for the CH Chat API, designed to simplify API client generation and streamline integration workflows.
158 lines (157 loc) • 6.06 kB
TypeScript
/**
* CloudHospital.ChatApi
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ChatNotifications } from '../models';
/**
* NotificationsApi - axios parameter creator
* @export
*/
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get the notifications for the current user.
* @param {boolean} [isRead]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ChatNotificationsGet: (isRead?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Marks the notification as read for the current user.
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ChatNotificationsIdCheckPost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* NotificationsApi - functional programming interface
* @export
*/
export declare const NotificationsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get the notifications for the current user.
* @param {boolean} [isRead]
* @param {number} [page]
* @param {number} [limit]
* @param {Date} [lastRetrieved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ChatNotificationsGet(isRead?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatNotifications>>;
/**
*
* @summary Marks the notification as read for the current user.
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ChatNotificationsIdCheckPost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
};
/**
* NotificationsApi - factory interface
* @export
*/
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get the notifications for the current user.
* @param {NotificationsApiApiV1ChatNotificationsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ChatNotificationsGet(requestParameters?: NotificationsApiApiV1ChatNotificationsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatNotifications>;
/**
*
* @summary Marks the notification as read for the current user.
* @param {NotificationsApiApiV1ChatNotificationsIdCheckPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiV1ChatNotificationsIdCheckPost(requestParameters: NotificationsApiApiV1ChatNotificationsIdCheckPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
};
/**
* Request parameters for apiV1ChatNotificationsGet operation in NotificationsApi.
* @export
* @interface NotificationsApiApiV1ChatNotificationsGetRequest
*/
export interface NotificationsApiApiV1ChatNotificationsGetRequest {
/**
*
* @type {boolean}
* @memberof NotificationsApiApiV1ChatNotificationsGet
*/
readonly isRead?: boolean;
/**
*
* @type {number}
* @memberof NotificationsApiApiV1ChatNotificationsGet
*/
readonly page?: number;
/**
*
* @type {number}
* @memberof NotificationsApiApiV1ChatNotificationsGet
*/
readonly limit?: number;
/**
*
* @type {Date}
* @memberof NotificationsApiApiV1ChatNotificationsGet
*/
readonly lastRetrieved?: Date;
}
/**
* Request parameters for apiV1ChatNotificationsIdCheckPost operation in NotificationsApi.
* @export
* @interface NotificationsApiApiV1ChatNotificationsIdCheckPostRequest
*/
export interface NotificationsApiApiV1ChatNotificationsIdCheckPostRequest {
/**
*
* @type {string}
* @memberof NotificationsApiApiV1ChatNotificationsIdCheckPost
*/
readonly id: string;
}
/**
* NotificationsApi - object-oriented interface
* @export
* @class NotificationsApi
* @extends {BaseAPI}
*/
export declare class NotificationsApi extends BaseAPI {
/**
*
* @summary Get the notifications for the current user.
* @param {NotificationsApiApiV1ChatNotificationsGetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
apiV1ChatNotificationsGet(requestParameters?: NotificationsApiApiV1ChatNotificationsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatNotifications, any>>;
/**
*
* @summary Marks the notification as read for the current user.
* @param {NotificationsApiApiV1ChatNotificationsIdCheckPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
apiV1ChatNotificationsIdCheckPost(requestParameters: NotificationsApiApiV1ChatNotificationsIdCheckPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
}