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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { MarketsAPIV4Api } from '../generated';
import type { V4MarketsControllerDeleteMarketV4Request, V4MarketsControllerGetMarketColumnsV4Request, V4MarketsControllerGetMarketV4Request, V4MarketsControllerGetMarketsInViewV4Request, V4MarketsControllerGetMarketsV4Request, V4MarketsControllerUpdateMarketV4Request, V4MarketsDeleteMarketResponseDto, V4MarketsGetMarketColumnsResponseDto, V4MarketsGetMarketResponseDto, V4MarketsGetMarketsInViewResponseDto, V4MarketsGetMarketsResponseDto, V4MarketsUpdateMarketBodyDto, V4MarketsUpdateMarketResponseDto } from '../generated';
export declare class Markets {
    readonly list: MarketsList;
    readonly update: MarketsUpdate;
    readonly delete: MarketsDelete;
    constructor(config: Configuration);
}
export declare class MarketsList {
    private api;
    constructor(api: MarketsAPIV4Api);
    /**
     * one - get /v4/markets/{marketId}
     */
    one(marketId: V4MarketsControllerGetMarketV4Request['marketId'], options?: Omit<V4MarketsControllerGetMarketV4Request, 'marketId'>): Promise<V4MarketsGetMarketResponseDto>;
    /**
     * oneWithColumns - get /v4/markets/{marketId}/{columns}
     */
    oneWithColumns(marketId: V4MarketsControllerGetMarketColumnsV4Request['marketId'], columns: V4MarketsControllerGetMarketColumnsV4Request['columns'], options?: Omit<V4MarketsControllerGetMarketColumnsV4Request, 'marketId' | 'columns'>): Promise<V4MarketsGetMarketColumnsResponseDto>;
    /**
     * all - get /v4/markets
     */
    all(options?: V4MarketsControllerGetMarketsV4Request): Promise<V4MarketsGetMarketsResponseDto>;
    /**
     * withView - get /v4/markets/viewId/{viewId}
     */
    withView(viewId: V4MarketsControllerGetMarketsInViewV4Request['viewId'], options?: Omit<V4MarketsControllerGetMarketsInViewV4Request, 'viewId'>): Promise<V4MarketsGetMarketsInViewResponseDto>;
}
export declare class MarketsUpdate {
    private api;
    constructor(api: MarketsAPIV4Api);
    /**
     * one - patch /v4/markets/{marketId}
     */
    one(marketId: V4MarketsControllerUpdateMarketV4Request['marketId'], body: V4MarketsUpdateMarketBodyDto): Promise<V4MarketsUpdateMarketResponseDto>;
}
export declare class MarketsDelete {
    private api;
    constructor(api: MarketsAPIV4Api);
    /**
     * one - delete /v4/markets/{marketId}
     */
    one(marketId: V4MarketsControllerDeleteMarketV4Request['marketId'], options?: Omit<V4MarketsControllerDeleteMarketV4Request, 'marketId'>): Promise<V4MarketsDeleteMarketResponseDto>;
}
//# sourceMappingURL=markets.d.ts.map