@unboundcx/sdk 4.13.20 → 4.13.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.13.20",
+  "version": "4.13.22",
   "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/SmsService.js

@@ -17,6 +17,8 @@ export class SmsService {
    * @param {Object} [params.variables] - Template variables
    * @param {Array<string>} [params.mediaUrls] - Media URLs for MMS
    * @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
    * @returns {Promise<Object>} Message details
    */
   async send({
@@ -27,6 +29,7 @@ export class SmsService {
     variables,
     mediaUrls,
     webhookUrl,
+    relatedId,
   }) {
     const messageData = {};
     if (from) messageData.from = from;
@@ -35,6 +38,7 @@ export class SmsService {
     if (variables) messageData.variables = variables;
     if (mediaUrls) messageData.mediaUrls = mediaUrls;
     if (webhookUrl) messageData.webhookUrl = webhookUrl;
+    if (relatedId) messageData.relatedId = relatedId;
 
     this.sdk.validateParams(
       { to, ...messageData },
@@ -46,6 +50,7 @@ export class SmsService {
         variables: { type: 'object', required: false },
         mediaUrls: { type: 'array', required: false },
         webhookUrl: { type: 'string', required: false },
+        relatedId: { type: 'string', required: false },
       },
     );
 
@@ -73,4 +78,26 @@ export class SmsService {
     const result = await internalRequest(this.sdk, `/messaging/sms/${id}`, 'GET');
     return result;
   }
+
+  /**
+   * List SMS/MMS messages tied to a task/engagement (or other record) id —
+   * feed read path for the contact-center interaction timeline.
+   * @param {string} relatedId - Related record id
+   * @returns {Promise<Object>} { messages: [...] }
+   */
+  async getByRelated(relatedId) {
+    this.sdk.validateParams(
+      { relatedId },
+      {
+        relatedId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await internalRequest(
+      this.sdk,
+      `/messaging/sms/related/${relatedId}`,
+      'GET',
+    );
+    return result;
+  }
 }

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.
@@ -572,16 +592,31 @@ export class PortalsService {
   }
 
   /**
-   * Staff-only portal credential status for a person. Never includes hashes.
+   * Staff-only portal credential + access status for a person. Never
+   * includes hashes or tokens.
    *
    * @param {string} peopleId
    * @returns {Promise<{
+   *   status: "none"|"invited"|"active"|"locked",
    *   hasPassword: boolean,
    *   ssoLinked: boolean,
    *   lastLoginAt: string|null,
    *   lastLoginMethod: string|null,
-   *   mustReset: boolean
-   * }>}
+   *   mustReset: boolean,
+   *   invitedAt: string|null,
+   *   lockedUntil: string|null,
+   *   portals: Array<{
+   *     id: string,
+   *     name: string,
+   *     kind: "support"|"partner",
+   *     hostedDomain: string,
+   *     domain: string|null,
+   *     matches: boolean
+   *   }>
+   * }>} `portals` lists only support/partner portals on the account (a
+   *   portal with no login surface, e.g. `marketing`, is never included);
+   *   `matches` is whether this person currently passes that portal's
+   *   people-access filter.
    */
   async getPeopleAccess(peopleId) {
     this.sdk.validateParams(
@@ -625,6 +660,106 @@ export class PortalsService {
     );
   }
 
+  /**
+   * Invites a person to sign in to a support/partner portal: upserts their
+   * portal credential (`mustReset=1`), stamps `invitedAt`/`invitedBy`, and
+   * sends the account's `portal-welcome` email with a fresh 30-minute
+   * single-use set-password link.
+   *
+   * The person must pass the target portal's people-access filter — see
+   * `getPeopleAccess(peopleId).portals[].matches` — or the call 400s.
+   *
+   * @param {string} peopleId
+   * @param {object} params
+   * @param {string} params.portalId - The support/partner portal to invite them to.
+   * @returns {Promise<{
+   *   status: "invited",
+   *   hasPassword: boolean,
+   *   ssoLinked: boolean,
+   *   lastLoginAt: string|null,
+   *   lastLoginMethod: string|null,
+   *   mustReset: boolean,
+   *   invitedAt: string,
+   *   lockedUntil: string|null
+   * }>}
+   */
+  async invitePerson(peopleId, { portalId }) {
+    this.sdk.validateParams(
+      { peopleId, portalId },
+      {
+        peopleId: { type: "string", required: true },
+        portalId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/people/${encodeURIComponent(peopleId)}/invite`,
+      "POST",
+      { body: { portalId } },
+    );
+  }
+
+  /**
+   * Sends a person a fresh password-reset email for a support/partner
+   * portal (the account's `portal-password-reset` template) with a new
+   * 30-minute single-use set-password link. Works whether they were
+   * previously invited or already active.
+   *
+   * @param {string} peopleId
+   * @param {object} params
+   * @param {string} params.portalId - The support/partner portal to send the reset for.
+   * @returns {Promise<{
+   *   status: "none"|"invited"|"active"|"locked",
+   *   hasPassword: boolean,
+   *   ssoLinked: boolean,
+   *   lastLoginAt: string|null,
+   *   lastLoginMethod: string|null,
+   *   mustReset: boolean,
+   *   invitedAt: string|null,
+   *   lockedUntil: string|null
+   * }>}
+   */
+  async resetPersonPassword(peopleId, { portalId }) {
+    this.sdk.validateParams(
+      { peopleId, portalId },
+      {
+        peopleId: { type: "string", required: true },
+        portalId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/people/${encodeURIComponent(peopleId)}/reset-password`,
+      "POST",
+      { body: { portalId } },
+    );
+  }
+
+  /**
+   * Revokes a person's portal access (soft-deletes their credential across
+   * every portal on the account). Idempotent — revoking someone with no
+   * credential is a no-op, not an error.
+   *
+   * @param {string} peopleId
+   * @returns {Promise<{ ok: true }>}
+   */
+  async revokePeopleAccess(peopleId) {
+    this.sdk.validateParams(
+      { peopleId },
+      {
+        peopleId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/people/${encodeURIComponent(peopleId)}/access`,
+      "DELETE",
+    );
+  }
+
   /**
    * Lists the customer-facing labels configured for each engagement status.
    *