@rocket.chat/apps-engine/definition/api/ApiEndpoint.d.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { IApp } from '../IApp';
import type { IApiEndpoint } from './IApiEndpoint';
import type { IApiResponse, IApiResponseJSON } from './IResponse';
/** Represents an api endpoint that is being provided. */
export declare abstract class ApiEndpoint implements IApiEndpoint {
    app: IApp;
    /**
     * The last part of the api URL. Example: https://{your-server-address}/api/apps/public/{your-app-id}/{path}
     * or https://{your-server-address}/api/apps/private/{your-app-id}/{private-hash}/{path}
     */
    path: string;
    constructor(app: IApp);
    /**
     * Return response with status 200 (OK) and a optional content
     * @param content
     */
    protected success(content?: any): IApiResponse;
    /**
     * Return a json response adding Content Type header as
     * application/json if not already provided
     * @param reponse
     */
    protected json(response: IApiResponseJSON): IApiResponse;
}