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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { InspectionsAPIV4Api } from '../generated';
import type { V4InspectionsControllerDeleteInspectionV4Request, V4InspectionsControllerGetInspectionColumnsV4Request, V4InspectionsControllerGetInspectionV4Request, V4InspectionsControllerGetInspectionsInViewV4Request, V4InspectionsControllerGetInspectionsV4Request, V4InspectionsControllerGetUniqueValuesV4Request, V4InspectionsControllerUpdateInspectionV4Request, V4InspectionsCreateInspectionBodyDto, V4InspectionsCreateInspectionResponseDto, V4InspectionsDeleteInspectionResponseDto, V4InspectionsGetInspectionColumnsResponseDto, V4InspectionsGetInspectionResponseDto, V4InspectionsGetInspectionsInViewResponseDto, V4InspectionsGetInspectionsResponseDto, V4InspectionsGetUniqueValuesResponseDto, V4InspectionsUpdateInspectionBodyDto, V4InspectionsUpdateInspectionResponseDto } from '../generated';
export declare class Inspections {
    readonly list: InspectionsList;
    readonly create: InspectionsCreate;
    readonly update: InspectionsUpdate;
    readonly delete: InspectionsDelete;
    constructor(config: Configuration);
}
export declare class InspectionsList {
    private api;
    constructor(api: InspectionsAPIV4Api);
    /**
     * uniqueValues - get /v4/inspections/unique/{column}
     */
    uniqueValues(column: V4InspectionsControllerGetUniqueValuesV4Request['column'], options?: Omit<V4InspectionsControllerGetUniqueValuesV4Request, 'column'>): Promise<V4InspectionsGetUniqueValuesResponseDto>;
    /**
     * one - get /v4/inspections/{inspectionId}
     */
    one(inspectionId: V4InspectionsControllerGetInspectionV4Request['inspectionId'], options?: Omit<V4InspectionsControllerGetInspectionV4Request, 'inspectionId'>): Promise<V4InspectionsGetInspectionResponseDto>;
    /**
     * oneWithColumns - get /v4/inspections/{inspectionId}/{columns}
     */
    oneWithColumns(inspectionId: V4InspectionsControllerGetInspectionColumnsV4Request['inspectionId'], columns: V4InspectionsControllerGetInspectionColumnsV4Request['columns'], options?: Omit<V4InspectionsControllerGetInspectionColumnsV4Request, 'inspectionId' | 'columns'>): Promise<V4InspectionsGetInspectionColumnsResponseDto>;
    /**
     * all - get /v4/inspections
     */
    all(options?: V4InspectionsControllerGetInspectionsV4Request): Promise<V4InspectionsGetInspectionsResponseDto>;
    /**
     * withView - get /v4/inspections/viewId/{viewId}
     */
    withView(viewId: V4InspectionsControllerGetInspectionsInViewV4Request['viewId'], options?: Omit<V4InspectionsControllerGetInspectionsInViewV4Request, 'viewId'>): Promise<V4InspectionsGetInspectionsInViewResponseDto>;
}
export declare class InspectionsCreate {
    private api;
    constructor(api: InspectionsAPIV4Api);
    /**
     * one - post /v4/inspections
     */
    one(body: V4InspectionsCreateInspectionBodyDto): Promise<V4InspectionsCreateInspectionResponseDto>;
}
export declare class InspectionsUpdate {
    private api;
    constructor(api: InspectionsAPIV4Api);
    /**
     * one - patch /v4/inspections/{inspectionId}
     */
    one(inspectionId: V4InspectionsControllerUpdateInspectionV4Request['inspectionId'], body: V4InspectionsUpdateInspectionBodyDto['inspection']): Promise<V4InspectionsUpdateInspectionResponseDto>;
}
export declare class InspectionsDelete {
    private api;
    constructor(api: InspectionsAPIV4Api);
    /**
     * one - delete /v4/inspections/{inspectionId}
     */
    one(inspectionId: V4InspectionsControllerDeleteInspectionV4Request['inspectionId'], options?: Omit<V4InspectionsControllerDeleteInspectionV4Request, 'inspectionId'>): Promise<V4InspectionsDeleteInspectionResponseDto>;
}
//# sourceMappingURL=inspections.d.ts.map