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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { OffersAPIV4Api } from '../generated';
import type { V4OffersControllerDeleteOfferV4Request, V4OffersControllerGetOfferColumnsV4Request, V4OffersControllerGetOfferV4Request, V4OffersControllerGetOffersInViewV4Request, V4OffersControllerGetOffersV4Request, V4OffersControllerUpdateOfferV4Request, V4OffersCreateOfferBodyDto, V4OffersCreateOfferResponseDto, V4OffersDeleteOfferResponseDto, V4OffersGetOfferColumnsResponseDto, V4OffersGetOfferResponseDto, V4OffersGetOffersInViewResponseDto, V4OffersGetOffersResponseDto, V4OffersUpdateOfferBodyDto, V4OffersUpdateOfferResponseDto } from '../generated';
export declare class Offers {
    readonly list: OffersList;
    readonly create: OffersCreate;
    readonly update: OffersUpdate;
    readonly delete: OffersDelete;
    constructor(config: Configuration);
}
export declare class OffersList {
    private api;
    constructor(api: OffersAPIV4Api);
    /**
     * one - get /v4/offers/{offerId}
     */
    one(offerId: V4OffersControllerGetOfferV4Request['offerId'], options?: Omit<V4OffersControllerGetOfferV4Request, 'offerId'>): Promise<V4OffersGetOfferResponseDto>;
    /**
     * oneWithColumns - get /v4/offers/{offerId}/{columns}
     */
    oneWithColumns(offerId: V4OffersControllerGetOfferColumnsV4Request['offerId'], columns: V4OffersControllerGetOfferColumnsV4Request['columns'], options?: Omit<V4OffersControllerGetOfferColumnsV4Request, 'offerId' | 'columns'>): Promise<V4OffersGetOfferColumnsResponseDto>;
    /**
     * all - get /v4/offers
     */
    all(options?: V4OffersControllerGetOffersV4Request): Promise<V4OffersGetOffersResponseDto>;
    /**
     * withView - get /v4/offers/viewId/{viewId}
     */
    withView(viewId: V4OffersControllerGetOffersInViewV4Request['viewId'], options?: Omit<V4OffersControllerGetOffersInViewV4Request, 'viewId'>): Promise<V4OffersGetOffersInViewResponseDto>;
}
export declare class OffersCreate {
    private api;
    constructor(api: OffersAPIV4Api);
    /**
     * one - post /v4/offers
     */
    one(body: V4OffersCreateOfferBodyDto): Promise<V4OffersCreateOfferResponseDto>;
}
export declare class OffersUpdate {
    private api;
    constructor(api: OffersAPIV4Api);
    /**
     * one - patch /v4/offers/{offerId}
     */
    one(offerId: V4OffersControllerUpdateOfferV4Request['offerId'], body: V4OffersUpdateOfferBodyDto): Promise<V4OffersUpdateOfferResponseDto>;
}
export declare class OffersDelete {
    private api;
    constructor(api: OffersAPIV4Api);
    /**
     * one - delete /v4/offers/{offerId}
     */
    one(offerId: V4OffersControllerDeleteOfferV4Request['offerId'], options?: Omit<V4OffersControllerDeleteOfferV4Request, 'offerId'>): Promise<V4OffersDeleteOfferResponseDto>;
}
//# sourceMappingURL=offers.d.ts.map