@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
88 lines • 2.72 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 { SoSMessageEntityEntityType } from './SoSMessageEntityEntityType';
/**
*
* @export
* @interface SoSMessageEntityBase
*/
export interface SoSMessageEntityBase {
/**
* Unique message identifier
* @type {number}
* @memberof SoSMessageEntityBase
*/
mid: number;
/**
* Property ID reference - REQUIRED for all messages (property-centric architecture)
* @type {string}
* @memberof SoSMessageEntityBase
*/
propertyId: string;
/**
* Entity type this message belongs to (property, transaction, unit, inspection, etc.)
* @type {SoSMessageEntityEntityType}
* @memberof SoSMessageEntityBase
*/
entityType: SoSMessageEntityEntityType;
/**
* Entity ID this message belongs to (property ID for property messages, entity ID for others)
* @type {string}
* @memberof SoSMessageEntityBase
*/
entityId: string;
/**
* The message content text
* @type {string}
* @memberof SoSMessageEntityBase
*/
content: string;
/**
* Parent message ID - set when this message is a reply to another message
* @type {number}
* @memberof SoSMessageEntityBase
*/
parentId?: number;
/**
* User ID of the message author
* @type {string}
* @memberof SoSMessageEntityBase
*/
userId: string;
/**
* Organization ID for access control and data scoping
* @type {number}
* @memberof SoSMessageEntityBase
*/
organizationId: number;
/**
* When the message was created
* @type {Date}
* @memberof SoSMessageEntityBase
*/
createdAt: string;
/**
* When the message was last updated
* @type {Date}
* @memberof SoSMessageEntityBase
*/
updatedAt: string;
}
/**
* Check if a given object implements the SoSMessageEntityBase interface.
*/
export declare function instanceOfSoSMessageEntityBase(value: object): value is SoSMessageEntityBase;
export declare function SoSMessageEntityBaseFromJSON(json: any): SoSMessageEntityBase;
export declare function SoSMessageEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSMessageEntityBase;
export declare function SoSMessageEntityBaseToJSON(json: any): SoSMessageEntityBase;
export declare function SoSMessageEntityBaseToJSONTyped(value?: SoSMessageEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSMessageEntityBase.d.ts.map