samls-js-integration 1.0.31

package/LICENSE

@@ -0,0 +1 @@
+# Copyright (c) 2023-present

package/README.md

@@ -0,0 +1 @@
+# SAMLS-NODEJS-Integration

package/lib/clients/ListingClient.ts

@@ -0,0 +1,19 @@
+import { http } from '../globals/HttpModule';
+import {
+  ListingModel,
+  GetByMlsIdRequestModel,
+  GetListingsByFilterRequestModel,
+} from '../models';
+import { Pagination, IApiResponse } from '../globals/interfaces';
+
+export class ListingClient {
+  GetListingsByFilter(
+    model: GetListingsByFilterRequestModel,
+  ): Promise<IApiResponse<Pagination<ListingModel>>> {
+    return http.post('/api/Listing/filter', model);
+  }
+
+  GetByMlsId(model: GetByMlsIdRequestModel) {
+    return http.post('/api/Listing/mlsId', model);
+  }
+}

package/lib/clients/MlsClient.ts

@@ -0,0 +1,13 @@
+import { http } from '../globals/HttpModule';
+import { MlsInfoModel } from '../models';
+import { IApiResponse } from '../globals/interfaces';
+
+export class MlsClient {
+  GetMlsInfos(): Promise<IApiResponse<MlsInfoModel[]>> {
+    return http.get('/api/Mls');
+  }
+
+  GetMlsInfoById(id: number): Promise<IApiResponse<MlsInfoModel>> {
+    return http.get(`/api/Mls/${id}`);
+  }
+}

package/lib/clients/index.ts

@@ -0,0 +1,2 @@
+export * from './MlsClient';
+export * from './ListingClient';

package/lib/globals/HttpModule.ts

@@ -0,0 +1,7 @@
+import axios, { AxiosRequestConfig } from 'axios';
+
+const requestConfig: AxiosRequestConfig = {
+  baseURL: 'https://samls-providerapi.purlin.vision/',
+};
+
+export const http = axios.create(requestConfig);

package/lib/globals/interfaces/IApiResponse.ts

@@ -0,0 +1,5 @@
+export interface IApiResponse<T> {
+  data: T;
+  statusCode: number;
+  message: string;
+}

package/lib/globals/interfaces/IPagination.ts

@@ -0,0 +1,4 @@
+export interface Pagination<T> {
+  Data: T[];
+  TotalCount: number;
+}

package/lib/globals/interfaces/index.ts

@@ -0,0 +1,2 @@
+export * from './IPagination';
+export * from './IApiResponse';

package/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './services/SamlsClient';
+export * from './models';

package/lib/models/Address/AddressDetailModel.ts

@@ -0,0 +1,40 @@
+import { StreetDirectionEnum, StreetSuffixEnum } from "../Enums";
+
+export class AddressDetailModel {
+  CoreListingId: number = 0;
+  City: string = "";
+  Country: string = "";
+  County: string = "";
+  CrossStreet: string = "";
+  Directions: string = "";
+  ElementarySchool: string = "";
+  ElementarySchoolDistrict: string = "";
+  FullAddress: string = "";
+  HighSchool: string = "";
+  HighSchoolDistrict: string = "";
+  Latitude: number | null = null;
+  LocationDescription: string = "";
+  Longitude: number | null = null;
+  MiddleOrJuniorSchool: string = "";
+  MiddleOrJuniorSchoolDistrict: string = "";
+  Neighborhood: string = "";
+  PostalCode: string = "";
+  SeniorCommunityYN: boolean | null = null;
+  StateOrProvince: string = "";
+  StreetDirPrefix: StreetDirectionEnum | null = null;
+  StreetDirSuffix: StreetDirectionEnum | null = null;
+  StreetName: string = "";
+  StreetNumber: string = "";
+  StreetSuffix: StreetSuffixEnum | null = null;
+  SubDivision: string = "";
+  UnitNumber: string = "";
+  WaterBodyName: string = "";
+  WaterfrontProximity: string = "";
+  WaterfrontYN: boolean | null = null;
+  Zoning: string = "";
+
+  SamlsFullAddress: string = "";
+  SamlsPartialAddress: string = "";
+
+  PolygonCollection: number[] = [];
+}

