@indexea/sdk
Version:
Indexea JavaScript SDK (indexea.com)
88 lines (87 loc) • 2.45 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.
*/
/**
* UI组件表单
* @export
* @interface WidgetForm
*/
export interface WidgetForm {
/**
*
* @type {string}
* @memberof WidgetForm
*/
name: string;
/**
*
* @type {string}
* @memberof WidgetForm
*/
type: WidgetFormTypeEnum;
/**
*
* @type {string}
* @memberof WidgetForm
*/
subType?: WidgetFormSubTypeEnum;
/**
*
* @type {string}
* @memberof WidgetForm
*/
intro?: string;
/**
*
* @type {Array<number>}
* @memberof WidgetForm
*/
queries: Array<number>;
/**
*
* @type {string}
* @memberof WidgetForm
*/
layout?: string;
/**
*
* @type {number}
* @memberof WidgetForm
*/
status?: number;
}
/**
* @export
*/
export declare const WidgetFormTypeEnum: {
readonly Web: "web";
readonly Mobile: "mobile";
readonly Desktop: "desktop";
readonly Widget: "widget";
};
export type WidgetFormTypeEnum = typeof WidgetFormTypeEnum[keyof typeof WidgetFormTypeEnum];
/**
* @export
*/
export declare const WidgetFormSubTypeEnum: {
readonly None: "None";
readonly SearchBox: "SearchBox";
readonly SearchDialog: "SearchDialog";
readonly QueryBox: "QueryBox";
};
export type WidgetFormSubTypeEnum = typeof WidgetFormSubTypeEnum[keyof typeof WidgetFormSubTypeEnum];
/**
* Check if a given object implements the WidgetForm interface.
*/
export declare function instanceOfWidgetForm(value: object): boolean;
export declare function WidgetFormFromJSON(json: any): WidgetForm;
export declare function WidgetFormFromJSONTyped(json: any, ignoreDiscriminator: boolean): WidgetForm;
export declare function WidgetFormToJSON(value?: WidgetForm | null): any;