@apillon/sdk/dist/lib/apillon.d.ts

▶◀ Apillon SDK for NodeJS ▶◀

import { LogLevel } from '../types/apillon';
export interface ApillonConfig {
    /**
     * Your API key, generated through the Apillon dashboard
     * @default env.APILLON_API_KEY
     */
    key?: string;
    /**
     * Your API secret, generated through the Apillon dashboard
     * @default env.APILLON_API_SECRET
     */
    secret?: string;
    /**
     * The API URL to use for executing the queries and actions.
     * @default https://api.apillon.io
     */
    apiUrl?: string;
    /**
     * The level of logger output to use for the Apillon logger.
     * @default ERROR
     */
    logLevel?: LogLevel;
    /**
     * Used for CLI - indicates whether to output verbose logs
     * @default false
     */
    debug?: boolean;
}
export interface ICreateApillonModel {
    /**
     * Name of the model object
     */
    name: string;
    /**
     * Description of the model object
     */
    description: string;
}
export declare class ApillonModule {
    protected config: ApillonConfig;
    constructor(config?: ApillonConfig);
}
export declare class ApillonModel {
    /**
     * API url prefix for this class.
     */
    protected API_PREFIX: string;
    /**
     * Unique identifier of the model.
     */
    uuid: string;
    /**
     * The object's creation date
     */
    createTime: string;
    /**
     * The date when the object was last updated
     */
    updateTime: string;
    constructor(uuid: string);
    /**
     * Gets and populates the object details of this entity
     * @returns A new instance of this object
     */
    get(): Promise<this>;
    /**
     * Populates class properties via data object.
     * @param data Data object.
     */
    protected populate(data: object): this;
    /**
     * Convert object to JSON output, with unnecessary properties excluded
     */
    serialize(): any;
    /**
     * Define and exclude custom keys from serialized object
     */
    protected serializeFilter(key: string, value: any): any;
}
//# sourceMappingURL=apillon.d.ts.map