@indexea/sdk
Version:
Indexea JavaScript SDK (indexea.com)
182 lines (181 loc) • 7.06 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 { WidgetBean, WidgetForm, WidgetLogo } from '../models';
export interface WidgetCopyRequest {
app: string;
widget: number;
}
export interface WidgetCopyToWidgetRequest {
app: string;
widget: number;
to: number;
}
export interface WidgetCreateRequest {
app: string;
widgetForm: WidgetForm;
}
export interface WidgetDeleteRequest {
app: string;
widget: number;
password: string;
}
export interface WidgetDeleteLogoRequest {
app: string;
widget: number;
}
export interface WidgetDetailRequest {
ident: string;
xToken?: string;
}
export interface WidgetDownloadRequest {
app: string;
widget: number;
framework: string;
}
export interface WidgetGetRequest {
app: string;
widget: number;
}
export interface WidgetListRequest {
app: string;
}
export interface WidgetLogoRequest {
app: string;
widget: number;
logo?: Blob;
}
export interface WidgetUpdateRequest {
app: string;
widget: number;
widgetForm: WidgetForm;
}
export interface WidgetUpdateSettingsRequest {
app: string;
widget: number;
key: string;
type: WidgetUpdateSettingsTypeEnum;
value: string;
vcode?: string;
}
/**
*
*/
export declare class WidgetsApi extends runtime.BaseAPI {
/**
* 复制指定组件并创建新组件
*/
widgetCopyRaw(requestParameters: WidgetCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetBean>>;
/**
* 复制指定组件并创建新组件
*/
widgetCopy(requestParameters: WidgetCopyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetBean>;
/**
* 复制组件到已有组件
*/
widgetCopyToWidgetRaw(requestParameters: WidgetCopyToWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
/**
* 复制组件到已有组件
*/
widgetCopyToWidget(requestParameters: WidgetCopyToWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
/**
* 创建组件
*/
widgetCreateRaw(requestParameters: WidgetCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetBean>>;
/**
* 创建组件
*/
widgetCreate(requestParameters: WidgetCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetBean>;
/**
* 删除组件
*/
widgetDeleteRaw(requestParameters: WidgetDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
/**
* 删除组件
*/
widgetDelete(requestParameters: WidgetDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
/**
* 删除组件 Logo
*/
widgetDeleteLogoRaw(requestParameters: WidgetDeleteLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
/**
* 删除组件 Logo
*/
widgetDeleteLogo(requestParameters: WidgetDeleteLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
/**
* 获取UI组件的所有相关信息
*/
widgetDetailRaw(requestParameters: WidgetDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetBean>>;
/**
* 获取UI组件的所有相关信息
*/
widgetDetail(requestParameters: WidgetDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetBean>;
/**
* 下载组件应用源码
*/
widgetDownloadRaw(requestParameters: WidgetDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
/**
* 下载组件应用源码
*/
widgetDownload(requestParameters: WidgetDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
/**
* 获取组件的详情
*/
widgetGetRaw(requestParameters: WidgetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetBean>>;
/**
* 获取组件的详情
*/
widgetGet(requestParameters: WidgetGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetBean>;
/**
* 获取应用的组件列表
*/
widgetListRaw(requestParameters: WidgetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WidgetBean>>>;
/**
* 获取应用的组件列表
*/
widgetList(requestParameters: WidgetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WidgetBean>>;
/**
*
* 设置组件 Logo
*/
widgetLogoRaw(requestParameters: WidgetLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetLogo>>;
/**
*
* 设置组件 Logo
*/
widgetLogo(requestParameters: WidgetLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetLogo>;
/**
* 修改组件
*/
widgetUpdateRaw(requestParameters: WidgetUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WidgetBean>>;
/**
* 修改组件
*/
widgetUpdate(requestParameters: WidgetUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WidgetBean>;
/**
* 修改组件设置参数
*/
widgetUpdateSettingsRaw(requestParameters: WidgetUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
/**
* 修改组件设置参数
*/
widgetUpdateSettings(requestParameters: WidgetUpdateSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
}
/**
* @export
*/
export declare const WidgetUpdateSettingsTypeEnum: {
readonly Int: "int";
readonly Bool: "bool";
readonly String: "string";
};
export type WidgetUpdateSettingsTypeEnum = typeof WidgetUpdateSettingsTypeEnum[keyof typeof WidgetUpdateSettingsTypeEnum];