@cavuno/board 1.21.1 → 1.23.0

package/dist/index.js

@@ -149,7 +149,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.21.1";
+var SDK_VERSION = "1.23.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -347,6 +347,35 @@ function authNamespace(client) {
         body
       });
     },
+    /**
+     * Verify the signed-in board user's email with the 6-digit code from the
+     * verification email (requires the bearer). Resolves void (204); an
+     * invalid/expired code is a 401 `BoardApiError`. Distinct from the
+     * anonymous magic-link `verifyEmail({ token })`.
+     *
+     * @example
+     * await board.auth.verifyEmailWithCode({ code: '123456' });
+     */
+    verifyEmailWithCode(body, options) {
+      return client.fetch("/auth/verify-email/otp", {
+        ...options,
+        method: "POST",
+        body
+      });
+    },
+    /**
+     * Re-send the verification email (fresh code + magic link) to the signed-in
+     * board user. Resolves void (204); no-op if already verified.
+     *
+     * @example
+     * await board.auth.resendVerification();
+     */
+    resendVerification(options) {
+      return client.fetch("/auth/verify-email/resend", {
+        ...options,
+        method: "POST"
+      });
+    },
     /**
      * Request a password-reset email. Always resolves (204) whether or
      * not the email exists — no account oracle.
@@ -869,6 +898,53 @@ function jobsNamespace(client) {
           query
         }
       );
+    },
+    /**
+     * Apply to a job natively (ADR-0054). Optional auth: a signed-in candidate
+     * applies from their profile (omit name/email); a guest supplies them
+     * (allowed only when the board permits applications without sign-up).
+     * Idempotent — a repeat apply returns the existing application.
+     *
+     * @example
+     * const application = await board.jobs.apply('senior-chef', {
+     *   coverNote: 'Excited to cook here.',
+     * });
+     */
+    apply(jobSlug, body, options) {
+      return client.fetch(
+        `/jobs/${encodeURIComponent(jobSlug)}/apply`,
+        { ...options, method: "POST", body: body ?? {} }
+      );
+    },
+    /**
+     * Upload + attach a resume to an application (multipart). Signed-in
+     * candidates target their own application for the job; a guest passes the
+     * `applicationId` returned by `apply`. Returns the updated application.
+     *
+     * @example
+     * await board.jobs.uploadApplicationResume('senior-chef', file);
+     */
+    uploadApplicationResume(jobSlug, file, opts, options) {
+      const form = new FormData();
+      form.append("file", file);
+      if (opts?.applicationId) form.append("applicationId", opts.applicationId);
+      return client.fetch(
+        `/jobs/${encodeURIComponent(jobSlug)}/apply/resume`,
+        { ...options, method: "POST", body: form }
+      );
+    },
+    /**
+     * The authenticated candidate's application for this job (the apply-button
+     * "have I applied?" check). Throws a 404 `BoardApiError` when there is none.
+     *
+     * @example
+     * const application = await board.jobs.myApplication('senior-chef');
+     */
+    myApplication(jobSlug, options) {
+      return client.fetch(
+        `/jobs/${encodeURIComponent(jobSlug)}/application`,
+        options
+      );
     }
   };
 }
@@ -1508,6 +1584,185 @@ function meNamespace(client) {
         }
       }
     },
