UNPKG

@simplyhomes/sos-sdk

Version:

TypeScript SDK for Simply Homes SoS API v4

454 lines 17.9 kB
/** * 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 { SoSContactEntityBase } from './SoSContactEntityBase'; import type { SoSRelContactPropertyEntityBase } from './SoSRelContactPropertyEntityBase'; import type { SoSRelGroupUserEntityBase } from './SoSRelGroupUserEntityBase'; import type { SoSRelOrganizationZipcodeEntityBase } from './SoSRelOrganizationZipcodeEntityBase'; import type { SoSRelMarketOwnerEntityBase } from './SoSRelMarketOwnerEntityBase'; import type { SoSInsurancePolicyEntityBase } from './SoSInsurancePolicyEntityBase'; import type { SoSPropertyManagerEntityBase } from './SoSPropertyManagerEntityBase'; import type { SoSLeadEntityBase } from './SoSLeadEntityBase'; import type { SoSPropertyEntityBase } from './SoSPropertyEntityBase'; import type { SoSGroupEntityBase } from './SoSGroupEntityBase'; import type { SoSMlsListingEntityBase } from './SoSMlsListingEntityBase'; import type { SoSImageUploadEntityBase } from './SoSImageUploadEntityBase'; import type { SoSTitleCompanyEntityBase } from './SoSTitleCompanyEntityBase'; import type { SoSMarketEntityBase } from './SoSMarketEntityBase'; import type { SoSOfferEntityBase } from './SoSOfferEntityBase'; import type { SoSOptionEntityBase } from './SoSOptionEntityBase'; import type { SoSRelLeasingUserEntityBase } from './SoSRelLeasingUserEntityBase'; import type { SoSRelRentalListingUserEntityBase } from './SoSRelRentalListingUserEntityBase'; import type { SoSAirtableCommentNotificationEntityBase } from './SoSAirtableCommentNotificationEntityBase'; import type { SoSZipcodeEntityBase } from './SoSZipcodeEntityBase'; import type { SoSRelRenovationUserEntityBase } from './SoSRelRenovationUserEntityBase'; import type { SoSContractorEntityBase } from './SoSContractorEntityBase'; import type { SoSNotificationEntityBase } from './SoSNotificationEntityBase'; import type { SoSRelSourcePropertyEntityBase } from './SoSRelSourcePropertyEntityBase'; import type { SoSCountyEntityBase } from './SoSCountyEntityBase'; import type { SoSCommentEntityBase } from './SoSCommentEntityBase'; import type { SoSOwnerEntityBase } from './SoSOwnerEntityBase'; import type { SoSDataAuditEntityBase } from './SoSDataAuditEntityBase'; import type { SoSSchoolzoneEntityBase } from './SoSSchoolzoneEntityBase'; import type { SoSSourceEntityBase } from './SoSSourceEntityBase'; import type { SoSRenovationEntityBase } from './SoSRenovationEntityBase'; import type { SoSRelUserThreadEntityBase } from './SoSRelUserThreadEntityBase'; import type { SoSHousingAuthorityEntityBase } from './SoSHousingAuthorityEntityBase'; import type { SoSAirtableCommentSubscriptionEntityBase } from './SoSAirtableCommentSubscriptionEntityBase'; import type { SoSRelOfferPropertyEntityBase } from './SoSRelOfferPropertyEntityBase'; import type { SoSRentalListingEntityBase } from './SoSRentalListingEntityBase'; import type { SoSTenantEntityBase } from './SoSTenantEntityBase'; import type { SoSAssetManagerEntityBase } from './SoSAssetManagerEntityBase'; import type { SoSUtilitiesAllowanceEntityBase } from './SoSUtilitiesAllowanceEntityBase'; import type { SoSRelLeasingTenantEntityBase } from './SoSRelLeasingTenantEntityBase'; import type { SoSRelInspectionUserEntityBase } from './SoSRelInspectionUserEntityBase'; import type { SoSNeighborhoodEntityBase } from './SoSNeighborhoodEntityBase'; import type { SoSThreadEntityBase } from './SoSThreadEntityBase'; import type { SoSInsuranceProviderEntityBase } from './SoSInsuranceProviderEntityBase'; import type { SoSRelLeadUserEntityBase } from './SoSRelLeadUserEntityBase'; import type { SoSUnitEntityBase } from './SoSUnitEntityBase'; import type { SoSLeasingEntityBase } from './SoSLeasingEntityBase'; import type { SoSInspectionEntityBase } from './SoSInspectionEntityBase'; import type { SoSViewEntityBase } from './SoSViewEntityBase'; import type { SoSRelMarketTitleCompanyEntityBase } from './SoSRelMarketTitleCompanyEntityBase'; import type { SoSWalkthroughEntityBase } from './SoSWalkthroughEntityBase'; import type { SoSRelWorkOrderContractorEntityBase } from './SoSRelWorkOrderContractorEntityBase'; import type { SoSUserEntityBase } from './SoSUserEntityBase'; import type { SoSAirtableCommentEntityBase } from './SoSAirtableCommentEntityBase'; import type { SoSOrganizationEntityBase } from './SoSOrganizationEntityBase'; import type { SoSRelLeadPropertyEntityBase } from './SoSRelLeadPropertyEntityBase'; import type { SoSLenderEntityBase } from './SoSLenderEntityBase'; import type { SoSPaymentStandardEntityBase } from './SoSPaymentStandardEntityBase'; import type { SoSFileUploadEntityBase } from './SoSFileUploadEntityBase'; import type { SoSRelContactSourceEntityBase } from './SoSRelContactSourceEntityBase'; import type { SoSWorkOrderEntityBase } from './SoSWorkOrderEntityBase'; /** * * @export * @interface V4EntitiesGetEntitiesSchemaResponseDto */ export interface V4EntitiesGetEntitiesSchemaResponseDto { /** * Airtable Comment entity schema * @type {SoSAirtableCommentEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ airtableComment: SoSAirtableCommentEntityBase; /** * Airtable Comment Notification entity schema * @type {SoSAirtableCommentNotificationEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ airtableCommentNotification: SoSAirtableCommentNotificationEntityBase; /** * Airtable Comment Subscription entity schema * @type {SoSAirtableCommentSubscriptionEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ airtableCommentSubscription: SoSAirtableCommentSubscriptionEntityBase; /** * Asset Manager entity schema * @type {SoSAssetManagerEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ assetManager: SoSAssetManagerEntityBase; /** * Comment entity schema * @type {SoSCommentEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ comment: SoSCommentEntityBase; /** * Contact entity schema * @type {SoSContactEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ contact: SoSContactEntityBase; /** * County entity schema * @type {SoSCountyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ county: SoSCountyEntityBase; /** * Data Audit entity schema * @type {SoSDataAuditEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ dataAudit: SoSDataAuditEntityBase; /** * File Upload entity schema * @type {SoSFileUploadEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ fileUpload: SoSFileUploadEntityBase; /** * Group entity schema * @type {SoSGroupEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ group: SoSGroupEntityBase; /** * Housing Authority entity schema * @type {SoSHousingAuthorityEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ housingAuthority: SoSHousingAuthorityEntityBase; /** * Image Upload entity schema * @type {SoSImageUploadEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ imageUpload: SoSImageUploadEntityBase; /** * Inspection entity schema * @type {SoSInspectionEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ inspection: SoSInspectionEntityBase; /** * Renovation entity schema * @type {SoSRenovationEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ renovation: SoSRenovationEntityBase; /** * Rental Listing entity schema * @type {SoSRentalListingEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ rentalListing: SoSRentalListingEntityBase; /** * Work Order entity schema * @type {SoSWorkOrderEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ workOrder: SoSWorkOrderEntityBase; /** * Contractor entity schema * @type {SoSContractorEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ contractor: SoSContractorEntityBase; /** * Insurance Policy entity schema * @type {SoSInsurancePolicyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ insurancePolicy: SoSInsurancePolicyEntityBase; /** * Insurance Provider entity schema * @type {SoSInsuranceProviderEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ insuranceProvider: SoSInsuranceProviderEntityBase; /** * Lead entity schema * @type {SoSLeadEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ lead: SoSLeadEntityBase; /** * Leasing entity schema * @type {SoSLeasingEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ leasing: SoSLeasingEntityBase; /** * Lender entity schema * @type {SoSLenderEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ lender: SoSLenderEntityBase; /** * Market entity schema * @type {SoSMarketEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ market: SoSMarketEntityBase; /** * MLS Listing entity schema * @type {SoSMlsListingEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ mlsListing: SoSMlsListingEntityBase; /** * Neighborhood entity schema * @type {SoSNeighborhoodEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ neighborhood: SoSNeighborhoodEntityBase; /** * Notification entity schema * @type {SoSNotificationEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ notification: SoSNotificationEntityBase; /** * Offer entity schema * @type {SoSOfferEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ offer: SoSOfferEntityBase; /** * Option entity schema * @type {SoSOptionEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ option: SoSOptionEntityBase; /** * Organization entity schema * @type {SoSOrganizationEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ organization: SoSOrganizationEntityBase; /** * Owner entity schema * @type {SoSOwnerEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ owner: SoSOwnerEntityBase; /** * Payment Standard entity schema * @type {SoSPaymentStandardEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ paymentStandard: SoSPaymentStandardEntityBase; /** * Property entity schema * @type {SoSPropertyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ property: SoSPropertyEntityBase; /** * Property Manager entity schema * @type {SoSPropertyManagerEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ propertyManager: SoSPropertyManagerEntityBase; /** * Schoolzone entity schema * @type {SoSSchoolzoneEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ schoolzone: SoSSchoolzoneEntityBase; /** * Source entity schema * @type {SoSSourceEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ source: SoSSourceEntityBase; /** * Tenant entity schema * @type {SoSTenantEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ tenant: SoSTenantEntityBase; /** * Thread entity schema * @type {SoSThreadEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ thread: SoSThreadEntityBase; /** * Title Company entity schema * @type {SoSTitleCompanyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ titleCompany: SoSTitleCompanyEntityBase; /** * Unit entity schema * @type {SoSUnitEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ unit: SoSUnitEntityBase; /** * User entity schema * @type {SoSUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ user: SoSUserEntityBase; /** * Utilities Allowance entity schema * @type {SoSUtilitiesAllowanceEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ utilitiesAllowance: SoSUtilitiesAllowanceEntityBase; /** * View entity schema * @type {SoSViewEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ view: SoSViewEntityBase; /** * Walkthrough entity schema * @type {SoSWalkthroughEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ walkthrough: SoSWalkthroughEntityBase; /** * Zipcode entity schema * @type {SoSZipcodeEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ zipcode: SoSZipcodeEntityBase; /** * Contact Property Relation entity schema * @type {SoSRelContactPropertyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relContactProperty: SoSRelContactPropertyEntityBase; /** * Contact Source Relation entity schema * @type {SoSRelContactSourceEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relContactSource: SoSRelContactSourceEntityBase; /** * Group User Relation entity schema * @type {SoSRelGroupUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relGroupUser: SoSRelGroupUserEntityBase; /** * Inspection User Relation entity schema * @type {SoSRelInspectionUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relInspectionUser: SoSRelInspectionUserEntityBase; /** * Renovation User Relation entity schema * @type {SoSRelRenovationUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relRenovationUser: SoSRelRenovationUserEntityBase; /** * Rental Listing User Relation entity schema * @type {SoSRelRentalListingUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relRentalListingUser: SoSRelRentalListingUserEntityBase; /** * Work Order Contractor Relation entity schema * @type {SoSRelWorkOrderContractorEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relWorkOrderContractor: SoSRelWorkOrderContractorEntityBase; /** * Lead Property Relation entity schema * @type {SoSRelLeadPropertyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relLeadProperty: SoSRelLeadPropertyEntityBase; /** * Lead User Relation entity schema * @type {SoSRelLeadUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relLeadUser: SoSRelLeadUserEntityBase; /** * Leasing Tenant Relation entity schema * @type {SoSRelLeasingTenantEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relLeasingTenant: SoSRelLeasingTenantEntityBase; /** * Leasing User Relation entity schema * @type {SoSRelLeasingUserEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relLeasingUser: SoSRelLeasingUserEntityBase; /** * Market Owner Relation entity schema * @type {SoSRelMarketOwnerEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relMarketOwner: SoSRelMarketOwnerEntityBase; /** * Market Title Company Relation entity schema * @type {SoSRelMarketTitleCompanyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relMarketTitleCompany: SoSRelMarketTitleCompanyEntityBase; /** * Offer Property Relation entity schema * @type {SoSRelOfferPropertyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relOfferProperty: SoSRelOfferPropertyEntityBase; /** * Organization Zipcode Relation entity schema * @type {SoSRelOrganizationZipcodeEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relOrganizationZipcode: SoSRelOrganizationZipcodeEntityBase; /** * Source Property Relation entity schema * @type {SoSRelSourcePropertyEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relSourceProperty: SoSRelSourcePropertyEntityBase; /** * User Thread Relation entity schema * @type {SoSRelUserThreadEntityBase} * @memberof V4EntitiesGetEntitiesSchemaResponseDto */ relUserThread: SoSRelUserThreadEntityBase; } /** * Check if a given object implements the V4EntitiesGetEntitiesSchemaResponseDto interface. */ export declare function instanceOfV4EntitiesGetEntitiesSchemaResponseDto(value: object): value is V4EntitiesGetEntitiesSchemaResponseDto; export declare function V4EntitiesGetEntitiesSchemaResponseDtoFromJSON(json: any): V4EntitiesGetEntitiesSchemaResponseDto; export declare function V4EntitiesGetEntitiesSchemaResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): V4EntitiesGetEntitiesSchemaResponseDto; export declare function V4EntitiesGetEntitiesSchemaResponseDtoToJSON(json: any): V4EntitiesGetEntitiesSchemaResponseDto; export declare function V4EntitiesGetEntitiesSchemaResponseDtoToJSONTyped(value?: V4EntitiesGetEntitiesSchemaResponseDto | null, ignoreDiscriminator?: boolean): any; //# sourceMappingURL=V4EntitiesGetEntitiesSchemaResponseDto.d.ts.map