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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { RentalListingsAPIV4Api } from '../generated';
import type { V4RentalListingsControllerDeleteRentalListingV4Request, V4RentalListingsControllerGetRentalListingV4Request, V4RentalListingsControllerGetRentalListingsInViewV4Request, V4RentalListingsControllerGetRentalListingsV4Request, V4RentalListingsControllerGetUniqueValuesV4Request, V4RentalListingsControllerUpdateRentalListingV4Request, V4RentalListingsCreateRentalListingBodyDto, V4RentalListingsCreateRentalListingResponseDto, V4RentalListingsDeleteRentalListingResponseDto, V4RentalListingsGetRentalListingResponseDto, V4RentalListingsGetRentalListingsInViewResponseDto, V4RentalListingsGetRentalListingsResponseDto, V4RentalListingsGetUniqueValuesResponseDto, V4RentalListingsUpdateRentalListingBodyDto, V4RentalListingsUpdateRentalListingResponseDto } from '../generated';
export declare class RentalListings {
    readonly list: RentalListingsList;
    readonly create: RentalListingsCreate;
    readonly update: RentalListingsUpdate;
    readonly delete: RentalListingsDelete;
    constructor(config: Configuration);
}
export declare class RentalListingsList {
    private api;
    constructor(api: RentalListingsAPIV4Api);
    /**
     * uniqueValues - get /v4/rental-listings/unique/{column}
     */
    uniqueValues(column: V4RentalListingsControllerGetUniqueValuesV4Request['column'], options?: Omit<V4RentalListingsControllerGetUniqueValuesV4Request, 'column'>): Promise<V4RentalListingsGetUniqueValuesResponseDto>;
    /**
     * one - get /v4/rental-listings/{rentalListingId}
     */
    one(rentalListingId: V4RentalListingsControllerGetRentalListingV4Request['rentalListingId'], options?: Omit<V4RentalListingsControllerGetRentalListingV4Request, 'rentalListingId'>): Promise<V4RentalListingsGetRentalListingResponseDto>;
    /**
     * all - get /v4/rental-listings
     */
    all(options?: V4RentalListingsControllerGetRentalListingsV4Request): Promise<V4RentalListingsGetRentalListingsResponseDto>;
    /**
     * withView - get /v4/rental-listings/viewId/{viewId}
     */
    withView(viewId: V4RentalListingsControllerGetRentalListingsInViewV4Request['viewId'], options?: Omit<V4RentalListingsControllerGetRentalListingsInViewV4Request, 'viewId'>): Promise<V4RentalListingsGetRentalListingsInViewResponseDto>;
}
export declare class RentalListingsCreate {
    private api;
    constructor(api: RentalListingsAPIV4Api);
    /**
     * one - post /v4/rental-listings
     */
    one(body: V4RentalListingsCreateRentalListingBodyDto): Promise<V4RentalListingsCreateRentalListingResponseDto>;
}
export declare class RentalListingsUpdate {
    private api;
    constructor(api: RentalListingsAPIV4Api);
    /**
     * one - patch /v4/rental-listings/{rentalListingId}
     */
    one(rentalListingId: V4RentalListingsControllerUpdateRentalListingV4Request['rentalListingId'], body: V4RentalListingsUpdateRentalListingBodyDto): Promise<V4RentalListingsUpdateRentalListingResponseDto>;
}
export declare class RentalListingsDelete {
    private api;
    constructor(api: RentalListingsAPIV4Api);
    /**
     * one - delete /v4/rental-listings/{rentalListingId}
     */
    one(rentalListingId: V4RentalListingsControllerDeleteRentalListingV4Request['rentalListingId'], options?: Omit<V4RentalListingsControllerDeleteRentalListingV4Request, 'rentalListingId'>): Promise<V4RentalListingsDeleteRentalListingResponseDto>;
}
//# sourceMappingURL=rentalListings.d.ts.map