@simplyhomes/sos-client/dist/client/properties/getById/index.d.ts

Client SDK for SimplyHomes SOS API

import { SDK_Base } from '../../base';
import { SDK_Context } from 'sdk/client/client';
import { SDK_Execution } from 'sdk/interfaces/sdk-execution';
import { SDK_GetPropertyById_IncludedFieldsType, SDK_GetPropertyByPid_Response_Dto } from './types';
export declare class SDK_Properties_GetById extends SDK_Base implements SDK_Execution {
    private propertyId;
    private includedFields?;
    constructor(ctx: SDK_Context, propertyId: string);
    /**
     * Sets the property ID for the request
     * @param propertyId - The ID of the property to retrieve
     * @returns The current instance for method chaining
     */
    included(fields: SDK_GetPropertyById_IncludedFieldsType[]): this;
    /**
     * Executes the request to get property by ID
     * @returns The response from the API
     */
    execute(): Promise<SDK_GetPropertyByPid_Response_Dto>;
    private clonePayload;
    private resetPayload;
}