samls-js-integration 1.0.31

package/lib/models/Enums/ListingStatusEnum.ts

@@ -0,0 +1,35 @@
+export enum ListingStatusEnum {
+  NotMapped = -1,
+  Other = 0,
+  Active,
+  ActiveUnderContract,
+  Auction,
+  ComingSoon,
+  Closed,
+  Expired,
+  Withdrawn,
+  Pending,
+  Cancelled,
+  TemporaryOffMarket,
+  Incomplete,
+}
+
+// Extension methods
+function IsActiveListing(status: ListingStatusEnum): boolean {
+  return (
+    status === ListingStatusEnum.Active ||
+    status === ListingStatusEnum.ActiveUnderContract ||
+    status === ListingStatusEnum.Auction ||
+    status === ListingStatusEnum.ComingSoon
+  );
+}
+
+function IsArchiveListing(status: ListingStatusEnum): boolean {
+  return !IsActiveListing(status);
+}
+
+// // Usage example
+// const status: ListingStatusEnum = ListingStatusEnum.Active;
+// console.log(listingStatusDisplayNames[status]); // "Active"
+// console.log(IsActiveListing(status)); // true
+// console.log(IsArchiveListing(status)); // false

package/lib/models/Enums/ListingTypeClassEnum.ts

@@ -0,0 +1,5 @@
+export enum ListingTypeClassEnum {
+  Rental,
+  Residential,
+  Other,
+}

package/lib/models/Enums/ListingTypeEnum.ts

@@ -0,0 +1,20 @@
+export enum ListingTypeEnum {
+  NotMapped = -1,
+  Other,
+  CommercialLease,
+  CommercialSale,
+  FarmSale,
+  FarmLease,
+  LandSale,
+  LandLease,
+  ResidentialSale,
+  ResidentialLease,
+  ResidentialIncome,
+  BoatDockSale,
+  BoatDockLease,
+  BusinessOpportunity,
+}
+
+// // Usage example
+// const typeName: ListingTypeEnum = ListingTypeEnum.ResidentialSale;
+// console.log(listingTypeEnumDisplayNames[typeName]); // "Residential sale"

package/lib/models/Enums/MLSEnum.ts

@@ -0,0 +1,38 @@
+export enum MLSEnum {
+  HAR = 1,
+  ONEKEY,
+  STELLAR,
+  MLSPIN,
+  NABOR,
+  MIAMIRE,
+  REBNY,
+  GLVAR,
+  FTL,
+  ACTRIS,
+  RAIRC,
+  BCS,
+  CTEXAS,
+  CRMLS,
+  RAMC,
+  AGS,
+  PBB,
+  NEFAR,
+  VAIL,
+  MOMLS,
+  SBR,
+  GRW,
+  IRESDS,
+  RECO,
+  SABOR,
+  NTREIS,
+  HCMLS,
+  CLAW,
+  NJMLS,
+  GSMLS,
+  MLSL,
+  SMART,
+  BRIGHT,
+  NCB,
+  OEAST,
+  EELI,
+}

package/lib/models/Enums/OrderByOptions.ts

@@ -0,0 +1,6 @@
+export enum OrderByOptions {
+  ByPrice = 1,
+  ByPricePerSquareFeet = 2,
+  ByNewest = 3,
+  BySize = 4,
+}

package/lib/models/Enums/OwnershipTypeEnum.ts

@@ -0,0 +1,26 @@
+export enum OwnershipTypeEnum {
+  NotMapped = -1,
+  CoOp = 1,
+  CondoMinium, //TODO this was Condominium after convertion
+  Corporation,
+  FeeSimple,
+  Fractional,
+  Franchise,
+  HomeownerAssociation,
+  JointTenancy,
+  Partnership,
+  Private,
+  SoleProprietor,
+  TenancyByEntirety,
+  TenancyInCommon,
+  Timeshare,
+  LimitedPartnership,
+  REO,
+  CorporateRELOOwned,
+  HUDOwned,
+  VAOwned,
+}
+
+// // Usage example
+// const ownershipType: OwnershipTypeEnum = OwnershipTypeEnum.FeeSimple;
+// console.log(ownershipTypeEnumDisplayNames[ownershipType]); // "Fee Simple"

