@indexea/sdk
Version:
Indexea JavaScript SDK (indexea.com)
102 lines (101 loc) • 3.94 kB
TypeScript
/**
* Indexea OpenAPI
* 这是 Indexea 搜索服务平台的 OpenAPI，用于描述平台的所有接口信息，你可以通过这个页面来了解和在线验证平台的所有接口信息。 ### Errors 本 API 使用标准的 HTTP 状态码来指示操作成功或者失败，如果失败将会在 body 中以 JSON 格式提供详细的错误信息，如下所示： ``` { \"error\": 404, \"message\": \"page not found\" } ```
*
* The version of the OpenAPI document: 1.0.0
* Contact: indexea.com@gmail.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 * as runtime from '../runtime';
import type { Message, Messages } from '../models';
export interface MessageDeleteRequest {
id: number;
}
export interface MessageFeedbackRequest {
content: string;
type: MessageFeedbackTypeEnum;
}
export interface MessageListRequest {
scope: MessageListScopeEnum;
from?: number;
size?: number;
}
export interface MessageReadRequest {
id: string;
}
export interface MessageSendRequest {
receiver: number;
msg: string;
}
/**
*
*/
export declare class MessageApi extends runtime.BaseAPI {
/**
* 删除消息
* 删除消息
*/
messageDeleteRaw(requestParameters: MessageDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
/**
* 删除消息
* 删除消息
*/
messageDelete(requestParameters: MessageDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
/**
* 反馈意见
*/
messageFeedbackRaw(requestParameters: MessageFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
/**
* 反馈意见
*/
messageFeedback(requestParameters: MessageFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
/**
* 获取我相关的消息信息，包括未读消息数量、最新消息等
*/
messageListRaw(requestParameters: MessageListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Messages>>;
/**
* 获取我相关的消息信息，包括未读消息数量、最新消息等
*/
messageList(requestParameters: MessageListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Messages>;
/**
* 标识消息为已读
* 标识消息为已读
*/
messageReadRaw(requestParameters: MessageReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Messages>>;
/**
* 标识消息为已读
* 标识消息为已读
*/
messageRead(requestParameters: MessageReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Messages>;
/**
* 发送站内消息给某人
* 发送消息
*/
messageSendRaw(requestParameters: MessageSendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Message>>;
/**
* 发送站内消息给某人
* 发送消息
*/
messageSend(requestParameters: MessageSendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Message>;
}
/**
* @export
*/
export declare const MessageFeedbackTypeEnum: {
readonly General: "general";
readonly Bugs: "bugs";
readonly Feature: "feature";
};
export type MessageFeedbackTypeEnum = typeof MessageFeedbackTypeEnum[keyof typeof MessageFeedbackTypeEnum];
/**
* @export
*/
export declare const MessageListScopeEnum: {
readonly All: "all";
readonly Unread: "unread";
readonly Read: "read";
};
export type MessageListScopeEnum = typeof MessageListScopeEnum[keyof typeof MessageListScopeEnum];