drf-react-by-schema/dist/api.d.ts

Components and Tools for building a React App having Django Rest Framework (DRF) as server

import { ServerEndPoint } from './context/DRFReactBySchemaContext';
import { Item, SchemaType, DataSchemaColumnsType, ItemSchemaColumnsType, Id, TargetApiParams, TargetApiPostParams, GetGenericModelListProps, GetGenericModelProps } from './@types';
interface TargetApiParamsOptionalId {
    path: string;
    serverEndPoint: ServerEndPoint | null;
    data: Item;
    id?: Id;
    contentType?: 'application/json' | 'multipart/form-data';
}
export declare const getRawData: ({ path, serverEndPoint, }: {
    path: string;
    serverEndPoint: ServerEndPoint | null;
}) => Promise<any>;
/**
 *
 * @param options - params
 * @returns updatedData when succesfully updated, axiosError otherwise
 */
export declare const updateData: ({ path, serverEndPoint, data, id, contentType, }: TargetApiParams) => Promise<any>;
export declare const partialUpdateData: ({ path, serverEndPoint, data, id }: TargetApiParams) => Promise<any>;
export declare const createData: ({ path, serverEndPoint, data, contentType, }: TargetApiPostParams) => Promise<any>;
export declare const deleteData: (path: string, serverEndPoint: ServerEndPoint | null, id: Id) => Promise<any>;
export declare const createOrUpdateData: ({ path, serverEndPoint, data, id, contentType, }: TargetApiParamsOptionalId) => Promise<any>;
export declare const updateDataBySchema: ({ model, modelObjectId, serverEndPoint, data, schema, path, }: {
    model: string;
    modelObjectId: Id;
    serverEndPoint: ServerEndPoint | null;
    data: Item;
    schema: SchemaType;
    path?: string | null;
}) => Promise<any>;
export declare const addExistingRelatedModel: ({ model, serverEndPoint, id, data, }: {
    model: string;
    serverEndPoint: ServerEndPoint | null;
    id: Id;
    data: Item;
}) => Promise<any>;
export declare const getAutoComplete: ({ model, serverEndPoint, }: {
    model: string;
    serverEndPoint: ServerEndPoint | null;
}) => Promise<false | Item[]>;
export declare const loginByPayload: (payload: Item, serverEndPoint: ServerEndPoint | null) => Promise<any>;
export declare const clearJWT: () => boolean;
export declare const hasJWT: () => boolean;
export declare const setAuthToken: (token: string | null) => void;
export declare const isLoggedIn: (serverEndPoint: ServerEndPoint | null) => Promise<false | Item>;
export declare const getSignUpOptions: (serverEndPoint: ServerEndPoint | null) => Promise<any>;
export declare const signUp: (data: Item, serverEndPoint: ServerEndPoint | null) => Promise<any>;
export declare const getGenericModelList: ({ model, serverEndPoint, id, relatedModel, relatedModelId, columnFields, hiddenFields, creatableFields, disabledFields, isInBatches, loadedSchema, loadedModelOptions, page, filter, queryParams, sort, sumRows, }: GetGenericModelListProps) => Promise<false | DataSchemaColumnsType>;
export declare const getGenericModel: ({ model, serverEndPoint, id, relatedModel, relatedModelId, }: GetGenericModelProps) => Promise<false | ItemSchemaColumnsType>;
export declare const getAllModels: (serverEndPoint: ServerEndPoint | null) => Promise<any>;
export {};
//# sourceMappingURL=api.d.ts.map