package/lib/models/Enums/PhysicalPropertyClassEnum.ts

@@ -0,0 +1,6 @@
+export enum PhysicalPropertyClassEnum {
+  Residential,
+  NonResidential,
+  Land,
+  Other,
+}

package/lib/models/Enums/PhysicalPropertyTypeEnum.ts

@@ -0,0 +1,55 @@
+export enum PhysicalPropertyTypeEnum {
+  NotMapped = -1,
+  Other = 0,
+  HighRise,
+  Apartment,
+  Attached,
+  CoOp,
+  Condominium,
+  DetachedSingle,
+  Duplex,
+  Fourplex,
+  ManufacturedHome,
+  MixedUse,
+  MobileHome,
+  ModularHome,
+  MultiFamily,
+  Residential,
+  SingleFamily,
+  Timeshare,
+  Townhouse,
+  Triplex,
+  Villa,
+  AgriculturalLand,
+  BoatSlip,
+  Business,
+  Commercial,
+  DeededParking,
+  Farm,
+  HotelMotel,
+  Industrial,
+  Office,
+  Recreation,
+  Restaurant,
+  Retail,
+  SitePlanned,
+  SpecialPurpose,
+  StockCooperative,
+  Warehouse,
+  CommercialLand,
+  ImprovedLand,
+  Land,
+  MultifamilyLot,
+  MultipleParcels,
+  RVLot,
+  SingleFamilyLot,
+  UnimprovedLand,
+  RanchLand,
+  AccessoryApartment,
+  GarageApartment,
+  PUD,
+}
+
+// Usage example
+// const propertyType: PhysicalPropertyTypeEnum = PhysicalPropertyTypeEnum.DetachedSingleFamilyResidence;
+// console.log(physicalPropertyTypeEnumDisplayNames[propertyType]); // "Detached single family residence"

package/lib/models/Enums/PlatformEnum.ts

@@ -0,0 +1,6 @@
+export enum PlatformEnum {
+  None = 0,
+  Bridge,
+  Trestle,
+  Spark,
+}

package/lib/models/Enums/ProcessingStatusEnum.ts

@@ -0,0 +1,8 @@
+export enum ProcessingStatusEnum {
+  Processing = -2, //TODO why some of them are starting from -2
+  NotReady,
+  NotProcessed,
+  Processed,
+  Skipped,
+  Failed,
+}

package/lib/models/Enums/ProcessingTypeEnum.ts

@@ -0,0 +1,5 @@
+export enum ProcessingTypeEnum {
+  ImageProcessing = 1,
+  NLProcessing,
+  GeoProcessing,
+}

package/lib/models/Enums/PropertyConditionEnum.ts

@@ -0,0 +1,21 @@
+export enum PropertyConditionEnum {
+  NotMapped = -1,
+  ToBeBuilt = 1, // Display Name: "To Be Built"
+  UnderConstruction, // Display Name: "Under Construction"
+  Resale, // Display Name: "Resale"
+  NewConstruction, // Display Name: "New Construction"
+  UpdatedOrRemodeled, // Display Name: "Updated or Remodeled"
+  TeardownValueinLand, // Display Name: "Teardown / Value in Land"
+  FixerUpper, // Display Name: "Fixer-upper"
+  Good, // Display Name: "Good"
+  Excellent, // Display Name: "Excellent"
+  VeryGood, // Display Name: "Very Good"
+  Poor, // Display Name: "Poor"
+  Average, // Display Name: "Average"
+  Unknown, // Display Name: "Unknown"
+  SeeRemarks, // Display Name: "See Remarks"
+}
+
+// Usage example
+// const condition: PropertyConditionEnum = PropertyConditionEnum.NewConstruction;
+// console.log(propertyConditionEnumDisplayNames[condition]); // "New Construction"

package/lib/models/Enums/PropertyLevelEnum.ts

