@cavuno/board 4.26.0 → 4.28.0

package/dist/index.js

@@ -56,6 +56,7 @@ var BOARD_API_ERROR_CODES = [
   "rate_limited",
   "rate_limit_unavailable",
   "search_unavailable",
+  "search_filter_unavailable",
   "too_many_filter_values",
   "pagination_invalid_cursor",
   "pagination_offset_too_large",
@@ -88,6 +89,9 @@ var BOARD_API_ERROR_CODES = [
   "categories_not_found",
   "skills_not_found",
   "places_not_found",
+  // Location search + `locationId` on job office locations
+  "locations_invalid_id",
+  "locations_unavailable",
   // Companies (public reads)
   "companies_not_found",
   "company_markets_not_found",
@@ -119,6 +123,7 @@ var BOARD_API_ERROR_CODES = [
   "candidate_handle_taken",
   "candidate_job_not_found",
   "candidate_notification_preference_paused",
+  "candidate_profile_required",
   "resume_invalid_file",
   "resume_upload_forbidden",
   // Applications
@@ -358,7 +363,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "4.26.0";
+var SDK_VERSION = "4.28.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -1078,6 +1083,13 @@ function jobPostingNamespace(client) {
 // src/namespaces/jobs.ts
 function jobsNamespace(client) {
   return {
+    /** List active entries available to a job collection field. Follow nextCursor for more. */
+    collectionChoices(fieldKey, query, options) {
+      return client.fetch(
+        `/job-fields/${encodeURIComponent(fieldKey)}/choices`,
+        { ...options, query }
+      );
+    },
     /**
      * List published jobs.
      *
@@ -1111,7 +1123,7 @@ function jobsNamespace(client) {
      * @example
      * const { data } = await board.jobs.search({
      *   query: 'chef',
-     *   filters: { seniority: ['senior'] },
+     *   filters: { seniority: ['senior'], categories: ['engineering'] },
      * });
      */
     search(body, query, options) {
@@ -1226,6 +1238,37 @@ function jobsNamespace(client) {
   };
 }
 
+// src/namespaces/locations.ts
+function locationsNamespace(client) {
+  return {
+    /**
+     * GET /locations/search — worldwide autocomplete over countries,
+     * regions, cities, and localities, not only places the board's jobs already
+     * use (that is `taxonomy.places.list({ q })`). Order is the contract: do
+     * not re-sort. Complete a pick with `locations.resolve` using the same
+     * session before sending its `id` as `locationId` later.
+     *
+     * @example
+     * const session = crypto.randomUUID();
+     * const { data } = await board.locations.search({ q: 'berl', session });
+     */
+    search(query, options) {
+      return client.fetch("/locations/search", {
+        ...options,
+        query
+      });
+    },
+    /** Complete a picked suggestion with the same search session. */
+    resolve(input, options) {
+      return client.fetch("/locations/resolve", {
+        ...options,
+        method: "POST",
+        body: input
+      });
+    }
+  };
+}
+
 // src/namespaces/me.ts
 function meNamespace(client) {
   return {
@@ -1322,6 +1365,13 @@ function meNamespace(client) {
      * experience / education / skills / languages collections + avatar.
      */
     profile: {
+      /** List selectable records for an owner-editable catalog field, including private fields. */
+      listObjectReferenceChoices(fieldKey, query, options) {
+        return client.fetch(
+          "/me/profile/object-references/choices",
+          { ...options, query: { ...query, fieldKey } }
+        );
+      },
       /**
        * Retrieve my lean candidate profile.
        *
@@ -1349,6 +1399,34 @@ function meNamespace(client) {
           query
         });
       },
+      /** Retrieve my profile custom-field definitions and current values. */
+      retrieveCustomFields(options) {
+        return client.fetch("/me/profile/custom-fields", {
+          ...options
+        });
+      },
+      /** Additively update my editable candidate profile custom fields. */
+      updateCustomFields(body, options) {
+        return client.fetch("/me/profile/custom-fields", {
+          ...options,
+          method: "PATCH",
+          body
+        });
+      },
+      /** Retrieve editable catalog references on my candidate profile. */
+      retrieveObjectReferences(options) {
+        return client.fetch(
+          "/me/profile/object-references",
+          options
+        );
+      },
+      /** Replace editable catalog references on my candidate profile. */
+      updateObjectReferences(body, options) {
+        return client.fetch(
+          "/me/profile/object-references",
+          { ...options, method: "PUT", body }
+        );
+      },
       /**
        * Check whether a handle is available for me on this board (my own
        * current handle counts as available). Advisory — `update` re-checks.
@@ -1502,6 +1580,27 @@ function meNamespace(client) {
      * claiming a company — the same identity can also be a candidate.
      */
     companies: {
+      /** List selectable records for an approved company's owner-editable catalog field. */
+      listObjectReferenceChoices(slug, fieldKey, query, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/object-references/choices`,
+          { ...options, query: { ...query, fieldKey } }
+        );
+      },
+      /** Retrieve editable catalog references for one of my companies. */
+      retrieveObjectReferences(slug, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/object-references`,
+          options
+        );
+      },
+      /** Replace editable catalog references for one of my companies. */
+      updateObjectReferences(slug, body, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/object-references`,
+          { ...options, method: "PUT", body }
+        );
+      },
       /**
        * Search companies on this board to claim.
        *
@@ -1592,6 +1691,20 @@ function meNamespace(client) {
           { ...options, method: "PATCH", body }
         );
       },
+      /** Retrieve profile custom fields for a company I belong to. */
+      retrieveCustomFields(slug, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/custom-fields`,
+          options
+        );
+      },
+      /** Additively update editable custom fields for a company I belong to. */
+      updateCustomFields(slug, body, options) {
+        return client.fetch(
+          `/me/companies/${encodeURIComponent(slug)}/custom-fields`,
+          { ...options, method: "PATCH", body }
+        );
+      },
       /**
        * Delete a company I admin (soft-delete cascade + Forager
        * exclusion). Resolves void on success (204).
@@ -1628,7 +1741,9 @@ function meNamespace(client) {
        */
       updateMemberRole(slug, memberId, body, options) {
         return client.fetch(
-          `/me/companies/${encodeURIComponent(slug)}/members/${encodeURIComponent(memberId)}`,
+          `/me/companies/${encodeURIComponent(
+            slug
+          )}/members/${encodeURIComponent(memberId)}`,
           { ...options, method: "PATCH", body }
         );
       },
@@ -1641,7 +1756,9 @@ function meNamespace(client) {
        */
       removeMember(slug, memberId, options) {
         return client.fetch(
-          `/me/companies/${encodeURIComponent(slug)}/members/${encodeURIComponent(memberId)}`,
+          `/me/companies/${encodeURIComponent(
+            slug
+          )}/members/${encodeURIComponent(memberId)}`,
           { ...options, method: "DELETE" }
         );
       },
@@ -1693,7 +1810,9 @@ function meNamespace(client) {
        */
       retrieveMembershipCheckout(slug, sessionId, options) {
         return client.fetch(
-          `/me/companies/${encodeURIComponent(slug)}/membership/checkout/${encodeURIComponent(sessionId)}`,
+          `/me/companies/${encodeURIComponent(
+            slug
+          )}/membership/checkout/${encodeURIComponent(sessionId)}`,
           options
         );
       },
@@ -1733,7 +1852,9 @@ function meNamespace(client) {
        */
       revokeInvite(slug, inviteId, options) {
         return client.fetch(
-          `/me/companies/${encodeURIComponent(slug)}/invites/${encodeURIComponent(inviteId)}`,
+          `/me/companies/${encodeURIComponent(
+            slug
+          )}/invites/${encodeURIComponent(inviteId)}`,
           { ...options, method: "DELETE" }
         );
       },
@@ -1815,18 +1936,27 @@ function meNamespace(client) {
          */
         retrieve(slug, id, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/jobs/${encodeURIComponent(id)}`,
             options
           );
         },
         /**
          * Create a job as a held draft. Returns the created job.
+         * `remoteOption` is required. A `salaryMin` or `salaryMax` needs both
+         * `salaryCurrency` and `salaryTimeframe`.
          *
          * @example
          * await board.me.companies.jobs.create('acme', {
          *   title: 'Staff Engineer',
          *   description: '…',
          *   applicationUrl: 'https://acme.com/apply',
+         *   remoteOption: 'remote',
+         *   remotePermits: [{ type: 'worldwide', value: 'worldwide' }],
+         *   salaryMin: 150000,
+         *   salaryCurrency: 'USD',
+         *   salaryTimeframe: 'per_year',
          * });
          */
         create(slug, body, options) {
@@ -1846,7 +1976,9 @@ function meNamespace(client) {
          */
         update(slug, id, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/jobs/${encodeURIComponent(id)}`,
             { ...options, method: "PATCH", body }
           );
         },
@@ -1858,7 +1990,9 @@ function meNamespace(client) {
          */
         delete(slug, id, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/jobs/${encodeURIComponent(id)}`,
             { ...options, method: "DELETE" }
           );
         },
@@ -1872,7 +2006,9 @@ function meNamespace(client) {
          */
         publish(slug, id, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}/publish`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/jobs/${encodeURIComponent(id)}/publish`,
             { ...options, method: "POST" }
           );
         },
@@ -1885,26 +2021,34 @@ function meNamespace(client) {
          */
         unpublish(slug, id, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}/unpublish`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/jobs/${encodeURIComponent(id)}/unpublish`,
             { ...options, method: "POST" }
           );
         },
         /**
          * Pay for / publish a held draft. 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'`).
+         * the webhook publishes on payment); a free plan publishes immediately
+         * (`status: 'published'`) unless the board requires free-job approval
+         * (`status: 'pending_approval'`); bundle, subscription, and member-credit
+         * posts always publish immediately; an invoice plan emails a Stripe
+         * invoice (`status: 'invoice_sent'`) or holds an on-issue post for
+         * approval.
          *
          * @example
          * const r = await board.me.companies.jobs.checkout('acme', jobId, {
          *   billing: { type: 'new', planId },
          * });
          * if (r.status === 'checkout') location.href = r.checkoutUrl!;
+         * if (r.status === 'pending_approval') showAwaitingReview(r.jobId);
          */
         checkout(slug, id, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/jobs/${encodeURIComponent(id)}/checkout`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/jobs/${encodeURIComponent(id)}/checkout`,
             { ...options, method: "POST", body }
           );
         }
@@ -2026,7 +2170,9 @@ function meNamespace(client) {
          */
         timeseries(slug, query, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/profile-stats/timeseries`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/profile-stats/timeseries`,
             { ...options, query }
           );
         }
@@ -2102,14 +2248,18 @@ function meNamespace(client) {
          */
         update(slug, listId, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/talent-lists/${encodeURIComponent(listId)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/talent-lists/${encodeURIComponent(listId)}`,
             { ...options, method: "PATCH", body }
           );
         },
         /** Delete a talent list. Sourced membership is unaffected. */
         remove(slug, listId, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/talent-lists/${encodeURIComponent(listId)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/talent-lists/${encodeURIComponent(listId)}`,
             { ...options, method: "DELETE" }
           );
         }
@@ -2157,7 +2307,9 @@ function meNamespace(client) {
         /** Remove a sourced membership. Does not touch pipeline applications. */
         remove(slug, sourcedId, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/sourced-candidates/${encodeURIComponent(sourcedId)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/sourced-candidates/${encodeURIComponent(sourcedId)}`,
             { ...options, method: "DELETE" }
           );
         },
@@ -2177,7 +2329,9 @@ function meNamespace(client) {
          */
         convert(slug, sourcedId, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/sourced-candidates/${encodeURIComponent(sourcedId)}/convert`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/sourced-candidates/${encodeURIComponent(sourcedId)}/convert`,
             { ...options, method: "POST", body }
           );
         }
@@ -2217,7 +2371,9 @@ function meNamespace(client) {
          */
         move(slug, applicationId, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/applicants/${encodeURIComponent(applicationId)}/stage`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/applicants/${encodeURIComponent(applicationId)}/stage`,
             { ...options, method: "PATCH", body }
           );
         },
@@ -2262,7 +2418,9 @@ function meNamespace(client) {
          */
         addNote(slug, applicationId, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/applicants/${encodeURIComponent(applicationId)}/notes`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/applicants/${encodeURIComponent(applicationId)}/notes`,
             { ...options, method: "POST", body }
           );
         }
@@ -2299,7 +2457,9 @@ function meNamespace(client) {
          */
         update(slug, stageId, body, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/pipeline-stages/${encodeURIComponent(stageId)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/pipeline-stages/${encodeURIComponent(stageId)}`,
             { ...options, method: "PATCH", body }
           );
         },
@@ -2312,7 +2472,9 @@ function meNamespace(client) {
          */
         remove(slug, stageId, options) {
           return client.fetch(
-            `/me/companies/${encodeURIComponent(slug)}/pipeline-stages/${encodeURIComponent(stageId)}`,
+            `/me/companies/${encodeURIComponent(
+              slug
+            )}/pipeline-stages/${encodeURIComponent(stageId)}`,
             { ...options, method: "DELETE" }
           );
         },
@@ -2982,8 +3144,11 @@ function meNamespace(client) {
        * profile.
        *
        * @example
+       * const { data: offers } = await board.paywall.offers();
+       * const selectedOffer = offers[0]; // Or the offer selected in your UI.
+       * if (!selectedOffer) throw new Error('No access offers available');
        * const kit = await board.me.access.checkout({
-       *   offerKey: 'monthly',
+       *   offerKey: selectedOffer.offerKey,
        *   returnPath: '/account/access',
        *   colorMode: 'light',
        * });
@@ -3125,6 +3290,26 @@ function plansNamespace(client) {
   };
 }
 
+// src/namespaces/profile-fields.ts
+function profileFieldsNamespace(client) {
+  return {
+    /** Discover public scalar and catalog field definitions for a profile type. */
+    retrieve(entity, options) {
+      return client.fetch(
+        `/profile-fields/${encodeURIComponent(entity)}`,
+        options
+      );
+    },
+    /** Discover active choices for a public catalog field; follow nextCursor for more. */
+    choices(entity, fieldKey, query, options) {
+      return client.fetch(
+        `/profile-fields/${encodeURIComponent(entity)}/${encodeURIComponent(fieldKey)}/choices`,
+        { ...options, query }
+      );
+    }
+  };
+}
+
 // src/namespaces/redirects.ts
 function redirectsNamespace(client) {
   return {
@@ -3302,9 +3487,14 @@ function talentNamespace(client) {
      * const { data } = await board.talent.list({ skill: 'react', limit: 20 });
      */
     list(query, options) {
+      const serializedQuery = query ? {
+        ...query,
+        customFields: query.customFields ? JSON.stringify(query.customFields) : void 0,
+        objectReferences: query.objectReferences ? JSON.stringify(query.objectReferences) : void 0
+      } : void 0;
       return client.fetch("/talent", {
         ...options,
-        query
+        query: serializedQuery
       });
     },
     /**
@@ -3514,11 +3704,13 @@ function createBoardClient(options) {
     password: passwordNamespace(client),
     taxonomy: taxonomyNamespace(client),
     search: searchNamespace(client),
+    locations: locationsNamespace(client),
     redirects: redirectsNamespace(client),
     jobAlerts: jobAlertsNamespace(client),
     jobPosting: jobPostingNamespace(client),
     salaries: salariesNamespace(client),
     talent: talentNamespace(client),
+    profileFields: profileFieldsNamespace(client),
     plans: plansNamespace(client),
     paywall: paywallNamespace(client),
     sitemap: sitemapNamespace(client)