@etsoo/smarterp-crm/lib/cjs/PersonProfileApi.d.ts

TypeScript APIs for SmartERP Customer Relationship Management (CRM)

import { EntityApi, IApi, IApiPayload, IApp, IdResultPayload } from "@etsoo/appscript";
import { PersonProfileListData } from "./dto/personProfile/PersonProfileListData";
import { PersonProfileListRQ } from "./rq/personProfile/PersonProfileListRQ";
import { PersonProfileQueryRQ } from "./rq/personProfile/PersonProfileQueryRQ";
import { PersonProfileUpdateReadData } from "./dto/personProfile/PersonProfileUpdateReadData";
import { PersonProfileQueryData } from "./dto/personProfile/PersonProfileQueryData";
import { PersonProfileViewData } from "./dto/personProfile/PersonProfileViewData";
import { PersonProfileCreateRQ } from "./rq/personProfile/PersonProfileCreateRQ";
/**
 * Person profile API
 */
export declare class PersonProfileApi extends EntityApi {
    /**
     * Constructor
     * @param app Application
     * @param api API
     */
    constructor(app: IApp, api?: IApi);
    /**
     * Create
     * @param rq Request data
     * @param payload Payload
     * @returns Result
     */
    create(rq: PersonProfileCreateRQ, payload?: IdResultPayload): Promise<import("@etsoo/shared").IdActionResult | undefined>;
    /**
     * List
     * @param rq Request data
     * @param payload Payload
     * @returns Result
     */
    list(rq: PersonProfileListRQ, payload: IApiPayload<PersonProfileListData[]>): Promise<PersonProfileListData[] | undefined>;
    /**
     * Query
     * @param rq Request data
     * @param payload Payload
     * @returns Result
     */
    query(rq: PersonProfileQueryRQ, payload?: IApiPayload<PersonProfileQueryData[]>): Promise<PersonProfileQueryData[] | undefined>;
    /**
     * Read
     * @param id Id
     * @param payload Payload
     * @returns Result
     */
    read(id: number, payload?: IApiPayload<PersonProfileViewData>): Promise<PersonProfileViewData | undefined>;
    /**
     * Update read
     * @param id Id
     * @param payload Payload
     * @returns Result
     */
    updateRead(id: number, payload?: IApiPayload<PersonProfileUpdateReadData>): Promise<PersonProfileUpdateReadData | undefined>;
}