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

TypeScript SDK for Simply Homes SoS API v4

import type { Configuration } from '../generated';
import { PropertiesAPIV4Api } from '../generated';
import type { V4PropertiesAddToAirtableResponseDto, V4PropertiesCheckAirtableResponseDto, V4PropertiesCheckExistingResponseDto, V4PropertiesControllerAddToAirtableV4Request, V4PropertiesControllerCheckAirtableV4Request, V4PropertiesControllerCheckExistingV4Request, V4PropertiesControllerCreateOnePagerV4Request, V4PropertiesControllerDeletePropertyV4Request, V4PropertiesControllerGetAddressAutocompleteV4Request, V4PropertiesControllerGetPropertiesFilteredByV4Request, V4PropertiesControllerGetPropertiesInViewV4Request, V4PropertiesControllerGetPropertiesV4Request, V4PropertiesControllerGetPropertyColumnsV4Request, V4PropertiesControllerGetPropertyV4Request, V4PropertiesControllerGetUniqueValuesV4Request, V4PropertiesControllerRefreshRentometerV4Request, V4PropertiesControllerRefreshTractTierV4Request, V4PropertiesControllerUpdatePropertyV4Request, V4PropertiesCreateOnePagerReturn, V4PropertiesCreatePropertyBodyDto, V4PropertiesCreatePropertyResponseDto, V4PropertiesDeletePropertyResponseDto, V4PropertiesGetAddressAutocompleteResponseDto, V4PropertiesGetPropertiesFilteredByResponseDto, V4PropertiesGetPropertiesInViewResponseDto, V4PropertiesGetPropertiesResponseDto, V4PropertiesGetPropertyColumnsResponseDto, V4PropertiesGetPropertyResponseDto, V4PropertiesGetUniqueValuesResponseDto, V4PropertiesRefreshRentometerReturnDto, V4PropertiesRefreshTractTierReturnDto, V4PropertiesUpdatePropertyBodyDto, V4PropertiesUpdatePropertyResponseDto } from '../generated';
export declare class Properties {
    readonly list: PropertiesList;
    readonly create: PropertiesCreate;
    readonly update: PropertiesUpdate;
    readonly delete: PropertiesDelete;
    readonly misc: PropertiesMisc;
    constructor(config: Configuration);
}
export declare class PropertiesList {
    private api;
    constructor(api: PropertiesAPIV4Api);
    /**
     * uniqueValues - get /v4/properties/unique/{column}
     */
    uniqueValues(column: V4PropertiesControllerGetUniqueValuesV4Request['column'], options?: Omit<V4PropertiesControllerGetUniqueValuesV4Request, 'column'>): Promise<V4PropertiesGetUniqueValuesResponseDto>;
    /**
     * addressAutocomplete - get /v4/properties/address/autocomplete
     */
    addressAutocomplete(input: V4PropertiesControllerGetAddressAutocompleteV4Request['input'], options?: Omit<V4PropertiesControllerGetAddressAutocompleteV4Request, 'input'>): Promise<V4PropertiesGetAddressAutocompleteResponseDto>;
    /**
     * one - get /v4/properties/{propertyId}
     */
    one(propertyId: V4PropertiesControllerGetPropertyV4Request['propertyId'], options?: Omit<V4PropertiesControllerGetPropertyV4Request, 'propertyId'>): Promise<V4PropertiesGetPropertyResponseDto>;
    /**
     * oneWithView - get /v4/properties/viewId/{viewId}
     */
    oneWithView(viewId: V4PropertiesControllerGetPropertiesInViewV4Request['viewId'], options?: Omit<V4PropertiesControllerGetPropertiesInViewV4Request, 'viewId'>): Promise<V4PropertiesGetPropertiesInViewResponseDto>;
    /**
     * oneWithColumns - get /v4/properties/{propertyId}/{columns}
     */
    oneWithColumns(propertyId: V4PropertiesControllerGetPropertyColumnsV4Request['propertyId'], columns: V4PropertiesControllerGetPropertyColumnsV4Request['columns'], options?: Omit<V4PropertiesControllerGetPropertyColumnsV4Request, 'propertyId' | 'columns'>): Promise<V4PropertiesGetPropertyColumnsResponseDto>;
    /**
     * all - get /v4/properties
     */
    all(options?: V4PropertiesControllerGetPropertiesV4Request): Promise<V4PropertiesGetPropertiesResponseDto>;
    /**
     * withView - get /v4/properties/viewId/{viewId}
     */
    withView(viewId: V4PropertiesControllerGetPropertiesInViewV4Request['viewId'], options?: Omit<V4PropertiesControllerGetPropertiesInViewV4Request, 'viewId'>): Promise<V4PropertiesGetPropertiesInViewResponseDto>;
    /**
     * withFilters - get /v4/properties/filteredBy/{column}/{value}
     */
    withFilters(column: V4PropertiesControllerGetPropertiesFilteredByV4Request['column'], value: V4PropertiesControllerGetPropertiesFilteredByV4Request['value'], options?: Omit<V4PropertiesControllerGetPropertiesFilteredByV4Request, 'column' | 'value'>): Promise<V4PropertiesGetPropertiesFilteredByResponseDto>;
}
export declare class PropertiesCreate {
    private api;
    constructor(api: PropertiesAPIV4Api);
    /**
     * one - post /v4/properties
     */
    one(body: V4PropertiesCreatePropertyBodyDto): Promise<V4PropertiesCreatePropertyResponseDto>;
}
export declare class PropertiesUpdate {
    private api;
    constructor(api: PropertiesAPIV4Api);
    /**
     * one - patch /v4/properties/{propertyId}
     */
    one(propertyId: V4PropertiesControllerUpdatePropertyV4Request['propertyId'], body: V4PropertiesUpdatePropertyBodyDto['property']): Promise<V4PropertiesUpdatePropertyResponseDto>;
}
export declare class PropertiesDelete {
    private api;
    constructor(api: PropertiesAPIV4Api);
    /**
     * one - delete /v4/properties/{propertyId}
     */
    one(propertyId: V4PropertiesControllerDeletePropertyV4Request['propertyId'], options?: Omit<V4PropertiesControllerDeletePropertyV4Request, 'propertyId'>): Promise<V4PropertiesDeletePropertyResponseDto>;
}
export declare class PropertiesMisc {
    private api;
    constructor(api: PropertiesAPIV4Api);
    /**
     * refreshRentometer - post /v4/properties/{propertyId}/refresh-rentometer
     */
    refreshRentometer(propertyId: V4PropertiesControllerRefreshRentometerV4Request['propertyId'], body: Omit<V4PropertiesControllerRefreshRentometerV4Request, 'propertyId'>): Promise<V4PropertiesRefreshRentometerReturnDto>;
    /**
     * refreshTractTier - post /v4/properties/{propertyId}/refresh-tract-tier
     */
    refreshTractTier(propertyId: V4PropertiesControllerRefreshTractTierV4Request['propertyId'], body: Omit<V4PropertiesControllerRefreshTractTierV4Request, 'propertyId'>): Promise<V4PropertiesRefreshTractTierReturnDto>;
    /**
     * checkExisting - get /v4/properties/check-existing
     */
    checkExisting(address: V4PropertiesControllerCheckExistingV4Request['address'], options?: Omit<V4PropertiesControllerCheckExistingV4Request, 'address'>): Promise<V4PropertiesCheckExistingResponseDto>;
    /**
     * checkAirtable - get /v4/properties/{propertyId}/check-airtable
     */
    checkAirtable(propertyId: V4PropertiesControllerCheckAirtableV4Request['propertyId'], options?: Omit<V4PropertiesControllerCheckAirtableV4Request, 'propertyId'>): Promise<V4PropertiesCheckAirtableResponseDto>;
    /**
     * addToAirtable - post /v4/properties/{propertyId}/add-to-airtable
     */
    addToAirtable(propertyId: V4PropertiesControllerAddToAirtableV4Request['propertyId'], body: Omit<V4PropertiesControllerAddToAirtableV4Request, 'propertyId'>): Promise<V4PropertiesAddToAirtableResponseDto>;
    /**
     * createOnePager - post /v4/properties/{propertyId}/create-one-pager
     */
    createOnePager(propertyId: V4PropertiesControllerCreateOnePagerV4Request['propertyId'], body: Omit<V4PropertiesControllerCreateOnePagerV4Request, 'propertyId'>): Promise<V4PropertiesCreateOnePagerReturn>;
}
//# sourceMappingURL=properties.d.ts.map