@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
64 lines • 2.36 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 SoSMessageSubscriptionEntityBase
*/
export interface SoSMessageSubscriptionEntityBase {
/**
* User ID subscribing to messages
* @type {string}
* @memberof SoSMessageSubscriptionEntityBase
*/
userId: string;
/**
* Property ID reference - REQUIRED for all subscriptions
* @type {string}
* @memberof SoSMessageSubscriptionEntityBase
*/
propertyId: string;
/**
* Entity type for subscription (property, transaction, unit, inspection, etc.)
* @type {SoSMessageEntityEntityType}
* @memberof SoSMessageSubscriptionEntityBase
*/
entityType: SoSMessageEntityEntityType;
/**
* Entity ID for subscription (property ID for property subscriptions, entity ID for others)
* @type {string}
* @memberof SoSMessageSubscriptionEntityBase
*/
entityId: string;
/**
* Organization ID for access control and data scoping
* @type {number}
* @memberof SoSMessageSubscriptionEntityBase
*/
organizationId: number;
/**
* When the subscription was created
* @type {Date}
* @memberof SoSMessageSubscriptionEntityBase
*/
createdAt: string;
}
/**
* Check if a given object implements the SoSMessageSubscriptionEntityBase interface.
*/
export declare function instanceOfSoSMessageSubscriptionEntityBase(value: object): value is SoSMessageSubscriptionEntityBase;
export declare function SoSMessageSubscriptionEntityBaseFromJSON(json: any): SoSMessageSubscriptionEntityBase;
export declare function SoSMessageSubscriptionEntityBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSMessageSubscriptionEntityBase;
export declare function SoSMessageSubscriptionEntityBaseToJSON(json: any): SoSMessageSubscriptionEntityBase;
export declare function SoSMessageSubscriptionEntityBaseToJSONTyped(value?: SoSMessageSubscriptionEntityBase | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSMessageSubscriptionEntityBase.d.ts.map