@unboundcx/sdk 4.13.18 → 4.13.20

package/package.json

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

@@ -1,4 +1,4 @@
-import { internalRequest } from '../base.js';
+import { internalRequest } from "../base.js";
 export class PortalsService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -9,8 +9,11 @@ export class PortalsService {
    *
    * @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`).
+   * @param {string} [params.kind] - Portal kind (`marketing` | `support` | `partner`).
+   * @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 {string} [params.slug] - Per-account preview slug (not a custom domain).
+   *   At least one of `domain` or `slug` is required by the API.
    * @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.
@@ -28,7 +31,9 @@ export class PortalsService {
    */
   async create({
     name,
+    kind,
     domain,
+    slug,
     settings,
     isPublic,
     customCss,
@@ -37,20 +42,25 @@ export class PortalsService {
     logo,
   }) {
     this.sdk.validateParams(
-      { name, domain },
+      { name, kind, domain, slug },
       {
-        name: { type: 'string', required: true },
-        domain: { type: 'string', required: true },
-        settings: { type: 'object', required: false },
-        isPublic: { type: 'boolean', required: false },
-        customCss: { type: 'string', required: false },
-        customJs: { type: 'string', required: false },
-        favicon: { type: 'string', required: false },
-        logo: { type: 'string', required: false },
+        name: { type: "string", required: true },
+        kind: { type: "string", required: false },
+        domain: { type: "string", required: false },
+        slug: { type: "string", required: false },
+        settings: { type: "object", required: false },
+        isPublic: { type: "boolean", required: false },
+        customCss: { type: "string", required: false },
+        customJs: { type: "string", required: false },
+        favicon: { type: "string", required: false },
+        logo: { type: "string", required: false },
       },
     );
 
-    const portalData = { name, domain };
+    const portalData = { name };
+    if (kind) portalData.kind = kind;
+    if (domain) portalData.domain = domain;
+    if (slug) portalData.slug = slug;
     if (settings) portalData.settings = settings;
     if (isPublic !== undefined) portalData.isPublic = isPublic;
     if (customCss) portalData.customCss = customCss;
@@ -62,7 +72,7 @@ export class PortalsService {
       body: portalData,
     };
 
-    const result = await internalRequest(this.sdk, '/portals', 'POST', params);
+    const result = await internalRequest(this.sdk, "/portals", "POST", params);
     return result;
   }
 
@@ -91,26 +101,38 @@ export class PortalsService {
    */
   async update(
     portalId,
-    { name, domain, settings, isPublic, customCss, customJs, favicon, logo },
+    {
+      name,
+      domain,
+      slug,
+      settings,
+      isPublic,
+      customCss,
+      customJs,
+      favicon,
+      logo,
+    },
   ) {
     this.sdk.validateParams(
       { portalId },
       {
-        portalId: { type: 'string', required: true },
-        name: { type: 'string', required: false },
-        domain: { type: 'string', required: false },
-        settings: { type: 'object', required: false },
-        isPublic: { type: 'boolean', required: false },
-        customCss: { type: 'string', required: false },
-        customJs: { type: 'string', required: false },
-        favicon: { type: 'string', required: false },
-        logo: { type: 'string', required: false },
+        portalId: { type: "string", required: true },
+        name: { type: "string", required: false },
+        domain: { type: "string", required: false },
+        slug: { type: "string", required: false },
+        settings: { type: "object", required: false },
+        isPublic: { type: "boolean", required: false },
+        customCss: { type: "string", required: false },
+        customJs: { type: "string", required: false },
+        favicon: { type: "string", required: false },
+        logo: { type: "string", required: false },
       },
     );
 
     const updateData = {};
     if (name) updateData.name = name;
-    if (domain) updateData.domain = domain;
+    if (domain !== undefined) updateData.domain = domain;
+    if (slug !== undefined) updateData.slug = slug;
     if (settings) updateData.settings = settings;
     if (isPublic !== undefined) updateData.isPublic = isPublic;
     if (customCss) updateData.customCss = customCss;
@@ -122,7 +144,12 @@ export class PortalsService {
       body: updateData,
     };
 
-    const result = await internalRequest(this.sdk, `/portals/${portalId}`, 'PUT', params);
+    const result = await internalRequest(
+      this.sdk,
+      `/portals/${portalId}`,
+      "PUT",
+      params,
+    );
     return result;
   }
 
@@ -136,11 +163,15 @@ export class PortalsService {
     this.sdk.validateParams(
       { portalId },
       {
-        portalId: { type: 'string', required: true },
+        portalId: { type: "string", required: true },
       },
     );
 
-    const result = await internalRequest(this.sdk, `/portals/${portalId}`, 'DELETE');
+    const result = await internalRequest(
+      this.sdk,
+      `/portals/${portalId}`,
+      "DELETE",
+    );
     return result;
   }
 
@@ -154,11 +185,15 @@ export class PortalsService {
     this.sdk.validateParams(
       { portalId },
       {
-        portalId: { type: 'string', required: true },
+        portalId: { type: "string", required: true },
       },
     );
 
-    const result = await internalRequest(this.sdk, `/portals/${portalId}`, 'GET');
+    const result = await internalRequest(
+      this.sdk,
+      `/portals/${portalId}`,
+      "GET",
+    );
     return result;
   }
 
@@ -177,7 +212,7 @@ export class PortalsService {
     this.sdk.validateParams(
       { domain },
       {
-        domain: { type: 'string', required: true },
+        domain: { type: "string", required: true },
       },
     );
 
@@ -185,7 +220,12 @@ export class PortalsService {
       query: { domain },
     };
 
-    const result = await internalRequest(this.sdk, '/portals/public', 'GET', params);
+    const result = await internalRequest(
+      this.sdk,
+      "/portals/public",
+      "GET",
+      params,
+    );
     return result;
   }
 
@@ -195,7 +235,7 @@ export class PortalsService {
    * @returns {Promise<{ portals: object[] }>} An object containing an array of portal records.
    */
   async list() {
-    const result = await internalRequest(this.sdk, '/portals', 'GET');
+    const result = await internalRequest(this.sdk, "/portals", "GET");
     return result;
   }
 
@@ -219,14 +259,513 @@ export class PortalsService {
     this.sdk.validateParams(
       { portalId },
       {
-        portalId: { type: 'string', required: true },
+        portalId: { type: "string", required: true },
       },
     );
 
-    const result = await internalRequest(this.sdk, 
-      `/portals/${portalId}/verify-dns`,
-      'POST',
+    const result = await internalRequest(
+      this.sdk,
+      "/portals/dns/verify",
+      "GET",
+      {
+        query: { id: portalId },
+      },
     );
     return result;
   }
+
+  /**
+   * Lists pages for a portal.
+   *
+   * @param {string} portalId
+   * @returns {Promise<{ pages: object[] }>}
+   */
+  async listPages(portalId) {
+    this.sdk.validateParams(
+      { portalId },
+      {
+        portalId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(this.sdk, `/portals/${portalId}/pages`, "GET");
+  }
+
+  /**
+   * Creates a portal page.
+   *
+   * @param {string} portalId
+   * @param {object} params
+   * @param {string} params.path - `/` or a slash-prefixed path like `/spring-sale`.
+   * @param {string} params.title
+   * @param {string} params.type - landing|html|layout|kbHome|kbArticle|ticketList|ticketDetail|login|redirect
+   * @param {boolean} [params.requiresLogin] - Require a signed-in portal session to view this page.
+   * @returns {Promise<object>}
+   */
+  async createPage(portalId, { path, title, type, requiresLogin }) {
+    this.sdk.validateParams(
+      { portalId, path, title, type, requiresLogin },
+      {
+        portalId: { type: "string", required: true },
+        path: { type: "string", required: true },
+        title: { type: "string", required: true },
+        type: { type: "string", required: true },
+        requiresLogin: { type: "boolean", required: false },
+      },
+    );
+
+    const body = { path, title, type };
+    if (requiresLogin !== undefined) body.requiresLogin = requiresLogin;
+
+    return internalRequest(this.sdk, `/portals/${portalId}/pages`, "POST", {
+      body,
+    });
+  }
+
+  /**
+   * Retrieves a portal page by ID.
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @returns {Promise<object>}
+   */
+  async getPage(portalId, pageId) {
+    this.sdk.validateParams(
+      { portalId, pageId },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}`,
+      "GET",
+    );
+  }
+
+  /**
+   * Updates a portal page. Only provided fields are changed.
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @param {object} [updates]
+   * @returns {Promise<object>}
+   */
+  async updatePage(
+    portalId,
+    pageId,
+    {
+      path,
+      title,
+      type,
+      isPublished,
+      publishedVersionId,
+      draftVersionId,
+      requiresLogin,
+    } = {},
+  ) {
+    this.sdk.validateParams(
+      {
+        portalId,
+        pageId,
+        path,
+        title,
+        type,
+        isPublished,
+        publishedVersionId,
+        draftVersionId,
+        requiresLogin,
+      },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+        path: { type: "string", required: false },
+        title: { type: "string", required: false },
+        type: { type: "string", required: false },
+        isPublished: { type: "boolean", required: false },
+        publishedVersionId: { type: "string", required: false },
+        draftVersionId: { type: "string", required: false },
+        requiresLogin: { type: "boolean", required: false },
+      },
+    );
+
+    const body = {};
+    if (path !== undefined) body.path = path;
+    if (title !== undefined) body.title = title;
+    if (type !== undefined) body.type = type;
+    if (isPublished !== undefined) body.isPublished = isPublished;
+    if (publishedVersionId !== undefined) {
+      body.publishedVersionId = publishedVersionId;
+    }
+    if (draftVersionId !== undefined) body.draftVersionId = draftVersionId;
+    if (requiresLogin !== undefined) body.requiresLogin = requiresLogin;
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}`,
+      "PUT",
+      { body },
+    );
+  }
+
+  /**
+   * Soft-deletes a portal page.
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @returns {Promise<{ message: string }>}
+   */
+  async deletePage(portalId, pageId) {
+    this.sdk.validateParams(
+      { portalId, pageId },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}`,
+      "DELETE",
+    );
+  }
+
+  /**
+   * Lists versions for a portal page.
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @returns {Promise<{ versions: object[] }>}
+   */
+  async listPageVersions(portalId, pageId) {
+    this.sdk.validateParams(
+      { portalId, pageId },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}/versions`,
+      "GET",
+    );
+  }
+
+  /**
+   * Creates a page version (S3 pointers / layout / object only; no HTML compile).
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  async createPageVersion(
+    portalId,
+    pageId,
+    { designStorageId, htmlStorageId, layoutId, objectName } = {},
+  ) {
+    this.sdk.validateParams(
+      {
+        portalId,
+        pageId,
+        designStorageId,
+        htmlStorageId,
+        layoutId,
+        objectName,
+      },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+        designStorageId: { type: "string", required: false },
+        htmlStorageId: { type: "string", required: false },
+        layoutId: { type: "string", required: false },
+        objectName: { type: "string", required: false },
+      },
+    );
+
+    const body = {};
+    if (designStorageId !== undefined) body.designStorageId = designStorageId;
+    if (htmlStorageId !== undefined) body.htmlStorageId = htmlStorageId;
+    if (layoutId !== undefined) body.layoutId = layoutId;
+    if (objectName !== undefined) body.objectName = objectName;
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}/versions`,
+      "POST",
+      { body },
+    );
+  }
+
+  /**
+   * Autosave a page draft. Landing pages pass a block `tree`; `html`-type
+   * pages (marketing portals only, P7.1) pass the raw full-document `html`
+   * string instead.
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @param {object} params
+   * @param {object|Array} [params.tree] - Block tree JSON (landing pages).
+   * @param {string} [params.html] - Raw full-document HTML (html pages).
+   * @returns {Promise<object>}
+   */
+  async savePageDraft(portalId, pageId, { tree, html } = {}) {
+    this.sdk.validateParams(
+      { portalId, pageId, tree, html },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+        tree: { type: "object", required: false },
+        html: { type: "string", required: false },
+      },
+    );
+
+    const body = {};
+    if (tree !== undefined) body.tree = tree;
+    if (html !== undefined) body.html = html;
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}/draft`,
+      "PUT",
+      { body },
+    );
+  }
+
+  /**
+   * Compile a landing-page draft (P1.4) and publish HTML, or (for `html`-type
+   * pages, P7.1) store the raw document string verbatim.
+   *
+   * @param {string} portalId
+   * @param {string} pageId
+   * @param {object} [params]
+   * @param {object|Array} [params.tree] - Optional tree; otherwise the draft design is loaded.
+   * @param {string} [params.html] - Raw full-document HTML (html pages); otherwise the draft is loaded.
+   * @returns {Promise<object>}
+   */
+  async publishPage(portalId, pageId, { tree, html } = {}) {
+    this.sdk.validateParams(
+      { portalId, pageId, tree, html },
+      {
+        portalId: { type: "string", required: true },
+        pageId: { type: "string", required: true },
+        tree: { type: "object", required: false },
+        html: { type: "string", required: false },
+      },
+    );
+
+    const body = {};
+    if (tree !== undefined) body.tree = tree;
+    if (html !== undefined) body.html = html;
+
+    return internalRequest(
+      this.sdk,
+      `/portals/${portalId}/pages/${pageId}/publish`,
+      "POST",
+      { body },
+    );
+  }
+
+  /**
+   * Staff-only portal credential status for a person. Never includes hashes.
+   *
+   * @param {string} peopleId
+   * @returns {Promise<{
+   *   hasPassword: boolean,
+   *   ssoLinked: boolean,
+   *   lastLoginAt: string|null,
+   *   lastLoginMethod: string|null,
+   *   mustReset: boolean
+   * }>}
+   */
+  async getPeopleAccess(peopleId) {
+    this.sdk.validateParams(
+      { peopleId },
+      {
+        peopleId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/people/${encodeURIComponent(peopleId)}/access`,
+      "GET",
+    );
+  }
+
+  /**
+   * Force the person to reset their portal password on next login (`mustReset=1`).
+   *
+   * @param {string} peopleId
+   * @returns {Promise<{
+   *   hasPassword: boolean,
+   *   ssoLinked: boolean,
+   *   lastLoginAt: string|null,
+   *   lastLoginMethod: string|null,
+   *   mustReset: boolean
+   * }>}
+   */
+  async forceResetPeopleAccess(peopleId) {
+    this.sdk.validateParams(
+      { peopleId },
+      {
+        peopleId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(
+      this.sdk,
+      `/portals/people/${encodeURIComponent(peopleId)}/access/force-reset`,
+      "POST",
+    );
+  }
+
+  /**
+   * Lists the customer-facing labels configured for each engagement status.
+   *
+   * One entry per valid `engagementSessions.status` value; `customerLabel`
+   * is `null` when unset (P4.2: the portal hides statuses with no label).
+   *
+   * @returns {Promise<{ statuses: Array<{ status: string, customerLabel: string|null }> }>}
+   */
+  async listTicketStatuses() {
+    return internalRequest(this.sdk, "/portals/ticket-statuses", "GET");
+  }
+
+  /**
+   * Upserts customer-facing labels for engagement statuses.
+   *
+   * @param {object} params
+   * @param {Array<{ status: string, customerLabel: string|null }>} params.statuses
+   * @returns {Promise<{ statuses: Array<{ status: string, customerLabel: string|null }> }>}
+   */
+  async updateTicketStatuses({ statuses }) {
+    this.sdk.validateParams(
+      { statuses },
+      {
+        statuses: { type: "array", required: true },
+      },
+    );
+
+    return internalRequest(this.sdk, "/portals/ticket-statuses", "PUT", {
+      body: { statuses },
+    });
+  }
+
+  /**
+   * Retrieves the single-sign-on (OIDC) connection configured for a portal.
+   *
+   * Never includes the client secret; `hasClientSecret` indicates whether
+   * one is on file.
+   *
+   * @param {string} portalId
+   * @returns {Promise<{ connection: {
+   *   id: string,
+   *   provider: string,
+   *   name: string,
+   *   issuer: string,
+   *   clientId: string,
+   *   tenant: string|null,
+   *   scopes: string,
+   *   status: string,
+   *   requireVerifiedEmail: boolean,
+   *   hasClientSecret: boolean,
+   *   redirectUri: string,
+   *   updatedAt: string
+   * } | null }>}
+   */
+  async getSsoConnection(portalId) {
+    this.sdk.validateParams(
+      { portalId },
+      {
+        portalId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(this.sdk, `/portals/${portalId}/sso`, "GET");
+  }
+
+  /**
+   * Creates or updates a portal's single-sign-on (OIDC) connection.
+   *
+   * Only `support`/`partner` portals may have a connection. `clientSecret`
+   * is required when creating a connection and optional on update (omit it
+   * to keep the existing secret).
+   *
+   * @param {string} portalId
+   * @param {object} params
+   * @param {string} [params.name] - Display name shown to visitors (e.g. "Single sign-on").
+   * @param {string} params.issuer - OIDC issuer URL (https, no query/fragment).
+   * @param {string} params.clientId
+   * @param {string} [params.clientSecret] - Required to create; omit on update to keep existing.
+   * @param {string} [params.tenant] - Provider tenant hint (e.g. an Azure tenant id).
+   * @param {string} [params.scopes] - Space-separated scopes; must include `openid` and `email`.
+   * @param {string} [params.status] - `active` | `disabled`.
+   * @param {boolean} [params.requireVerifiedEmail]
+   * @returns {Promise<{ connection: object }>}
+   */
+  async upsertSsoConnection(
+    portalId,
+    {
+      name,
+      issuer,
+      clientId,
+      clientSecret,
+      tenant,
+      scopes,
+      status,
+      requireVerifiedEmail,
+    } = {},
+  ) {
+    this.sdk.validateParams(
+      { portalId, issuer, clientId },
+      {
+        portalId: { type: "string", required: true },
+        issuer: { type: "string", required: true },
+        clientId: { type: "string", required: true },
+        name: { type: "string", required: false },
+        clientSecret: { type: "string", required: false },
+        tenant: { type: "string", required: false },
+        scopes: { type: "string", required: false },
+        status: { type: "string", required: false },
+        requireVerifiedEmail: { type: "boolean", required: false },
+      },
+    );
+
+    const body = { issuer, clientId };
+    if (name !== undefined) body.name = name;
+    if (clientSecret !== undefined) body.clientSecret = clientSecret;
+    if (tenant !== undefined) body.tenant = tenant;
+    if (scopes !== undefined) body.scopes = scopes;
+    if (status !== undefined) body.status = status;
+    if (requireVerifiedEmail !== undefined) {
+      body.requireVerifiedEmail = requireVerifiedEmail;
+    }
+
+    return internalRequest(this.sdk, `/portals/${portalId}/sso`, "PUT", {
+      body,
+    });
+  }
+
+  /**
+   * Soft-deletes a portal's single-sign-on (OIDC) connection.
+   *
+   * @param {string} portalId
+   * @returns {Promise<{ message: string }>}
+   */
+  async deleteSsoConnection(portalId) {
+    this.sdk.validateParams(
+      { portalId },
+      {
+        portalId: { type: "string", required: true },
+      },
+    );
+
+    return internalRequest(this.sdk, `/portals/${portalId}/sso`, "DELETE");
+  }
 }