@unboundcx/sdk 4.8.11 → 4.8.13

package/index.js

@@ -30,7 +30,7 @@ import { FaxService } from './services/fax.js';
 import { DocumentsService } from './services/documents.js';
 import { PermissionsService } from './services/permissions.js';
 import { TriggersService } from './services/triggers.js';
-import { InboxService } from './services/inbox.js';
+import { RecentsService } from './services/recents.js';
 import { SearchService } from './services/search.js';
 import { DirectoryService } from './services/directory.js';
 import { ChatService } from './services/chat.js';
@@ -106,7 +106,7 @@ class UnboundSDK extends BaseSDK {
     this.documents = new DocumentsService(this);
     this.permissions = new PermissionsService(this);
     this.triggers = new TriggersService(this);
-    this.inbox = new InboxService(this);
+    this.recents = new RecentsService(this);
     this.search = new SearchService(this);
     this.directory = new DirectoryService(this);
     this.chat = new ChatService(this);
@@ -291,7 +291,7 @@ export { WorkerService } from './services/taskRouter/WorkerService.js';
 export { KnowledgeBaseService } from './services/knowledgeBase.js';
 export { FaxService } from './services/fax.js';
 export { PermissionsService } from './services/permissions.js';
-export { InboxService } from './services/inbox.js';
+export { RecentsService } from './services/recents.js';
 export { SearchService } from './services/search.js';
 export { DirectoryService } from './services/directory.js';
 export { ChatService } from './services/chat.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.8.11",
+  "version": "4.8.13",
   "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/chat.js

@@ -2,7 +2,8 @@ import { internalRequest } from '../base.js';
 /**
  * ChatService — channels, DMs, membership, unreads, DND, messages, search,
  * webhooks, card actions, reports, admin review, admin export, record feeds,
- * channel meet, push devices, and notifyLevel.
+ * channel meet, threads, bots, group default channels, push devices, and
+ * notifyLevel.
  * Backed by /chat/* on app1-api (checkApiAuth). Incoming webhook POST
  * (HMAC) is external and is not an SDK method.
  */
@@ -77,14 +78,15 @@ export class ChatService {
    * @param {Object} [params.settings]
    * @returns {Promise<Object>}
    */
-  async updateChannel(id, { name, topic, settings } = {}) {
+  async updateChannel(id, { name, topic, settings, kind } = {}) {
     this.sdk.validateParams(
-      { id, name, topic, settings },
+      { id, name, topic, settings, kind },
       {
         id: { type: 'string', required: true },
         name: { type: 'string', required: false },
         topic: { type: 'string', required: false },
         settings: { type: 'object', required: false },
+        kind: { type: 'string', required: false },
       },
     );
 
@@ -92,6 +94,7 @@ export class ChatService {
     if (name !== undefined) body.name = name;
     if (topic !== undefined) body.topic = topic;
     if (settings !== undefined) body.settings = settings;
+    if (kind !== undefined) body.kind = kind;
 
     return internalRequest(this.sdk, `/chat/channels/${id}`, 'PATCH', { body });
   }
@@ -265,6 +268,30 @@ export class ChatService {
     return internalRequest(this.sdk, '/chat/dnd', 'PATCH', { body: { enabled } });
   }
 
+  /**
+   * Favorite reaction emojis for the current user.
+   * @returns {Promise<Object>}
+   */
+  async getEmojiFavorites() {
+    return internalRequest(this.sdk, '/chat/emoji-favorites', 'GET');
+  }
+
+  /**
+   * Replace the caller's favorite reaction emojis.
+   * @param {Object} params
+   * @param {string[]} params.emojis
+   * @returns {Promise<Object>}
+   */
+  async setEmojiFavorites({ emojis } = {}) {
+    this.sdk.validateParams(
+      { emojis },
+      { emojis: { type: 'array', required: true } },
+    );
+    return internalRequest(this.sdk, '/chat/emoji-favorites', 'PATCH', {
+      body: { emojis },
+    });
+  }
+
   /**
    * Advance the read watermark and recompute unread counters.
    * @param {string} channelId
@@ -361,20 +388,45 @@ export class ChatService {
    * @param {string} [params.threadRootId]
    * @param {boolean} [params.alsoSendToChannel]
    * @param {string[]} [params.storageIds]
+   * @param {string[]} [params.tools]
+   * @param {Object} [params.toolConfig]
    * @returns {Promise<Object>} Created message
    */
   async sendMessage(
     channelId,
-    { message, threadRootId, alsoSendToChannel, storageIds } = {},
+    {
+      message,
+      threadRootId,
+      alsoSendToChannel,
+      storageIds,
+      suppressUnfurlUrls,
+      unfurls,
+      tools,
+      toolConfig,
+    } = {},
   ) {
     this.sdk.validateParams(
-      { channelId, message, threadRootId, alsoSendToChannel, storageIds },
+      {
+        channelId,
+        message,
+        threadRootId,
+        alsoSendToChannel,
+        storageIds,
+        suppressUnfurlUrls,
+        unfurls,
+        tools,
+        toolConfig,
+      },
       {
         channelId: { type: 'string', required: true },
         message: { type: 'object', required: true },
         threadRootId: { type: 'string', required: false },
         alsoSendToChannel: { type: 'boolean', required: false },
         storageIds: { type: 'array', required: false },
+        suppressUnfurlUrls: { type: 'array', required: false },
+        unfurls: { type: 'array', required: false },
+        tools: { type: 'array', required: false },
+        toolConfig: { type: 'object', required: false },
       },
     );
 
@@ -384,6 +436,12 @@ export class ChatService {
       body.alsoSendToChannel = alsoSendToChannel;
     }
     if (storageIds !== undefined) body.storageIds = storageIds;
+    if (suppressUnfurlUrls !== undefined) {
+      body.suppressUnfurlUrls = suppressUnfurlUrls;
+    }
+    if (unfurls !== undefined) body.unfurls = unfurls;
+    if (tools !== undefined) body.tools = tools;
+    if (toolConfig !== undefined) body.toolConfig = toolConfig;
 
     return internalRequest(this.sdk, `/chat/channels/${channelId}/messages`, 'POST', {
       body,
@@ -410,6 +468,44 @@ export class ChatService {
     });
   }
 
+  /**
+   * Fetch Open Graph data for a URL (composer preview).
+   * @param {Object} params
+   * @param {string} params.url
+   * @returns {Promise<Object>}
+   */
+  async previewLink({ url } = {}) {
+    this.sdk.validateParams({ url }, { url: { type: 'string', required: true } });
+    return internalRequest(
+      this.sdk,
+      `/chat/link-preview?url=${encodeURIComponent(url)}`,
+      'GET',
+    );
+  }
+
+  /**
+   * Hide a link preview on a message.
+   * @param {string} id
+   * @param {Object} params
+   * @param {string} params.url
+   * @returns {Promise<Object>}
+   */
+  async hideUnfurl(id, { url } = {}) {
+    this.sdk.validateParams(
+      { id, url },
+      {
+        id: { type: 'string', required: true },
+        url: { type: 'string', required: true },
+      },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/messages/${id}/unfurls/hide`,
+      'POST',
+      { body: { url } },
+    );
+  }
+
   /**
    * Delete a message (tombstone).
    * @param {string} id
@@ -895,6 +991,289 @@ export class ChatService {
     return internalRequest(this.sdk, `/chat/pins/${id}`, 'DELETE');
   }
 
+  /**
+   * Pin a message to the top of a channel/feed.
+   * @param {string} channelId
+   * @param {Object} params
+   * @param {string} params.messageId
+   * @returns {Promise<Object>}
+   */
+  async pinMessage(channelId, { messageId } = {}) {
+    this.sdk.validateParams(
+      { channelId, messageId },
+      {
+        channelId: { type: 'string', required: true },
+        messageId: { type: 'string', required: true },
+      },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/pinned-message`,
+      'PUT',
+      { body: { messageId } },
+    );
+  }
+
+  /**
+   * Clear the pinned message on a channel/feed.
+   * @param {string} channelId
+   * @returns {Promise<Object>}
+   */
+  async unpinMessage(channelId) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/pinned-message`,
+      'DELETE',
+    );
+  }
+
+  /**
+   * List messages that mention the caller.
+   * @param {Object} [params]
+   * @param {'public'|'private'|'dm'|'group_dm'|'record'} [params.kind]
+   * @param {number} [params.limit]
+   * @returns {Promise<Object>}
+   */
+  async listMentions({ kind, limit } = {}) {
+    const query = {};
+    if (kind) query.kind = kind;
+    if (limit != null) query.limit = limit;
+    return internalRequest(this.sdk, '/chat/mentions', 'GET', { query });
+  }
+
+  /**
+   * List thread roots the caller participates in.
+   * @param {Object} [params]
+   * @param {'public'|'private'|'dm'|'group_dm'|'record'} [params.kind]
+   * @param {number} [params.limit]
+   * @returns {Promise<Object>}
+   */
+  async listThreads({ kind, limit } = {}) {
+    const query = {};
+    if (kind) query.kind = kind;
+    if (limit != null) query.limit = limit;
+    return internalRequest(this.sdk, '/chat/threads', 'GET', { query });
+  }
+
+  /**
+   * List default channels for a group (auto-join on membership).
+   * @param {string} groupId
+   * @returns {Promise<Object>}
+   */
+  async getGroupDefaultChannels(groupId) {
+    this.sdk.validateParams(
+      { groupId },
+      { groupId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/groups/${groupId}/default-channels`,
+      'GET',
+    );
+  }
+
+  /**
+   * Replace default channels for a group.
+   * @param {string} groupId
+   * @param {Object} [params]
+   * @param {string[]} [params.channelIds]
+   * @returns {Promise<Object>}
+   */
+  async setGroupDefaultChannels(groupId, { channelIds } = {}) {
+    this.sdk.validateParams(
+      { groupId, channelIds },
+      {
+        groupId: { type: 'string', required: true },
+        channelIds: { type: 'array', required: false },
+      },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/groups/${groupId}/default-channels`,
+      'PUT',
+      { body: { channelIds } },
+    );
+  }
+
+  /**
+   * Create a Meet/Call room for a channel.
+   * @param {string} channelId
+   * @returns {Promise<Object>}
+   */
+  async createChannelMeet(channelId) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/meet`,
+      'POST',
+      { body: {} },
+    );
+  }
+
+  /**
+   * Update a channel Meet/Call room.
+   * @param {string} channelId
+   * @param {Object} [patch]
+   * @param {string} [patch.slug]
+   * @param {string} [patch.password]
+   * @param {boolean} [patch.guestsCanStart]
+   * @param {boolean} [patch.startRecordingOn]
+   * @param {boolean} [patch.startTranscribingOn]
+   * @param {number} [patch.endMeetingWithoutHostTimeLimit]
+   * @returns {Promise<Object>}
+   */
+  async updateChannelMeet(channelId, patch = {}) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    const body = {};
+    for (const key of [
+      'slug',
+      'password',
+      'guestsCanStart',
+      'startRecordingOn',
+      'startTranscribingOn',
+      'endMeetingWithoutHostTimeLimit',
+    ]) {
+      if (patch[key] !== undefined) body[key] = patch[key];
+    }
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/meet`,
+      'PATCH',
+      { body },
+    );
+  }
+
+  /**
+   * Check whether a Meet slug is available for a channel.
+   * @param {string} channelId
+   * @param {string} slug
+   * @returns {Promise<Object>}
+   */
+  async checkChannelMeetSlug(channelId, slug) {
+    this.sdk.validateParams(
+      { channelId, slug },
+      {
+        channelId: { type: 'string', required: true },
+        slug: { type: 'string', required: true },
+      },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/meet/slug-available`,
+      'GET',
+      { query: { slug } },
+    );
+  }
+
+  /**
+   * Regenerate the Meet room password for a channel.
+   * @param {string} channelId
+   * @returns {Promise<Object>}
+   */
+  async regenerateChannelMeetPassword(channelId) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/meet/regenerate-password`,
+      'POST',
+      { body: {} },
+    );
+  }
+
+  /**
+   * List chat bots for the account.
+   * @returns {Promise<Object>}
+   */
+  async listBots() {
+    return internalRequest(this.sdk, '/chat/bots', 'GET');
+  }
+
+  /**
+   * Update a chat bot.
+   * @param {string} id
+   * @param {Object} [params]
+   * @param {string} [params.name]
+   * @returns {Promise<Object>}
+   */
+  async updateBot(id, { name } = {}) {
+    this.sdk.validateParams(
+      { id, name },
+      {
+        id: { type: 'string', required: true },
+        name: { type: 'string', required: false },
+      },
+    );
+    return internalRequest(this.sdk, `/chat/bots/${id}`, 'PATCH', {
+      body: { name },
+    });
+  }
+
+  /**
+   * Get bot memory for a channel.
+   * @param {string} channelId
+   * @returns {Promise<Object>}
+   */
+  async getBotMemory(channelId) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/bot-memory`,
+      'GET',
+    );
+  }
+
+  /**
+   * Reset bot memory for a channel.
+   * @param {string} channelId
+   * @returns {Promise<Object>}
+   */
+  async resetBotMemory(channelId) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/bot-memory/reset`,
+      'POST',
+      { body: {} },
+    );
+  }
+
+  /**
+   * Compact bot memory for a channel.
+   * @param {string} channelId
+   * @returns {Promise<Object>}
+   */
+  async compactBotMemory(channelId) {
+    this.sdk.validateParams(
+      { channelId },
+      { channelId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/chat/channels/${channelId}/bot-memory/compact`,
+      'POST',
+      { body: {} },
+    );
+  }
+
   async listAdminChannels(query) {
     return this.adminListChannels(query);
   }