+    /**
+     * The authenticated board user's job-alert preferences (ADR-0053) —
+     * a collection (up to 10). Creating one is active immediately (no
+     * double opt-in — the authenticated action is the consent). There is no
+     * pause: `remove` is the only way to stop an alert.
+     */
+    alerts: {
+      /**
+       * List my job alerts.
+       *
+       * @example
+       * const { data } = await board.me.alerts.list();
+       */
+      list(options) {
+        return client.fetch("/me/alerts", options);
+      },
+      /**
+       * Create a new active job alert.
+       *
+       * @example
+       * await board.me.alerts.create({
+       *   frequency: 'weekly',
+       *   jobFunctions: ['engineering'],
+       *   remoteOptions: ['remote'],
+       * });
+       */
+      create(body, options) {
+        return client.fetch("/me/alerts", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /**
+       * Retrieve one of my job alerts.
+       *
+       * @example
+       * const alert = await board.me.alerts.retrieve(alertId);
+       */
+      retrieve(alertId, options) {
+        return client.fetch(
+          `/me/alerts/${encodeURIComponent(alertId)}`,
+          options
+        );
+      },
+      /**
+       * Replace a job alert's filters + frequency in full. Returns the updated
+       * alert.
+       *
+       * @example
+       * await board.me.alerts.update(alertId, {
+       *   frequency: 'daily',
+       *   placeIds: ['ChIJ…'],
+       * });
+       */
+      update(alertId, body, options) {
+        return client.fetch(
+          `/me/alerts/${encodeURIComponent(alertId)}`,
+          { ...options, method: "PUT", body }
+        );
+      },
+      /**
+       * Delete a job alert. Resolves void on success (204).
+       *
+       * @example
+       * await board.me.alerts.remove(alertId);
+       */
+      remove(alertId, options) {
+        return client.fetch(`/me/alerts/${encodeURIComponent(alertId)}`, {
+          ...options,
+          method: "DELETE"
+        });
+      }
+    },
+    /**
+     * The authenticated candidate's applications (ADR-0054). Apply itself lives
+     * on the job (`board.jobs.apply` — it is optional-auth); these manage the
+     * applications the candidate has already submitted, keyed by `applicationId`.
+     */
+    applications: {
+      /**
+       * List my applications, newest first.
+       *
+       * @example
+       * const { data } = await board.me.applications.list();
+       */
+      list(query, options) {
+        return client.fetch("/me/applications", {
+          ...options,
+          query
+        });
+      },
+      /**
+       * Retrieve one of my applications by id.
+       *
+       * @example
+       * const application = await board.me.applications.retrieve(id);
+       */
+      retrieve(applicationId, options) {
+        return client.fetch(
+          `/me/applications/${encodeURIComponent(applicationId)}`,
+          options
+        );
+      },
+      /**
+       * Edit the candidate-facing facts of an application (merge-patch). Only
+       * while it is still editable. Returns the updated application.
+       *
+       * @example
+       * await board.me.applications.updateFacts(id, { coverNote: '…' });
+       */
+      updateFacts(applicationId, body, options) {
+        return client.fetch(
+          `/me/applications/${encodeURIComponent(applicationId)}`,
+          { ...options, method: "PATCH", body }
+        );
+      },
+      /**
+       * Withdraw (permanently delete) an application. Resolves void on 204.
+       *
+       * @example
+       * await board.me.applications.withdraw(id);
+       */
+      withdraw(applicationId, options) {
+        return client.fetch(
+          `/me/applications/${encodeURIComponent(applicationId)}/withdraw`,
+          { ...options, method: "POST" }
+        );
+      }
+    },
+    /**
+     * The candidate's resume (ADR-0055). `upload` starts an async parse that
+     * auto-populates the profile — it returns `parseStatus: 'parsing'`; poll
+     * `retrieve()` until `parsed`/`failed`, then re-read `profile.*`.
+     */
+    resume: {
+      /**
+       * Upload a resume and start the async parse. Returns the resume with
+       * `parseStatus: 'parsing'`.
+       *
+       * @example
+       * await board.me.resume.upload(file, { keepResumeOnFile: true });
+       */
+      upload(file, opts, options) {
+        const form = new FormData();
+        form.append("resume", file);
+        if (opts?.keepResumeOnFile) form.append("keepResumeOnFile", "true");
+        if (opts?.importMode) form.append("importMode", opts.importMode);
+        if (opts?.confirmReplaceAll) form.append("confirmReplaceAll", "true");
+        return client.fetch("/me/resume", {
+          ...options,
+          method: "POST",
+          body: form
+        });
+      },
+      /**
+       * Retrieve my resume state (parse status + stored file). Poll this after
+       * `upload` until `parseStatus` is `parsed` or `failed`.
+       *
+       * @example
+       * const resume = await board.me.resume.retrieve();
+       */
+      retrieve(options) {
+        return client.fetch("/me/resume", options);
+      },
+      /**
+       * Delete my stored resume file + withdraw keep-on-file consent (parsed
+       * profile fields stay). Resolves void (204).
+       *
+       * @example
+       * await board.me.resume.delete();
+       */
+      delete(options) {
+        return client.fetch("/me/resume", {
+          ...options,
+          method: "DELETE"
+        });
+      }
+    },
     savedJobs: {
       /**
        * List the authenticated user's saved jobs (each embeds the full
@@ -1549,6 +1804,256 @@ 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 }
+        );
+      }
     }
   };
 }