@23blocks/block-crm 3.1.7 → 3.2.0

package/dist/src/lib/services/touches.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"touches.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/touches.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAG3B,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,cAAc,CA2DrG"}
+{"version":3,"file":"touches.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/touches.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAG3B,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEnE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC;AAED,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,cAAc,CA2DrG"}

package/dist/src/lib/services/users.service.d.ts

@@ -3,11 +3,43 @@ import type { CrmUser, RegisterCrmUserRequest, ListCrmUsersParams } from '../typ
 import type { Contact } from '../types/contact.js';
 import type { Meeting } from '../types/meeting.js';
 export interface CrmUsersService {
+    /**
+     * List CRM users with optional filtering and pagination.
+     * @param params - Optional filtering (status, search) and pagination parameters.
+     * @returns Paginated result containing CrmUser objects and metadata.
+     */
     list(params?: ListCrmUsersParams): Promise<PageResult<CrmUser>>;
+    /**
+     * Retrieve a single CRM user by their unique identifier.
+     * @param uniqueId - The unique identifier of the CRM user.
+     * @returns The matching CrmUser object.
+     */
     get(uniqueId: string): Promise<CrmUser>;
+    /**
+     * Register a user in the CRM system.
+     * @param uniqueId - The unique identifier of the user to register.
+     * @param data - The registration payload with email, name, phone, and optional payload.
+     * @returns The newly registered CrmUser object.
+     * @note This associates an existing authentication user with the CRM block.
+     */
     register(uniqueId: string, data: RegisterCrmUserRequest): Promise<CrmUser>;
+    /**
+     * Delete a CRM user.
+     * @param uniqueId - The unique identifier of the CRM user to delete.
+     * @returns Resolves when the CRM user has been deleted.
+     */
     delete(uniqueId: string): Promise<void>;
+    /**
+     * Retrieve all contacts assigned to a CRM user.
+     * @param uniqueId - The unique identifier of the CRM user.
+     * @returns An array of Contact objects assigned to the user.
+     */
     getContacts(uniqueId: string): Promise<Contact[]>;
+    /**
+     * Retrieve all meetings associated with a CRM user.
+     * @param uniqueId - The unique identifier of the CRM user.
+     * @returns An array of Meeting objects associated with the user.
+     */
     getMeetings(uniqueId: string): Promise<Meeting[]>;
 }
 export declare function createCrmUsersService(transport: Transport, _config: {

package/dist/src/lib/services/users.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/users.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAKnD,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3E,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAClD,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACnD;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CA4CvG"}
+{"version":3,"file":"users.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/users.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAKnD,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhE;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE3E;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAElD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACnD;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CA4CvG"}

package/dist/src/lib/services/zoom-hosts.service.d.ts

@@ -1,13 +1,54 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { ZoomHost, ZoomHostAvailability, ZoomHostAllocation, AvailableUser, CreateZoomHostRequest, UpdateZoomHostRequest, ListZoomHostsParams } from '../types/zoom-host.js';
 export interface ZoomHostsService {
+    /**
+     * List Zoom hosts with optional filtering, pagination, and sorting.
+     * @param params - Optional filtering (status, licenseType, available, search), pagination, and sorting.
+     * @returns Paginated result containing ZoomHost objects and metadata.
+     */
     list(params?: ListZoomHostsParams): Promise<PageResult<ZoomHost>>;
+    /**
+     * Retrieve a single Zoom host by its unique identifier.
+     * @param uniqueId - The unique identifier of the Zoom host.
+     * @returns The matching ZoomHost object.
+     */
     get(uniqueId: string): Promise<ZoomHost>;
+    /**
+     * Create a new Zoom host.
+     * @param data - The Zoom host creation payload with user reference, Zoom user ID, email, name, license, and capacity.
+     * @returns The newly created ZoomHost object.
+     */
     create(data: CreateZoomHostRequest): Promise<ZoomHost>;
+    /**
+     * Update an existing Zoom host.
+     * @param uniqueId - The unique identifier of the Zoom host to update.
+     * @param data - The fields to update on the Zoom host.
+     * @returns The updated ZoomHost object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(uniqueId: string, data: UpdateZoomHostRequest): Promise<ZoomHost>;
+    /**
+     * Delete a Zoom host.
+     * @param uniqueId - The unique identifier of the Zoom host to delete.
+     * @returns Resolves when the Zoom host has been deleted.
+     */
     delete(uniqueId: string): Promise<void>;
+    /**
+     * Retrieve the availability status of a Zoom host.
+     * @param uniqueId - The unique identifier of the Zoom host.
+     * @returns A ZoomHostAvailability object with the host's current availability details.
+     */
     getAvailability(uniqueId: string): Promise<ZoomHostAvailability>;
+    /**
+     * Retrieve the meeting allocations for a Zoom host.
+     * @param uniqueId - The unique identifier of the Zoom host.
+     * @returns An array of ZoomHostAllocation objects representing assigned meetings.
+     */
     getAllocations(uniqueId: string): Promise<ZoomHostAllocation[]>;
+    /**
+     * Retrieve users who are available to become Zoom hosts.
+     * @returns An array of AvailableUser objects representing eligible users.
+     */
     getAvailableUsers(): Promise<AvailableUser[]>;
 }
 export declare function createZoomHostsService(transport: Transport, _config: {

package/dist/src/lib/services/zoom-hosts.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zoom-hosts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/zoom-hosts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClE,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjE,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAChE,iBAAiB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;CAC/C;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CA2EzG"}
+{"version":3,"file":"zoom-hosts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/zoom-hosts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjE;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEhE;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;CAC/C;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CA2EzG"}

package/dist/src/lib/services/zoom-meetings.service.d.ts

@@ -1,10 +1,43 @@
 import type { Transport } from '@23blocks/contracts';
 import type { ZoomMeeting, ZoomAvailability, ProvisionZoomMeetingRequest, UpdateZoomMeetingRequest } from '../types/zoom-meeting.js';
 export interface ZoomMeetingsService {
+    /**
+     * Retrieve Zoom meeting details for a specific user and meeting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param meetingUniqueId - The unique identifier of the meeting.
+     * @returns The matching ZoomMeeting object with Zoom-specific details.
+     */
     get(userUniqueId: string, meetingUniqueId: string): Promise<ZoomMeeting>;
+    /**
+     * Provision a new Zoom meeting for a user's meeting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param meetingUniqueId - The unique identifier of the meeting to provision Zoom for.
+     * @param request - Optional Zoom meeting settings (topic, agenda, duration, recording, waiting room, etc.).
+     * @returns The newly provisioned ZoomMeeting object with join/start URLs.
+     * @note Creates the Zoom meeting on the Zoom platform and links it to the CRM meeting.
+     */
     provision(userUniqueId: string, meetingUniqueId: string, request?: ProvisionZoomMeetingRequest): Promise<ZoomMeeting>;
+    /**
+     * Update the Zoom meeting settings for a user's meeting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param meetingUniqueId - The unique identifier of the meeting.
+     * @param request - The Zoom meeting fields to update.
+     * @returns The updated ZoomMeeting object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(userUniqueId: string, meetingUniqueId: string, request: UpdateZoomMeetingRequest): Promise<ZoomMeeting>;
+    /**
+     * Cancel and remove the Zoom meeting for a user's meeting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param meetingUniqueId - The unique identifier of the meeting.
+     * @returns Resolves when the Zoom meeting has been cancelled.
+     */
     cancel(userUniqueId: string, meetingUniqueId: string): Promise<void>;
+    /**
+     * Check Zoom availability for a user.
+     * @param userUniqueId - The unique identifier of the user.
+     * @returns A ZoomAvailability object indicating whether the user can host Zoom meetings.
+     */
     checkAvailability(userUniqueId: string): Promise<ZoomAvailability>;
 }
 export declare function createZoomMeetingsService(transport: Transport, _config: {

package/dist/src/lib/services/zoom-meetings.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zoom-meetings.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/zoom-meetings.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,KAAK,EACV,WAAW,EACX,gBAAgB,EAChB,2BAA2B,EAC3B,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAGlC,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACzE,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACtH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/G,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACpE;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,mBAAmB,CAqD/G"}
+{"version":3,"file":"zoom-meetings.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/zoom-meetings.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,KAAK,EACV,WAAW,EACX,gBAAgB,EAChB,2BAA2B,EAC3B,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAGlC,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEtH;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE/G;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;;OAIG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACpE;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,mBAAmB,CAqD/G"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@23blocks/block-crm",
-  "version": "3.1.7",
+  "version": "3.2.0",
   "description": "CRM block for 23blocks SDK - accounts, contacts, leads, opportunities, meetings",
   "license": "MIT",
   "author": "23blocks <hello@23blocks.com>",