samls-js-integration 1.0.39 → 1.0.41

package/README.md

@@ -1 +1,6 @@
-# Samls-integration
+# Samls-js-integration
+
+The package provides 
+* Core http interface as a service to make calls to samls api with axios library.
+* A bunch of ts Models to work with Samls Data, model files have .model filename suffix to make it possible to use them 
+   easily in libraries supporting OpenApi specification(e.g. @nestjs/swagger).

package/dist/clients/AddressDetail.d.ts

@@ -0,0 +1,5 @@
+import { AddressDetailModel, AddressQueryModel } from '../models';
+import { IApiResponse, IPagination } from '../globals';
+export declare class AddressDetail {
+    getByQuery(queryModel: AddressQueryModel): Promise<IApiResponse<IPagination<AddressDetailModel>>>;
+}

package/dist/clients/AddressDetail.js

@@ -0,0 +1,6 @@
+import { http } from '../globals';
+export class AddressDetail {
+    getByQuery(queryModel) {
+        return http.post(`AddressDetail/query`, queryModel);
+    }
+}

package/dist/clients/ListingsClient.d.ts

@@ -0,0 +1,9 @@
+import { ListingModel, GetByMlsIdRequestModel, GetListingsByFilterRequestModel, GlobalQueryModel, ListingTypeClassEnum, ListingTypeEnum, GetByIdRequestModel } from '../models';
+import { IPagination, IApiResponse } from '../globals';
+export declare class ListingsClient {
+    get(model: GetByIdRequestModel): Promise<IApiResponse<ListingModel>>;
+    getListingsByFilter(model: GetListingsByFilterRequestModel): Promise<IApiResponse<IPagination<ListingModel>>>;
+    getByMlsId(model: GetByMlsIdRequestModel): Promise<IApiResponse<Partial<ListingModel>[]>>;
+    getByQuery(queryModel: GlobalQueryModel): Promise<IApiResponse<IPagination<ListingModel>>>;
+    getListingTypeGroups(): Promise<IApiResponse<Record<keyof typeof ListingTypeClassEnum, (keyof typeof ListingTypeEnum)[]>>>;
+}

package/dist/clients/ListingsClient.js

@@ -0,0 +1,18 @@
+import { http } from '../globals';
+export class ListingsClient {
+    get(model) {
+        return http.post('Listing', model);
+    }
+    getListingsByFilter(model) {
+        return http.post('Listing/filter', model);
+    }
+    getByMlsId(model) {
+        return http.post('Listing/mlsId', model);
+    }
+    getByQuery(queryModel) {
+        return http.post('Listing/query', queryModel);
+    }
+    getListingTypeGroups() {
+        return http.get('Listing/type/groups');
+    }
+}

package/dist/clients/MlsClient.d.ts

@@ -0,0 +1,6 @@
+import { MlsInfoModel } from '../models';
+import { IApiResponse } from '../globals';
+export declare class MlsClient {
+    getMlsInfos(): Promise<IApiResponse<MlsInfoModel[]>>;
+    getMlsInfoById(id: number): Promise<IApiResponse<MlsInfoModel>>;
+}

package/dist/clients/MlsClient.js

@@ -0,0 +1,10 @@
+import { http } from '../globals';
+const PATH_SEGMENT = 'AddressDetail';
+export class MlsClient {
+    getMlsInfos() {
+        return http.get(`${PATH_SEGMENT}/Mls`);
+    }
+    getMlsInfoById(id) {
+        return http.get(`${PATH_SEGMENT}/Mls/${id}`);
+    }
+}

package/dist/clients/PolygonClient.d.ts

@@ -0,0 +1,5 @@
+import { IApiResponse } from '../globals';
+import { PolygonFilterRequestModel, PolygonFilterResponseModel } from '../models';
+export declare class PolygonClient {
+    filter(model: PolygonFilterRequestModel): Promise<IApiResponse<PolygonFilterResponseModel[]>>;
+}

