stentor-models 1.59.48 → 1.59.51

package/lib/Services/CrmService.d.ts

@@ -1,5 +1,78 @@
 /*! Copyright (c) 2022, XAPPmedia */
 import { CrmResponse, ExternalLead } from "../Crm";
+import { DateTime, DateTimeRange } from "../DateTime";
+export type DayOfWeek = "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
+/**
+ * Settings for the availability of the CRM service.
+ */
+export interface CrmServiceAvailabilitySettings {
+    /**
+     * The days of the week they are available to schedule appointments through the scheduler.
+     */
+    availableDays?: DayOfWeek[];
+    /**
+     * These are holidays or any other days specific to the business that they are not available for appointments.
+     */
+    blockedDays?: DateTime[];
+    /**
+     * Maximum total number of appointments a day that can be scheduled through the scheduler.
+     */
+    maxTotalDailyAppointments?: number;
+}
+export interface CrmServiceTimeAvailability {
+    /**
+     * The time slot
+     */
+    range: DateTimeRange;
+    /**
+     * If the time slot is available.
+     */
+    available: boolean;
+}
+export interface CrmServiceDateAvailability {
+    /**
+     * The number of appointments available for the given range.
+     *
+     * Typically, just the date is used, tz and time are not needed.
+     */
+    date: DateTime;
+    /**
+     * If the day has any availability for appointments.
+     */
+    available: boolean;
+    /**
+     * The number of remaining available appointments.
+     */
+    remainingAppointments?: number;
+    /**
+     * Blocked time slots for the day.
+     *
+     * These are only blocked times during their normal business hours.
+     *
+     * @note - This is only for future consideration.
+     */
+    blockedTimeSlots?: CrmServiceTimeAvailability[];
+}
+export interface CrmServiceAvailability {
+    /**
+     * The range
+     */
+    range: DateTimeRange;
+    /**
+     * Availability for each date in the range.
+     *
+     * If the date is not included in the array, it is assumed to be available.
+     */
+    unavailabilities: CrmServiceDateAvailability[];
+}
+export interface CrmServiceAvailabilityOptions extends CrmServiceAvailabilitySettings {
+    /**
+     * Job Type to filter availability by.
+     *
+     * This allows to display availability for a specific job type, which can be different.
+     */
+    jobType?: string;
+}
 export interface CrmService {
     /**
      * Send information about a lead to the CRM.
@@ -17,8 +90,27 @@ export interface CrmService {
      *
      * It leverages the refId on the externalLead, which is originally provided in the CrmResponse to properly
      *
+     * @deprecated Use send with a refId on the externalLead and call send() again.  This will update.
+     *
      * @param externalLead
      * @param extras
      */
     update?(externalLead: ExternalLead, extras?: Record<string, unknown>): Promise<CrmResponse>;
+    /**
+     * Returns availability for scheduling an appointment with the business.
+     *
+     * @param range
+     * @param options
+     */
+    getAvailability(range: DateTimeRange, options?: CrmServiceAvailabilityOptions): Promise<CrmServiceAvailability>;
+}
+export type CrmServiceProps = CrmServiceAvailabilitySettings;
+export declare class AbstractCrmService implements CrmService {
+    protected availableDays?: DayOfWeek[];
+    protected blockedDays?: DateTime[];
+    protected maxTotalDailyAppointments?: number | undefined;
+    constructor(props: CrmServiceProps);
+    send(externalLead: ExternalLead, extras?: Record<string, unknown>): Promise<CrmResponse>;
+    getAvailability(range: DateTimeRange, options?: CrmServiceAvailabilityOptions): Promise<CrmServiceAvailability>;
+    update?(externalLead: ExternalLead, extras?: Record<string, unknown>): Promise<CrmResponse>;
 }

package/lib/Services/CrmService.js

@@ -1,4 +1,46 @@
 "use strict";
 /*! Copyright (c) 2022, XAPPmedia */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractCrmService = void 0;
+class AbstractCrmService {
+    constructor(props) {
+        if (props.availableDays) {
+            this.availableDays = props.availableDays;
+        }
+        if (props.blockedDays) {
+            this.blockedDays = props.blockedDays;
+        }
+        if (typeof props.maxTotalDailyAppointments === "number") {
+            this.maxTotalDailyAppointments = props.maxTotalDailyAppointments;
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    send(externalLead, extras) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw new Error("Method not implemented.");
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    getAvailability(range, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw new Error("Method not implemented.");
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    update(externalLead, extras) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw new Error("Method not implemented.");
+        });
+    }
+}
+exports.AbstractCrmService = AbstractCrmService;
 //# sourceMappingURL=CrmService.js.map

package/lib/Services/CrmService.js.map

@@ -1 +1 @@
-{"version":3,"file":"CrmService.js","sourceRoot":"","sources":["../../src/Services/CrmService.ts"],"names":[],"mappings":";AAAA,oCAAoC"}
+{"version":3,"file":"CrmService.js","sourceRoot":"","sources":["../../src/Services/CrmService.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;AAqHpC,MAAa,kBAAkB;IAQ3B,YAAmB,KAAsB;QAErC,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACtB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAC7C,CAAC;QAED,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACzC,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,yBAAyB,KAAK,QAAQ,EAAE,CAAC;YACtD,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC,yBAAyB,CAAC;QACrE,CAAC;IACL,CAAC;IAED,6DAA6D;IAChD,IAAI,CAAC,YAA0B,EAAE,MAAgC;;YAC1E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,6DAA6D;IAChD,eAAe,CAAC,KAAoB,EAAE,OAAuC;;YACtF,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,6DAA6D;IAChD,MAAM,CAAE,YAA0B,EAAE,MAAgC;;YAC7E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;KAAA;CACJ;AArCD,gDAqCC"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.59.48",
+  "version": "1.59.51",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "2.0.2"
   },
-  "gitHead": "65123d5160983698c5518d31257a63ef951f1cb8"
+  "gitHead": "3209e2f9b9aae5e7099c8076e84986aa7291cb42"
 }