@cavuno/board 1.19.1 → 1.21.0

package/dist/index.js

@@ -149,7 +149,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.19.1";
+var SDK_VERSION = "1.21.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -910,6 +910,604 @@ function meNamespace(client) {
     retrieve(query, options) {
       return client.fetch("/me", { ...options, query });
     },
+    /**
+     * Permanently delete my account and all dependent data (profile,
+     * collections, saved jobs, alerts, avatar/resume files). Synchronous and
+     * irreversible — resolves void once the cascade completes (204).
+     *
+     * @example
+     * await board.me.delete();
+     */
+    delete(options) {
+      return client.fetch("/me", { ...options, method: "DELETE" });
+    },
+    /**
+     * The authenticated candidate's own account self-service (doc 32).
+     * `profile.*` is the lean profile singleton + (commit 2+) its
+     * experience / education / skills / languages collections + avatar.
+     */
+    profile: {
+      /**
+       * Retrieve my lean candidate profile.
+       *
+       * @example
+       * const profile = await board.me.profile.retrieve();
+       */
+      retrieve(query, options) {
+        return client.fetch("/me/profile", {
+          ...options,
+          query
+        });
+      },
+      /**
+       * Update my candidate profile. Optional-field merge-patch — omitted
+       * fields stay unchanged.
+       *
+       * @example
+       * await board.me.profile.update({ headline: 'Staff Engineer' });
+       */
+      update(body, query, options) {
+        return client.fetch("/me/profile", {
+          ...options,
+          method: "PATCH",
+          body,
+          query
+        });
+      },
+      /**
+       * Check whether a handle is available for me on this board (my own
+       * current handle counts as available). Advisory — `update` re-checks.
+       *
+       * @example
+       * const { available } = await board.me.profile.handleAvailable('jane');
+       */
+      handleAvailable(handle, options) {
+        return client.fetch(
+          "/me/profile/handle-available",
+          { ...options, query: { handle } }
+        );
+      },
+      /** List my experience entries. */
+      listExperience(options) {
+        return client.fetch(
+          "/me/profile/experience",
+          options
+        );
+      },
+      /** Add an experience entry. */
+      createExperience(body, options) {
+        return client.fetch("/me/profile/experience", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /** Update an experience entry (merge-patch). */
+      updateExperience(id, body, options) {
+        return client.fetch(
+          `/me/profile/experience/${encodeURIComponent(id)}`,
+          { ...options, method: "PATCH", body }
+        );
+      },
+      /** Delete an experience entry. */
+      deleteExperience(id, options) {
+        return client.fetch(
+          `/me/profile/experience/${encodeURIComponent(id)}`,
+          { ...options, method: "DELETE" }
+        );
+      },
+      /** List my education entries. */
+      listEducation(options) {
+        return client.fetch(
+          "/me/profile/education",
+          options
+        );
+      },
+      /** Add an education entry. */
+      createEducation(body, options) {
+        return client.fetch("/me/profile/education", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /** Update an education entry (merge-patch). */
+      updateEducation(id, body, options) {
+        return client.fetch(
+          `/me/profile/education/${encodeURIComponent(id)}`,
+          { ...options, method: "PATCH", body }
+        );
+      },
+      /** Delete an education entry. */
+      deleteEducation(id, options) {
+        return client.fetch(
+          `/me/profile/education/${encodeURIComponent(id)}`,
+          { ...options, method: "DELETE" }
+        );
+      },
+      /** List my skills. */
+      listSkills(options) {
+        return client.fetch(
+          "/me/profile/skills",
+          options
+        );
+      },
+      /** Replace my skills with the provided ordered names. */
+      updateSkills(body, options) {
+        return client.fetch(
+          "/me/profile/skills",
+          { ...options, method: "PUT", body }
+        );
+      },
+      /** List my languages. */
+      listLanguages(options) {
+        return client.fetch(
+          "/me/profile/languages",
+          options
+        );
+      },
+      /** Replace my languages with the provided ordered set. */
+      updateLanguages(body, options) {
+        return client.fetch(
+          "/me/profile/languages",
+          { ...options, method: "PUT", body }
+        );
+      },
+      /**
+       * Upload my avatar (JPEG/PNG/WebP, ≤5 MB) via a single multipart POST.
+       *
+       * @example
+       * await board.me.profile.uploadAvatar(file);
+       */
+      uploadAvatar(file, options) {
+        const form = new FormData();
+        form.append("file", file);
+        return client.fetch("/me/profile/avatar", {
+          ...options,
+          method: "POST",
+          body: form
+        });
+      }
+    },
+    /**
+     * Signed-in notification preferences + the anonymous email-link
+     * unsubscribe branch (doc 32).
+     */
+    notificationPreferences: {
+      /** List every notification channel + its subscribed state. */
+      retrieve(options) {
+        return client.fetch(
+          "/me/notification-preferences",
+          options
+        );
+      },
+      /** Toggle one channel; returns the full updated set. */
+      update(body, options) {
+        return client.fetch(
+          "/me/notification-preferences",
+          { ...options, method: "PUT", body }
+        );
+      },
+      /**
+       * Anonymous one-click unsubscribe via an HMAC email-link token — no
+       * session. Resolves void on success (204).
+       */
+      unsubscribeWithToken(body, options) {
+        return client.fetch("/me/notification-preferences/unsubscribe", {
+          ...options,
+          method: "POST",
+          body
+        });
+      }
+    },
+    /**
+     * The authenticated board user's employer facet (doc 35 / ADR-0052):
+     * claiming/creating a company, the work-email verification state machine,
+     * and editing the company profile. A board user becomes an employer by
+     * claiming a company — the same identity can also be a candidate.
+     */
+    companies: {
+      /**
+       * Search companies on this board to claim.
+       *
+       * @example
+       * const { data } = await board.me.companies.search({ q: 'acme' });
+       */
+      search(query, options) {
+        return client.fetch(
+          "/me/companies/search",
+          { ...options, query }
+        );
+      },
+      /**
+       * List my company memberships, each with its computed claim `status`.
+       *
+       * @example
+       * const { data } = await board.me.companies.list();
+       */
+      list(options) {
+        return client.fetch(
+          "/me/companies",
+          options
+        );
+      },
+      /**
+       * Create (or adopt an existing same-domain) company and open a
+       * membership. Returns the membership.
+       *
+       * @example
+       * await board.me.companies.create({ name: 'Acme', website: 'acme.com' });
+       */
+      create(body, options) {
+        return client.fetch("/me/companies", {
+          ...options,
+          method: "POST",
+          body
+        });
+      },
+      /**
+       * Claim an existing company by slug. Returns the membership with its
+       * computed status (`approved` on email-domain match, else pending).
+       *
+       * @example
+       * await board.me.companies.claim('acme');
+       */
+      claim(slug, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/claim`,
+          { ...options, method: "POST" }
+        );
+      },
+      /**
+       * Cancel my pending claim on a company. Resolves void on success (204).
+       *
+       * @example
+       * await board.me.companies.cancelClaim('acme');
+       */
+      cancelClaim(slug, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/claim`,
+          { ...options, method: "DELETE" }
+        );
+      },
+      /**
+       * Edit my company profile (merge-patch — omitted fields stay
+       * unchanged). Requires an approved membership. Returns the company.
+       *
+       * @example
+       * await board.me.companies.update('acme', { website: 'acme.io' });
+       */
+      update(slug, body, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}`,
+          { ...options, method: "PATCH", body }
+        );
+      },
+      /** The work-email verification state machine for a pending claim. */
+      workEmail: {
+        /**
+         * Email a 24h verification link to a work email for my pending claim.
+         * Returns the membership with the work email recorded.
+         *
+         * @example
+         * await board.me.companies.workEmail.verify('acme', {
+         *   workEmail: 'me@acme.com',
+         * });
+         */
+        verify(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/work-email/verify`,
+            { ...options, method: "POST", body }
+          );
+        },
+        /**
+         * Confirm a verification token (from the email link) — no session
+         * required, the token IS the authorization. Returns the membership in
+         * its new state.
+         *
+         * @example
+         * await board.me.companies.workEmail.confirm('acme', { token });
+         */
+        confirm(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/work-email/confirm`,
+            { ...options, method: "POST", body }
+          );
+        }
+      },
+      /**
+       * Manage the jobs of a company I am an approved member of (doc 35 /
+       * ADR-0052). Every method is scoped to the company `slug`. New jobs are
+       * created as held drafts — publishing is `publish` (within a live paid
+       * window) or the paid-post checkout flow.
+       */
+      jobs: {
+        /**
+         * List a company's jobs (all statuses), newest first.
+         *
+         * @example
+         * const { data } = await board.me.companies.jobs.list('acme');
+         */
+        list(slug, query, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs`,
+            { ...options, query }
+          );
+        },
+        /**
+         * Retrieve one of my company's jobs (any status), fully enriched.
+         *
+         * @example
+         * const job = await board.me.companies.jobs.retrieve('acme', jobId);
+         */
+        retrieve(slug, id, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}`,
+            options
+          );
+        },
+        /**
+         * Create a job as a held draft. Returns the created job.
+         *
+         * @example
+         * await board.me.companies.jobs.create('acme', {
+         *   title: 'Staff Engineer',
+         *   description: '…',
+         *   applicationUrl: 'https://acme.com/apply',
+         * });
+         */
+        create(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs`,
+            { ...options, method: "POST", body }
+          );
+        },
+        /**
+         * Edit a job (merge-patch — omitted fields stay unchanged). Returns the
+         * updated job.
+         *
+         * @example
+         * await board.me.companies.jobs.update('acme', jobId, {
+         *   salaryMax: 220000,
+         * });
+         */
+        update(slug, id, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}`,
+            { ...options, method: "PATCH", body }
+          );
+        },
+        /**
+         * Delete a job (cascade). Resolves void on success (204).
+         *
+         * @example
+         * await board.me.companies.jobs.delete('acme', jobId);
+         */
+        delete(slug, id, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}`,
+            { ...options, method: "DELETE" }
+          );
+        },
+        /**
+         * Publish a job that is still inside its paid window (republish — a held
+         * draft or expired job must instead pay via checkout). Returns the
+         * updated job.
+         *
+         * @example
+         * await board.me.companies.jobs.publish('acme', jobId);
+         */
+        publish(slug, id, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}/publish`,
+            { ...options, method: "POST" }
+          );
+        },
+        /**
+         * Unpublish a job (back to draft; the paid window is preserved). Returns
+         * the updated job.
+         *
+         * @example
+         * await board.me.companies.jobs.unpublish('acme', jobId);
+         */
+        unpublish(slug, id, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}/unpublish`,
+            { ...options, method: "POST" }
+          );
+        },
+        /**
+         * Pay for / publish a held draft (ADR-0031). Select billing: a paid plan
+         * returns `{ status: 'checkout', checkoutUrl }` (send the buyer there;
+         * the webhook publishes on payment); a free / bundle / subscription plan
+         * publishes immediately (`status: 'published'`); an invoice plan emails a
+         * Stripe invoice (`status: 'invoice_sent'`).
+         *
+         * @example
+         * const r = await board.me.companies.jobs.checkout('acme', jobId, {
+         *   billing: { type: 'new', planId },
+         * });
+         * if (r.status === 'checkout') location.href = r.checkoutUrl!;
+         */
+        checkout(slug, id, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}/checkout`,
+            { ...options, method: "POST", body }
+          );
+        }
+      },
+      /**
+       * My reusable billing options for a company — active subscription slots +
+       * remaining pre-purchased (bundle) order slots, the options a held draft
+       * can be published with at no new charge (the checkout `billing.type:
+       * 'order' | 'subscription'`).
+       */
+      billingOptions: {
+        /**
+         * List my reusable billing options for the company.
+         *
+         * @example
+         * const { data } = await board.me.companies.billingOptions.list('acme');
+         */
+        list(slug, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/billing-options`,
+            options
+          );
+        }
+      },
+      /**
+       * The applicant pipeline (ATS) for a company I am an approved member of
+       * (doc 35 / ADR-0052 / ADR-0004). Reads return the full pipeline (job
+       * header + stage rail + applicants with timelines); the move/reject/note
+       * writes resolve void — re-read the pipeline for fresh state, mirroring
+       * the hosted portal's single reactive query.
+       */
+      applicants: {
+        /**
+         * Read a job's applicant pipeline: its header, stage rail, and every
+         * applicant (candidate snapshot, signed resume URL, activity timeline).
+         * `query.job` is required; `query.stage` filters to one stage.
+         *
+         * @example
+         * const pipeline = await board.me.companies.applicants.list('acme', {
+         *   job: jobId,
+         * });
+         */
+        list(slug, query, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/applicants`,
+            { ...options, query }
+          );
+        },
+        /**
+         * Move one applicant to a visible stage of its job's pipeline. Resolves
+         * void on success (204).
+         *
+         * @example
+         * await board.me.companies.applicants.move('acme', applicationId, {
+         *   stageId,
+         * });
+         */
+        move(slug, applicationId, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/applicants/${encodeURIComponent(applicationId)}/stage`,
+            { ...options, method: "PATCH", body }
+          );
+        },
+        /**
+         * Move many applicants of one job to a visible stage atomically.
+         * Resolves void on success (204).
+         *
+         * @example
+         * await board.me.companies.applicants.bulkMove('acme', {
+         *   applicationIds, stageId,
+         * });
+         */
+        bulkMove(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/applicants/bulk/move`,
+            { ...options, method: "POST", body }
+          );
+        },
+        /**
+         * Reject many applicants of one job atomically (move to the rejected
+         * stage). Resolves void on success (204).
+         *
+         * @example
+         * await board.me.companies.applicants.bulkReject('acme', {
+         *   applicationIds,
+         * });
+         */
+        bulkReject(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/applicants/bulk/reject`,
+            { ...options, method: "POST", body }
+          );
+        },
+        /**
+         * Append a company-private note to an applicant (it surfaces in the
+         * applicant timeline). Resolves void on success (204).
+         *
+         * @example
+         * await board.me.companies.applicants.addNote('acme', applicationId, {
+         *   body: 'Strong candidate.',
+         * });
+         */
+        addNote(slug, applicationId, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/applicants/${encodeURIComponent(applicationId)}/notes`,
+            { ...options, method: "POST", body }
+          );
+        }
+      },
+      /**
+       * The pipeline stage rail (ATS) for a company I am an approved member of.
+       * Every write resolves void (the backing portal mutations return void) —
+       * re-read the pipeline via `applicants.list` for the fresh stage rail.
+       */
+      pipelineStages: {
+        /**
+         * Add a custom stage to a job pipeline (before the terminal
+         * Hired/Rejected stages; up to 10 custom per job). Resolves void (204).
+         *
+         * @example
+         * await board.me.companies.pipelineStages.create('acme', {
+         *   jobId, label: 'Phone screen',
+         * });
+         */
+        create(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/pipeline-stages`,
+            { ...options, method: "POST", body }
+          );
+        },
+        /**
+         * Rename a stage (`{ label }`) or show/hide it (`{ hidden }`) — exactly
+         * one. Resolves void on success (204).
+         *
+         * @example
+         * await board.me.companies.pipelineStages.update('acme', stageId, {
+         *   label: 'Tech screen',
+         * });
+         */
+        update(slug, stageId, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/pipeline-stages/${encodeURIComponent(stageId)}`,
+            { ...options, method: "PATCH", body }
+          );
+        },
+        /**
+         * Remove a custom stage (protected stages cannot be removed). Resolves
+         * void on success (204).
+         *
+         * @example
+         * await board.me.companies.pipelineStages.remove('acme', stageId);
+         */
+        remove(slug, stageId, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/pipeline-stages/${encodeURIComponent(stageId)}`,
+            { ...options, method: "DELETE" }
+          );
+        },
+        /**
+         * Set the full stage order for a job (list every stage exactly once,
+         * keeping Review first and Hired immediately before Rejected). Resolves
+         * void on success (204).
+         *
+         * @example
+         * await board.me.companies.pipelineStages.reorder('acme', {
+         *   jobId, orderedStageIds,
+         * });
+         */
+        reorder(slug, body, options) {
+          return client.fetch(
+            `/me/companies/${encodeURIComponent(slug)}/pipeline-stages/reorder`,
+            { ...options, method: "PUT", body }
+          );
+        }
+      }
+    },
     savedJobs: {
       /**
        * List the authenticated user's saved jobs (each embeds the full