@simplyhomes/sos-sdk/dist/resources/leads.d.ts

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { LeadsAPIV4Api } from '../generated';
import type { V4LeadsControllerDeleteLeadV4Request, V4LeadsControllerGetLeadColumnsV4Request, V4LeadsControllerGetLeadV4Request, V4LeadsControllerGetLeadsInViewV4Request, V4LeadsControllerGetLeadsV4Request, V4LeadsControllerUpdateLeadV4Request, V4LeadsCreateLeadBodyDto, V4LeadsCreateLeadResponseDto, V4LeadsDeleteLeadResponseDto, V4LeadsGetLeadColumnsResponseDto, V4LeadsGetLeadResponseDto, V4LeadsGetLeadsInViewResponseDto, V4LeadsGetLeadsResponseDto, V4LeadsUpdateLeadBodyDto, V4LeadsUpdateLeadResponseDto } from '../generated';
export declare class Leads {
    readonly list: LeadsList;
    readonly create: LeadsCreate;
    readonly update: LeadsUpdate;
    readonly delete: LeadsDelete;
    constructor(config: Configuration);
}
export declare class LeadsList {
    private api;
    constructor(api: LeadsAPIV4Api);
    /**
     * one - get /v4/leads/{leadId}
     */
    one(leadId: V4LeadsControllerGetLeadV4Request['leadId'], options?: Omit<V4LeadsControllerGetLeadV4Request, 'leadId'>): Promise<V4LeadsGetLeadResponseDto>;
    /**
     * oneWithColumns - get /v4/leads/{leadId}/{columns}
     */
    oneWithColumns(leadId: V4LeadsControllerGetLeadColumnsV4Request['leadId'], columns: V4LeadsControllerGetLeadColumnsV4Request['columns'], options?: Omit<V4LeadsControllerGetLeadColumnsV4Request, 'leadId' | 'columns'>): Promise<V4LeadsGetLeadColumnsResponseDto>;
    /**
     * all - get /v4/leads
     */
    all(options?: V4LeadsControllerGetLeadsV4Request): Promise<V4LeadsGetLeadsResponseDto>;
    /**
     * withView - get /v4/leads/viewId/{viewId}
     */
    withView(viewId: V4LeadsControllerGetLeadsInViewV4Request['viewId'], options?: Omit<V4LeadsControllerGetLeadsInViewV4Request, 'viewId'>): Promise<V4LeadsGetLeadsInViewResponseDto>;
}
export declare class LeadsCreate {
    private api;
    constructor(api: LeadsAPIV4Api);
    /**
     * one - post /v4/leads
     */
    one(body: V4LeadsCreateLeadBodyDto): Promise<V4LeadsCreateLeadResponseDto>;
}
export declare class LeadsUpdate {
    private api;
    constructor(api: LeadsAPIV4Api);
    /**
     * one - patch /v4/leads/{leadId}
     */
    one(leadId: V4LeadsControllerUpdateLeadV4Request['leadId'], body: V4LeadsUpdateLeadBodyDto): Promise<V4LeadsUpdateLeadResponseDto>;
}
export declare class LeadsDelete {
    private api;
    constructor(api: LeadsAPIV4Api);
    /**
     * one - delete /v4/leads/{leadId}
     */
    one(leadId: V4LeadsControllerDeleteLeadV4Request['leadId'], options?: Omit<V4LeadsControllerDeleteLeadV4Request, 'leadId'>): Promise<V4LeadsDeleteLeadResponseDto>;
}
//# sourceMappingURL=leads.d.ts.map