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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { OptionsAPIV4Api } from '../generated';
import type { V4OptionsControllerGetOptionColumnsV4Request, V4OptionsControllerGetOptionV4Request, V4OptionsControllerGetOptionsFilteredByV4Request, V4OptionsControllerGetOptionsInViewV4Request, V4OptionsControllerGetOptionsV4Request, V4OptionsCreateOptionBodyDto, V4OptionsCreateOptionResponseDto, V4OptionsGetOptionColumnsResponseDto, V4OptionsGetOptionResponseDto, V4OptionsGetOptionsFilteredByResponseDto, V4OptionsGetOptionsInViewResponseDto, V4OptionsGetOptionsResponseDto } from '../generated';
export declare class Options {
    readonly list: OptionsList;
    readonly create: OptionsCreate;
    constructor(config: Configuration);
}
export declare class OptionsList {
    private api;
    constructor(api: OptionsAPIV4Api);
    /**
     * one - get /v4/options/{optionId}
     */
    one(optionId: V4OptionsControllerGetOptionV4Request['optionId'], options?: Omit<V4OptionsControllerGetOptionV4Request, 'optionId'>): Promise<V4OptionsGetOptionResponseDto>;
    /**
     * oneWithColumns - get /v4/options/{optionId}/{columns}
     */
    oneWithColumns(optionId: V4OptionsControllerGetOptionColumnsV4Request['optionId'], columns: V4OptionsControllerGetOptionColumnsV4Request['columns'], options?: Omit<V4OptionsControllerGetOptionColumnsV4Request, 'optionId' | 'columns'>): Promise<V4OptionsGetOptionColumnsResponseDto>;
    /**
     * all - get /v4/options
     */
    all(options?: V4OptionsControllerGetOptionsV4Request): Promise<V4OptionsGetOptionsResponseDto>;
    /**
     * withView - get /v4/options/viewId/{viewId}
     */
    withView(viewId: V4OptionsControllerGetOptionsInViewV4Request['viewId'], options?: Omit<V4OptionsControllerGetOptionsInViewV4Request, 'viewId'>): Promise<V4OptionsGetOptionsInViewResponseDto>;
    /**
     * withFilters - get /v4/options/filteredBy/{column}/{value}
     */
    withFilters(column: V4OptionsControllerGetOptionsFilteredByV4Request['column'], value: V4OptionsControllerGetOptionsFilteredByV4Request['value'], options?: Omit<V4OptionsControllerGetOptionsFilteredByV4Request, 'column' | 'value'>): Promise<V4OptionsGetOptionsFilteredByResponseDto>;
}
export declare class OptionsCreate {
    private api;
    constructor(api: OptionsAPIV4Api);
    /**
     * one - post /v4/options
     */
    one(body: V4OptionsCreateOptionBodyDto): Promise<V4OptionsCreateOptionResponseDto>;
}
//# sourceMappingURL=options.d.ts.map