@unboundcx/sdk 4.7.0 → 4.8.1

package/index.js

@@ -30,6 +30,8 @@ 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 { DirectoryService } from './services/directory.js';
 
 class UnboundSDK extends BaseSDK {
   constructor(options = {}) {
@@ -101,6 +103,8 @@ 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.directory = new DirectoryService(this);
 
     // Add additional services that might be missing
     this._initializeAdditionalServices();
@@ -281,4 +285,6 @@ 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 { DirectoryService } from './services/directory.js';
 export { BaseSDK } from './base.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.7.0",
+  "version": "4.8.1",
   "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/directory.js

@@ -0,0 +1,124 @@
+export class DirectoryService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List the current user's directory favorites, hydrated with the
+   * favorited record and its channels.
+   *
+   * @returns {Promise<{favorites: Object[]}>}
+   */
+  async listFavorites() {
+    const result = await this.sdk._fetch('/directory/favorites', 'GET');
+    return result;
+  }
+
+  /**
+   * Add a person or company to directory favorites. Reactivates a
+   * soft-deleted favorite on unique conflict.
+   *
+   * @param {Object} params
+   * @param {string} params.objectType - 'person' or 'company' (required).
+   * @param {string} params.objectId - Id of the favorited record (required).
+   * @param {string[]} [params.channelIds] - Channel ids to pin for this favorite.
+   * @returns {Promise<Object>} The created (or reactivated) favorite.
+   */
+  async addFavorite({ objectType, objectId, channelIds }) {
+    this.sdk.validateParams(
+      { objectType, objectId, channelIds },
+      {
+        objectType: { type: 'string', required: true },
+        objectId: { type: 'string', required: true },
+        channelIds: { type: 'array', required: false },
+      },
+    );
+
+    const body = { objectType, objectId };
+    if (channelIds !== undefined) body.channelIds = channelIds;
+
+    const params = { body };
+
+    const result = await this.sdk._fetch('/directory/favorites', 'POST', params);
+    return result;
+  }
+
+  /**
+   * Update a directory favorite's pinned channels and/or sort order.
+   *
+   * @param {string} favoriteId - Id of the favorite to update (required).
+   * @param {Object} params
+   * @param {string[]} [params.channelIds]
+   * @param {number} [params.sortOrder]
+   * @returns {Promise<Object>} The updated favorite.
+   */
+  async updateFavorite(favoriteId, { channelIds, sortOrder } = {}) {
+    this.sdk.validateParams(
+      { favoriteId, channelIds, sortOrder },
+      {
+        favoriteId: { type: 'string', required: true },
+        channelIds: { type: 'array', required: false },
+        sortOrder: { type: 'number', required: false },
+      },
+    );
+
+    const body = {};
+    if (channelIds !== undefined) body.channelIds = channelIds;
+    if (sortOrder !== undefined) body.sortOrder = sortOrder;
+
+    const params = { body };
+
+    const result = await this.sdk._fetch(
+      `/directory/favorites/${favoriteId}`,
+      'PUT',
+      params,
+    );
+    return result;
+  }
+
+  /**
+   * Soft delete a directory favorite.
+   *
+   * @param {string} favoriteId - Id of the favorite to remove (required).
+   * @returns {Promise<Object>}
+   */
+  async removeFavorite(favoriteId) {
+    this.sdk.validateParams(
+      { favoriteId },
+      {
+        favoriteId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/directory/favorites/${favoriteId}`,
+      'DELETE',
+    );
+    return result;
+  }
+
+  /**
+   * Reorder directory favorites.
+   *
+   * @param {Object} params
+   * @param {string[]} params.order - Favorite ids in the desired order (required).
+   * @returns {Promise<{ok: boolean}>}
+   */
+  async reorderFavorites({ order }) {
+    this.sdk.validateParams(
+      { order },
+      {
+        order: { type: 'array', required: true },
+      },
+    );
+
+    const params = { body: { order } };
+
+    const result = await this.sdk._fetch(
+      '/directory/favorites/reorder',
+      'PUT',
+      params,
+    );
+    return result;
+  }
+}

package/services/inbox.js

@@ -0,0 +1,94 @@
+export class InboxService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List unified inbox items merged across call/voicemail/fax/sms sources,
+   * sorted descending by timestamp.
+   *
+   * @param {Object} params
+   * @param {string|string[]} [params.types] - Source kinds to include
+   *   ('call','voicemail','fax','sms'). Pass an array or a comma-joined
+   *   string; omit to include all kinds.
+   * @param {number} [params.limit] - Max items to return.
+   * @param {string} [params.before] - UTC cursor 'YYYY-MM-DD HH:mm:ss';
+   *   only items strictly older than this are returned.
+   * @param {boolean} [params.unreadOnly] - When true, only unread items.
+   * @returns {Promise<{items: Object[], nextCursor: string|null}>}
+   */
+  async list({ types, limit, before, unreadOnly } = {}) {
+    this.sdk.validateParams(
+      { limit, before, unreadOnly },
+      {
+        limit: { type: 'number', required: false },
+        before: { type: 'string', required: false },
+        unreadOnly: { type: 'boolean', required: false },
+      },
+    );
+
+    if (
+      types !== undefined &&
+      typeof types !== 'string' &&
+      !Array.isArray(types)
+    ) {
+      throw new Error('types must be a string or an array of strings');
+    }
+
+    const query = {};
+    if (types !== undefined) {
+      query.types = Array.isArray(types) ? types.join(',') : types;
+    }
+    if (limit !== undefined) query.limit = limit;
+    if (before !== undefined) query.before = before;
+    if (unreadOnly !== undefined) query.unreadOnly = unreadOnly;
+
+    const params = { query };
+
+    const result = await this.sdk._fetch('/inbox', 'GET', params);
+    return result;
+  }
+
+  /**
+   * Fetch a paginated SMS/MMS thread for a phone number + counterparty pair.
+   *
+   * @param {Object} params
+   * @param {string} params.phoneNumberId - Our phone number id (required).
+   * @param {string} params.counterparty - Counterparty phone number (required).
+   * @param {number} [params.limit] - Max messages to return.
+   * @param {string} [params.before] - UTC cursor 'YYYY-MM-DD HH:mm:ss';
+   *   only messages strictly older than this are returned.
+   * @returns {Promise<{messages: Object[], nextCursor: string|null}>}
+   */
+  async smsThread({ phoneNumberId, counterparty, limit, before }) {
+    this.sdk.validateParams(
+      { phoneNumberId, counterparty, limit, before },
+      {
+        phoneNumberId: { type: 'string', required: true },
+        counterparty: { type: 'string', required: true },
+        limit: { type: 'number', required: false },
+        before: { type: 'string', required: false },
+      },
+    );
+
+    const query = { phoneNumberId, counterparty };
+    if (limit !== undefined) query.limit = limit;
+    if (before !== undefined) query.before = before;
+
+    const params = { query };
+
+    const result = await this.sdk._fetch('/inbox/smsThread', 'GET', params);
+    return result;
+  }
+
+  /**
+   * Fetch inbox stats (calls/talk time/missed/unread voicemail) for the
+   * current user.
+   *
+   * @returns {Promise<{callsToday: number, talkTimeSeconds: number, missedToday: number, unreadVoicemail: number, oldestUnreadVoicemailAt: string|null}>}
+   */
+  async stats() {
+    const result = await this.sdk._fetch('/inbox/stats', 'GET');
+    return result;
+  }
+}