@@ -0,0 +1,16 @@
+export enum PropertyLevelEnum {
+  NotMapped = -1,
+  Other,
+  One,
+  Two,
+  OneAndHalf,
+  TwoAndHalf,
+  ThreeOrMore,
+  SplitLevel,
+  SplitEntry,
+  FrontToBackSplit,
+}
+
+// Usage example
+// const level: PropertyLevelEnum = PropertyLevelEnum.Two;
+// console.log(propertyLevelEnumDisplayNames[level]);

package/lib/models/Enums/StreetDirectionEnum.ts

@@ -0,0 +1,15 @@
+export enum StreetDirectionEnum {
+  NotMapped = -1,
+  North = 1,
+  NorthEast,
+  East,
+  SouthEast,
+  South,
+  SouthWest,
+  West,
+  NorthWest,
+}
+
+// Usage example
+// const direction: StreetDirectionEnum = StreetDirectionEnum.East;
+// console.log(streetDirectionEnumDisplayNames[direction]); // "E"

package/lib/models/Enums/StreetSuffixEnum.ts

@@ -0,0 +1,245 @@
+export enum StreetSuffixEnum {
+  NotMapped = -1,
+  Alley = 1,
+  Anex,
+  Arcade,
+  Avenue,
+  Bayou,
+  Beach,
+  Bend,
+  Bluff,
+  Bluffs,
+  Bottom,
+  Boulevard,
+  Branch,
+  Bridge,
+  Brook,
+  Bypass,
+  Camp,
+  Canyon,
+  Cape,
+  Causeway,
+  Center,
+  Circle,
+  Circles,
+  Cliff,
+  Cliffs,
+  Club,
+  Common,
+  Commons,
+  Corner,
+  Corners,
+  Course,
+  Court,
+  Courts,
+  Cove,
+  Coves,
+  Creek,
+  Crescent,
+  Crest,
+  Crossing,
+  Crossroad,
+  Crossroads,
+  Curve,
+  Dale,
+  Dam,
+  Divide,
+  Drive,
+  Drives,
+  Estate,
+  Estates,
+  Expressway,
+  Extension,
+  Fall,
+  Falls,
+  Ferry,
+  Field,
+  Fields,
+  Flat,
+  Flats,
+  Ford,
+  Forest,
+  Forge,
+  Fork,
+  Fort,
+  Freeway,
+  Garden,
+  Gardens,
+  Gateway,
+  Glen,
+  Green,
+  Greens,
+  Grove,
+  Harbor,
+  Haven,
+  Heights,
+  Highway,
+  Hill,
+  Hills,
+  Hollow,
+  Island,
+  Islands,
+  Isle,
+  Junction,
+  Key,
+  Knoll,
+  Knolls,
+  Lake,
+  Lakes,
+  Land,
+  Landing,
+  Lane,
+  Light,
+  Lights,
+  Lock,
+  Lodge,
+  Loop,
+  Mall,
+  Manor,
+  Meadow,
+  Meadows,
+  Mews,
+  Mill,
+  Mills,
+  Mission,
+  Mount,
+  Mountain,
+  Neck,
+  Orchard,
+  Oval,
+  Overpass,
+  Park,
+  Parkway,
+  Pass,
+  Passage,
+  Path,
+  Pike,
+  Pine,
+  Pines,
+  Place,
+  Plain,
+  Plains,
+  Plaza,
+  Point,
+  Port,
+  Prairie,
+  Radial,
+  Ranch,
+  Rapid,
+  Rapids,
+  Rest,
+  Ridge,
+  Ridges,
+  River,
+  Road,
+  Roads,
+  Route,
+  Row,
+  Rue,
+  Run,
+  Shoal,
+  Shore,
+  Shores,
+  Skyway,
+  Spring,
+  Springs,
+  Spur,
+  Square,
+  Station,
+  Stravenue,
+  Stream,
+  Street,
+  Streets,
+  Summit,
+  Terrace,
+  Trace,
+  Track,
+  Trail,
+  Trailer,
+  Turnpike,
+  Valley,
+  Viaduct,
+  View,
+  Views,
+  Village,
+  Villages,
+  Ville,
+  Vista,
+  Walk,
+  Way,
+  Ways,
+  Well,
+  Wells,
+  Brooks,
+  Burg,
+  Burgs,
+  Centers,
+  Extensions,
+  Fords,
+  Forges,
+  Forks,
+  Glens,
+  Groves,
+  Harbors,
+  Inlet,
+  Junctions,
+  Keys,
+  Loaf,
+  Locks,
+  Manors,
+  Motorway,
+  Mountains,
+  Parks,
+  Parkways,
+  Points,
+  Ports,
+  Ramp,
+  Shoals,
+  Spurs,
+  Squares,
+  Throughway,
+  Trafficway,
+  Tunnel,
+  Underpass,
+  Union,
+  Unions,
+  Valleys,
+  Walks,
+  Wall,
+  AveCir,
+  AveCt,
+  AveDr,
+  AveLn,
+  AvePkwy,
+  AvePl,
+  AveRd,
+  AveWay,
+  Bay,
+  Cay,
+  CirCt,
+  CirDr,
+  Crossway,
+  CtRd,
+  DrRd,
+  LnCt,
+  LnRd,
+  PlCt,
+  PlDr,
+  SqDr,
+  StCir,
+  StCt,
+  StDr,
+  StLn,
+  StPl,
+  StRd,
+  Downs,
+  Gate,
+  Prom,
+  Via,
+  Woods,
+  Close,
+  Trails,
+  Mile,
+  Chase,
+  LaneSpur,
+}