package/dist/clients/PolygonClient.js

@@ -0,0 +1,7 @@
+import { http } from '../globals';
+const PATH_SEGMENT = 'Polygon';
+export class PolygonClient {
+    filter(model) {
+        return http.post(`${PATH_SEGMENT}/filter`, model);
+    }
+}

package/dist/clients/index.js

@@ -0,0 +1,3 @@
+export * from './MlsClient';
+export * from './ListingsClient';
+export * from './AddressDetail';

package/dist/globals/HttpModule.d.ts

@@ -0,0 +1 @@
+export declare const http: import("axios").AxiosInstance;

package/dist/globals/HttpModule.js

@@ -0,0 +1,4 @@
+import axios from 'axios';
+import { URL } from './constants/url';
+const requestConfig = { baseURL: URL.domain };
+export const http = axios.create(requestConfig);

package/dist/globals/constants/url.d.ts

@@ -0,0 +1,4 @@
+export declare const URL: {
+    domain: string;
+    pathPrefix: string;
+};

package/dist/globals/constants/url.js

@@ -0,0 +1,4 @@
+export const URL = {
+    domain: 'https://samls-providerapi.purlin.tech/api/',
+    pathPrefix: '',
+};

package/dist/globals/index.js

@@ -0,0 +1,3 @@
+export * from './HttpModule';
+export * from './models';
+export * from './constants/url';

package/dist/globals/models/IApiResponse.d.ts

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

package/dist/globals/models/IApiResponse.js

@@ -0,0 +1 @@
+export {};

package/{lib/globals/models/index.ts → dist/globals/models/index.d.ts}

@@ -1,3 +1,2 @@
 export * from '../../models/PData/models/IPagination';
 export * from './IApiResponse';
-export * from './ObjectPropertyPathChecker';

package/dist/globals/models/index.js

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

package/dist/index.js

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

package/dist/models/Address/AddressDetailModel.d.ts

@@ -0,0 +1,37 @@
+import { StreetDirectionEnum, StreetSuffixEnum } from '../Enums';
+export declare class AddressDetailModel {
+    coreListingId: number;
+    city: string;
+    country: string;
+    county: string;
+    crossStreet: string;
+    directions: string;
+    elementarySchool: string;
+    elementarySchoolDistrict: string;
+    fullAddress: string;
+    highSchool: string;
+    highSchoolDistrict: string;
+    latitude: number | null;
+    locationDescription: string;
+    longitude: number | null;
+    middleOrJuniorSchool: string;
+    middleOrJuniorSchoolDistrict: string;
+    neighborhood: string;
+    postalCode: string;
+    seniorCommunityYN: boolean | null;
+    stateOrProvince: string;
+    streetDirPrefix: StreetDirectionEnum | null;
+    streetDirSuffix: StreetDirectionEnum | null;
+    streetName: string;
+    streetNumber: string;
+    streetSuffix: StreetSuffixEnum | null;
+    subDivision: string;
+    unitNumber: string;
+    waterBodyName: string;
+    waterfrontProximity: string;
+    waterfrontYN: boolean | null;
+    zoning: string;
+    samlsFullAddress: string;
+    samlsPartialAddress: string;
+    polygonCollection: number[];
+}

package/dist/models/Address/AddressDetailModel.js

