@simplyhomes/sos-sdk
Version:
TypeScript SDK for Simply Homes SoS API v4
127 lines • 4.38 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 { SoSViewEntityDataSort } from './SoSViewEntityDataSort';
import type { SoSViewEntityDataRelation } from './SoSViewEntityDataRelation';
import type { SoSViewEntityDataColumn } from './SoSViewEntityDataColumn';
import type { SoSViewEntityDataFilter } from './SoSViewEntityDataFilter';
/**
*
* @export
* @interface SoSViewEntityData
*/
export interface SoSViewEntityData {
/**
*
* @type {string}
* @memberof SoSViewEntityData
*/
objectName: SoSViewEntityDataObjectName;
/**
*
* @type {Array<SoSViewEntityDataColumn>}
* @memberof SoSViewEntityData
*/
columns?: Array<SoSViewEntityDataColumn>;
/**
*
* @type {Array<SoSViewEntityDataFilter>}
* @memberof SoSViewEntityData
*/
filters?: Array<SoSViewEntityDataFilter>;
/**
*
* @type {Array<SoSViewEntityDataSort>}
* @memberof SoSViewEntityData
*/
sorts?: Array<SoSViewEntityDataSort>;
/**
*
* @type {Array<SoSViewEntityDataRelation>}
* @memberof SoSViewEntityData
*/
relations?: Array<SoSViewEntityDataRelation>;
}
/**
* @export
* @enum {string}
*/
export declare enum SoSViewEntityDataObjectName {
Property = "property",
Unit = "unit",
Source = "source",
Organization = "organization",
Contact = "contact",
County = "county",
HousingAuthority = "housing_authority",
Lender = "lender",
Neighborhood = "neighborhood",
Notification = "notification",
Owner = "owner",
PropertyManager = "property_manager",
Option = "option",
Thread = "thread",
Lead = "lead",
Offer = "offer",
User = "user",
Group = "group",
Market = "market",
Message = "message",
MessageSubscription = "message_subscription",
TitleCompany = "title_company",
View = "view",
FileUpload = "file_upload",
ImageUpload = "image_upload",
PaymentStandard = "payment_standard",
InsurancePolicy = "insurance_policy",
InsuranceProvider = "insurance_provider",
Leasing = "leasing",
Tenant = "tenant",
Inspection = "inspection",
UtilityAllowance = "utility_allowance",
Walkthrough = "walkthrough",
Zipcode = "zipcode",
MlsListing = "mls_listing",
Transaction = "transaction",
AirtableComment = "airtableComment",
AirtableCommentNotification = "airtableCommentNotification",
AirtableCommentSubscription = "airtableCommentSubscription",
RelationContactProperty = "relation_contact_property",
RelationContactSource = "relation_contact_source",
RelationGroupUser = "relation_group_user",
RelationLeadUser = "relation_lead_user",
RelationMarketOwner = "relation_market_owner",
RelationMarketTitleCompany = "relation_market_title_company",
RelationOfferProperty = "relation_offer_property",
RelationUserThread = "relation_user_thread",
RelationSourceProperty = "relation_source_property",
RelationLeadProperty = "relation_lead_property",
RelationInspectionUser = "relation_inspection_user",
RelationLeasingUser = "relation_leasing_user",
Renovation = "renovation",
RelationRenovationUser = "relation_renovation_user",
RentalListing = "rental_listing",
RelationRentalListingUser = "relation_rental_listing_user",
Update = "update",
WorkOrder = "work_order",
Contractor = "contractor",
RelationWorkOrderContractor = "relation_work_order_contractor",
RelationLeasingTenant = "relation_leasing_tenant"
}
/**
* Check if a given object implements the SoSViewEntityData interface.
*/
export declare function instanceOfSoSViewEntityData(value: object): value is SoSViewEntityData;
export declare function SoSViewEntityDataFromJSON(json: any): SoSViewEntityData;
export declare function SoSViewEntityDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SoSViewEntityData;
export declare function SoSViewEntityDataToJSON(json: any): SoSViewEntityData;
export declare function SoSViewEntityDataToJSONTyped(value?: SoSViewEntityData | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=SoSViewEntityData.d.ts.map