package/lib/models/Enums/index.ts

@@ -0,0 +1,23 @@
+//TODO combine all enums in this namespace
+export * from "./AgentTypeEnum";
+export * from "./AssociationFeeFrequencyEnum";
+export * from "./AuthenticationTypeEnum";
+export * from "./CurrencyEnum";
+export * from "./DirectionFacesEnum";
+export * from "./FeatureSourceEnum";
+export * from "./GeometryTypeEnum";
+export * from "./ListingStatusEnum";
+export * from "./ListingTypeClassEnum";
+export * from "./ListingTypeEnum";
+export * from "./MLSEnum";
+export * from "./OrderByOptions";
+export * from "./OwnershipTypeEnum";
+export * from "./PhysicalPropertyTypeEnum";
+export * from "./PhysicalPropertyClassEnum";
+export * from "./PlatformEnum";
+export * from "./ProcessingStatusEnum";
+export * from "./ProcessingTypeEnum";
+export * from "./PropertyConditionEnum";
+export * from "./PropertyLevelEnum";
+export * from "./StreetSuffixEnum";
+export * from "./StreetDirectionEnum";

package/lib/models/Feature/CategoryModel.ts

@@ -0,0 +1,4 @@
+export class CategoryModel {
+  id: number = 0;
+  name: string = '';
+}

package/lib/models/Feature/FeatureModel.ts

@@ -0,0 +1,11 @@
+//Fully Cleaned
+import { CategoryModel } from './CategoryModel';
+import { SubCategoryModel } from './SubCategoryModel';
+
+export class FeatureModel {
+  id: number = 0;
+  name: string = '';
+  weight: number = 0;
+  category: CategoryModel | null = null;
+  subCategory: SubCategoryModel | null = null;
+}

package/lib/models/Feature/SubCategoryModel.ts

@@ -0,0 +1,4 @@
+export class SubCategoryModel {
+  id: number = 0;
+  name: string = '';
+}

package/lib/models/Feature/index.ts

@@ -0,0 +1,3 @@
+export * from './CategoryModel';
+export * from './FeatureModel';
+export * from './SubCategoryModel';

package/lib/models/Listing/ClusteringFilterRequestBaseModel.ts

@@ -0,0 +1,17 @@
+// using NetTopologySuite.Geometries;
+// using Purlin.SAMLS.Integration.Model.Common;
+//
+// namespace Purlin.SAMLS.Integration.Model.Listing;
+//
+// public class ClusteringFilterRequestBaseModel
+// {
+//     public int ZoomLevel { get; set; }
+//
+//     public GlobalQueryModel Query { get; set; } = new ();
+// }
+//
+//
+// public class ClusteringFilterRequestModel : ClusteringFilterRequestBaseModel
+// {
+//     public Geometry Polygon { get; set; }
+// }