@@ -0,0 +1,38 @@
+export class AddressDetailModel {
+    constructor() {
+        this.coreListingId = 0;
+        this.city = '';
+        this.country = '';
+        this.county = '';
+        this.crossStreet = '';
+        this.directions = '';
+        this.elementarySchool = '';
+        this.elementarySchoolDistrict = '';
+        this.fullAddress = '';
+        this.highSchool = '';
+        this.highSchoolDistrict = '';
+        this.latitude = null;
+        this.locationDescription = '';
+        this.longitude = null;
+        this.middleOrJuniorSchool = '';
+        this.middleOrJuniorSchoolDistrict = '';
+        this.neighborhood = '';
+        this.postalCode = '';
+        this.seniorCommunityYN = null;
+        this.stateOrProvince = '';
+        this.streetDirPrefix = null;
+        this.streetDirSuffix = null;
+        this.streetName = '';
+        this.streetNumber = '';
+        this.streetSuffix = null;
+        this.subDivision = '';
+        this.unitNumber = '';
+        this.waterBodyName = '';
+        this.waterfrontProximity = '';
+        this.waterfrontYN = null;
+        this.zoning = '';
+        this.samlsFullAddress = '';
+        this.samlsPartialAddress = '';
+        this.polygonCollection = [];
+    }
+}

package/dist/models/Address/AddressQueryModel.d.ts

@@ -0,0 +1,5 @@
+import { GlobalQueryModel } from '../Common';
+export declare class AddressQueryModel extends GlobalQueryModel {
+    fullAddress: string;
+    constructor(fullAddress: string, data?: Partial<GlobalQueryModel>);
+}

package/dist/models/Address/AddressQueryModel.js

@@ -0,0 +1,8 @@
+import { GlobalQueryModel } from '../Common';
+export class AddressQueryModel extends GlobalQueryModel {
+    constructor(fullAddress, data) {
+        super(data);
+        this.fullAddress = '';
+        this.fullAddress = fullAddress;
+    }
+}

package/dist/models/Address/index.js

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

package/dist/models/Agent/AgentInfoModel.d.ts

@@ -0,0 +1,27 @@
+import { MLSEnum } from "../Enums";
+export declare class AgentInfoModel {
+    agentId: number;
+    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;
+    agentMlsId: string;
+    agentMobilePhone: string;
+    agentNamePrefix: string;
+    agentNameSuffix: string;
+    agentOfficePhone: string;
+    agentOfficePhoneExt: string;
+    agentPreferredPhone: string;
+    agentStateLicense: string;
+    agentUrl: string;
+    teamKey: string;
+    teamName: string;
+}

package/dist/models/Agent/AgentInfoModel.js

@@ -0,0 +1,28 @@
+export class AgentInfoModel {
+    constructor() {
+        this.agentId = 0;
+        this.agentAOR = '';
+        this.agentDesignation = '';
+        this.agentDirectPhone = '';
+        this.agentEmail = '';
+        this.agentFirstName = '';
+        this.agentFullName = '';
+        this.agentHomePhone = '';
+        this.agentKey = '';
+        this.agentLastName = '';
+        this.agentLicenseNumber = '';
+        this.agentMiddleName = '';
+        this.agentMls = null;
+        this.agentMlsId = '';
+        this.agentMobilePhone = '';
+        this.agentNamePrefix = '';
+        this.agentNameSuffix = '';
+        this.agentOfficePhone = '';
+        this.agentOfficePhoneExt = '';
+        this.agentPreferredPhone = '';
+        this.agentStateLicense = '';
+        this.agentUrl = '';
+        this.teamKey = '';
+        this.teamName = '';
+    }
+}

package/dist/models/Agent/AgentModel.d.ts

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

package/dist/models/Agent/AgentModel.js

@@ -0,0 +1,8 @@
+import { AgentInfoModel } from './AgentInfoModel';
+export class AgentModel extends AgentInfoModel {
+    constructor() {
+        super(...arguments);
+        this.agentTypeId = null;
+        this.office = null;
+    }
+}

package/dist/models/Agent/GetAgentRequestModel.d.ts

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

package/dist/models/Agent/GetAgentRequestModel.js

@@ -0,0 +1,7 @@
+class GetAgentRequestModel {
+    constructor() {
+        this.agentMlsId = '';
+        this.mlsId = null;
+    }
+}
+export { GetAgentRequestModel };

package/dist/models/Agent/GetAgentsRequestModel.d.ts

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

package/dist/models/Agent/GetAgentsRequestModel.js

