crisp-api
Version:
Crisp API wrapper for Node - official, maintained by Crisp
70 lines (69 loc) • 2 kB
TypeScript
/**************************************************************************
* IMPORTS
***************************************************************************/
import BaseResource from "./BaseResource";
/**************************************************************************
* TYPES
***************************************************************************/
export type Website = {
website_id?: string;
name?: string;
domain?: string;
logo?: string;
};
export type WebsiteCreate = {
name?: string;
domain?: string;
};
export type WebsiteRemoveVerify = {
method?: string;
secret?: string;
};
export type WebsiteFilter = {
model?: string;
criterion?: string;
operator?: string;
query?: Record<string, unknown>;
};
/**************************************************************************
* CLASSES
***************************************************************************/
/**
* Crisp WebsiteBase Resource
*/
declare class WebsiteBase extends BaseResource {
/**
* Check If Website Exists
* @memberof WebsiteBase
* @public
* @method checkWebsiteExists
* @param {string} domain
* @return {Promise}
*/
checkWebsiteExists(domain: string): Promise<any>;
/**
* Create Website
*/
createWebsite(websiteData: WebsiteCreate): Promise<Website>;
/**
* Get A Website
* @memberof WebsiteBase
* @public
* @method getWebsite
* @param {string} websiteID
* @return {Promise}
*/
getWebsite(websiteID: string): Promise<Website>;
/**
* Delete A Website
*/
deleteWebsite(websiteID: string, verify: WebsiteRemoveVerify): Promise<any>;
/**
* Abort Website Deletion
*/
abortWebsiteDeletion(websiteID: string): Promise<any>;
}
/**************************************************************************
* EXPORTS
***************************************************************************/
export default WebsiteBase;