package/services/{inbox.js → recents.js}

@@ -1,11 +1,11 @@
 import { internalRequest } from '../base.js';
-export class InboxService {
+export class RecentsService {
   constructor(sdk) {
     this.sdk = sdk;
   }
 
   /**
-   * List unified inbox items merged across call/voicemail/fax/sms sources,
+   * List unified recents items merged across call/voicemail/fax/sms sources,
    * sorted descending by timestamp.
    *
    * @param {Object} params
@@ -93,7 +93,7 @@ export class InboxService {
 
     const params = { query };
 
-    const result = await internalRequest(this.sdk, '/inbox', 'GET', params);
+    const result = await internalRequest(this.sdk, '/recents', 'GET', params);
     return result;
   }
 
@@ -125,18 +125,18 @@ export class InboxService {
 
     const params = { query };
 
-    const result = await internalRequest(this.sdk, '/inbox/smsThread', 'GET', params);
+    const result = await internalRequest(this.sdk, '/recents/smsThread', 'GET', params);
     return result;
   }
 
   /**
-   * Fetch inbox stats (calls/talk time/missed/unread voicemail/meetings) for
+   * Fetch recents stats (calls/talk time/missed/unread voicemail/meetings) for
    * the current user.
    *
    * @returns {Promise<{callsToday: number, talkTimeSeconds: number, missedToday: number, unreadVoicemail: number, oldestUnreadVoicemailAt: string|null, meetingsToday: number, meetingMinutesToday: number}>}
    */
   async stats() {
-    const result = await internalRequest(this.sdk, '/inbox/stats', 'GET');
+    const result = await internalRequest(this.sdk, '/recents/stats', 'GET');
     return result;
   }
 
@@ -154,7 +154,7 @@ export class InboxService {
       { voicemailMessageId: { type: 'string', required: true } },
     );
     return await internalRequest(this.sdk, 
-      `/inbox/voicemail/${voicemailMessageId}/transcribe`,
+      `/recents/voicemail/${voicemailMessageId}/transcribe`,
       'POST',
       { body: {} },
     );