@bapp/auto-api-client/dist/service.d.ts

Client to consume BAPP auto API, based on content types with type inference

import { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
import { Config, RegisteredMapping, PagedData } from './types';
export type Options = {
    host?: string;
    axiosInstance?: AxiosInstance;
};
export type RequestOptions = {
    filter?: Record<string, unknown>;
    config?: Config;
    axiosConfig?: AxiosRequestConfig;
};
export declare class BappAutoApi {
    axiosInstance: AxiosInstance;
    constructor(options?: Options);
    _makeRequest<TData = any>(method: Method, url: string, options?: RequestOptions): Promise<TData>;
    getMe<TData = any>(options?: RequestOptions): Promise<TData>;
    getApp<TData = any>(appSlug: string, options?: RequestOptions): Promise<TData>;
    getEntityListIntrospect<TData = any>(contentType: RegisteredMapping["ContentType"], options?: RequestOptions): Promise<TData>;
    getEntityDetailIntrospect<TData = any>(contentType: RegisteredMapping["ContentType"], pk?: string, options?: RequestOptions): Promise<TData>;
    listEntities<TData = any>(contentType: RegisteredMapping["ContentType"], options?: RequestOptions): Promise<PagedData<TData>>;
    getEntity<TData = any>(contentType: RegisteredMapping["ContentType"], id: string, options?: RequestOptions): Promise<TData>;
    createEntity<TData = any>(contentType: RegisteredMapping["ContentType"], payload?: unknown, options?: RequestOptions): Promise<TData>;
    updateEntity<TData = any>(contentType: RegisteredMapping["ContentType"], id: string, payload?: unknown, options?: RequestOptions): Promise<TData>;
    updatePartialEntity<TData = any>(contentType: RegisteredMapping["ContentType"], id: string, payload?: unknown, options?: RequestOptions): Promise<TData>;
    deleteEntity<TData = any>(contentType: RegisteredMapping["ContentType"], id: string, options?: RequestOptions): Promise<TData>;
    listTasks<TData = any>(options?: RequestOptions): Promise<TData>;
    detailTask<TData = any>(code: RegisteredMapping["TaskCode"], options?: RequestOptions): Promise<TData>;
    runTask<TData = any>(code: RegisteredMapping["TaskCode"], payload?: unknown, options?: RequestOptions): Promise<TData>;
    listWidgets<TData = any>(options?: RequestOptions): Promise<TData>;
    detailWidget<TData = any>(code: string, options?: RequestOptions): Promise<TData>;
    renderWidget<TData = any>(code: string, payload?: unknown, options?: RequestOptions): Promise<TData>;
}
export default BappAutoApi;