package/lib/models/Listing/ClusteringFilterResponseModel.cs

@@ -0,0 +1,29 @@
+using Purlin.SAMLS.Integration.Model.Enums;
+
+namespace Purlin.SAMLS.Integration.Model.Listing;
+
+public class ClusteringFilterResponseModel
+{
+    public int TotalCount { get; set; }
+    public IEnumerable<MarkerInfo> MarkersInfo { get; set; }
+    public IEnumerable<NonClusteredListingsInfo> NonClusteredListingsInfo { get; set; }
+}
+
+public class MarkerInfo
+{
+    public int Count { get; set; }
+    public float Latitude { get; set; }
+    public float Longitude { get; set; }
+}
+
+public class NonClusteredListingsInfo
+{
+    public long Id { get; set; }
+    public float Latitude { get; set; }
+    public float Longitude { get; set; }
+    public double? ListPrice { get; set; }
+    public RentPriceModel RentPrices { get; set; }
+    public ListingStatusEnum ListingStatus { get; set; }
+    public DateTime? ListingEntryTimestamp { get; set; }
+    public OpenHouseLiteModel OpenHouse { get; set; }
+}

package/lib/models/Listing/GetByAddressRequestModel.cs

@@ -0,0 +1,21 @@
+using System.Text.Json.Serialization;
+
+namespace Purlin.SAMLS.Integration.Model.Listing;
+
+public class GetByAddressRequestModel
+{
+    [JsonPropertyName("fullAddress")]
+    public string FullAddress { get; set; }
+
+    [JsonPropertyName("skip")]
+    public int Skip { get; set; } = 0;
+
+    [JsonPropertyName("take")]
+    public int Take { get; set; } = 10;
+
+    [JsonPropertyName("activeStatusGroup")]
+    public bool ActiveStatusGroup { get; set; } = true;
+
+    [JsonPropertyName("fields")]
+    public List<string> Fields { get; set; } = new();
+}

package/lib/models/Listing/GetByAgentRequestModel.cs

@@ -0,0 +1,13 @@
+using Purlin.SAMLS.Integration.Model.Common;
+using Purlin.SAMLS.Integration.Model.Enums;
+
+namespace Purlin.SAMLS.Integration.Model.Listing;
+
+public class GetByAgentRequestModel : PaginationOptions
+{
+    public MLSEnum MlsId { get; set; }
+    public string AgentMlsId { get; set; }
+    public IEnumerable<AgentTypeEnum> AgentTypes { get; set; }
+    public bool ActiveStatusGroup { get; set; } = true;
+    public List<string> Fields { get; set; }
+}

package/lib/models/Listing/GetByIdRequestModel.cs

@@ -0,0 +1,7 @@
+namespace Purlin.SAMLS.Integration.Model.Listing;
+
+public class GetByIdRequestModel
+{
+    public long Id { get; set; }
+    public List<string> Fields { get; set; }
+}

package/lib/models/Listing/GetByMlsIdRequestModel.ts

@@ -0,0 +1,5 @@
+//Fully cleaned
+export class GetByMlsIdRequestModel {
+  MlsId: string = '';
+  Fields: string[] | null = null;
+}

package/lib/models/Listing/GetListingsByFilterRequestModel.ts

@@ -0,0 +1,19 @@
+import { PaginationOptions } from '../Common';
+import {
+  ListingStatusEnum,
+  ListingTypeEnum,
+  OrderByOptions,
+  PhysicalPropertyTypeEnum,
+} from '../Enums';
+
+export class GetListingsByFilterRequestModel extends PaginationOptions {
+  ListingTypes: ListingTypeEnum[] | null = null;
+  OrderBy: OrderByOptions | null = null;
+  NumberOfBedrooms: number | null = null;
+  MinPrice: number | null = null;
+  MaxPrice: number | null = null;
+  ListingStatuses: ListingStatusEnum[] | null = null;
+  PropertyTypes: PhysicalPropertyTypeEnum[] | null = null;
+  PlaceIds: number[] | null = null;
+  Fields: string[] | null = null;
+}