package/lib/models/Address/AddressQueryModel.ts

@@ -0,0 +1,5 @@
+import { GlobalQueryModel } from "../Common";
+
+export class AddressQueryModel extends GlobalQueryModel {
+  fullAddress: string | undefined;
+}

package/lib/models/Address/index.ts

@@ -0,0 +1,2 @@
+export * from './AddressQueryModel';
+export * from './AddressDetailModel';

package/lib/models/Agent/AgentInfoModel.ts

@@ -0,0 +1,28 @@
+import { MLSEnum } from "../Enums";
+
+export class AgentInfoModel {
+  agentId: number = 0;
+  agentAOR: string = '';
+  agentDesignation: string = '';
+  agentDirectPhone: string = '';
+  agentEmail: string = '';
+  agentFirstName: string = '';
+  agentFullName: string = '';
+  agentHomePhone: string = '';
+  agentKey: string = '';
+  agentLastName: string = '';
+  agentLicenseNumber: string = '';
+  agentMiddleName: string = '';
+  agentMls: MLSEnum | null = null;
+  agentMlsId: string = '';
+  agentMobilePhone: string = '';
+  agentNamePrefix: string = '';
+  agentNameSuffix: string = '';
+  agentOfficePhone: string = '';
+  agentOfficePhoneExt: string = '';
+  agentPreferredPhone: string = '';
+  agentStateLicense: string = '';
+  agentUrl: string = '';
+  teamKey: string = '';
+  teamName: string = '';
+}

package/lib/models/Agent/AgentModel.ts

@@ -0,0 +1,8 @@
+import { AgentInfoModel } from './AgentInfoModel';
+import { AgentTypeEnum } from '../Enums';
+import { OfficeModel } from './OfficeModel';
+
+export class AgentModel extends AgentInfoModel {
+  agentTypeId: AgentTypeEnum | null = null;
+  office: OfficeModel | null = null;
+}

package/lib/models/Agent/GetAgentRequestModel.ts

@@ -0,0 +1,8 @@
+import { MLSEnum } from '../Enums';
+
+class GetAgentRequestModel {
+  agentMlsId: string = '';
+  mlsId: MLSEnum | null = null;
+}
+
+export { GetAgentRequestModel };

package/lib/models/Agent/GetAgentsRequestModel.ts

@@ -0,0 +1,9 @@
+import { MLSEnum } from '../Enums';
+import { PaginationOptions } from '../Common';
+
+export class GetAgentsRequestModel extends PaginationOptions {
+  email: string = '';
+  lastName: string = '';
+  firstName: string = '';
+  mlsId: MLSEnum | null = null;
+}

package/lib/models/Agent/OfficeModel.ts

@@ -0,0 +1,20 @@
+import { MLSEnum } from '../Enums';
+
+export class OfficeModel {
+  officeKey: string = '';
+  officeAOR: string = '';
+  officeCity: string = '';
+  officeEmail: string = '';
+  officeLocation: string = '';
+  officeMls: MLSEnum | null = null;
+  officeMlsId: string = '';
+  officeName: string = '';
+  officeNeighborhood: string = '';
+  officePhone: string = '';
+  officePhoneExt: string = '';
+  officeState: string = '';
+  officeStreetName: string = '';
+  officeStreetNumber: string = '';
+  officeURL: string = '';
+  officeZip: string = '';
+}

package/lib/models/Agent/index.ts

@@ -0,0 +1,5 @@
+export * from './AgentInfoModel';
+export * from './AgentModel';
+export * from './GetAgentRequestModel';
+export * from './GetAgentsRequestModel';
+export * from './OfficeModel';