@@ -0,0 +1,10 @@
+import { PaginationOptions } from '../Common';
+export class GetAgentsRequestModel extends PaginationOptions {
+    constructor() {
+        super(...arguments);
+        this.email = '';
+        this.lastName = '';
+        this.firstName = '';
+        this.mlsId = null;
+    }
+}

package/dist/models/Agent/OfficeModel.d.ts

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

package/dist/models/Agent/OfficeModel.js

@@ -0,0 +1,20 @@
+export class OfficeModel {
+    constructor() {
+        this.officeKey = '';
+        this.officeAOR = '';
+        this.officeCity = '';
+        this.officeEmail = '';
+        this.officeLocation = '';
+        this.officeMls = null;
+        this.officeMlsId = '';
+        this.officeName = '';
+        this.officeNeighborhood = '';
+        this.officePhone = '';
+        this.officePhoneExt = '';
+        this.officeState = '';
+        this.officeStreetName = '';
+        this.officeStreetNumber = '';
+        this.officeURL = '';
+        this.officeZip = '';
+    }
+}

package/dist/models/Agent/index.js

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

package/dist/models/Common/GlobalQueryModel.d.ts

@@ -0,0 +1,11 @@
+import { ConditionModel, OrderingModel } from '../PData';
+export declare class GlobalQueryModel {
+    skip: number | null;
+    take: number | null;
+    count: boolean;
+    filter: string | null;
+    order: OrderingModel[] | null;
+    conditions: ConditionModel[] | null;
+    fields: string[];
+    constructor(data?: Partial<GlobalQueryModel>);
+}

package/dist/models/Common/GlobalQueryModel.js

@@ -0,0 +1,14 @@
+export class GlobalQueryModel {
+    constructor(data) {
+        this.skip = 0;
+        this.take = 10;
+        this.count = false;
+        this.filter = null;
+        this.order = null;
+        this.conditions = null;
+        this.fields = [];
+        if (data) {
+            Object.assign(this, data);
+        }
+    }
+}

package/dist/models/Common/LocationModel.d.ts

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

package/dist/models/Common/LocationModel.js

@@ -0,0 +1,6 @@
+export class LocationModel {
+    constructor() {
+        this.Latitude = 0;
+        this.Longitude = 0;
+    }
+}

package/dist/models/Common/PaginationOptions.d.ts

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

package/dist/models/Common/PaginationOptions.js

@@ -0,0 +1,6 @@
+export class PaginationOptions {
+    constructor() {
+        this.Page = 0;
+        this.Count = 0;
+    }
+}

package/dist/models/Common/Point.d.ts

@@ -0,0 +1,5 @@
+export declare class Point {
+    private latitude;
+    private longitude;
+    constructor(latitude: number, longitude: number);
+}

package/dist/models/Common/Point.js

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

package/dist/models/Common/index.js

@@ -0,0 +1,5 @@
+export * from './Point';
+export * from './GlobalQueryModel';
+export * from './LocationModel';
+export * from './PaginationOptions';
+export * from '../PData/models/ConditionModel';

package/dist/models/Entities/AddressDetail.d.ts

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

package/dist/models/Entities/AddressDetail.js

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

package/dist/models/Entities/AddressPolygon.d.ts

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

package/dist/models/Entities/AddressPolygon.js

@@ -0,0 +1,10 @@
+export class AddressPolygon {
+    constructor() {
+        this.id = 0;
+        this.addressId = 0;
+        this.polygonId = 0;
+        this.createDate = null;
+        this.polygon = null;
+        this.address = null;
+    }
+}

package/dist/models/Entities/Entity.d.ts

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

package/dist/models/Entities/Entity.js

@@ -0,0 +1,7 @@
+export class Entity {
+    constructor(id, createDate, updateDate) {
+        this.id = id;
+        this.createDate = createDate;
+        this.updateDate = updateDate;
+    }
+}