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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { ZipcodesAPIV4Api } from '../generated';
import type { V4ZipcodesControllerDeleteZipcodeV4Request, V4ZipcodesControllerGetZipcodeColumnsV4Request, V4ZipcodesControllerGetZipcodeV4Request, V4ZipcodesControllerGetZipcodesInViewV4Request, V4ZipcodesControllerGetZipcodesV4Request, V4ZipcodesControllerUpdateZipcodeV4Request, V4ZipcodesCreateZipcodeBodyDto, V4ZipcodesCreateZipcodeResponseDto, V4ZipcodesDeleteZipcodeResponseDto, V4ZipcodesGetZipcodeColumnsResponseDto, V4ZipcodesGetZipcodeResponseDto, V4ZipcodesGetZipcodesInViewResponseDto, V4ZipcodesGetZipcodesResponseDto, V4ZipcodesUpdateZipcodeBodyDto, V4ZipcodesUpdateZipcodeResponseDto } from '../generated';
export declare class Zipcodes {
    readonly list: ZipcodesList;
    readonly create: ZipcodesCreate;
    readonly update: ZipcodesUpdate;
    readonly delete: ZipcodesDelete;
    constructor(config: Configuration);
}
export declare class ZipcodesList {
    private api;
    constructor(api: ZipcodesAPIV4Api);
    /**
     * one - get /v4/zipcodes/{zipcodeId}
     */
    one(zipcodeId: V4ZipcodesControllerGetZipcodeV4Request['zipcodeId'], options?: Omit<V4ZipcodesControllerGetZipcodeV4Request, 'zipcodeId'>): Promise<V4ZipcodesGetZipcodeResponseDto>;
    /**
     * oneWithColumns - get /v4/zipcodes/{zipcodeId}/{columns}
     */
    oneWithColumns(zipcodeId: V4ZipcodesControllerGetZipcodeColumnsV4Request['zipcodeId'], columns: V4ZipcodesControllerGetZipcodeColumnsV4Request['columns'], options?: Omit<V4ZipcodesControllerGetZipcodeColumnsV4Request, 'zipcodeId' | 'columns'>): Promise<V4ZipcodesGetZipcodeColumnsResponseDto>;
    /**
     * all - get /v4/zipcodes
     */
    all(options?: V4ZipcodesControllerGetZipcodesV4Request): Promise<V4ZipcodesGetZipcodesResponseDto>;
    /**
     * withView - get /v4/zipcodes/viewId/{viewId}
     */
    withView(viewId: V4ZipcodesControllerGetZipcodesInViewV4Request['viewId'], options?: Omit<V4ZipcodesControllerGetZipcodesInViewV4Request, 'viewId'>): Promise<V4ZipcodesGetZipcodesInViewResponseDto>;
}
export declare class ZipcodesCreate {
    private api;
    constructor(api: ZipcodesAPIV4Api);
    /**
     * one - post /v4/zipcodes
     */
    one(body: V4ZipcodesCreateZipcodeBodyDto): Promise<V4ZipcodesCreateZipcodeResponseDto>;
}
export declare class ZipcodesUpdate {
    private api;
    constructor(api: ZipcodesAPIV4Api);
    /**
     * one - patch /v4/zipcodes/{zipcodeId}
     */
    one(zipcodeId: V4ZipcodesControllerUpdateZipcodeV4Request['zipcodeId'], body: V4ZipcodesUpdateZipcodeBodyDto['zipcode']): Promise<V4ZipcodesUpdateZipcodeResponseDto>;
}
export declare class ZipcodesDelete {
    private api;
    constructor(api: ZipcodesAPIV4Api);
    /**
     * one - delete /v4/zipcodes/{zipcodeId}
     */
    one(zipcodeId: V4ZipcodesControllerDeleteZipcodeV4Request['zipcodeId'], options?: Omit<V4ZipcodesControllerDeleteZipcodeV4Request, 'zipcodeId'>): Promise<V4ZipcodesDeleteZipcodeResponseDto>;
}
//# sourceMappingURL=zipcodes.d.ts.map