package/lib/models/Common/GlobalQueryModel.ts

@@ -0,0 +1,2 @@
+//TODO
+export class GlobalQueryModel /*extends Query*/ {}

package/lib/models/Common/LocationModel.ts

@@ -0,0 +1,4 @@
+export class LocationModel {
+  Latitude: number = 0;
+  Longitude: number = 0;
+}

package/lib/models/Common/PaginationOptions.ts

@@ -0,0 +1,4 @@
+export class PaginationOptions {
+  Page: number = 0;
+  Count: number = 0;
+}

package/lib/models/Common/Point.ts

@@ -0,0 +1,10 @@
+//TODO custom field
+export class Point {
+  private latitude: number;
+  private longitude: number;
+
+  constructor(latitude: number, longitude: number) {
+    this.latitude = latitude;
+    this.longitude = longitude;
+  }
+}

package/lib/models/Common/index.ts

@@ -0,0 +1,4 @@
+export * from './Point';
+export * from './GlobalQueryModel';
+export * from './LocationModel';
+export * from './PaginationOptions';

package/lib/models/Entities/AddressDetail.ts

@@ -0,0 +1,46 @@
+import { Point } from '../Common';
+import { StreetDirectionEnum, StreetSuffixEnum } from '../Enums';
+import { AddressPolygon } from './AddressPolygon';
+import { Listing } from './Listing';
+
+export class AddressDetail {
+  CoreListingId: number = 0;
+  City: string = '';
+  Country: string = '';
+  County: string = '';
+  CrossStreet: string = '';
+  Directions: string = '';
+  ElementarySchool: string = '';
+  ElementarySchoolDistrict: string = '';
+  FullAddress: string = '';
+  HighSchool: string = '';
+  HighSchoolDistrict: string = '';
+  Latitude: number | null = null;
+  LocationDescription: string = '';
+  Longitude: number | null = null;
+  MiddleOrJuniorSchool: string = '';
+  MiddleOrJuniorSchoolDistrict: string = '';
+  Neighborhood: string = '';
+  PostalCode: string = '';
+  SeniorCommunityYN: boolean | null = null;
+  StateOrProvince: string = '';
+  StreetDirPrefix: StreetDirectionEnum | null = null;
+  StreetDirSuffix: StreetDirectionEnum | null = null;
+  StreetName: string = '';
+  StreetNumber: string = '';
+  StreetSuffix: StreetSuffixEnum | null = null;
+  SubDivision: string = '';
+  UnitNumber: string = '';
+  WaterBodyName: string = '';
+  WaterfrontProximity: string = '';
+  WaterfrontYN: boolean | null = null;
+  Zoning: string = '';
+
+  Coordinate: Point = new Point(0, 0);
+
+  SamlsFullAddress: string = '';
+  SamlsPartialAddress: string = '';
+
+  AddressPolygons: AddressPolygon[] = [];
+  CoreListing: Listing = new Listing();
+}

package/lib/models/Entities/AddressPolygon.ts

@@ -0,0 +1,11 @@
+import { AddressDetail } from './AddressDetail';
+import { Polygon } from './Polygon';
+
+export class AddressPolygon {
+  id: number = 0;
+  addressId: number = 0;
+  polygonId: number = 0;
+  createDate: Date | null = null;
+  polygon: Polygon | null = null;
+  address: AddressDetail | null = null;
+}

package/lib/models/Entities/Entity.ts

@@ -0,0 +1,11 @@
+export class Entity<T> {
+  id: T;
+  createDate: Date;
+  updateDate: Date | null;
+
+  constructor(id: T, createDate: Date, updateDate: Date | null) {
+    this.id = id;
+    this.createDate = createDate;
+    this.updateDate = updateDate;
+  }
+}

package/lib/models/Entities/Listing.ts

