@unboundcx/sdk 4.13.23 → 4.13.25

package/index.js

@@ -20,6 +20,7 @@ import { ContentService } from './services/content.js';
 import { VerificationService } from './services/verification.js';
 import { PortalsService } from './services/portals.js';
 import { SipEndpointsService } from './services/sipEndpoints.js';
+import { WebchatService } from './services/webchat.js';
 import { ExternalOAuthService } from './services/externalOAuth.js';
 import { GoogleCalendarService } from './services/googleCalendar.js';
 import { DriveService } from './services/drive.js';
@@ -105,6 +106,7 @@ class UnboundSDK extends BaseSDK {
     this.verification = new VerificationService(this);
     this.portals = new PortalsService(this);
     this.sipEndpoints = new SipEndpointsService(this);
+    this.webchat = new WebchatService(this);
     this.externalOAuth = new ExternalOAuthService(this);
     this.googleCalendar = new GoogleCalendarService(this);
     this.drive = new DriveService(this);
@@ -297,6 +299,11 @@ export {
 export { VerificationService } from './services/verification.js';
 export { PortalsService } from './services/portals.js';
 export { SipEndpointsService } from './services/sipEndpoints.js';
+export {
+  WebchatService,
+  WebchatWidgetsService,
+  WebchatWidgetKeysService,
+} from './services/webchat.js';
 export { ExternalOAuthService } from './services/externalOAuth.js';
 export { GoogleCalendarService } from './services/googleCalendar.js';
 export { DriveService } from './services/drive.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.13.23",
+  "version": "4.13.25",
   "description": "Official JavaScript SDK for the Unbound API - A comprehensive toolkit for integrating with Unbound's communication, AI, and data management services",
   "main": "index.js",
   "type": "module",

package/services/messaging/EmailService.js

@@ -63,6 +63,8 @@ export class EmailService {
    * @param {boolean} [params.tracking=true] - Enable email tracking (opens, clicks)
    * @param {string} [params.mailboxId] - Specific mailbox to send from
    * @param {string} [params.draftId] - Convert existing draft to sent email
+   * @param {string} [params.engagementSessionId] - Engagement to attach this email to
+   * @param {string} [params.taskId] - Task the email was sent under (multi-channel-per-task attribution)
    * @returns {Promise<Object>} Email send result with ID and threading info
    */
   async send({
@@ -86,6 +88,7 @@ export class EmailService {
     mailboxId,
     draftId,
     engagementSessionId,
+    taskId,
   }) {
     // Validate required params (relaxed when using draftId)
     if (!draftId) {
@@ -118,6 +121,7 @@ export class EmailService {
         mailboxId,
         draftId,
         engagementSessionId,
+        taskId,
       },
       {
         html: { type: 'string', required: false },
@@ -135,6 +139,7 @@ export class EmailService {
         mailboxId: { type: 'string', required: false },
         draftId: { type: 'string', required: false },
         engagementSessionId: { type: 'string', required: false },
+        taskId: { type: 'string', required: false },
       },
     );
 
@@ -161,6 +166,7 @@ export class EmailService {
     if (draftId) emailData.draftId = draftId;
     if (engagementSessionId)
       emailData.engagementSessionId = engagementSessionId;
+    if (taskId) emailData.taskId = taskId;
 
     const options = {
       body: emailData,

package/services/messaging/SmsService.js

@@ -19,6 +19,8 @@ export class SmsService {
    * @param {string} [params.webhookUrl] - Webhook URL for delivery status
    * @param {string} [params.relatedId] - Task/engagement (or other record) id
    *   to attach this message to, so it surfaces on that record's feed
+   * @param {string} [params.engagementSessionId] - Engagement to attach this message to
+   * @param {string} [params.taskId] - Task the message was sent under (multi-channel-per-task attribution)
    * @returns {Promise<Object>} Message details
    */
   async send({
@@ -30,6 +32,8 @@ export class SmsService {
     mediaUrls,
     webhookUrl,
     relatedId,
+    engagementSessionId,
+    taskId,
   }) {
     const messageData = {};
     if (from) messageData.from = from;
@@ -39,6 +43,8 @@ export class SmsService {
     if (mediaUrls) messageData.mediaUrls = mediaUrls;
     if (webhookUrl) messageData.webhookUrl = webhookUrl;
     if (relatedId) messageData.relatedId = relatedId;
+    if (engagementSessionId) messageData.engagementSessionId = engagementSessionId;
+    if (taskId) messageData.taskId = taskId;
 
     this.sdk.validateParams(
       { to, ...messageData },
@@ -51,6 +57,8 @@ export class SmsService {
         mediaUrls: { type: 'array', required: false },
         webhookUrl: { type: 'string', required: false },
         relatedId: { type: 'string', required: false },
+        engagementSessionId: { type: 'string', required: false },
+        taskId: { type: 'string', required: false },
       },
     );
 

package/services/objects.js

@@ -372,6 +372,7 @@ export class ObjectsService {
    * @param {string} args.object
    * @param {object} args.where
    * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @param {object} [args.options] - Extra delete options (e.g. { deleteEmails: true })
    * @returns {Promise} Delete result
    *
    * @example
@@ -379,15 +380,17 @@ export class ObjectsService {
    *   object: 'people',
    *   where: { id: '013…' },
    *   skipTriggers: true,
+   *   options: { deleteEmails: true },
    * });
    */
-  async delete({ object, where, skipTriggers = false }) {
+  async delete({ object, where, skipTriggers = false, options }) {
     this.sdk.validateParams(
-      { object, where, skipTriggers },
+      { object, where, skipTriggers, options },
       {
         object: { type: 'string', required: true },
         where: { type: 'object', required: true },
         skipTriggers: { type: 'boolean', required: false },
+        options: { type: 'object', required: false },
       },
     );
 
@@ -396,6 +399,7 @@ export class ObjectsService {
         where,
       },
     };
+    if (options) params.body.options = options;
     if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await internalRequest(this.sdk, `/object/${object}`, 'DELETE', params);
@@ -409,18 +413,25 @@ export class ObjectsService {
    * @param {string} args.object
    * @param {string} args.id
    * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @param {object} [args.options] - Extra delete options (e.g. { deleteEmails: true })
    * @returns {Promise} Delete result
    *
    * @example
-   * await sdk.objects.deleteById({ object: 'people', id: '013…', skipTriggers: true });
+   * await sdk.objects.deleteById({
+   *   object: 'people',
+   *   id: '013…',
+   *   skipTriggers: true,
+   *   options: { deleteEmails: true },
+   * });
    */
-  async deleteById({ object, id, skipTriggers = false }) {
+  async deleteById({ object, id, skipTriggers = false, options }) {
     this.sdk.validateParams(
-      { object, id, skipTriggers },
+      { object, id, skipTriggers, options },
       {
         object: { type: 'string', required: true },
         id: { type: 'string', required: true },
         skipTriggers: { type: 'boolean', required: false },
+        options: { type: 'object', required: false },
       },
     );
 
@@ -431,12 +442,84 @@ export class ObjectsService {
         },
       },
     };
+    if (options) params.body.options = options;
     if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await internalRequest(this.sdk, `/object/${object}`, 'DELETE', params);
     return result;
   }
 
+  /**
+   * Merge 1–3 records into a survivor record. people|company only (v1 gate,
+   * enforced server-side). Related-record cleanup runs sync (owned child rows)
+   * + async (high-volume history) after the survivor is updated and the
+   * losers are deleted.
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {string} args.survivorId - Record that remains after the merge.
+   * @param {string[]} args.mergeIds - 1-3 ids to merge into the survivor (then deleted).
+   * @param {object} [args.fields] - Map of column -> the record id whose value wins.
+   *   Omitted columns keep the survivor's value.
+   * @returns {Promise<{survivorId: string, queued: boolean}>}
+   *
+   * @example
+   * await sdk.objects.merge({
+   *   object: 'people',
+   *   survivorId: '013…',
+   *   mergeIds: ['014…', '015…'],
+   *   fields: { firstName: '014…', email: '015…' },
+   * });
+   */
+  async merge({ object, survivorId, mergeIds, fields }) {
+    this.sdk.validateParams(
+      { object, survivorId, mergeIds, fields },
+      {
+        object: { type: 'string', required: true },
+        survivorId: { type: 'string', required: true },
+        mergeIds: { type: 'array', required: true },
+        fields: { type: 'object', required: false },
+      },
+    );
+
+    const body = { survivorId, mergeIds };
+    if (fields) body.fields = fields;
+
+    const params = { body };
+
+    const result = await internalRequest(this.sdk, `/object/${object}/merge`, 'POST', params);
+    return result;
+  }
+
+  /**
+   * Get merge backfill status for a record (pending Bucket B re-point count
+   * from the recordMerges ledger).
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {string} args.id
+   * @returns {Promise<{pending: number, lastMergedAt: string|null}>}
+   *
+   * @example
+   * await sdk.objects.mergeStatus({ object: 'people', id: '013…' });
+   */
+  async mergeStatus({ object, id }) {
+    this.sdk.validateParams(
+      { object, id },
+      {
+        object: { type: 'string', required: true },
+        id: { type: 'string', required: true },
+      },
+    );
+
+    const result = await internalRequest(
+      this.sdk,
+      `/object/${object}/merge-status/${id}`,
+      'GET',
+    );
+    return result;
+  }
+
   /**
    * List saved list-views for an object (system + shared + own).
    * @param {Object} params

package/services/portals.js

@@ -86,6 +86,26 @@ export class PortalsService {
    * @param {string} [updates.name] - New display name for the portal.
    * @param {string} [updates.domain] - New custom domain for the portal.
    * @param {object} [updates.settings] - Updated portal configuration settings.
+   * @param {object} [updates.settings.profile] - P11.2: visitor-editable
+   *   profile fields. `{ people: { enabled, fields: [{ name, editable }] },
+   *   company: { enabled, fields: [{ name, editable }], editorMode,
+   *   editorFilter } }`. `fields` (max 40 each) is the allowlist of
+   *   people/company columns exposed on the portal's `GET /portal-profile` —
+   *   never system columns (id/*At/*By/isDeleted/recordTypeId), foreign
+   *   keys, or encrypted fields (the API 400s on save otherwise).
+   *   `company.editorMode` is `'none'|'all'|'rules'` — whether a signed-in
+   *   visitor may edit their OWN company record: nobody / everyone signed
+   *   in / only people matching `editorFilter` (same `{'<field>::<op>':
+   *   value}` AND-map as `settings.peopleFilter`, ≥1 rule required for
+   *   `'rules'`). A per-person override (people custom field
+   *   `portalCompanyEdit__c`, `'allow'|'deny'`, set via `sdk.objects.update`)
+   *   wins over `editorMode`/`editorFilter` when present.
+   * @param {string} [updates.settings.companyTicketsMode] - `'none'|'all'|'rules'`
+   *   — successor to the legacy `settings.companyTickets` boolean
+   *   (`true`→`'all'`, `false`→`'none'`); same 3-way shape as
+   *   `settings.profile.company.editorMode` above, paired with
+   *   `settings.companyTicketsFilter`. Prefer this over the boolean going
+   *   forward — both may be sent, `companyTicketsMode` wins.
    * @param {boolean} [updates.isPublic] - Updated public accessibility flag.
    * @param {string} [updates.customCss] - Updated custom CSS for the portal.
    * @param {string} [updates.customJs] - Updated custom JavaScript for the portal.

package/services/webchat.js

@@ -0,0 +1,172 @@
+import { internalRequest } from '../base.js';
+
+// WebChat P0: agent-facing widget CRUD. Endpoints live under
+// /webchat/widgets/ (checkApiAuth) -- deliberately not bare /webchat/, which
+// is reserved for the future unauthenticated visitor surface (plan §5).
+export class WebchatWidgetKeysService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List signing keys for a widget.
+   * @param {string} widgetId
+   * @returns {Promise<Array<Object>>}
+   */
+  async list(widgetId) {
+    this.sdk.validateParams(
+      { widgetId },
+      { widgetId: { type: 'string', required: true } },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/webchat/widgets/${widgetId}/keys`,
+      'GET',
+    );
+  }
+
+  /**
+   * Create a signing key for a widget. The token is server-generated and
+   * returned once in this response only.
+   * @param {string} widgetId
+   * @param {Object} [options]
+   * @param {string[]} [options.urls] - allowlisted origins/domains for this key
+   * @returns {Promise<Object>}
+   */
+  async create(widgetId, options = {}) {
+    this.sdk.validateParams(
+      { widgetId },
+      { widgetId: { type: 'string', required: true } },
+    );
+
+    const params = { body: { ...options } };
+
+    return internalRequest(
+      this.sdk,
+      `/webchat/widgets/${widgetId}/keys`,
+      'POST',
+      params,
+    );
+  }
+
+  /**
+   * Delete (soft) a widget signing key.
+   * @param {string} widgetId
+   * @param {string} keyId
+   * @returns {Promise<Object>}
+   */
+  async delete(widgetId, keyId) {
+    this.sdk.validateParams(
+      { widgetId, keyId },
+      {
+        widgetId: { type: 'string', required: true },
+        keyId: { type: 'string', required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/webchat/widgets/${widgetId}/keys/${keyId}`,
+      'DELETE',
+    );
+  }
+}
+
+export class WebchatWidgetsService {
+  constructor(sdk) {
+    this.sdk = sdk;
+    this.keys = new WebchatWidgetKeysService(sdk);
+  }
+
+  /**
+   * List WebChat widgets for the authenticated account.
+   * @returns {Promise<Array<Object>>}
+   */
+  async list() {
+    return internalRequest(this.sdk, '/webchat/widgets', 'GET');
+  }
+
+  /**
+   * Get a single WebChat widget by id.
+   * @param {string} widgetId
+   * @returns {Promise<Object>}
+   */
+  async get(widgetId) {
+    this.sdk.validateParams(
+      { widgetId },
+      { widgetId: { type: 'string', required: true } },
+    );
+
+    return internalRequest(this.sdk, `/webchat/widgets/${widgetId}`, 'GET');
+  }
+
+  /**
+   * Create a WebChat widget. identitySecret is always server-generated and
+   * returned once (plaintext) in this response only -- never on list/get.
+   * @param {Object} options
+   * @param {string} options.name
+   * @param {'draft'|'active'|'paused'} [options.status]
+   * @param {'workflow'|'queue'} [options.routeType]
+   * @param {'full'|'first'|'firstLastInitial'} [options.agentNameDisplay]
+   * @returns {Promise<Object>}
+   */
+  async create(options) {
+    this.sdk.validateParams(
+      { name: options?.name },
+      { name: { type: 'string', required: true } },
+    );
+
+    const params = { body: { ...options } };
+
+    return internalRequest(this.sdk, '/webchat/widgets', 'POST', params);
+  }
+
+  /**
+   * Update a WebChat widget. Pass regenerateIdentitySecret:true to rotate
+   * the identity secret (returned once, plaintext, in this response).
+   * @param {string} widgetId
+   * @param {Object} options
+   * @returns {Promise<Object>}
+   */
+  async update(widgetId, options) {
+    this.sdk.validateParams(
+      { widgetId },
+      { widgetId: { type: 'string', required: true } },
+    );
+
+    const params = { body: { ...options } };
+
+    return internalRequest(
+      this.sdk,
+      `/webchat/widgets/${widgetId}`,
+      'PUT',
+      params,
+    );
+  }
+
+  /**
+   * Delete (soft) a WebChat widget.
+   * @param {string} widgetId
+   * @returns {Promise<Object>}
+   */
+  async delete(widgetId) {
+    this.sdk.validateParams(
+      { widgetId },
+      { widgetId: { type: 'string', required: true } },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/webchat/widgets/${widgetId}`,
+      'DELETE',
+    );
+  }
+}
+
+export class WebchatService {
+  constructor(sdk) {
+    this.sdk = sdk;
+    this.widgets = new WebchatWidgetsService(sdk);
+  }
+}