@23blocks/block-crm 3.1.7 → 3.2.0

package/dist/index.esm.js

@@ -2268,7 +2268,15 @@ function createCalendarSyncService(transport, _config) {
     };
 }
 
-function createCrmBlock(transport, config) {
+/**
+ * Create the CRM block.
+ *
+ * @example
+ * ```typescript
+ * const block = createCrmBlock(transport, { appId: 'xxx' });
+ * const leads = await block.leads.list({ page: 1 });
+ * ```
+ */ function createCrmBlock(transport, config) {
     return {
         accounts: createAccountsService(transport),
         contacts: createContactsService(transport),

package/dist/src/lib/crm.block.d.ts

@@ -1,35 +1,76 @@
 import type { Transport, BlockConfig, BlockMetadata } from '@23blocks/contracts';
 import { type AccountsService, type ContactsService, type ContactEventsService, type LeadsService, type LeadFollowsService, type OpportunitiesService, type MeetingsService, type MeetingParticipantsService, type MeetingBillingsService, type QuotesService, type SubscribersService, type ReferralsService, type TouchesService, type CategoriesService, type CalendarAccountsService, type BusyBlocksService, type IcsTokensService, type ZoomMeetingsService, type ZoomHostsService, type CrmMailTemplatesService, type CommunicationsService, type CrmUsersService, type BillingReportsService, type CalendarSyncService } from './services/index.js';
+/**
+ * Configuration for the CRM block.
+ */
 export interface CrmBlockConfig extends BlockConfig {
+    /** Application ID */
     appId: string;
+    /** Tenant ID (optional, for multi-tenant setups) */
     tenantId?: string;
 }
+/**
+ * Customer relationship management block interface.
+ */
 export interface CrmBlock {
+    /** Account CRUD operations */
     accounts: AccountsService;
+    /** Contact management */
     contacts: ContactsService;
+    /** Contact event tracking */
     contactEvents: ContactEventsService;
+    /** Lead management */
     leads: LeadsService;
+    /** Lead follow-up tracking */
     leadFollows: LeadFollowsService;
+    /** Sales opportunity management */
     opportunities: OpportunitiesService;
+    /** Meeting scheduling and management */
     meetings: MeetingsService;
+    /** Meeting participant management */
     meetingParticipants: MeetingParticipantsService;
+    /** Meeting billing management */
     meetingBillings: MeetingBillingsService;
+    /** Quote/proposal management */
     quotes: QuotesService;
+    /** Subscriber management */
     subscribers: SubscribersService;
+    /** Referral tracking */
     referrals: ReferralsService;
+    /** Touch-point tracking */
     touches: TouchesService;
+    /** CRM category management */
     categories: CategoriesService;
+    /** Calendar account integration */
     calendarAccounts: CalendarAccountsService;
+    /** Calendar busy-block management */
     busyBlocks: BusyBlocksService;
+    /** ICS calendar token management */
     icsTokens: IcsTokensService;
+    /** Zoom meeting integration */
     zoomMeetings: ZoomMeetingsService;
+    /** Zoom host management */
     zoomHosts: ZoomHostsService;
+    /** CRM mail template management */
     mailTemplates: CrmMailTemplatesService;
+    /** Communication log management */
     communications: CommunicationsService;
+    /** CRM user management */
     users: CrmUsersService;
+    /** Billing report generation */
     billingReports: BillingReportsService;
+    /** Calendar sync operations */
     calendarSync: CalendarSyncService;
 }
+/**
+ * Create the CRM block.
+ *
+ * @example
+ * ```typescript
+ * const block = createCrmBlock(transport, { appId: 'xxx' });
+ * const leads = await block.leads.list({ page: 1 });
+ * ```
+ */
 export declare function createCrmBlock(transport: Transport, config: CrmBlockConfig): CrmBlock;
 export declare const crmBlockMetadata: BlockMetadata;
 //# sourceMappingURL=crm.block.d.ts.map

package/dist/src/lib/crm.block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"crm.block.d.ts","sourceRoot":"","sources":["../../../src/lib/crm.block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAyBL,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACzB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,eAAe,CAAC;IAC1B,QAAQ,EAAE,eAAe,CAAC;IAC1B,aAAa,EAAE,oBAAoB,CAAC;IACpC,KAAK,EAAE,YAAY,CAAC;IACpB,WAAW,EAAE,kBAAkB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;IACpC,QAAQ,EAAE,eAAe,CAAC;IAC1B,mBAAmB,EAAE,0BAA0B,CAAC;IAChD,eAAe,EAAE,sBAAsB,CAAC;IACxC,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,kBAAkB,CAAC;IAChC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,OAAO,EAAE,cAAc,CAAC;IACxB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,UAAU,EAAE,iBAAiB,CAAC;IAC9B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,YAAY,EAAE,mBAAmB,CAAC;IAClC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,aAAa,EAAE,uBAAuB,CAAC;IACvC,cAAc,EAAE,qBAAqB,CAAC;IACtC,KAAK,EAAE,eAAe,CAAC;IACvB,cAAc,EAAE,qBAAqB,CAAC;IACtC,YAAY,EAAE,mBAAmB,CAAC;CACnC;AAED,wBAAgB,cAAc,CAC5B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,cAAc,GACrB,QAAQ,CA2BV;AAED,eAAO,MAAM,gBAAgB,EAAE,aA8B9B,CAAC"}
+{"version":3,"file":"crm.block.d.ts","sourceRoot":"","sources":["../../../src/lib/crm.block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAyBL,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACzB,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,8BAA8B;IAC9B,QAAQ,EAAE,eAAe,CAAC;IAC1B,yBAAyB;IACzB,QAAQ,EAAE,eAAe,CAAC;IAC1B,6BAA6B;IAC7B,aAAa,EAAE,oBAAoB,CAAC;IACpC,sBAAsB;IACtB,KAAK,EAAE,YAAY,CAAC;IACpB,8BAA8B;IAC9B,WAAW,EAAE,kBAAkB,CAAC;IAChC,mCAAmC;IACnC,aAAa,EAAE,oBAAoB,CAAC;IACpC,wCAAwC;IACxC,QAAQ,EAAE,eAAe,CAAC;IAC1B,qCAAqC;IACrC,mBAAmB,EAAE,0BAA0B,CAAC;IAChD,iCAAiC;IACjC,eAAe,EAAE,sBAAsB,CAAC;IACxC,gCAAgC;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,4BAA4B;IAC5B,WAAW,EAAE,kBAAkB,CAAC;IAChC,wBAAwB;IACxB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,2BAA2B;IAC3B,OAAO,EAAE,cAAc,CAAC;IACxB,8BAA8B;IAC9B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,mCAAmC;IACnC,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,qCAAqC;IACrC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,oCAAoC;IACpC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,+BAA+B;IAC/B,YAAY,EAAE,mBAAmB,CAAC;IAClC,2BAA2B;IAC3B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,mCAAmC;IACnC,aAAa,EAAE,uBAAuB,CAAC;IACvC,mCAAmC;IACnC,cAAc,EAAE,qBAAqB,CAAC;IACtC,0BAA0B;IAC1B,KAAK,EAAE,eAAe,CAAC;IACvB,gCAAgC;IAChC,cAAc,EAAE,qBAAqB,CAAC;IACtC,+BAA+B;IAC/B,YAAY,EAAE,mBAAmB,CAAC;CACnC;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,cAAc,GACrB,QAAQ,CA2BV;AAED,eAAO,MAAM,gBAAgB,EAAE,aA8B9B,CAAC"}

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

@@ -1,13 +1,57 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { Account, CreateAccountRequest, UpdateAccountRequest, ListAccountsParams } from '../types/account.js';
 export interface AccountsService {
+    /**
+     * List accounts with optional filtering, pagination, and sorting.
+     * @param params - Optional filtering, pagination, and sorting parameters.
+     * @returns Paginated result containing Account objects and metadata.
+     */
     list(params?: ListAccountsParams): Promise<PageResult<Account>>;
+    /**
+     * Retrieve a single account by its unique identifier.
+     * @param uniqueId - The unique identifier of the account.
+     * @returns The matching Account object.
+     */
     get(uniqueId: string): Promise<Account>;
+    /**
+     * Create a new account.
+     * @param data - The account creation payload.
+     * @returns The newly created Account object.
+     */
     create(data: CreateAccountRequest): Promise<Account>;
+    /**
+     * Update an existing account.
+     * @param uniqueId - The unique identifier of the account to update.
+     * @param data - The fields to update on the account.
+     * @returns The updated Account object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(uniqueId: string, data: UpdateAccountRequest): Promise<Account>;
+    /**
+     * Soft-delete an account.
+     * @param uniqueId - The unique identifier of the account to delete.
+     * @returns Resolves when the account has been deleted.
+     */
     delete(uniqueId: string): Promise<void>;
+    /**
+     * Recover a previously soft-deleted account.
+     * @param uniqueId - The unique identifier of the account to recover.
+     * @returns The recovered Account object.
+     */
     recover(uniqueId: string): Promise<Account>;
+    /**
+     * Search accounts by a query string with optional pagination.
+     * @param query - The search query string.
+     * @param params - Optional pagination parameters.
+     * @returns Paginated result containing matching Account objects.
+     * @note Performs a server-side POST-based search.
+     */
     search(query: string, params?: ListAccountsParams): Promise<PageResult<Account>>;
+    /**
+     * List soft-deleted accounts with optional pagination.
+     * @param params - Optional pagination parameters.
+     * @returns Paginated result containing soft-deleted Account objects.
+     */
     listDeleted(params?: ListAccountsParams): Promise<PageResult<Account>>;
 }
 export declare function createAccountsService(transport: Transport, _config: {

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

@@ -1 +1 @@
-{"version":3,"file":"accounts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/accounts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,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,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IACjF,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;CACxE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CA6EvG"}
+{"version":3,"file":"accounts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/accounts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,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;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;CACxE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CA6EvG"}

package/dist/src/lib/services/billing-reports.service.d.ts

@@ -1,8 +1,22 @@
 import type { Transport } from '@23blocks/contracts';
 import type { BillingReportParams, RevenueReport, AgingReport, ParticipantBillingReport } from '../types/billing-report.js';
 export interface BillingReportsService {
+    /**
+     * Retrieve the revenue report with optional date range and status filtering.
+     * @param params - Optional date range and status filters.
+     * @returns A RevenueReport containing totals, period info, and breakdowns by month and status.
+     */
     getRevenueReport(params?: BillingReportParams): Promise<RevenueReport>;
+    /**
+     * Retrieve the aging report for outstanding billings.
+     * @returns An AgingReport with amounts bucketed by days outstanding (current, 30, 60, 90, 90+) and individual items.
+     */
     getAgingReport(): Promise<AgingReport>;
+    /**
+     * Retrieve billing report for a specific participant.
+     * @param participantEmail - The email address of the participant.
+     * @returns A ParticipantBillingReport with billing totals and session details for the participant.
+     */
     getParticipantReport(participantEmail: string): Promise<ParticipantBillingReport>;
 }
 export declare function createBillingReportsService(transport: Transport, _config: {

package/dist/src/lib/services/billing-reports.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"billing-reports.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/billing-reports.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACvE,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACvC,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACnF;AAED,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,qBAAqB,CA8DnH"}
+{"version":3,"file":"billing-reports.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/billing-reports.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEvE;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAEvC;;;;OAIG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACnF;AAED,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,qBAAqB,CA8DnH"}

package/dist/src/lib/services/busy-blocks.service.d.ts

@@ -1,8 +1,26 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { BusyBlock, CreateBusyBlockRequest, ListBusyBlocksParams } from '../types/busy-block.js';
 export interface BusyBlocksService {
+    /**
+     * List busy blocks for a specific user with optional filtering, pagination, and sorting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param params - Optional filtering (status, startTime, endTime, search), pagination, and sorting.
+     * @returns Paginated result containing BusyBlock objects and metadata.
+     */
     list(userUniqueId: string, params?: ListBusyBlocksParams): Promise<PageResult<BusyBlock>>;
+    /**
+     * Create a new busy block for a user, marking a time range as unavailable.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param data - The busy block creation payload with title, time range, all-day flag, and recurrence settings.
+     * @returns The newly created BusyBlock object.
+     */
     create(userUniqueId: string, data: CreateBusyBlockRequest): Promise<BusyBlock>;
+    /**
+     * Delete a busy block for a user, freeing up the time range.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param uniqueId - The unique identifier of the busy block to delete.
+     * @returns Resolves when the busy block has been deleted.
+     */
     delete(userUniqueId: string, uniqueId: string): Promise<void>;
 }
 export declare function createBusyBlocksService(transport: Transport, _config: {

package/dist/src/lib/services/busy-blocks.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"busy-blocks.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/busy-blocks.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,SAAS,EACT,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1F,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/E,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAoC3G"}
+{"version":3,"file":"busy-blocks.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/busy-blocks.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,SAAS,EACT,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAGhC,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAoC3G"}

package/dist/src/lib/services/calendar-accounts.service.d.ts

@@ -1,12 +1,55 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { CalendarAccount, CreateCalendarAccountRequest, UpdateCalendarAccountRequest, ListCalendarAccountsParams, SyncCalendarRequest, SyncCalendarResponse } from '../types/calendar-account.js';
 export interface CalendarAccountsService {
+    /**
+     * List calendar accounts for a specific user with optional filtering, pagination, and sorting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param params - Optional filtering (status, provider, syncEnabled, search), pagination, and sorting.
+     * @returns Paginated result containing CalendarAccount objects and metadata.
+     */
     list(userUniqueId: string, params?: ListCalendarAccountsParams): Promise<PageResult<CalendarAccount>>;
+    /**
+     * Retrieve a single calendar account for a user.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param uniqueId - The unique identifier of the calendar account.
+     * @returns The matching CalendarAccount object.
+     */
     get(userUniqueId: string, uniqueId: string): Promise<CalendarAccount>;
+    /**
+     * Create a new calendar account for a user.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param data - The calendar account creation payload with provider, email, tokens, and sync settings.
+     * @returns The newly created CalendarAccount object.
+     */
     create(userUniqueId: string, data: CreateCalendarAccountRequest): Promise<CalendarAccount>;
+    /**
+     * Update an existing calendar account for a user.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param uniqueId - The unique identifier of the calendar account to update.
+     * @param data - The fields to update on the calendar account.
+     * @returns The updated CalendarAccount object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(userUniqueId: string, uniqueId: string, data: UpdateCalendarAccountRequest): Promise<CalendarAccount>;
+    /**
+     * Delete a calendar account for a user.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param uniqueId - The unique identifier of the calendar account to delete.
+     * @returns Resolves when the calendar account has been deleted.
+     */
     delete(userUniqueId: string, uniqueId: string): Promise<void>;
+    /**
+     * Trigger a calendar sync for a specific user's calendar accounts.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param request - Optional sync parameters (forceRefresh, date range).
+     * @returns A SyncCalendarResponse with sync results.
+     */
     syncUser(userUniqueId: string, request?: SyncCalendarRequest): Promise<SyncCalendarResponse>;
+    /**
+     * Trigger a calendar sync for all calendar accounts across the tenant.
+     * @param request - Optional sync parameters (forceRefresh, date range).
+     * @returns A SyncCalendarResponse with sync results.
+     */
     syncTenant(request?: SyncCalendarRequest): Promise<SyncCalendarResponse>;
 }
 export declare function createCalendarAccountsService(transport: Transport, _config: {

package/dist/src/lib/services/calendar-accounts.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calendar-accounts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/calendar-accounts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,eAAe,EACf,4BAA4B,EAC5B,4BAA4B,EAC5B,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,8BAA8B,CAAC;AAGtC,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;IACtG,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACtE,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3F,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7G,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7F,UAAU,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC1E;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,uBAAuB,CAgFvH"}
+{"version":3,"file":"calendar-accounts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/calendar-accounts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,eAAe,EACf,4BAA4B,EAC5B,4BAA4B,EAC5B,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,8BAA8B,CAAC;AAGtC,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;IAEtG;;;;;OAKG;IACH,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE3F;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE7G;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE7F;;;;OAIG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC1E;AAED,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,uBAAuB,CAgFvH"}

package/dist/src/lib/services/calendar-sync.service.d.ts

@@ -6,7 +6,16 @@ export interface CalendarSyncResult {
     syncedAt: Date;
 }
 export interface CalendarSyncService {
+    /**
+     * Trigger a calendar sync for a specific user.
+     * @param userUniqueId - The unique identifier of the user whose calendar to sync.
+     * @returns A CalendarSyncResult indicating success status, number of synced events, any errors, and sync timestamp.
+     */
     syncUser(userUniqueId: string): Promise<CalendarSyncResult>;
+    /**
+     * Trigger a calendar sync for the entire tenant.
+     * @returns A CalendarSyncResult indicating success status, number of synced events, any errors, and sync timestamp.
+     */
     syncTenant(): Promise<CalendarSyncResult>;
 }
 export declare function createCalendarSyncService(transport: Transport, _config: {

package/dist/src/lib/services/calendar-sync.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calendar-sync.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/calendar-sync.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC5D,UAAU,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC3C;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,mBAAmB,CAsB/G"}
+{"version":3,"file":"calendar-sync.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/calendar-sync.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE5D;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC3C;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,mBAAmB,CAsB/G"}

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

@@ -1,10 +1,37 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { Category, CreateCategoryRequest, UpdateCategoryRequest, ListCategoriesParams } from '../types/category.js';
 export interface CategoriesService {
+    /**
+     * List categories with optional filtering, pagination, and sorting.
+     * @param params - Optional filtering (status, parentUniqueId, search), pagination, and sorting parameters.
+     * @returns Paginated result containing Category objects and metadata.
+     */
     list(params?: ListCategoriesParams): Promise<PageResult<Category>>;
+    /**
+     * Retrieve a single category by its unique identifier.
+     * @param uniqueId - The unique identifier of the category.
+     * @returns The matching Category object.
+     */
     get(uniqueId: string): Promise<Category>;
+    /**
+     * Create a new category.
+     * @param data - The category creation payload including name, code, and optional hierarchy/display fields.
+     * @returns The newly created Category object.
+     */
     create(data: CreateCategoryRequest): Promise<Category>;
+    /**
+     * Update an existing category.
+     * @param uniqueId - The unique identifier of the category to update.
+     * @param data - The fields to update on the category.
+     * @returns The updated Category object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(uniqueId: string, data: UpdateCategoryRequest): Promise<Category>;
+    /**
+     * Delete a category.
+     * @param uniqueId - The unique identifier of the category to delete.
+     * @returns Resolves when the category has been deleted.
+     */
     delete(uniqueId: string): Promise<void>;
 }
 export declare function createCategoriesService(transport: Transport, _config: {

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

@@ -1 +1 @@
-{"version":3,"file":"categories.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/categories.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAG9B,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnE,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;CACzC;AAED,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CA0D3G"}
+{"version":3,"file":"categories.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/categories.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAG9B,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEnE;;;;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;CACzC;AAED,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CA0D3G"}

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

@@ -1,6 +1,11 @@
 import type { Transport } from '@23blocks/contracts';
 import type { UnsubscribeRequest, UnsubscribeResponse } from '../types/communication.js';
 export interface CommunicationsService {
+    /**
+     * Unsubscribe an email address from communications.
+     * @param data - The unsubscribe request containing email, optional reason, and campaign ID.
+     * @returns An UnsubscribeResponse with success status, email, and unsubscription timestamp.
+     */
     unsubscribe(data: UnsubscribeRequest): Promise<UnsubscribeResponse>;
 }
 export declare function createCommunicationsService(transport: Transport, _config: {

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

@@ -1 +1 @@
-{"version":3,"file":"communications.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/communications.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEzF,MAAM,WAAW,qBAAqB;IACpC,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACrE;AAED,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,qBAAqB,CAkBnH"}
+{"version":3,"file":"communications.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/communications.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEzF,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACrE;AAED,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,qBAAqB,CAkBnH"}

package/dist/src/lib/services/contact-events.service.d.ts

@@ -1,18 +1,93 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { ContactEvent, CreateContactEventRequest, UpdateContactEventRequest, ListContactEventsParams, ConfirmationRequest, CheckinRequest, CheckoutRequest, EventNotesRequest } from '../types/contact-event.js';
 export interface ContactEventsService {
+    /**
+     * List contact events with optional filtering, pagination, and sorting.
+     * @param params - Optional filtering (status, eventType, contactUniqueId, userUniqueId), pagination, and sorting.
+     * @returns Paginated result containing ContactEvent objects and metadata.
+     */
     list(params?: ListContactEventsParams): Promise<PageResult<ContactEvent>>;
+    /**
+     * Retrieve a single contact event by its unique identifier.
+     * @param uniqueId - The unique identifier of the contact event.
+     * @returns The matching ContactEvent object.
+     */
     get(uniqueId: string): Promise<ContactEvent>;
+    /**
+     * Create a new contact event.
+     * @param data - The event creation payload with contact, user, type, and scheduling details.
+     * @returns The newly created ContactEvent object.
+     */
     create(data: CreateContactEventRequest): Promise<ContactEvent>;
+    /**
+     * Update an existing contact event.
+     * @param uniqueId - The unique identifier of the event to update.
+     * @param data - The fields to update on the event.
+     * @returns The updated ContactEvent object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(uniqueId: string, data: UpdateContactEventRequest): Promise<ContactEvent>;
+    /**
+     * Delete a contact event.
+     * @param uniqueId - The unique identifier of the event to delete.
+     * @returns Resolves when the event has been deleted.
+     */
     delete(uniqueId: string): Promise<void>;
+    /**
+     * Record a student confirmation for a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - Optional confirmation payload with notes.
+     * @returns The updated ContactEvent object reflecting the student confirmation.
+     */
     studentConfirmation(uniqueId: string, request?: ConfirmationRequest): Promise<ContactEvent>;
+    /**
+     * Record a student check-in for a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - Optional check-in payload with notes.
+     * @returns The updated ContactEvent object reflecting the student check-in.
+     */
     studentCheckin(uniqueId: string, request?: CheckinRequest): Promise<ContactEvent>;
+    /**
+     * Record a teacher confirmation for a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - Optional confirmation payload with notes.
+     * @returns The updated ContactEvent object reflecting the teacher confirmation.
+     */
     teacherConfirmation(uniqueId: string, request?: ConfirmationRequest): Promise<ContactEvent>;
+    /**
+     * Record a teacher check-in for a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - Optional check-in payload with notes.
+     * @returns The updated ContactEvent object reflecting the teacher check-in.
+     */
     teacherCheckin(uniqueId: string, request?: CheckinRequest): Promise<ContactEvent>;
+    /**
+     * Record a teacher/employee checkout for a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - Optional checkout payload with notes.
+     * @returns The updated ContactEvent object reflecting the checkout.
+     */
     checkout(uniqueId: string, request?: CheckoutRequest): Promise<ContactEvent>;
+    /**
+     * Record a student checkout for a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - Optional checkout payload with notes.
+     * @returns The updated ContactEvent object reflecting the student checkout.
+     */
     checkoutStudent(uniqueId: string, request?: CheckoutRequest): Promise<ContactEvent>;
+    /**
+     * Add or update student notes on a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - The notes request containing the notes text.
+     * @returns The updated ContactEvent object with the student notes applied.
+     */
     studentNotes(uniqueId: string, request: EventNotesRequest): Promise<ContactEvent>;
+    /**
+     * Add or update admin notes on a contact event.
+     * @param uniqueId - The unique identifier of the event.
+     * @param request - The notes request containing the notes text.
+     * @returns The updated ContactEvent object with the admin notes applied.
+     */
     adminNotes(uniqueId: string, request: EventNotesRequest): Promise<ContactEvent>;
 }
 export declare function createContactEventsService(transport: Transport, _config: {

package/dist/src/lib/services/contact-events.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contact-events.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/contact-events.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,YAAY,EACZ,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AAGnC,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1E,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC7C,MAAM,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/D,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACjF,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC5F,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClF,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC5F,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClF,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC7E,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACpF,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClF,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACjF;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,oBAAoB,CA4IjH"}
+{"version":3,"file":"contact-events.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/contact-events.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,YAAY,EACZ,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AAGnC,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IAE1E;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE7C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEjF;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;OAKG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE5F;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAElF;;;;;OAKG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE5F;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAElF;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEpF;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAElF;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACjF;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,oBAAoB,CA4IjH"}

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

@@ -1,13 +1,57 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { Contact, CreateContactRequest, UpdateContactRequest, ListContactsParams } from '../types/contact.js';
 export interface ContactsService {
+    /**
+     * List contacts with optional filtering, pagination, and sorting.
+     * @param params - Optional filtering (status, contactStatus, search), pagination, and sorting parameters.
+     * @returns Paginated result containing Contact objects and metadata.
+     */
     list(params?: ListContactsParams): Promise<PageResult<Contact>>;
+    /**
+     * Retrieve a single contact by its unique identifier.
+     * @param uniqueId - The unique identifier of the contact.
+     * @returns The matching Contact object.
+     */
     get(uniqueId: string): Promise<Contact>;
+    /**
+     * Create a new contact.
+     * @param data - The contact creation payload with name, email, phone, and other fields.
+     * @returns The newly created Contact object.
+     */
     create(data: CreateContactRequest): Promise<Contact>;
+    /**
+     * Update an existing contact.
+     * @param uniqueId - The unique identifier of the contact to update.
+     * @param data - The fields to update on the contact.
+     * @returns The updated Contact object.
+     * @note Uses PUT (not PATCH) as required by the 23blocks backend.
+     */
     update(uniqueId: string, data: UpdateContactRequest): Promise<Contact>;
+    /**
+     * Soft-delete a contact.
+     * @param uniqueId - The unique identifier of the contact to delete.
+     * @returns Resolves when the contact has been deleted.
+     */
     delete(uniqueId: string): Promise<void>;
+    /**
+     * Recover a previously soft-deleted contact.
+     * @param uniqueId - The unique identifier of the contact to recover.
+     * @returns The recovered Contact object.
+     */
     recover(uniqueId: string): Promise<Contact>;
+    /**
+     * Search contacts by a query string with optional pagination.
+     * @param query - The search query string.
+     * @param params - Optional pagination parameters.
+     * @returns Paginated result containing matching Contact objects.
+     * @note Performs a server-side POST-based search.
+     */
     search(query: string, params?: ListContactsParams): Promise<PageResult<Contact>>;
+    /**
+     * List soft-deleted contacts with optional pagination.
+     * @param params - Optional pagination parameters.
+     * @returns Paginated result containing soft-deleted Contact objects.
+     */
     listDeleted(params?: ListContactsParams): Promise<PageResult<Contact>>;
 }
 export declare function createContactsService(transport: Transport, _config: {

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

@@ -1 +1 @@
-{"version":3,"file":"contacts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/contacts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,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,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IACjF,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;CACxE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CAoFvG"}
+{"version":3,"file":"contacts.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/contacts.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,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;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvE;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;CACxE;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,eAAe,CAoFvG"}

package/dist/src/lib/services/ics-tokens.service.d.ts

@@ -1,8 +1,26 @@
 import type { Transport, PageResult } from '@23blocks/contracts';
 import type { IcsToken, CreateIcsTokenRequest, ListIcsTokensParams } from '../types/ics-token.js';
 export interface IcsTokensService {
+    /**
+     * List ICS tokens for a specific user with optional filtering, pagination, and sorting.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param params - Optional filtering (status, search), pagination, and sorting parameters.
+     * @returns Paginated result containing IcsToken objects and metadata.
+     */
     list(userUniqueId: string, params?: ListIcsTokensParams): Promise<PageResult<IcsToken>>;
+    /**
+     * Create a new ICS token for a user, enabling calendar feed access.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param data - The ICS token creation payload with name, description, and optional expiration.
+     * @returns The newly created IcsToken object containing the generated token value.
+     */
     create(userUniqueId: string, data: CreateIcsTokenRequest): Promise<IcsToken>;
+    /**
+     * Delete an ICS token for a user, revoking calendar feed access.
+     * @param userUniqueId - The unique identifier of the user.
+     * @param uniqueId - The unique identifier of the ICS token to delete.
+     * @returns Resolves when the ICS token has been deleted.
+     */
     delete(userUniqueId: string, uniqueId: string): Promise<void>;
 }
 export declare function createIcsTokensService(transport: Transport, _config: {

package/dist/src/lib/services/ics-tokens.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ics-tokens.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/ics-tokens.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxF,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7E,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CA8BzG"}
+{"version":3,"file":"ics-tokens.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/ics-tokens.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjE,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExF;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7E;;;;;OAKG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/D;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,gBAAgB,CA8BzG"}