@blazeo.com/calendar-client 1.0.32 → 1.0.35

package/README.md

@@ -64,7 +64,7 @@ All `reqGet` / `reqPost` calls attach `Authorization: Bearer …` when a token i
 ```js
 setAccessToken(session.accessToken, session.expiresAt);
 setGetAccessToken(() => authService.acquireTokenSilent());
-await LeadModel.requestExport('company-key');
+await LeadModel.requestExport('company-key', { userEmail: 'user@example.com' });
 ```
 
 ## API overview
@@ -72,7 +72,7 @@ await LeadModel.requestExport('company-key');
 - **CalendarModel (static):** `get`, `getByCompany`, `getTimeZones`, `getTimeZone`, `getParticipants`, `getMonth`, `getEvents`, etc.
 - **EventModel (instance):** `get`, `create`, `cancel`, `getCancellable`, `getAvailability`, `setReminder`
 - **FlowModel:** Same pattern as Calendar — `FlowModel.create({}, { env })` with no fields; static `get`, `getRaw`, `list`, `createFlow`, `updateFlow`, `delete`, `duplicate`, appearance/embed/public/preview helpers; instance methods mirror those using `flowId` on the snapshot
-- **LeadModel:** `LeadModel.create({}, { env })`; static `get`, `getRaw`, `getByEmail`, `getByPhone`, `getByCompany`, `saveColumnSelection`, `getColumnSelection`, `allowedColumns`; instance `get`, `getByEmail`, `getByPhone`, `getByCompany`, `saveColumnSelection`, `getColumnSelection`. Pass `userId` in `getByCompany(companyKey, { userId })` to return only columns saved for that user.
+- **LeadModel:** `LeadModel.create({}, { env })`; static `get`, `getRaw`, `getByEmail`, `getByPhone`, `getByCompany`, `saveColumnSelection`, `getColumnSelection`, `allowedColumns`, `requestExport`; instance `get`, `getByEmail`, `getByPhone`, `getByCompany`, `saveColumnSelection`, `getColumnSelection`, `requestLeadExport`. Pass `userId` in `getByCompany(companyKey, { userId })` to return only columns saved for that user. For `requestExport`, pass `userEmail` (or rely on JWT email claim) so the server can publish a `NotificationGenerated` message when export completes.
 - **ParticipantModel:** static `get`, `getByEmail`, `getByIds`, `getAll`, …; instance `getByEmail` uses `email` + `companyKey` on the snapshot (see `GET /participant/getbyemail`)
 - **AuthModel (calendar OAuth / Connect Calendar):** `getCalendarProviders`, `getAuthorizationUrl`, `getAuthorizationStatus`, `openOAuthPopup`, `onCalendarAuthMessage` — see [Calendar authorization flow](#calendar-authorization-direct-ui)
 - **RootStore:** `addCalendar`, `addEvent`

package/dist/index.d.ts

@@ -76,9 +76,40 @@ export const CalendarModel: {
   create(snapshot: object, options?: { env?: object }): unknown;
 };
 
+/** Event fields returned by the API (camelCase). */
+export type EventSnapshot = {
+  eventId: string;
+  calendarId?: string;
+  participantId?: string | null;
+  title?: string | null;
+  description?: string | null;
+  calendarLocationId?: string | null;
+  /** From CalendarLocation.Value when event search endpoints enrich the row. */
+  calendarLocationValue?: string | null;
+  customLocation?: string | null;
+  visitorName?: string | null;
+  visitorEmail?: string | null;
+  visitorPhone?: string | null;
+  startDate?: string;
+  endDate?: string;
+  [key: string]: unknown;
+};
+
+export type EventSearchResult = {
+  events: unknown[];
+  totalCount: number;
+};
+
 export const EventModel: {
   get(eventId: string): Promise<unknown>;
   getByExternalId(externalEventId: string): Promise<unknown>;
+  getByDateRangeWithFilters(
+    companyKey: string,
+    startDateFrom: string,
+    startDateTo: string,
+    opts?: Record<string, unknown>
+  ): Promise<EventSearchResult>;
+  getByFilters(companyKey: string, opts?: Record<string, unknown>): Promise<EventSearchResult>;
   getRoundRobinParticipant(calendarId: string): Promise<unknown>;
   getEarliestAvailableDays(calendarId: string, count: number, opts?: { year?: number; month?: number; day?: number; offset?: number }): Promise<string[] | null>;
   getDaySelectable(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<boolean>;
@@ -100,7 +131,7 @@ export const EventModel: {
   getCustomData(calendarId: string, eventId?: string): Promise<unknown>;
   setReminder(eventId: string): Promise<unknown>;
   setAttendeeStatus(eventId: string, attendeeStatus: number | string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
+  create(snapshot: EventSnapshot | object, options?: { env?: object }): unknown;
 };
 
 export const AvailabilityModel: { create(snapshot: object, options?: { env?: object }): unknown };
@@ -268,6 +299,9 @@ export const LeadModel: {
       notify_path?: string;
       consumer?: string;
       Consumer?: string;
+      /** Recipient for lead-export completion notification (or omit to use JWT email claim). */
+      userEmail?: string;
+      user_email?: string;
     }
   ): Promise<{ status: string; data?: unknown; message?: string }>;
   getByCompany(

package/dist/index.js

@@ -38,6 +38,7 @@ __export(index_exports, {
   DayOfWeek: () => DayOfWeek,
   EmailProvider: () => EmailProvider,
   EventModel: () => Event_default,
+  EventSource: () => EventSource,
   FlowModel: () => Flow_default,
   LeadModel: () => Lead_default,
   LocationType: () => LocationType,
@@ -344,6 +345,11 @@ var RecurringFrequency = {
   Monthly: 3,
   Yearly: 4
 };
+var EventSource = {
+  AppointmentType: 0,
+  OneOffMeeting: 1,
+  MeetingLink: 2
+};
 var DayOfWeek = {
   Sunday: 0,
   Monday: 1,
@@ -476,6 +482,8 @@ var EventModel = import_mobx_state_tree4.types.model("Event", {
   modifiedOn: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   externalEventId: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   calendarLocationId: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
+  /** Resolved location text from CalendarLocation when returned by search APIs. */
+  calendarLocationValue: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   customLocation: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   flowId: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   flowPath: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
@@ -483,8 +491,14 @@ var EventModel = import_mobx_state_tree4.types.model("Event", {
   rescheduleLink: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   cancelLink: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
   timeZone: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.maybeNull(import_mobx_state_tree4.types.string), null),
-  offset: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.number, 0)
-}).actions((self) => {
+  offset: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.number, 0),
+  eventSource: import_mobx_state_tree4.types.optional(import_mobx_state_tree4.types.number, EventSource.AppointmentType)
+}).views((self) => ({
+  /** calendarLocationValue, else customLocation (one-off / typed location). */
+  get displayLocation() {
+    return self.calendarLocationValue ?? self.customLocation ?? null;
+  }
+})).actions((self) => {
   const { req, reqGet, reqPost } = createRequestHelpers(self, import_mobx_state_tree4.getEnv);
   const getOffset = () => {
     var _a, _b;
@@ -620,11 +634,14 @@ function mapEventFromApi(d) {
   const pick2 = (...keys) => keys.reduce((v, k) => v ?? d[k], void 0);
   const n = (v) => v != null && v !== "" ? Number(v) : void 0;
   return {
+    id: n(pick2("id", "Id")),
     eventId: String(pick2("eventId", "EventId", "event_id") ?? ""),
     calendarId: String(pick2("calendarId", "CalendarId", "calendar_id") ?? ""),
     participantId: pick2("participantId", "ParticipantId", "participant_id") ?? null,
     title: pick2("title", "Title"),
     description: pick2("description", "Description"),
+    isRecurring: pick2("isRecurring", "IsRecurring", "is_recurring") ?? false,
+    recurringFrequency: n(pick2("recurringFrequency", "RecurringFrequency", "recurring_frequency")),
     startDate: pick2("startDate", "StartDate", "start_date"),
     endDate: pick2("endDate", "EndDate", "end_date"),
     startHour: n(pick2("startHour", "StartHour", "start_hour")),
@@ -634,15 +651,18 @@ function mapEventFromApi(d) {
     visitorName: pick2("visitorName", "VisitorName", "visitor_name"),
     visitorEmail: pick2("visitorEmail", "VisitorEmail", "visitor_email"),
     visitorPhone: pick2("visitorPhone", "VisitorPhone", "visitor_phone"),
-    externalEventId: pick2("externalEventId", "ExternalEventId", "external_event_id"),
+    externalEventId: pick2("externalEventId", "ExternalEventId", "externalEventId", "external_event_id"),
     calendarLocationId: pick2("calendarLocationId", "CalendarLocationId", "calendar_location_id"),
+    calendarLocationValue: pick2("calendarLocationValue", "CalendarLocationValue", "calendar_location_value"),
     customLocation: pick2("customLocation", "CustomLocation", "custom_location"),
     flowId: pick2("flowId", "FlowId", "flow_id"),
     flowPath: pick2("flowPath", "FlowPath", "flow_path"),
     attendeeStatus: n(pick2("attendeeStatus", "AttendeeStatus", "attendee_status")),
+    eventSource: n(pick2("eventSource", "EventSource", "event_source")),
     rescheduleLink: pick2("rescheduleLink", "RescheduleLink", "reschedule_link"),
     cancelLink: pick2("cancelLink", "CancelLink", "cancel_link"),
     timeZone: pick2("timeZone", "TimeZone", "time_zone"),
+    offset: n(pick2("offset", "Offset")),
     createdOn: pick2("createdOn", "CreatedOn", "created_on"),
     modifiedOn: pick2("modifiedOn", "ModifiedOn", "modified_on")
   };
@@ -2497,7 +2517,7 @@ var LeadModel = import_mobx_state_tree19.types.model("Lead", {
     },
     /**
      * POST /lead/export/request – queue async full CSV export for self.companyKey (no list filters).
-     * @param {object} [opts] – { notifyPath?, consumer? } consumer = Consumer header for completion webhook
+     * @param {object} [opts] – { notifyPath?, consumer?, userEmail? } consumer = Consumer header; userEmail for completion notification
      */
     async requestLeadExport(opts = {}) {
       if (!self.companyKey || String(self.companyKey).trim() === "") {
@@ -2629,6 +2649,10 @@ LeadModel.requestExport = async (companyKey, opts = {}) => {
   if (np != null && String(np).trim() !== "") {
     body.notify_path = String(np).trim();
   }
+  const userEmail = opts.userEmail ?? opts.user_email;
+  if (userEmail != null && String(userEmail).trim() !== "") {
+    body.user_email = String(userEmail).trim();
+  }
   const headers = {};
   const consumer = opts.consumer ?? opts.Consumer;
   if (consumer != null && String(consumer).trim() !== "") {
@@ -3034,6 +3058,7 @@ function createRootStore(initialState = {}) {
   DayOfWeek,
   EmailProvider,
   EventModel,
+  EventSource,
   FlowModel,
   LeadModel,
   LocationType,

package/dist/index.mjs

@@ -273,6 +273,11 @@ var RecurringFrequency = {
   Monthly: 3,
   Yearly: 4
 };
+var EventSource = {
+  AppointmentType: 0,
+  OneOffMeeting: 1,
+  MeetingLink: 2
+};
 var DayOfWeek = {
   Sunday: 0,
   Monday: 1,
@@ -405,6 +410,8 @@ var EventModel = types4.model("Event", {
   modifiedOn: types4.optional(types4.maybeNull(types4.string), null),
   externalEventId: types4.optional(types4.maybeNull(types4.string), null),
   calendarLocationId: types4.optional(types4.maybeNull(types4.string), null),
+  /** Resolved location text from CalendarLocation when returned by search APIs. */
+  calendarLocationValue: types4.optional(types4.maybeNull(types4.string), null),
   customLocation: types4.optional(types4.maybeNull(types4.string), null),
   flowId: types4.optional(types4.maybeNull(types4.string), null),
   flowPath: types4.optional(types4.maybeNull(types4.string), null),
@@ -412,8 +419,14 @@ var EventModel = types4.model("Event", {
   rescheduleLink: types4.optional(types4.maybeNull(types4.string), null),
   cancelLink: types4.optional(types4.maybeNull(types4.string), null),
   timeZone: types4.optional(types4.maybeNull(types4.string), null),
-  offset: types4.optional(types4.number, 0)
-}).actions((self) => {
+  offset: types4.optional(types4.number, 0),
+  eventSource: types4.optional(types4.number, EventSource.AppointmentType)
+}).views((self) => ({
+  /** calendarLocationValue, else customLocation (one-off / typed location). */
+  get displayLocation() {
+    return self.calendarLocationValue ?? self.customLocation ?? null;
+  }
+})).actions((self) => {
   const { req, reqGet, reqPost } = createRequestHelpers(self, getEnv);
   const getOffset = () => {
     var _a, _b;
@@ -549,11 +562,14 @@ function mapEventFromApi(d) {
   const pick2 = (...keys) => keys.reduce((v, k) => v ?? d[k], void 0);
   const n = (v) => v != null && v !== "" ? Number(v) : void 0;
   return {
+    id: n(pick2("id", "Id")),
     eventId: String(pick2("eventId", "EventId", "event_id") ?? ""),
     calendarId: String(pick2("calendarId", "CalendarId", "calendar_id") ?? ""),
     participantId: pick2("participantId", "ParticipantId", "participant_id") ?? null,
     title: pick2("title", "Title"),
     description: pick2("description", "Description"),
+    isRecurring: pick2("isRecurring", "IsRecurring", "is_recurring") ?? false,
+    recurringFrequency: n(pick2("recurringFrequency", "RecurringFrequency", "recurring_frequency")),
     startDate: pick2("startDate", "StartDate", "start_date"),
     endDate: pick2("endDate", "EndDate", "end_date"),
     startHour: n(pick2("startHour", "StartHour", "start_hour")),
@@ -563,15 +579,18 @@ function mapEventFromApi(d) {
     visitorName: pick2("visitorName", "VisitorName", "visitor_name"),
     visitorEmail: pick2("visitorEmail", "VisitorEmail", "visitor_email"),
     visitorPhone: pick2("visitorPhone", "VisitorPhone", "visitor_phone"),
-    externalEventId: pick2("externalEventId", "ExternalEventId", "external_event_id"),
+    externalEventId: pick2("externalEventId", "ExternalEventId", "externalEventId", "external_event_id"),
     calendarLocationId: pick2("calendarLocationId", "CalendarLocationId", "calendar_location_id"),
+    calendarLocationValue: pick2("calendarLocationValue", "CalendarLocationValue", "calendar_location_value"),
     customLocation: pick2("customLocation", "CustomLocation", "custom_location"),
     flowId: pick2("flowId", "FlowId", "flow_id"),
     flowPath: pick2("flowPath", "FlowPath", "flow_path"),
     attendeeStatus: n(pick2("attendeeStatus", "AttendeeStatus", "attendee_status")),
+    eventSource: n(pick2("eventSource", "EventSource", "event_source")),
     rescheduleLink: pick2("rescheduleLink", "RescheduleLink", "reschedule_link"),
     cancelLink: pick2("cancelLink", "CancelLink", "cancel_link"),
     timeZone: pick2("timeZone", "TimeZone", "time_zone"),
+    offset: n(pick2("offset", "Offset")),
     createdOn: pick2("createdOn", "CreatedOn", "created_on"),
     modifiedOn: pick2("modifiedOn", "ModifiedOn", "modified_on")
   };
@@ -2426,7 +2445,7 @@ var LeadModel = types19.model("Lead", {
     },
     /**
      * POST /lead/export/request – queue async full CSV export for self.companyKey (no list filters).
-     * @param {object} [opts] – { notifyPath?, consumer? } consumer = Consumer header for completion webhook
+     * @param {object} [opts] – { notifyPath?, consumer?, userEmail? } consumer = Consumer header; userEmail for completion notification
      */
     async requestLeadExport(opts = {}) {
       if (!self.companyKey || String(self.companyKey).trim() === "") {
@@ -2558,6 +2577,10 @@ LeadModel.requestExport = async (companyKey, opts = {}) => {
   if (np != null && String(np).trim() !== "") {
     body.notify_path = String(np).trim();
   }
+  const userEmail = opts.userEmail ?? opts.user_email;
+  if (userEmail != null && String(userEmail).trim() !== "") {
+    body.user_email = String(userEmail).trim();
+  }
   const headers = {};
   const consumer = opts.consumer ?? opts.Consumer;
   if (consumer != null && String(consumer).trim() !== "") {
@@ -2962,6 +2985,7 @@ export {
   DayOfWeek,
   EmailProvider,
   Event_default as EventModel,
+  EventSource,
   Flow_default as FlowModel,
   Lead_default as LeadModel,
   LocationType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blazeo.com/calendar-client",
-  "version": "1.0.32",
+  "version": "1.0.35",
   "description": "Blazeo Calendar / Appointment API client with MobX State Tree models",
   "exports": {
     ".": {