@cavuno/board 1.22.0 → 1.24.0

package/dist/index.js

@@ -149,7 +149,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.22.0";
+var SDK_VERSION = "1.24.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -1804,6 +1804,329 @@ function meNamespace(client) {
           { ...options, method: "DELETE", query }
         );
       }
+    },
+    /**
+     * The authenticated board user's messaging inbox (doc 34 / ADR-0053).
+     * The v1 surface is polled REST — there is no realtime primitive; poll
+     * `list` / `listMessages` / `unreadCount` on an interval (3–5s is the
+     * reference cadence) for near-live updates.
+     */
+    conversations: {
+      /**
+       * List my conversations (each page sorted most-recent-activity-first;
+       * cross-page cursor order is approximate — see the API docs). `archived:
+       * true` returns the archived view. Poll for inbox liveness.
+       *
+       * @example
+       * const { data } = await board.me.conversations.list({ limit: 20 });
+       */
+      list(query, options) {
+        return client.fetch("/me/conversations", {
+          ...options,
+          query
+        });
+      },
+      /**
+       * The count of distinct conversations with an unread message — the
+       * inbox badge. Poll for liveness.
+       *
+       * @example
+       * const { count } = await board.me.conversations.unreadCount();
+       */
+      unreadCount(options) {
+        return client.fetch(
+          "/me/conversations/unread-count",
+          options
+        );
+      },
+      /**
+       * A conversation's header — live-resolved counterparty identity, the
+       * viewer's role, and the viewer's last-read pointer. The messages are a
+       * separate paginated call (`listMessages`).
+       *
+       * @example
+       * const convo = await board.me.conversations.retrieve(id);
+       */
+      retrieve(id, options) {
+        return client.fetch(
+          `/me/conversations/${encodeURIComponent(id)}`,
+          options
+        );
+      },
+      /**
+       * A conversation's messages, oldest-first (append order). Unsent
+       * messages are tombstones (empty `body`, `deletedAt` set). Poll for the
+       * live thread.
+       *
+       * @example
+       * const { data } = await board.me.conversations.listMessages(id, { limit: 50 });
+       */
+      listMessages(id, query, options) {
+        return client.fetch(
+          `/me/conversations/${encodeURIComponent(id)}/messages`,
+          { ...options, query }
+        );
+      },
+      /**
+       * Cold-initiate a conversation with a candidate (employer-only).
+       * Converges on the existing thread. Returns the created message.
+       *
+       * @example
+       * const msg = await board.me.conversations.start({ candidateBoardUserId, body: 'Hi!' });
+       */
+      start(body, options) {
+        return client.fetch("/me/conversations", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /**
+       * Message an applicant from the ATS (application context, outside the
+       * talent paywall). Returns the created message.
+       *
+       * @example
+       * const msg = await board.me.conversations.startAboutApplication({ applicationId, body: '…' });
+       */
+      startAboutApplication(body, options) {
+        return client.fetch("/me/conversations/about-application", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /**
+       * Reply in an existing conversation. Returns the created message.
+       *
+       * @example
+       * const msg = await board.me.conversations.reply(id, { body: 'Sounds good' });
+       */
+      reply(id, body, options) {
+        return client.fetch(
+          `/me/conversations/${encodeURIComponent(id)}/reply`,
+          { ...options, method: "POST", body }
+        );
+      },
+      /**
+       * Mark a conversation read for the viewer. Idempotent.
+       *
+       * @example
+       * await board.me.conversations.markRead(id);
+       */
+      markRead(id, options) {
+        return client.fetch(
+          `/me/conversations/${encodeURIComponent(id)}/read`,
+          { ...options, method: "POST" }
+        );
+      },
+      /**
+       * Archive a conversation for the viewer (per-side). Idempotent.
+       *
+       * @example
+       * await board.me.conversations.archive(id);
+       */
+      archive(id, options) {
+        return client.fetch(
+          `/me/conversations/${encodeURIComponent(id)}/archive`,
+          { ...options, method: "POST" }
+        );
+      },
+      /**
+       * Move an archived conversation back to the main inbox. Idempotent.
+       *
+       * @example
+       * await board.me.conversations.unarchive(id);
+       */
+      unarchive(id, options) {
+        return client.fetch(
+          `/me/conversations/${encodeURIComponent(id)}/unarchive`,
+          { ...options, method: "POST" }
+        );
+      },
+      /**
+       * The existing employer↔candidate conversation id (or null). Tier-3
+       * talent-contact helper — route to an existing thread instead of opening
+       * a composer.
+       *
+       * @example
+       * const { conversationId } = await board.me.conversations.findExisting({ candidateBoardUserId });
+       */
+      findExisting(query, options) {
+        return client.fetch(
+          "/me/conversations/find-existing",
+          { ...options, query }
+        );
+      }
+    },
+    /**
+     * Blocking (doc 34 §E): list / add / remove blocks + a Tier-3 status check.
+     */
+    blocks: {
+      /**
+       * The users I've blocked.
+       *
+       * @example
+       * const { data } = await board.me.blocks.list();
+       */
+      list(options) {
+        return client.fetch("/me/blocks", options);
+      },
+      /**
+       * Block a user (silent). Idempotent.
+       *
+       * @example
+       * await board.me.blocks.create({ boardUserId });
+       */
+      create(body, options) {
+        return client.fetch("/me/blocks", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /**
+       * Unblock a user. Idempotent.
+       *
+       * @example
+       * await board.me.blocks.remove(boardUserId);
+       */
+      remove(boardUserId, options) {
+        return client.fetch(
+          `/me/blocks/${encodeURIComponent(boardUserId)}`,
+          { ...options, method: "DELETE" }
+        );
+      },
+      /**
+       * Whether I've blocked a user (Tier-3 helper).
+       *
+       * @example
+       * const { blocked } = await board.me.blocks.status(boardUserId);
+       */
+      status(boardUserId, options) {
+        return client.fetch(
+          `/me/blocks/${encodeURIComponent(boardUserId)}`,
+          options
+        );
+      }
+    },
+    /**
+     * Message-scoped actions (doc 34 §E): edit / unsend your own messages
+     * (15-minute window), and report a message addressed to you.
+     */
+    messages: {
+      /**
+       * Edit one of your own messages (within the 15-minute window). Returns
+       * the updated message.
+       *
+       * @example
+       * const msg = await board.me.messages.edit(id, { body: 'fixed typo' });
+       */
+      edit(id, body, options) {
+        return client.fetch(`/me/messages/${encodeURIComponent(id)}`, {
+          ...options,
+          method: "PATCH",
+          body
+        });
+      },
+      /**
+       * Unsend (soft-delete) one of your own messages (within the 15-minute
+       * window). Idempotent. Returns the tombstoned message (empty `body`).
+       *
+       * @example
+       * await board.me.messages.unsend(id);
+       */
+      unsend(id, options) {
+        return client.fetch(`/me/messages/${encodeURIComponent(id)}`, {
+          ...options,
+          method: "DELETE"
+        });
+      },
+      /**
+       * Report a message addressed to you for moderation. Auto-blocks the
+       * author.
+       *
+       * @example
+       * const { blocked } = await board.me.messages.report(id, { reason: 'spam' });
+       */
+      report(id, body, options) {
+        return client.fetch(
+          `/me/messages/${encodeURIComponent(id)}/report`,
+          { ...options, method: "POST", body }
+        );
+      }
+    },
+    /**
+     * The candidate job-access paywall — the authenticated money flow (doc 36 /
+     * ADR-0056). Enumerate offers publicly with `board.paywall.offers()`, then
+     * `checkout` here; poll `retrieveCheckout` until complete and confirm with
+     * `grant`. The SDK stays Stripe-agnostic — `checkout` returns a mount kit
+     * and the frontend brings `@stripe/stripe-js`.
+     */
+    access: {
+      /**
+       * Start an embedded checkout for one offer and return a connected-account
+       * mount kit `{ sessionId, clientSecret, stripeAccountId, publishableKey,
+       * offerType }`. `returnPath` is a safe relative path. Requires a candidate
+       * profile.
+       *
+       * @example
+       * const kit = await board.me.access.checkout({
+       *   offerKey: 'monthly',
+       *   returnPath: '/account/access',
+       *   colorMode: 'light',
+       * });
+       * const stripe = await loadStripe(kit.publishableKey, {
+       *   stripeAccount: kit.stripeAccountId,
+       * });
+       */
+      checkout(body, options) {
+        return client.fetch("/me/access/checkout", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /**
+       * Poll a checkout session's state: `open` (re-mountable via
+       * `clientSecret`), `complete`, or `expired`. On `complete`, re-read
+       * `grant()` to confirm entitlement.
+       *
+       * @example
+       * const s = await board.me.access.retrieveCheckout(kit.sessionId);
+       */
+      retrieveCheckout(sessionId, options) {
+        return client.fetch(
+          `/me/access/checkout/${encodeURIComponent(sessionId)}`,
+          options
+        );
+      },
+      /**
+       * The viewer's candidate-access entitlement — always resolves (no-access
+       * is `{ hasAccess: false, … }`, not an error). Gate the ungated jobs
+       * listing on `hasAccess`.
+       *
+       * @example
+       * const { hasAccess } = await board.me.access.grant();
+       */
+      grant(options) {
+        return client.fetch("/me/access/grant", options);
+      },
+      /**
+       * Open a Stripe billing-portal session to manage a recurring subscription
+       * (only when the grant's `offerType` is `recurring`). Optional
+       * `returnPath` threads through to Stripe's return URL.
+       *
+       * @example
+       * const { url } = await board.me.access.portal({ returnPath: '/account' });
+       * location.href = url;
+       */
+      portal(body, options) {
+        return client.fetch("/me/access/portal", {
+          ...options,
+          method: "POST",
+          body
+        });
+      }
     }
   };
 }
@@ -1832,6 +2155,27 @@ function passwordNamespace(client) {
   };
 }
 
+// src/namespaces/paywall.ts
+function paywallNamespace(client) {
+  return {
+    /**
+     * List the board's enabled candidate-access paywall offers (public) — the
+     * pricing tiers a candidate picks before starting checkout
+     * (`board.me.access.checkout`). Returns `[]` when the paywall is disabled.
+     * The internal Stripe price id is never exposed.
+     *
+     * @example
+     * const { data } = await board.paywall.offers();
+     */
+    offers(options) {
+      return client.fetch(
+        "/paywall/offers/enabled",
+        options
+      );
+    }
+  };
+}
+
 // src/namespaces/plans.ts
 function plansNamespace(client) {
   return {
@@ -2108,6 +2452,7 @@ function createBoardClient(options) {
     jobPosting: jobPostingNamespace(client),
     salaries: salariesNamespace(client),
     talent: talentNamespace(client),
-    plans: plansNamespace(client)
+    plans: plansNamespace(client),
+    paywall: paywallNamespace(client)
   };
 }