@unboundcx/sdk 2.8.7 → 2.8.8

package/services/portals.js

@@ -3,6 +3,28 @@ export class PortalsService {
     this.sdk = sdk;
   }
 
+  /**
+   * Creates a new portal for the authenticated account.
+   *
+   * @param {object} params
+   * @param {string} params.name - Display name of the portal.
+   * @param {string} params.domain - Custom domain for the portal (e.g. `portal.example.com`).
+   *   A CNAME DNS record pointing to the platform's portal host is required.
+   * @param {object} [params.settings] - Optional portal configuration settings.
+   * @param {boolean} [params.isPublic] - Whether the portal is publicly accessible without
+   *   authentication. Defaults to private if omitted.
+   * @param {string} [params.customCss] - Optional custom CSS injected into the portal.
+   * @param {string} [params.customJs] - Optional custom JavaScript injected into the portal.
+   * @param {string} [params.favicon] - Optional URL or asset reference for the portal favicon.
+   * @param {string} [params.logo] - Optional URL or asset reference for the portal logo.
+   * @returns {Promise<{
+   *   id: string,
+   *   accountId: string,
+   *   name: string,
+   *   domain: string,
+   *   dns: Array<{ type: string, name: string, value: string, description: string }>
+   * }>} The newly created portal, including DNS records needed to configure the custom domain.
+   */
   async create({
     name,
     domain,
@@ -43,6 +65,29 @@ export class PortalsService {
     return result;
   }
 
+  /**
+   * Updates an existing portal's properties.
+   *
+   * Only the fields provided will be updated; omitted fields are left unchanged.
+   *
+   * @param {string} portalId - The ID of the portal to update.
+   * @param {object} updates
+   * @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 {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.
+   * @param {string} [updates.favicon] - Updated favicon URL or asset reference.
+   * @param {string} [updates.logo] - Updated logo URL or asset reference.
+   * @returns {Promise<{
+   *   id: string,
+   *   updatedBy: string,
+   *   updatedAt: string,
+   *   name?: string,
+   *   domain?: string
+   * }>} The updated portal fields along with audit metadata.
+   */
   async update(
     portalId,
     { name, domain, settings, isPublic, customCss, customJs, favicon, logo },
@@ -80,6 +125,12 @@ export class PortalsService {
     return result;
   }
 
+  /**
+   * Deletes a portal by ID.
+   *
+   * @param {string} portalId - The ID of the portal to delete.
+   * @returns {Promise<{ message: string }>} Confirmation message on success.
+   */
   async delete(portalId) {
     this.sdk.validateParams(
       { portalId },
@@ -92,6 +143,12 @@ export class PortalsService {
     return result;
   }
 
+  /**
+   * Retrieves a portal by ID.
+   *
+   * @param {string} portalId - The ID of the portal to retrieve.
+   * @returns {Promise<object>} The full portal record.
+   */
   async get(portalId) {
     this.sdk.validateParams(
       { portalId },
@@ -104,6 +161,17 @@ export class PortalsService {
     return result;
   }
 
+  /**
+   * Retrieves public portal information by domain.
+   *
+   * This is an unauthenticated endpoint used by portal front-ends to look up
+   * their own configuration based on the domain they are served from.
+   *
+   * @param {string} domain - The custom domain of the portal to look up
+   *   (e.g. `portal.example.com`).
+   * @returns {Promise<{ id: string, name: string, domain: string }>}
+   *   The public-facing portal fields. Sensitive account data is excluded.
+   */
   async getPublic(domain) {
     this.sdk.validateParams(
       { domain },
@@ -120,11 +188,32 @@ export class PortalsService {
     return result;
   }
 
+  /**
+   * Lists all portals belonging to the authenticated account.
+   *
+   * @returns {Promise<{ portals: object[] }>} An object containing an array of portal records.
+   */
   async list() {
     const result = await this.sdk._fetch('/portals', 'GET');
     return result;
   }
 
+  /**
+   * Verifies that a portal's custom domain has the correct DNS configuration.
+   *
+   * Checks that the domain has a valid CNAME record pointing to the platform's
+   * portal host. Use the `dns` records returned from `create()` to know the
+   * expected target value.
+   *
+   * @param {string} portalId - The ID of the portal whose DNS should be verified.
+   * @returns {Promise<{
+   *   portalId: string,
+   *   domain: string,
+   *   expectedTarget: string,
+   *   dns: object
+   * }>} The DNS verification result, including the expected CNAME target and
+   *   the actual resolution details.
+   */
   async verifyDns(portalId) {
     this.sdk.validateParams(
       { portalId },

package/services/storage.js

@@ -378,6 +378,28 @@ Response:
 }
 
 */
+  /**
+   * Upload a file to storage with optional format conversion
+   * @param {Object} config - Configuration object
+   * @param {Object} config.file - File content (Buffer or File) - REQUIRED
+   * @param {string} [config.classification='generic'] - File classification (e.g., 'fax', 'files', 'generic')
+   * @param {string} [config.folder] - Folder path for organizing files
+   * @param {string} [config.fileName] - Original file name
+   * @param {boolean} [config.isPublic=false] - Whether file is publicly accessible
+   * @param {string} [config.country='US'] - Country code for region selection
+   * @param {string} [config.expireAfter] - Expiration time
+   * @param {string} [config.relatedId] - Related object ID
+   * @param {boolean} [config.createAccessKey=false] - Generate an access key for the file
+   * @param {number} [config.accessKeyExpiresIn] - Access key expiration in seconds
+   * @param {string} [config.convertTo] - Convert uploaded file to this format before storing. Supported: 'pdf', 'tiff'. Input must be PDF, DOC, or DOCX.
+   * @param {Object} [config.convertOptions] - Options for file conversion (used with convertTo)
+   * @param {('fine'|'normal')} [config.convertOptions.resolution='fine'] - Fax resolution: 'fine' (204x196) or 'normal' (204x98)
+   * @param {('letter'|'a4')} [config.convertOptions.paperSize='letter'] - Paper size for conversion
+   * @param {('g4'|'g3')} [config.convertOptions.compression='g4'] - TIFF compression: 'g4' (default) or 'g3' for older fax machines
+   * @param {Function} [config.onProgress] - Progress callback for browser uploads
+   * @param {Object} [config._options] - Internal options
+   * @returns {Promise<Object>} Upload result with uploaded files, viruses, and errors
+   */
   async upload({
     classification = 'generic',
     folder,
@@ -389,6 +411,8 @@ Response:
     relatedId,
     createAccessKey = false,
     accessKeyExpiresIn,
+    convertTo,
+    convertOptions,
     onProgress,
     _options,
   }) {
@@ -404,6 +428,8 @@ Response:
         relatedId,
         createAccessKey,
         accessKeyExpiresIn,
+        convertTo,
+        convertOptions,
       },
       {
         classification: { type: 'string', required: false },
@@ -416,6 +442,8 @@ Response:
         relatedId: { type: 'string', required: false },
         createAccessKey: { type: 'boolean', required: false },
         accessKeyExpiresIn: { type: 'number', required: false },
+        convertTo: { type: 'string', required: false },
+        convertOptions: { type: 'object', required: false },
       },
     );
 
@@ -432,6 +460,9 @@ Response:
       formFields.push(['createAccessKey', createAccessKey.toString()]);
     if (accessKeyExpiresIn)
       formFields.push(['accessKeyExpiresIn', accessKeyExpiresIn]);
+    if (convertTo) formFields.push(['convertTo', convertTo]);
+    if (convertOptions)
+      formFields.push(['convertOptions', JSON.stringify(convertOptions)]);
 
     return this._performUpload(
       file,
@@ -891,6 +922,109 @@ Response:
     return result;
   }
 
+  /**
+   * Convert an existing stored file to a different format and save it as a new storage record.
+   * The original file remains unchanged. Supported source formats: PDF, DOC, DOCX.
+   * Supported output formats: 'pdf', 'tiff'.
+   *
+   * Fields not provided in the request (classification, folder, relatedId, isPublic)
+   * are inherited from the source file. If expireAfter is not provided, the expireAt
+   * timestamp is copied directly from the source file.
+   *
+   * @param {string} storageId - ID of the existing storage file to convert (required)
+   * @param {Object} config - Conversion options
+   * @param {string} config.convertTo - Target format: 'pdf' or 'tiff' (required)
+   * @param {Object} [config.convertOptions] - Options controlling the conversion output
+   * @param {('fine'|'normal')} [config.convertOptions.resolution='fine'] - Fax resolution: 'fine' (204x196 DPI) or 'normal' (204x98 DPI)
+   * @param {('letter'|'a4')} [config.convertOptions.paperSize='letter'] - Paper size for conversion
+   * @param {('g4'|'g3')} [config.convertOptions.compression='g4'] - TIFF compression: 'g4' (modern, default) or 'g3' (legacy fax machines)
+   * @param {string} [config.classification] - Storage classification for the new file. Defaults to source file's classification.
+   * @param {string} [config.folder] - Folder path for the new file. Defaults to source file's folder.
+   * @param {string} [config.relatedId] - Related object ID for the new file. Defaults to source file's relatedId.
+   * @param {boolean} [config.isPublic] - Whether the new file is publicly accessible. Defaults to source file's isPublic.
+   * @param {string} [config.expireAfter] - Expiration duration for the new file (e.g., '7d', '1h'). If omitted, copies expireAt from source.
+   * @param {boolean} [config.createAccessKey=false] - Generate a temporary access key for the new file
+   * @param {string} [config.accessKeyExpiresIn] - Access key expiration duration (e.g., '7d')
+   * @returns {Promise<Object>} The newly created storage record for the converted file
+   * @returns {string} result.id - Storage ID of the converted file
+   * @returns {string} result.sourceStorageId - Storage ID of the original source file
+   * @returns {string} result.fileName - File name of the converted file
+   * @returns {number} result.fileSize - Size in bytes of the converted file
+   * @returns {string} result.url - URL to access the converted file
+   * @returns {string} result.mimeType - MIME type of the converted file
+   * @returns {string[]} result.s3Regions - Regions where the converted file is stored
+   * @returns {boolean} result.isPublic - Whether the converted file is public
+   * @returns {string} [result.expireAt] - Expiration timestamp if set
+   * @returns {string} [result.accessKey] - Access key if createAccessKey was true
+   *
+   * @example
+   * // Convert a stored PDF to TIFF for fax transmission
+   * const result = await sdk.storage.convertFile('017d01...', {
+   *   convertTo: 'tiff',
+   *   convertOptions: {
+   *     resolution: 'fine',
+   *     paperSize: 'letter',
+   *     compression: 'g4',
+   *   },
+   * });
+   * console.log(result.id);           // new storage ID for the TIFF
+   * console.log(result.sourceStorageId); // original PDF storage ID
+   *
+   * @example
+   * // Convert a DOCX to PDF, overriding the classification and folder
+   * const result = await sdk.storage.convertFile('017d02...', {
+   *   convertTo: 'pdf',
+   *   classification: 'fax',
+   *   folder: 'outbound/2026',
+   * });
+   */
+  async convertFile(
+    storageId,
+    {
+      convertTo,
+      convertOptions,
+      classification,
+      folder,
+      relatedId,
+      isPublic,
+      expireAfter,
+      createAccessKey,
+      accessKeyExpiresIn,
+    } = {},
+  ) {
+    this.sdk.validateParams(
+      { storageId, convertTo },
+      {
+        storageId: { type: 'string', required: true },
+        convertTo: { type: 'string', required: true },
+        convertOptions: { type: 'object', required: false },
+        classification: { type: 'string', required: false },
+        folder: { type: 'string', required: false },
+        relatedId: { type: 'string', required: false },
+        isPublic: { type: 'boolean', required: false },
+        expireAfter: { type: 'string', required: false },
+        createAccessKey: { type: 'boolean', required: false },
+        accessKeyExpiresIn: { type: 'string', required: false },
+      },
+    );
+
+    const body = { convertTo };
+    if (convertOptions !== undefined)
+      body.convertOptions = convertOptions;
+    if (classification !== undefined) body.classification = classification;
+    if (folder !== undefined) body.folder = folder;
+    if (relatedId !== undefined) body.relatedId = relatedId;
+    if (isPublic !== undefined) body.isPublic = isPublic;
+    if (expireAfter !== undefined) body.expireAfter = expireAfter;
+    if (createAccessKey !== undefined) body.createAccessKey = createAccessKey;
+    if (accessKeyExpiresIn !== undefined)
+      body.accessKeyExpiresIn = accessKeyExpiresIn;
+
+    const params = { body };
+
+    return await this.sdk._fetch(`/storage/${storageId}/convert`, 'POST', params);
+  }
+
   /**
    * Update file contents and metadata
    * @param {string} storageId - Storage file ID (required)

package/services/taskRouter/TaskService.js

@@ -81,6 +81,7 @@ export class TaskService {
       relatedId,
       cdrId,
       sipCallId,
+      aiChatSessionId,
     } = options;
 
     this.sdk.validateParams(
@@ -99,6 +100,7 @@ export class TaskService {
         relatedObject,
         relatedId,
         sipCallId,
+        aiChatSessionId,
       },
       {
         type: { type: 'string', required: true },
@@ -115,6 +117,7 @@ export class TaskService {
         relatedObject: { type: 'string', required: false },
         relatedId: { type: 'string', required: false },
         sipCallId: { type: 'string', required: false },
+        aiChatSessionId: { type: 'string', required: false },
       },
     );
 
@@ -168,10 +171,15 @@ export class TaskService {
     if (relatedId !== undefined) {
       params.body.relatedId = relatedId;
     }
+
     if (sipCallId !== undefined) {
       params.body.sipCallId = sipCallId;
     }
 
+    if (aiChatSessionId !== undefined) {
+      params.body.aiChatSessionId = aiChatSessionId;
+    }
+
     const result = await this.sdk._fetch('/taskRouter/tasks', 'POST', params);
     return result;
   }

package/services/workflows.js

@@ -30,6 +30,82 @@ export class WorkflowsService {
     const result = await this.sdk._fetch('/workflows/modules', 'GET', params);
     return result;
   }
+
+  async listFormulaFunctions() {
+    const result = await this.sdk._fetch(
+      '/workflows/formula-functions',
+      'GET',
+    );
+    return result;
+  }
+
+  async getAvailableHolidaySets() {
+    const result = await this.sdk._fetch(
+      '/workflows/holiday-sets',
+      'GET',
+    );
+    return result;
+  }
+
+  async simulateWebhook(webhookSettings) {
+    this.sdk.validateParams(
+      { webhookSettings },
+      {
+        webhookSettings: { type: 'object', required: true },
+      },
+    );
+
+    const params = {
+      body: { webhookSettings },
+    };
+
+    const result = await this.sdk._fetch(
+      '/workflows/webhook/simulate',
+      'POST',
+      params,
+    );
+    return result;
+  }
+
+  async simulateLookup(lookupSettings) {
+    this.sdk.validateParams(
+      { lookupSettings },
+      {
+        lookupSettings: { type: 'object', required: true },
+      },
+    );
+
+    const params = {
+      body: { lookupSettings },
+    };
+
+    const result = await this.sdk._fetch(
+      '/workflows/lookup/simulate',
+      'POST',
+      params,
+    );
+    return result;
+  }
+
+  async simulateTimeControl(timeControlSettings, testDateTime = null) {
+    this.sdk.validateParams(
+      { timeControlSettings },
+      {
+        timeControlSettings: { type: 'object', required: true },
+      },
+    );
+
+    const params = {
+      body: { timeControlSettings, testDateTime },
+    };
+
+    const result = await this.sdk._fetch(
+      '/workflows/timeControl/simulate',
+      'POST',
+      params,
+    );
+    return result;
+  }
 }
 
 export class WorkflowItemsService {
@@ -386,4 +462,61 @@ export class WorkflowSessionsService {
     );
     return result;
   }
+
+  async logTranscript(sessionId, transcriptData) {
+    this.sdk.validateParams(
+      { sessionId },
+      {
+        sessionId: { type: 'string', required: true },
+      },
+    );
+
+    const params = {
+      body: transcriptData,
+    };
+
+    const result = await this.sdk._fetch(
+      `/workflows/session/${sessionId}/transcript`,
+      'POST',
+      params,
+    );
+    return result;
+  }
+
+  async replay(sessionId) {
+    this.sdk.validateParams(
+      { sessionId },
+      {
+        sessionId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/workflows/session/${sessionId}/replay`,
+      'GET',
+    );
+    return result;
+  }
+
+  async analytics(workflowVersionId, { startDate, endDate } = {}) {
+    this.sdk.validateParams(
+      { workflowVersionId, startDate, endDate },
+      {
+        workflowVersionId: { type: 'string', required: true },
+        startDate: { type: 'string', required: true },
+        endDate: { type: 'string', required: true },
+      },
+    );
+
+    const params = {
+      query: { startDate, endDate },
+    };
+
+    const result = await this.sdk._fetch(
+      `/workflows/${workflowVersionId}/analytics`,
+      'GET',
+      params,
+    );
+    return result;
+  }
 }