crisp-api
Version:
Crisp API wrapper for Node - official, maintained by Crisp
65 lines (64 loc) • 2.12 kB
TypeScript
/**************************************************************************
* IMPORTS
***************************************************************************/
import BaseResource from "./BaseResource";
/**************************************************************************
* TYPES
***************************************************************************/
export type PluginConnectAccount = {
plugin_id?: string;
};
export type PluginConnectWebsite = {
website_id?: string;
token?: string;
settings?: object;
plan?: PluginConnectWebsitePlan;
difference?: string;
};
export type PluginConnectWebsitePlan = {
id?: string;
name?: string;
trialing?: boolean;
};
export type PluginConnectEndpoints = {
socket?: PluginConnectEndpointsSocket;
rescue?: PluginConnectEndpointsRescue;
};
export type PluginConnectEndpointsSocket = {
app?: string;
};
export type PluginConnectEndpointsRescue = {
socket?: PluginConnectEndpointsSocket;
};
/**************************************************************************
* CLASSES
***************************************************************************/
/**
* Crisp PluginConnect Resource
*/
declare class PluginConnect extends BaseResource {
/**
* Get Connect Account
*/
getConnectAccount(): Promise<PluginConnectAccount>;
/**
* Check Connect Session Validity
*/
checkConnectSessionValidity(): Promise<any>;
/**
* List All Connect Websites
*/
listAllConnectWebsites(pageNumber: number, filterConfigured: boolean, includePlan: boolean): Promise<PluginConnectWebsite[]>;
/**
* List Connect Websites Since
*/
listConnectWebsitesSince(dateSince: string, filterConfigured: boolean, includePlan: boolean): Promise<PluginConnectWebsite[]>;
/**
* Get Connect Endpoints
*/
getConnectEndpoints(): Promise<PluginConnectEndpoints>;
}
/**************************************************************************
* EXPORTS
***************************************************************************/
export default PluginConnect;