@unboundcx/sdk 4.13.30 → 4.13.32

package/index.js

@@ -22,6 +22,7 @@ import { PortalsService } from './services/portals.js';
 import { DealRegistrationsService } from './services/dealRegistrations.js';
 import { SipEndpointsService } from './services/sipEndpoints.js';
 import { WebchatService } from './services/webchat.js';
+import { MessageTemplatesService } from './services/messageTemplates.js';
 import { ExternalOAuthService } from './services/externalOAuth.js';
 import { GoogleCalendarService } from './services/googleCalendar.js';
 import { DriveService } from './services/drive.js';
@@ -109,6 +110,7 @@ class UnboundSDK extends BaseSDK {
     this.dealRegistrations = new DealRegistrationsService(this);
     this.sipEndpoints = new SipEndpointsService(this);
     this.webchat = new WebchatService(this);
+    this.messageTemplates = new MessageTemplatesService(this);
     this.externalOAuth = new ExternalOAuthService(this);
     this.googleCalendar = new GoogleCalendarService(this);
     this.drive = new DriveService(this);
@@ -303,6 +305,7 @@ export { PortalsService } from './services/portals.js';
 export { DealRegistrationsService } from './services/dealRegistrations.js';
 export { SipEndpointsService } from './services/sipEndpoints.js';
 export { WebchatService, WebchatWidgetsService } from './services/webchat.js';
+export { MessageTemplatesService } from './services/messageTemplates.js';
 export { WebchatVisitorService } from './services/webchat/VisitorService.js';
 export { ExternalOAuthService } from './services/externalOAuth.js';
 export { GoogleCalendarService } from './services/googleCalendar.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.13.30",
+  "version": "4.13.32",
   "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/messageTemplates.js

@@ -0,0 +1,245 @@
+import { internalRequest } from '../base.js';
+
+/**
+ * Account-level stored message template groups. Distinct from SMS
+ * `/messaging/templates/` (messagesSmsMmsTemplates) and email campaign
+ * templates. Widget enablement is `sdk.webchat.widgets.update(widgetId,
+ * { slashConfig })` — two-arg; no extra widget method here.
+ */
+export class MessageTemplateGroupsService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List stored message template groups (ACL-filtered).
+   * @returns {Promise<{results: Object[]}>}
+   */
+  async list() {
+    return internalRequest(this.sdk, '/messageTemplates/groups', 'GET');
+  }
+
+  /**
+   * Get a stored message template group by id.
+   * @param {string} id
+   * @returns {Promise<Object>}
+   */
+  async get(id) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    return internalRequest(this.sdk, `/messageTemplates/groups/${id}`, 'GET');
+  }
+
+  /**
+   * Create a stored message template group.
+   * @param {Object} options
+   * @param {string} options.name
+   * @param {'active'|'archived'} [options.status]
+   * @param {number} [options.sortOrder]
+   * @param {string|null} [options.recordTypeId]
+   * @returns {Promise<Object>}
+   */
+  async create(options) {
+    this.sdk.validateParams(
+      { name: options?.name },
+      { name: { type: 'string', required: true } },
+    );
+
+    return internalRequest(this.sdk, '/messageTemplates/groups', 'POST', {
+      body: { ...options },
+    });
+  }
+
+  /**
+   * Update a stored message template group. Changing recordTypeId
+   * cascades to child templates on the API.
+   * @param {string} id
+   * @param {Object} options
+   * @returns {Promise<Object>}
+   */
+  async update(id, options) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+
+    return internalRequest(this.sdk, `/messageTemplates/groups/${id}`, 'PUT', {
+      body: { ...options },
+    });
+  }
+
+  /**
+   * Soft-delete a group and cascade-soft-delete its templates.
+   * @param {string} id
+   * @returns {Promise<{id: string, deleted: boolean}>}
+   */
+  async delete(id) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    return internalRequest(
+      this.sdk,
+      `/messageTemplates/groups/${id}`,
+      'DELETE',
+    );
+  }
+}
+
+/**
+ * Stored message templates (composer slash replies). Bodies are included
+ * on CRUD; the slash catalog omits them — use expand() to interpolate.
+ */
+export class MessageTemplatesCrudService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List stored message templates (ACL-filtered).
+   * @param {Object} [options]
+   * @param {string} [options.groupId]
+   * @returns {Promise<{results: Object[]}>}
+   */
+  async list(options = {}) {
+    const { groupId } = options;
+    // Omit unset groupId — URLSearchParams would send "undefined" and
+    // the API would 404 looking up that string as a group id.
+    const params = {};
+    if (groupId !== undefined && groupId !== null && groupId !== '') {
+      params.query = { groupId };
+    }
+    return internalRequest(this.sdk, '/messageTemplates/templates', 'GET', params);
+  }
+
+  /**
+   * Get a stored message template by id (includes body).
+   * @param {string} id
+   * @returns {Promise<Object>}
+   */
+  async get(id) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    return internalRequest(
+      this.sdk,
+      `/messageTemplates/templates/${id}`,
+      'GET',
+    );
+  }
+
+  /**
+   * Create a stored message template. slug must be unique among
+   * non-deleted templates account-wide.
+   * @param {Object} options
+   * @param {string} options.groupId
+   * @param {string} options.name
+   * @param {string} options.slug
+   * @param {string} options.body
+   * @param {'draft'|'active'} [options.status]
+   * @param {number} [options.sortOrder]
+   * @returns {Promise<Object>}
+   */
+  async create(options) {
+    this.sdk.validateParams(
+      {
+        groupId: options?.groupId,
+        name: options?.name,
+        slug: options?.slug,
+        body: options?.body,
+      },
+      {
+        groupId: { type: 'string', required: true },
+        name: { type: 'string', required: true },
+        slug: { type: 'string', required: true },
+        body: { type: 'string', required: true },
+      },
+    );
+
+    return internalRequest(this.sdk, '/messageTemplates/templates', 'POST', {
+      body: { ...options },
+    });
+  }
+
+  /**
+   * Update a stored message template.
+   * @param {string} id
+   * @param {Object} options
+   * @returns {Promise<Object>}
+   */
+  async update(id, options) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+
+    return internalRequest(
+      this.sdk,
+      `/messageTemplates/templates/${id}`,
+      'PUT',
+      { body: { ...options } },
+    );
+  }
+
+  /**
+   * Soft-delete a stored message template.
+   * @param {string} id
+   * @returns {Promise<{id: string, deleted: boolean}>}
+   */
+  async delete(id) {
+    this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
+    return internalRequest(
+      this.sdk,
+      `/messageTemplates/templates/${id}`,
+      'DELETE',
+    );
+  }
+}
+
+export class MessageTemplatesService {
+  constructor(sdk) {
+    this.sdk = sdk;
+    this.groups = new MessageTemplateGroupsService(sdk);
+    this.templates = new MessageTemplatesCrudService(sdk);
+  }
+
+  /**
+   * Agent slash palette for a surface. Catalog rows omit body.
+   * Webchat requires engagementSessionId and widget match.
+   * @param {Object} options
+   * @param {'webchat'|'sms'|'email'|'whatsapp'} options.channel
+   * @param {string} options.configId
+   * @param {string} options.engagementSessionId
+   * @returns {Promise<{commands: Object[], templates: Object[]}>}
+   */
+  async slashCatalog({ channel, configId, engagementSessionId }) {
+    this.sdk.validateParams(
+      { channel, configId, engagementSessionId },
+      {
+        channel: { type: 'string', required: true },
+        configId: { type: 'string', required: true },
+        engagementSessionId: { type: 'string', required: true },
+      },
+    );
+
+    return internalRequest(this.sdk, '/messageTemplates/slash-catalog', 'POST', {
+      body: { channel, configId, engagementSessionId },
+    });
+  }
+
+  /**
+   * Interpolate a catalog-visible template for a surface/session.
+   * @param {Object} options
+   * @param {'webchat'|'sms'|'email'|'whatsapp'} options.channel
+   * @param {string} options.configId
+   * @param {string} options.templateId
+   * @param {string} options.engagementSessionId
+   * @returns {Promise<{body: string}>}
+   */
+  async expand({ channel, configId, templateId, engagementSessionId }) {
+    this.sdk.validateParams(
+      { channel, configId, templateId, engagementSessionId },
+      {
+        channel: { type: 'string', required: true },
+        configId: { type: 'string', required: true },
+        templateId: { type: 'string', required: true },
+        engagementSessionId: { type: 'string', required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/messageTemplates/templates/${templateId}/expand`,
+      'POST',
+      { body: { channel, configId, engagementSessionId } },
+    );
+  }
+}

package/services/webchat/VisitorService.js

@@ -37,7 +37,14 @@ class WebchatVisitorSessionService {
    * @param {string} [params.pageUrl]
    * @returns {Promise<{engagementSessionId:string, token:string, resumeToken:string, status:'created'}>}
    */
-  async create({ widgetId, embedGrant, visitorData, pageUrl } = {}) {
+  async create({
+    widgetId,
+    embedGrant,
+    visitorData,
+    pageUrl,
+    trackingId,
+    initialMessage,
+  } = {}) {
     this.sdk.validateParams(
       { widgetId, embedGrant },
       {
@@ -49,7 +56,40 @@ class WebchatVisitorSessionService {
       this.sdk,
       `/webchat/${widgetId}/session`,
       'POST',
-      { body: { embedGrant, visitorData, pageUrl } },
+      {
+        body: {
+          embedGrant,
+          visitorData,
+          pageUrl,
+          trackingId,
+          initialMessage,
+        },
+      },
+      true,
+    );
+  }
+
+  /**
+   * Prefill the pre-chat form from a marketing `_tid` cookie.
+   * @param {Object} params
+   * @param {string} params.widgetId
+   * @param {string} params.embedGrant
+   * @param {string} [params.trackingId]
+   * @returns {Promise<{values: Object}>}
+   */
+  async profile({ widgetId, embedGrant, trackingId } = {}) {
+    this.sdk.validateParams(
+      { widgetId, embedGrant },
+      {
+        widgetId: { type: 'string', required: true },
+        embedGrant: { type: 'string', required: true },
+      },
+    );
+    return internalRequest(
+      this.sdk,
+      `/webchat/${widgetId}/visitor-profile`,
+      'POST',
+      { body: { embedGrant, trackingId } },
       true,
     );
   }