@@ -0,0 +1,87 @@
+import {
+  CurrencyEnum,
+  ListingStatusEnum,
+  ListingTypeEnum,
+  OwnershipTypeEnum,
+} from '../Enums';
+import { ListingSchool } from './ListingSchool';
+import { ListingOpenHouse } from './ListingOpenHouse';
+import { Property } from './Property';
+import { AddressDetail } from './AddressDetail';
+
+//TODO need to revisit
+export class Listing {
+  availabilityDate?: Date | null;
+  buyerAgencyCompensation?: number | null;
+  buyerFinancing?: string;
+  closePrice?: number | null;
+  closeTimestamp?: Date | null;
+  cumulativeDaysOnMarket?: number | null;
+  currency?: CurrencyEnum;
+  daysOnMarket?: number | null;
+  disclosures?: string;
+  expirationDate?: Date | null;
+  internetAddressDisplayYN?: boolean | null;
+  internetAutomatedValuationDisplayYN?: boolean | null;
+  internetConsumerCommentYN?: boolean | null;
+  internetEntireListingDisplayYN?: boolean | null;
+  lastModificationTimestamp?: Date | null;
+  leaseTerm?: string;
+  listingAgreement?: string;
+  listingEntryTimestamp?: Date | null;
+  listingId?: string;
+  listingService?: string;
+  listingStatus?: ListingStatusEnum;
+  listingTerms?: string;
+  listingType?: ListingTypeEnum;
+  listPrice?: number | null;
+  listPriceOriginal?: number | null;
+  lockBoxLocation?: string;
+  lockBoxSerialNumber?: string;
+  lockBoxType?: string;
+  maxPrice?: number | null;
+  minPrice?: number | null;
+  mlsArea?: string;
+  mlsName?: string;
+  onMarketTimestamp?: Date | null;
+  offMarketTimestamp?: Date | null;
+  originalListingSource?: string;
+  originatingSystemKey?: string;
+  ownerPays?: string;
+  ownershipType?: OwnershipTypeEnum | null;
+  pendingTimestamp?: Date | null;
+  petDeposit?: number | null;
+  petsAllowedYN?: boolean | null;
+  photosChangeTimestamp?: Date | null;
+  photosCount?: number;
+  priceChangeTimestamp?: Date | null;
+  privateRemarks?: string;
+  publicRemarks?: string;
+  purchaseContractDate?: Date | null;
+  showingContactName?: string;
+  showingContactPhone?: string;
+  showingContactPhoneExt?: string;
+  showingContactType?: string;
+  statusChangeTimestamp?: Date | null;
+  taxAnnualAmount?: number | null;
+  taxAssessedValue?: number | null;
+  taxYear?: number | null;
+  tenantPays?: string;
+  virtualTourURLBranded?: string;
+  virtualTourURLUnbranded?: string;
+  withdrawnDate?: Date | null;
+  pricePerSqFeet?: number | null;
+
+  sourceMlsId?: number;
+  sourceUpdateDate?: Date | null;
+  sourcePropertyChangeDate?: Date | null;
+  sourceAddressChangeDate?: Date | null;
+  sourcePhotosChangeDate?: Date | null;
+  sourceAgentsChangeDate?: Date | null;
+  sourceDBId?: number;
+
+  listingSchools?: ListingSchool[];
+  listingOpenHouses?: ListingOpenHouse[];
+  property?: Property;
+  addressDetail?: AddressDetail;
+}

package/lib/models/Entities/ListingOpenHouse.ts

@@ -0,0 +1,26 @@
+import { Listing } from './Listing';
+
+//TODO need to revisit
+export class ListingOpenHouse {
+  key?: string;
+  status?: string;
+  type?: string;
+  modificationTimestamp?: Date | null;
+  startTime?: Date | null;
+  endTime?: Date | null;
+  remarks?: string;
+  refreshmentsOrSnacks?: string;
+  attendedBy?: string;
+  appointmentRequiredYN?: boolean | null;
+  liveStreamUri?: string;
+  liveStreamDescription?: string;
+  liveStreamStart?: Date | null;
+  liveStreamEnd?: Date | null;
+  showingAgentMlsId?: string;
+  showingAgentFirstName?: string;
+  showingAgentLastName?: string;
+  showingAgentKey?: string;
+  hash?: string;
+  coreListingId?: number;
+  listing?: Listing;
+}

