@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
100 lines • 3.39 kB
TypeScript
/**
* API v4
* Swagger documentation for API v4
*
* The version of the OpenAPI document: 4.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { SoSRenovationEntityStatus } from './SoSRenovationEntityStatus';
/**
*
* @export
* @interface V4RenovationsCreateRenovationBodyDto
*/
export interface V4RenovationsCreateRenovationBodyDto {
/**
* Unit ID reference - every renovation must be associated with a specific unit
* @type {number}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
unitId: number;
/**
* Inspection ID reference - links renovation to an inspection if applicable
* @type {number}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
inspectionId?: number;
/**
* Current status of the renovation
* @type {SoSRenovationEntityStatus}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
status?: SoSRenovationEntityStatus;
/**
* Name/title of the renovation
* @type {string}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
name?: string;
/**
* Detailed notes about the renovation
* @type {string}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
notes?: string;
/**
* Estimated budget for the renovation
* @type {number}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
budget?: number;
/**
* Actual cost spent on the renovation (auto-calculated from work orders)
* @type {number}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
actualCost?: number;
/**
* Total budget allocated across all work orders (auto-calculated)
* @type {number}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
budgetAllocated?: number;
/**
* Deadline date for completing the renovation
* @type {Date}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
deadline?: string;
/**
* Date when renovation work started
* @type {Date}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
startDate?: string;
/**
* Date when renovation was completed
* @type {Date}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
completionDate?: string;
/**
* When the renovation was created
* @type {Date}
* @memberof V4RenovationsCreateRenovationBodyDto
*/
createdAt?: string;
}
/**
* Check if a given object implements the V4RenovationsCreateRenovationBodyDto interface.
*/
export declare function instanceOfV4RenovationsCreateRenovationBodyDto(value: object): value is V4RenovationsCreateRenovationBodyDto;
export declare function V4RenovationsCreateRenovationBodyDtoFromJSON(json: any): V4RenovationsCreateRenovationBodyDto;
export declare function V4RenovationsCreateRenovationBodyDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): V4RenovationsCreateRenovationBodyDto;
export declare function V4RenovationsCreateRenovationBodyDtoToJSON(json: any): V4RenovationsCreateRenovationBodyDto;
export declare function V4RenovationsCreateRenovationBodyDtoToJSONTyped(value?: V4RenovationsCreateRenovationBodyDto | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=V4RenovationsCreateRenovationBodyDto.d.ts.map