package/lib/models/Entities/ListingSchool.ts

@@ -0,0 +1,10 @@
+import { Listing } from './Listing';
+import { School } from './School';
+
+export class ListingSchool {
+  schoolId: number = 0;
+  coreListingId: number = 0;
+  school: School | null = null;
+  distance: number | null = null;
+  listing: Listing | null = null;
+}

package/lib/models/Entities/Polygon.ts

@@ -0,0 +1,23 @@
+// import { Geometry } from "ol/geom"; //TODO
+import { GeometryTypeEnum } from '../Enums';
+import { AddressPolygon } from './AddressPolygon';
+
+type Geometry = any;
+//TODO need to revisit
+export class Polygon {
+  // id: number;
+  // name: string;
+  // shortName: string;
+  // type: GeometryTypeEnum;
+  // geometry: Geometry;
+  // urlKey: string;
+  // weight: number;
+  // fipsCode: string;
+  // state: string;
+  // stateId?: number | null;
+  // city: string;
+  // cityId?: number | null;
+  // county: string;
+  // neighborhood: string;
+  // addressPolygons: AddressPolygon[];
+}

package/lib/models/Entities/Property.ts

@@ -0,0 +1,60 @@
+import {
+  PropertyLevelEnum,
+  DirectionFacesEnum,
+  PropertyConditionEnum,
+  PhysicalPropertyTypeEnum,
+  AssociationFeeFrequencyEnum,
+} from '../Enums';
+import { Listing } from './Listing';
+import { PropertyFeature } from './PropertyFeature';
+
+//TODO need to revisit
+export class Property {
+  // coreListingId: number;
+  // associationFee?: number | null;
+  // associationFeeFrequency?: AssociationFeeFrequencyEnum | null;
+  // associationFeeIncludes: string;
+  // associationName: string;
+  // associationPhone: string;
+  // basementDetails: string;
+  // basementYN?: boolean | null;
+  // bathroomsFull?: number | null;
+  // bathroomsHalf?: number | null;
+  // bathroomsOneQuarter?: number | null;
+  // bathroomsPartial?: number | null;
+  // bathroomsThreeQuarter?: number | null;
+  // bathroomsTotal?: number | null;
+  // bedroomsTotal?: number | null;
+  // builderModel: string;
+  // builderName: string;
+  // buildingName: string;
+  // directionFaces?: DirectionFacesEnum | null;
+  // entryLevel?: number | null;
+  // farmYN?: boolean | null;
+  // fireplacesTotal?: number | null;
+  // garageInBuildingYN?: boolean | null;
+  // garageSpaces?: number | null;
+  // levels?: PropertyLevelEnum | null;
+  // livingAreaSquareFeet?: number | null;
+  // livingAreaSquareMeters?: number | null;
+  // lotDescription: string;
+  // lotSizeAcres?: number | null;
+  // lotSizeDimensions: string;
+  // lotSizeSquareFeet?: number | null;
+  // newConstructionYN?: boolean | null;
+  // numberOfUnits?: number | null;
+  // parcelNumber: string;
+  // parkingTotal?: number | null;
+  // physicalPropertyType: PhysicalPropertyTypeEnum;
+  // poolPrivateYN?: boolean | null;
+  // propertyCondition?: PropertyConditionEnum | null;
+  // roofCondition: string;
+  // roomsTotal?: number | null;
+  // stories?: number | null;
+  // universalPropertyId: string;
+  // yearBuilt?: number | null;
+  // styleId?: number | null;
+  //
+  // propertyFeatures: PropertyFeature[];
+  // coreListing: Listing;
+}

package/lib/models/Entities/PropertyFeature.ts

@@ -0,0 +1,13 @@
+import { FeatureSourceEnum } from '../Enums';
+import { Property } from './Property';
+
+//TODO need to revisit
+export class PropertyFeature {
+  // id: number;
+  // featureId: number;
+  // sourceId: FeatureSourceEnum;
+  // order: string;
+  // propertyId: number;
+  //
+  // property: Property;
+}

package/lib/models/Entities/School.ts

@@ -0,0 +1,19 @@
+import { ListingSchool } from './ListingSchool';
+
+//TODO need to revisit
+export class School {
+  // schoolId: string;
+  // enhancerSchoolId: number;
+  // url: string;
+  // name: string;
+  // lowGrade: string;
+  // highGrade: string;
+  // level: number | null;
+  // lat: number | null;
+  // lng: number | null;
+  // state: string;
+  // isPrivate: boolean;
+  // score: number | null;
+  //
+  // schoolListings: ListingSchool[];
+}

package/lib/models/Entities/index.ts

@@ -0,0 +1,10 @@
+export * from './AddressDetail';
+export * from './AddressPolygon';
+export * from './Entity';
+export * from './Listing';
+export * from './ListingOpenHouse';
+export * from './ListingSchool';
+export * from './Polygon';
+export * from './Property';
+export * from './PropertyFeature';
+export * from './School';

package/lib/models/Enums/AgentTypeEnum.ts

@@ -0,0 +1,7 @@
+export enum AgentTypeEnum
+{
+    ListAgent = 1,
+    CoListAgent,
+    BuyerAgent,
+    CoBuyerAgent
+}

package/lib/models/Enums/AssociationFeeFrequencyEnum.ts

@@ -0,0 +1,13 @@
+export enum AssociationFeeFrequencyEnum {
+  NotMapped = -1,
+  Annually = 1,
+  Quarterly,
+  Semiannually,
+  Bimonthly,
+  Monthly,
+  Semimonthly,
+  Weekly,
+  Daily,
+  OneTime,
+  SeeRemarks,
+}

package/lib/models/Enums/AuthenticationTypeEnum.ts

@@ -0,0 +1,6 @@
+export enum AuthenticationTypeEnum {
+  None = 0,
+  AccessTokenParameter,
+  AccessTokenHeader,
+  ClientCredentials,
+}

package/lib/models/Enums/CurrencyEnum.ts

@@ -0,0 +1,5 @@
+export enum CurrencyEnum {
+  NotMapped = -1,
+  Other,
+  USD,
+}

package/lib/models/Enums/DirectionFacesEnum.ts

@@ -0,0 +1,11 @@
+export enum DirectionFacesEnum {
+  NotMapped = -1,
+  North = 1,
+  NorthEast,
+  East,
+  SouthEast,
+  South,
+  SouthWest,
+  West,
+  NorthWest,
+}

package/lib/models/Enums/FeatureSourceEnum.ts

@@ -0,0 +1,15 @@
+export enum FeatureSourceEnum {
+  MLS = 1,
+  ImageProcessing = 2,
+  NLP = 4,
+}
+
+// Helper function to check if a combination of flags is set
+export function hasFlag(enumValue: number, flag: FeatureSourceEnum): boolean {
+  return (enumValue & flag) === flag;
+}
+
+// // Usage example
+// const value: FeatureSourceEnum = FeatureSourceEnum.MLS | FeatureSourceEnum.NLP;
+// console.log(hasFlag(value, FeatureSourceEnum.MLS)); // true
+// console.log(hasFlag(value, FeatureSourceEnum.ImageProcessing)); // false

package/lib/models/Enums/GeometryTypeEnum.ts

@@ -0,0 +1,10 @@
+export enum GeometryTypeEnum {
+  Zip = 1,
+  Neighborhood,
+  City,
+  County,
+  State,
+  School,
+  SubNeighborhood,
+  SubDivision,
+}