@cavuno/board 1.23.0 → 1.25.0

package/dist/index.d.mts

@@ -1,5 +1,61 @@
 interface components {
     schemas: {
+        AccessCheckoutBody: {
+            /**
+             * @description The offer tier to purchase (from `GET /paywall/offers/enabled`).
+             * @enum {string}
+             */
+            offerKey: "daily" | "weekly" | "monthly" | "quarterly" | "yearly" | "lifetime";
+            /** @description Relative path Stripe returns the buyer to on completion; `session_id` is appended. */
+            returnPath: string;
+            /** @enum {string} */
+            colorMode: "light" | "dark";
+        };
+        AccessCheckoutSession: {
+            /** @enum {string} */
+            object: "checkout_session";
+            sessionId: string;
+            /** @description The Checkout Session client secret to mount the embedded form. */
+            clientSecret: string;
+            /** @description The board’s connected Stripe account to initialise Stripe.js with. */
+            stripeAccountId: string;
+            /** @description The platform Stripe publishable key for `loadStripe`. */
+            publishableKey: string;
+            /**
+             * @description `recurring` grants get a manage-subscription portal; `lifetime` do not.
+             * @enum {string}
+             */
+            offerType: "recurring" | "lifetime";
+        };
+        AccessCheckoutSessionState: {
+            /** @enum {string} */
+            object: "checkout_session_state";
+            /** @enum {string} */
+            status: "open" | "complete" | "expired";
+            clientSecret: string | null;
+        };
+        AccessGrant: {
+            /** @enum {string} */
+            object: "access_grant";
+            hasAccess: boolean;
+            /** @enum {string|null} */
+            status: "active" | "past_due" | "unpaid" | "incomplete" | "incomplete_expired" | "canceled" | "pending" | null;
+            /** @enum {string|null} */
+            offerType: "recurring" | "lifetime" | null;
+            offerKey: string | null;
+            currentPeriodEnd: string | null;
+            cancelAtPeriodEnd: boolean;
+        };
+        AccessPortalBody: {
+            /** @description Relative path Stripe returns the buyer to; defaults to the board root. */
+            returnPath?: string;
+        };
+        AccessPortalSession: {
+            /** @enum {string} */
+            object: "portal_session";
+            /** Format: uri */
+            url: string;
+        };
         AddApplicantNoteBody: {
             /** @description The note text. */
             body: string;
@@ -1073,16 +1129,16 @@ interface components {
             name: string;
         };
         CustomFieldDefinition: {
-            /** @description Immutable per-board slug. Use this as the key in `customFieldValues` when writing values via POST/PATCH /v1/jobs. */
+            /** @description Immutable per-board slug. The key in a job’s `customFieldValues`, and the frontend translation token (`customField.<key>.*`). */
             key: string;
             /** @description Authoring-default label; the localized public string lives in the board template. */
             label: string;
             /**
-             * @description Field type, which dictates the accepted value: `short_text`/`long_text` → string; `single_select` → one option key (string); `multi_select` → array of option keys; `boolean` → boolean; `number` → number.
+             * @description Field type, which dictates the value: `short_text`/`long_text` → string; `single_select` → one option key; `multi_select` → array of option keys; `boolean` → boolean; `number` → number.
              * @enum {string}
              */
             type: "short_text" | "long_text" | "single_select" | "multi_select" | "boolean" | "number";
-            /** @description Present only for `single_select`/`multi_select`. A written value must be one (or, for multi, several) of these option `key`s — never a label. */
+            /** @description Present only for `single_select`/`multi_select`. A stored value is one (or, for multi, several) of these option `key`s — never a label. */
             options?: components["schemas"]["CustomFieldOption"][];
             /** @description When true, the value cannot be cleared or left empty on a write (rejected with `custom_field_required`). */
             required: boolean;
@@ -1092,7 +1148,7 @@ interface components {
             max?: number;
         };
         CustomFieldOption: {
-            /** @description Stable option key — send this in a write, not the label. */
+            /** @description Stable option key — the value stored on a job, not the label. */
             key: string;
             /** @description Display label (authoring default; localized per board in the template). */
             label: string;
@@ -2191,6 +2247,24 @@ interface components {
                 [key: string]: unknown;
             };
         };
+        PaywallOffer: {
+            /** @enum {string} */
+            object: "paywall_offer";
+            /** @description The tier key posted to checkout (e.g. `monthly`, `lifetime`). */
+            offerKey: string;
+            label: string;
+            billingLabel: string;
+            amountCents: number;
+            currency: string;
+            /**
+             * @description `recurring` tiers get a manage-subscription portal; `lifetime` do not.
+             * @enum {string}
+             */
+            offerType: "recurring" | "lifetime";
+            intervalUnit: string | null;
+            intervalCount: number | null;
+            isDefault: boolean;
+        };
         Plan: {
             /** @enum {string} */
             object: "plan";
@@ -2343,6 +2417,8 @@ interface components {
                     };
                 };
             } | null;
+            /** @description Operator-defined custom job-field definitions (CAV-294), in display order. Board-wide; the frontend uses these to render and localize each job's opaque `customFieldValues`. Empty when the board defines none. Display-only — not filterable or searchable in v1. */
+            customFields: components["schemas"]["CustomFieldDefinition"][];
         };
         PublicCompaniesSearchBody: {
             /** @description Free-text search query matched against company name. Up to 200 characters. */
@@ -2477,6 +2553,10 @@ interface components {
                 slug: string;
                 name: string;
             }[];
+            /** @description Opaque, display-only custom-field values (CAV-294), keyed by each field's `key`. Values are the option `key`(s) for select fields, or the raw boolean/number/text otherwise — resolve labels via the board's `customFields` definitions (see `GET /v1/boards/:identifier`). `{}` when the board defines no custom fields. Not filterable or searchable in v1. */
+            customFieldValues: {
+                [key: string]: string | string[] | boolean | number;
+            };
         };
         PublicJobAlertConfirmation: {
             /** @enum {string} */
@@ -3650,102 +3730,6 @@ interface components {
     pathItems: never;
 }
 
-type Schemas = components['schemas'];
-
-/**
- * Stripe-shaped success envelopes (`01-conventions.md` §5.1). The
- * server MAY add top-level fields; consumers MUST ignore unknown
- * fields.
- */
-/**
- * Medusa-style storefront pagination fields (ADR-0037 §7), populated only by
- * the board jobs catalog reads (browse / search / company-jobs); absent on
- * every other list/search. `nextCursor` is preserved alongside (offset-encoded).
- */
-interface StorefrontPagination {
-    /** Total matching results ("X jobs"). */
-    count?: number;
-    /** The page size used for this response. */
-    limit?: number;
-    /** Number of items skipped before this page. */
-    offset?: number;
-    /** Items hidden behind the candidate paywall for the current viewer; absent/0 when entitled. */
-    gatedCount?: number;
-}
-interface ListEnvelope<T> extends StorefrontPagination {
-    object: 'list';
-    url: string;
-    hasMore: boolean;
-    /** `null` when `hasMore` is false — always present, never undefined. */
-    nextCursor: string | null;
-    data: T[];
-}
-interface SearchEnvelope<T> extends StorefrontPagination {
-    object: 'search_result';
-    url: string;
-    hasMore: boolean;
-    nextCursor: string | null;
-    data: T[];
-}
-
-type PublicJob = Schemas['PublicJob'];
-type PublicJobCard = Schemas['PublicJobCard'];
-type JobCompany = Schemas['JobCompany'];
-type OfficeLocation = Schemas['JobOfficeLocation'];
-type RemoteOption = NonNullable<PublicJob['remoteOption']>;
-type EmploymentType = NonNullable<PublicJob['employmentType']>;
-type Seniority = NonNullable<PublicJob['seniority']>;
-/** Candidate-facing result ordering (ADR-0048); `relevance` is the default. */
-type JobSort = NonNullable<Schemas['PublicSearchJobsBody']['sort']>;
-type EducationRequirement = PublicJob['educationRequirements'][number];
-type RemotePermit = PublicJob['remotePermits'][number];
-type RemoteTimezone = PublicJob['remoteTimezones'][number];
-/**
- * Derived suggestion on a browse list (ADR-0037 §8): jobs surface `category`
- * and `skill` terms; the companies list surfaces `market` terms.
- */
-interface RelatedSearch {
-    type: 'category' | 'skill' | 'market';
-    slug: string;
-    term: string;
-    count: number;
-}
-/** The browse list envelope — `PublicJobCard`s + storefront fields + `relatedSearches`. */
-interface JobCardListEnvelope extends ListEnvelope<PublicJobCard> {
-    relatedSearches?: RelatedSearch[];
-}
-/** The search envelope — `PublicJobCard`s + storefront fields. */
-type JobCardSearchEnvelope = SearchEnvelope<PublicJobCard>;
-type JobsListQuery = {
-    cursor?: string;
-    /** 1–100. */
-    limit?: number;
-    /** Storefront page offset; takes precedence over `cursor`. `offset + limit` ≤ 10,000. */
-    offset?: number;
-    /** Repeated param (up to 10) — OR-matched. Repeat `companyId` per value. */
-    companyId?: string[];
-    remoteOption?: RemoteOption[];
-    employmentType?: EmploymentType[];
-    seniority?: Seniority[];
-    /** Result ordering (ADR-0048). Absent ⇒ `relevance` (the featured-ranked browse). */
-    sort?: JobSort;
-    /** Place slug for a geo radius search; unresolvable slugs are ignored. */
-    location?: string;
-    /** Radius in km around `location` (10–250; default 50). */
-    radius?: number;
-    /** Category slug seed (the `/jobs/[keyword]` page) — server resolves it to the English source name; unresolvable → 404. */
-    category?: string;
-    /** Skill slug seed (the `/jobs/skills/[skill]` page) — server-resolved; unresolvable → 404. */
-    skill?: string;
-    /** Sparse fieldset (Medusa-style `+field`). Only `'+description'` is supported — adds `description` to each card. */
-    fields?: string;
-};
-type JobsSimilarQuery = {
-    /** How many similar jobs to return (1–20; default 5). */
-    limit?: number;
-};
-type JobsSearchBody = Schemas['PublicSearchJobsBody'];
-
 type Awaitable<T> = T | Promise<T>;
 /**
  * Async token storage. The SDK reads the access token from storage on
@@ -3865,7 +3849,9 @@ declare function isConflict(e: unknown): e is BoardApiError;
  * constant because the package is platform-neutral and cannot read
  * package.json at runtime.
  */
-declare const SDK_VERSION = "1.23.0";
+declare const SDK_VERSION = "1.25.0";
+
+type Schemas = components['schemas'];
 
 type BoardUser = Schemas['BoardUser'];
 type BoardAuthSession = Schemas['BoardAuthSession'];
@@ -3889,6 +3875,15 @@ type PublicBoard = Schemas['PublicBoardContext'];
 type PublicBoardFeatures = PublicBoard['features'];
 type PublicBoardAnalytics = PublicBoard['analytics'];
 type PublicBoardTheme = NonNullable<PublicBoard['theme']>;
+/**
+ * An operator-defined custom job-field definition (CAV-294). Board-wide;
+ * use it to render and localize a job's opaque `customFieldValues` (resolve
+ * option `key`s → labels, honour field `type` and display order). Shared with
+ * the Operator API's custom-field surface (one canonical schema).
+ */
+type CustomFieldDefinition = Schemas['CustomFieldDefinition'];
+type CustomFieldType = CustomFieldDefinition['type'];
+type CustomFieldOption = Schemas['CustomFieldOption'];
 
 /**
  * The public SEO-infra payload (`board.seo()`) — the values a headless
@@ -3898,6 +3893,107 @@ type PublicBoardTheme = NonNullable<PublicBoard['theme']>;
  */
 type BoardSeo = Schemas['BoardSeo'];
 
+/**
+ * Stripe-shaped success envelopes (`01-conventions.md` §5.1). The
+ * server MAY add top-level fields; consumers MUST ignore unknown
+ * fields.
+ */
+/**
+ * Medusa-style storefront pagination fields (ADR-0037 §7), populated only by
+ * the board jobs catalog reads (browse / search / company-jobs); absent on
+ * every other list/search. `nextCursor` is preserved alongside (offset-encoded).
+ */
+interface StorefrontPagination {
+    /** Total matching results ("X jobs"). */
+    count?: number;
+    /** The page size used for this response. */
+    limit?: number;
+    /** Number of items skipped before this page. */
+    offset?: number;
+    /** Items hidden behind the candidate paywall for the current viewer; absent/0 when entitled. */
+    gatedCount?: number;
+}
+interface ListEnvelope<T> extends StorefrontPagination {
+    object: 'list';
+    url: string;
+    hasMore: boolean;
+    /** `null` when `hasMore` is false — always present, never undefined. */
+    nextCursor: string | null;
+    data: T[];
+}
+interface SearchEnvelope<T> extends StorefrontPagination {
+    object: 'search_result';
+    url: string;
+    hasMore: boolean;
+    nextCursor: string | null;
+    data: T[];
+}
+
+type PublicJob = Schemas['PublicJob'];
+type PublicJobCard = Schemas['PublicJobCard'];
+/**
+ * A job's opaque, display-only custom-field values (CAV-294), keyed by each
+ * field's `key`. Resolve labels via the board's `CustomFieldDefinition`s
+ * (`board.context().customFields`).
+ */
+type CustomFieldValues = PublicJob['customFieldValues'];
+type CustomFieldValue = CustomFieldValues[string];
+type JobCompany = Schemas['JobCompany'];
+type OfficeLocation = Schemas['JobOfficeLocation'];
+type RemoteOption = NonNullable<PublicJob['remoteOption']>;
+type EmploymentType = NonNullable<PublicJob['employmentType']>;
+type Seniority = NonNullable<PublicJob['seniority']>;
+/** Candidate-facing result ordering (ADR-0048); `relevance` is the default. */
+type JobSort = NonNullable<Schemas['PublicSearchJobsBody']['sort']>;
+type EducationRequirement = PublicJob['educationRequirements'][number];
+type RemotePermit = PublicJob['remotePermits'][number];
+type RemoteTimezone = PublicJob['remoteTimezones'][number];
+/**
+ * Derived suggestion on a browse list (ADR-0037 §8): jobs surface `category`
+ * and `skill` terms; the companies list surfaces `market` terms.
+ */
+interface RelatedSearch {
+    type: 'category' | 'skill' | 'market';
+    slug: string;
+    term: string;
+    count: number;
+}
+/** The browse list envelope — `PublicJobCard`s + storefront fields + `relatedSearches`. */
+interface JobCardListEnvelope extends ListEnvelope<PublicJobCard> {
+    relatedSearches?: RelatedSearch[];
+}
+/** The search envelope — `PublicJobCard`s + storefront fields. */
+type JobCardSearchEnvelope = SearchEnvelope<PublicJobCard>;
+type JobsListQuery = {
+    cursor?: string;
+    /** 1–100. */
+    limit?: number;
+    /** Storefront page offset; takes precedence over `cursor`. `offset + limit` ≤ 10,000. */
+    offset?: number;
+    /** Repeated param (up to 10) — OR-matched. Repeat `companyId` per value. */
+    companyId?: string[];
+    remoteOption?: RemoteOption[];
+    employmentType?: EmploymentType[];
+    seniority?: Seniority[];
+    /** Result ordering (ADR-0048). Absent ⇒ `relevance` (the featured-ranked browse). */
+    sort?: JobSort;
+    /** Place slug for a geo radius search; unresolvable slugs are ignored. */
+    location?: string;
+    /** Radius in km around `location` (10–250; default 50). */
+    radius?: number;
+    /** Category slug seed (the `/jobs/[keyword]` page) — server resolves it to the English source name; unresolvable → 404. */
+    category?: string;
+    /** Skill slug seed (the `/jobs/skills/[skill]` page) — server-resolved; unresolvable → 404. */
+    skill?: string;
+    /** Sparse fieldset (Medusa-style `+field`). Only `'+description'` is supported — adds `description` to each card. */
+    fields?: string;
+};
+type JobsSimilarQuery = {
+    /** How many similar jobs to return (1–20; default 5). */
+    limit?: number;
+};
+type JobsSearchBody = Schemas['PublicSearchJobsBody'];
+
 type EmbedJobsQuery = {
     /** Free-text search query, up to 200 characters. */
     q?: string;
@@ -4051,6 +4147,26 @@ type PlansListQuery = {
 type PlanListEnvelope = ListEnvelope<Plan>;
 type SalesLedPlanListEnvelope = ListEnvelope<SalesLedPlan>;
 
+/** An enabled candidate-access paywall offer tier (public). */
+type PaywallOffer = Schemas['PaywallOffer'];
+/**
+ * The connected-account embedded-checkout mount kit returned by
+ * `board.me.access.checkout`. Mount with `loadStripe(publishableKey, {
+ * stripeAccount: stripeAccountId })` then `initEmbeddedCheckout({ clientSecret })`.
+ */
+type AccessCheckoutSession = Schemas['AccessCheckoutSession'];
+/** The polled state of a checkout session (`board.me.access.retrieveCheckout`). */
+type AccessCheckoutSessionState = Schemas['AccessCheckoutSessionState'];
+/** The viewer's candidate-access entitlement (`board.me.access.grant`). */
+type AccessGrant = Schemas['AccessGrant'];
+/** A minted Stripe billing-portal session (`board.me.access.portal`). */
+type AccessPortalSession = Schemas['AccessPortalSession'];
+/** Body for `board.me.access.checkout`. */
+type AccessCheckoutBody = Schemas['AccessCheckoutBody'];
+/** Body for `board.me.access.portal`. */
+type AccessPortalBody = Schemas['AccessPortalBody'];
+type PaywallOfferListEnvelope = ListEnvelope<PaywallOffer>;
+
 type SavedJob = Schemas['SavedJob'];
 type SavedJobsListQuery = {
     cursor?: string;
@@ -4429,6 +4545,7 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
                 };
             };
         } | null;
+        customFields: components["schemas"]["CustomFieldDefinition"][];
     }>;
     /**
      * Board SEO infra — `ads.txt`, IndexNow key, Google site-verification, and
@@ -4514,6 +4631,9 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
                 slug: string;
                 name: string;
             }[];
+            customFieldValues: {
+                [key: string]: string | string[] | boolean | number;
+            };
         }>;
         search(body: JobsSearchBody, query?: Record<string, never>, options?: FetchOptions): Promise<JobCardSearchEnvelope>;
         similar(jobSlug: string, query?: JobsSimilarQuery, options?: FetchOptions): Promise<ListEnvelope<{
@@ -5898,6 +6018,34 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
                 blocked: boolean;
             }>;
         };
+        access: {
+            checkout(body: AccessCheckoutBody, options?: FetchOptions): Promise<{
+                object: "checkout_session";
+                sessionId: string;
+                clientSecret: string;
+                stripeAccountId: string;
+                publishableKey: string;
+                offerType: "recurring" | "lifetime";
+            }>;
+            retrieveCheckout(sessionId: string, options?: FetchOptions): Promise<{
+                object: "checkout_session_state";
+                status: "open" | "complete" | "expired";
+                clientSecret: string | null;
+            }>;
+            grant(options?: FetchOptions): Promise<{
+                object: "access_grant";
+                hasAccess: boolean;
+                status: "active" | "past_due" | "unpaid" | "incomplete" | "incomplete_expired" | "canceled" | "pending" | null;
+                offerType: "recurring" | "lifetime" | null;
+                offerKey: string | null;
+                currentPeriodEnd: string | null;
+                cancelAtPeriodEnd: boolean;
+            }>;
+            portal(body?: AccessPortalBody, options?: FetchOptions): Promise<{
+                object: "portal_session";
+                url: string;
+            }>;
+        };
     };
     password: {
         verify(password: string, options?: FetchOptions): Promise<BoardAccessGrant>;
@@ -6594,7 +6742,10 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
         list(query?: PlansListQuery, options?: FetchOptions): Promise<PlanListEnvelope>;
         salesLed(options?: FetchOptions): Promise<SalesLedPlanListEnvelope>;
     };
+    paywall: {
+        offers(options?: FetchOptions): Promise<PaywallOfferListEnvelope>;
+    };
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type AddApplicantNoteBody, type Alert, type AlertBody, type Application, type ApplicationsListQuery, type ApplyBody, type Awaitable, BOARD_ACCESS_GRANT_KEY, type Block, type BlockStatus, type BlockUserBody, type BlockedUser, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type BulkMoveApplicantsBody, type BulkRejectApplicantsBody, type CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type ClaimableCompany, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanyMembership, type CompanySalary, type CompanySimilarQuery, type ConfirmWorkEmailBody, type ConsumeMagicLinkBody, type Conversation, type ConversationArchive, type ConversationDetail, type ConversationRef, type ConversationsListQuery, type CreateBoardClientOptions, type CreateCompanyBody, type CreateEducationBody, type CreateEmployerJobBody, type CreateExperienceBody, type CreateJobPostingInput, type CreatePipelineStageBody, type CustomStorage, type EditMessageBody, type EducationRequirement, type EmbedJobsQuery, type EmployerApplicant, type EmployerBillingOption, type EmployerCheckout, type EmployerCheckoutBody, type EmployerCompany, type EmployerCompanySearchQuery, type EmployerJob, type EmployerJobSummary, type EmployerJobsListQuery, type EmployerPipeline, type EmployerPipelineQuery, type EmployerPipelineStage, type EmploymentType, type FetchOptions, type FindExistingConversationQuery, type ForgotPasswordBody, type HandleAvailability, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobPostingBillingCheck, type JobPostingBillingOptions, type JobPostingBillingVerification, type JobPostingLogoResult, type JobPostingPlan, type JobPostingResult, type JobPostingSubscriptionEntitlements, type JobSort, type JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type LocationSkillsIndex, type LocationTitlesIndex, type Logger, type LoginBody, type LogoutBody, type Message, type ModerationReport, type MoveApplicantStageBody, type NotificationPreference, type OAuthAuthorizationQuery, type OAuthAuthorizationUrl, type OAuthExchangeBody, type OAuthProvider, type OfficeLocation, type PlacesListQuery, type Plan, type PlanListEnvelope, type PlansListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicCompanyDetail, type PublicJob, type PublicJobCard, type PublicLegalPage, type PublicPlace, REFRESH_TOKEN_KEY, type ReadReceipt, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ReorderPipelineStagesBody, type ReplyBody, type ReportBody, type RequestMagicLinkBody, type ResetPasswordBody, type Resume, type ResumeUploadOptions, SDK_VERSION, type SalaryCompany, type SalaryDetailQuery, type SalaryLocation, type SalarySkill, type SalaryTitle, type SalesLedPlan, type SalesLedPlanListEnvelope, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type SendWorkEmailBody, type Seniority, type SkillLocationSalary, type SkillLocationsIndex, type SkillSalaryDetail, type StartAboutApplicationBody, type StartConversationBody, type StorageMode, type StorefrontPagination, type TalentDirectoryEntry, type TalentDirectoryListEnvelope, type TalentDirectoryQuery, type TalentProfile, type TaxonomyGeo, type TaxonomyResolution, type ThreadMessagesQuery, type TitleLocationSalary, type TitleLocationsIndex, type TitleSalaryDetail, type UnreadCount, type UnsubscribeBody, type UpdateApplicationFactsBody, type UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateEmployerCompanyBody, type UpdateEmployerJobBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdatePipelineStageBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type AccessCheckoutBody, type AccessCheckoutSession, type AccessCheckoutSessionState, type AccessGrant, type AccessPortalBody, type AccessPortalSession, type AddApplicantNoteBody, type Alert, type AlertBody, type Application, type ApplicationsListQuery, type ApplyBody, type Awaitable, BOARD_ACCESS_GRANT_KEY, type Block, type BlockStatus, type BlockUserBody, type BlockedUser, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type BulkMoveApplicantsBody, type BulkRejectApplicantsBody, type CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type ClaimableCompany, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanyMembership, type CompanySalary, type CompanySimilarQuery, type ConfirmWorkEmailBody, type ConsumeMagicLinkBody, type Conversation, type ConversationArchive, type ConversationDetail, type ConversationRef, type ConversationsListQuery, type CreateBoardClientOptions, type CreateCompanyBody, type CreateEducationBody, type CreateEmployerJobBody, type CreateExperienceBody, type CreateJobPostingInput, type CreatePipelineStageBody, type CustomFieldDefinition, type CustomFieldOption, type CustomFieldType, type CustomFieldValue, type CustomFieldValues, type CustomStorage, type EditMessageBody, type EducationRequirement, type EmbedJobsQuery, type EmployerApplicant, type EmployerBillingOption, type EmployerCheckout, type EmployerCheckoutBody, type EmployerCompany, type EmployerCompanySearchQuery, type EmployerJob, type EmployerJobSummary, type EmployerJobsListQuery, type EmployerPipeline, type EmployerPipelineQuery, type EmployerPipelineStage, type EmploymentType, type FetchOptions, type FindExistingConversationQuery, type ForgotPasswordBody, type HandleAvailability, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobPostingBillingCheck, type JobPostingBillingOptions, type JobPostingBillingVerification, type JobPostingLogoResult, type JobPostingPlan, type JobPostingResult, type JobPostingSubscriptionEntitlements, type JobSort, type JobsListQuery, type JobsSearchBody, type JobsSimilarQuery, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type LocationSkillsIndex, type LocationTitlesIndex, type Logger, type LoginBody, type LogoutBody, type Message, type ModerationReport, type MoveApplicantStageBody, type NotificationPreference, type OAuthAuthorizationQuery, type OAuthAuthorizationUrl, type OAuthExchangeBody, type OAuthProvider, type OfficeLocation, type PaywallOffer, type PaywallOfferListEnvelope, type PlacesListQuery, type Plan, type PlanListEnvelope, type PlansListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicCompanyDetail, type PublicJob, type PublicJobCard, type PublicLegalPage, type PublicPlace, REFRESH_TOKEN_KEY, type ReadReceipt, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ReorderPipelineStagesBody, type ReplyBody, type ReportBody, type RequestMagicLinkBody, type ResetPasswordBody, type Resume, type ResumeUploadOptions, SDK_VERSION, type SalaryCompany, type SalaryDetailQuery, type SalaryLocation, type SalarySkill, type SalaryTitle, type SalesLedPlan, type SalesLedPlanListEnvelope, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type SendWorkEmailBody, type Seniority, type SkillLocationSalary, type SkillLocationsIndex, type SkillSalaryDetail, type StartAboutApplicationBody, type StartConversationBody, type StorageMode, type StorefrontPagination, type TalentDirectoryEntry, type TalentDirectoryListEnvelope, type TalentDirectoryQuery, type TalentProfile, type TaxonomyGeo, type TaxonomyResolution, type ThreadMessagesQuery, type TitleLocationSalary, type TitleLocationsIndex, type TitleSalaryDetail, type UnreadCount, type UnsubscribeBody, type UpdateApplicationFactsBody, type UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateEmployerCompanyBody, type UpdateEmployerJobBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdatePipelineStageBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };

package/dist/index.d.ts

@@ -1,5 +1,61 @@
 interface components {
     schemas: {
+        AccessCheckoutBody: {
+            /**
+             * @description The offer tier to purchase (from `GET /paywall/offers/enabled`).
+             * @enum {string}
+             */
+            offerKey: "daily" | "weekly" | "monthly" | "quarterly" | "yearly" | "lifetime";
+            /** @description Relative path Stripe returns the buyer to on completion; `session_id` is appended. */
+            returnPath: string;
+            /** @enum {string} */
+            colorMode: "light" | "dark";
+        };
+        AccessCheckoutSession: {
+            /** @enum {string} */
+            object: "checkout_session";
+            sessionId: string;
+            /** @description The Checkout Session client secret to mount the embedded form. */
+            clientSecret: string;
+            /** @description The board’s connected Stripe account to initialise Stripe.js with. */
+            stripeAccountId: string;
+            /** @description The platform Stripe publishable key for `loadStripe`. */
+            publishableKey: string;
+            /**
+             * @description `recurring` grants get a manage-subscription portal; `lifetime` do not.
+             * @enum {string}
+             */
+            offerType: "recurring" | "lifetime";
+        };
+        AccessCheckoutSessionState: {
+            /** @enum {string} */
+            object: "checkout_session_state";
+            /** @enum {string} */
+            status: "open" | "complete" | "expired";
+            clientSecret: string | null;
+        };
+        AccessGrant: {
+            /** @enum {string} */
+            object: "access_grant";
+            hasAccess: boolean;
+            /** @enum {string|null} */
+            status: "active" | "past_due" | "unpaid" | "incomplete" | "incomplete_expired" | "canceled" | "pending" | null;
+            /** @enum {string|null} */
+            offerType: "recurring" | "lifetime" | null;
+            offerKey: string | null;
+            currentPeriodEnd: string | null;
+            cancelAtPeriodEnd: boolean;
+        };
+        AccessPortalBody: {
+            /** @description Relative path Stripe returns the buyer to; defaults to the board root. */
+            returnPath?: string;
+        };
+        AccessPortalSession: {
+            /** @enum {string} */
+            object: "portal_session";
+            /** Format: uri */
+            url: string;
+        };
         AddApplicantNoteBody: {
             /** @description The note text. */
             body: string;
@@ -1073,16 +1129,16 @@ interface components {
             name: string;
         };
         CustomFieldDefinition: {
-            /** @description Immutable per-board slug. Use this as the key in `customFieldValues` when writing values via POST/PATCH /v1/jobs. */
+            /** @description Immutable per-board slug. The key in a job’s `customFieldValues`, and the frontend translation token (`customField.<key>.*`). */
             key: string;
             /** @description Authoring-default label; the localized public string lives in the board template. */
             label: string;
             /**
-             * @description Field type, which dictates the accepted value: `short_text`/`long_text` → string; `single_select` → one option key (string); `multi_select` → array of option keys; `boolean` → boolean; `number` → number.
+             * @description Field type, which dictates the value: `short_text`/`long_text` → string; `single_select` → one option key; `multi_select` → array of option keys; `boolean` → boolean; `number` → number.
              * @enum {string}
              */
             type: "short_text" | "long_text" | "single_select" | "multi_select" | "boolean" | "number";
-            /** @description Present only for `single_select`/`multi_select`. A written value must be one (or, for multi, several) of these option `key`s — never a label. */
+            /** @description Present only for `single_select`/`multi_select`. A stored value is one (or, for multi, several) of these option `key`s — never a label. */
             options?: components["schemas"]["CustomFieldOption"][];
             /** @description When true, the value cannot be cleared or left empty on a write (rejected with `custom_field_required`). */
             required: boolean;
@@ -1092,7 +1148,7 @@ interface components {
             max?: number;
         };
         CustomFieldOption: {
-            /** @description Stable option key — send this in a write, not the label. */
+            /** @description Stable option key — the value stored on a job, not the label. */
             key: string;
             /** @description Display label (authoring default; localized per board in the template). */
             label: string;
@@ -2191,6 +2247,24 @@ interface components {
                 [key: string]: unknown;
             };
         };
+        PaywallOffer: {
+            /** @enum {string} */
+            object: "paywall_offer";
+            /** @description The tier key posted to checkout (e.g. `monthly`, `lifetime`). */
+            offerKey: string;
+            label: string;
+            billingLabel: string;
+            amountCents: number;
+            currency: string;
+            /**
+             * @description `recurring` tiers get a manage-subscription portal; `lifetime` do not.
+             * @enum {string}
+             */
+            offerType: "recurring" | "lifetime";
+            intervalUnit: string | null;
+            intervalCount: number | null;
+            isDefault: boolean;
+        };
         Plan: {
             /** @enum {string} */
             object: "plan";
@@ -2343,6 +2417,8 @@ interface components {
                     };
                 };
             } | null;
+            /** @description Operator-defined custom job-field definitions (CAV-294), in display order. Board-wide; the frontend uses these to render and localize each job's opaque `customFieldValues`. Empty when the board defines none. Display-only — not filterable or searchable in v1. */
+            customFields: components["schemas"]["CustomFieldDefinition"][];
         };
         PublicCompaniesSearchBody: {
             /** @description Free-text search query matched against company name. Up to 200 characters. */
@@ -2477,6 +2553,10 @@ interface components {
                 slug: string;
                 name: string;
             }[];
+            /** @description Opaque, display-only custom-field values (CAV-294), keyed by each field's `key`. Values are the option `key`(s) for select fields, or the raw boolean/number/text otherwise — resolve labels via the board's `customFields` definitions (see `GET /v1/boards/:identifier`). `{}` when the board defines no custom fields. Not filterable or searchable in v1. */
+            customFieldValues: {
+                [key: string]: string | string[] | boolean | number;
+            };
         };
         PublicJobAlertConfirmation: {
             /** @enum {string} */
@@ -3650,102 +3730,6 @@ interface components {
     pathItems: never;
 }
 
-type Schemas = components['schemas'];
-
-/**
- * Stripe-shaped success envelopes (`01-conventions.md` §5.1). The
- * server MAY add top-level fields; consumers MUST ignore unknown
- * fields.
- */
-/**
- * Medusa-style storefront pagination fields (ADR-0037 §7), populated only by
- * the board jobs catalog reads (browse / search / company-jobs); absent on
- * every other list/search. `nextCursor` is preserved alongside (offset-encoded).
- */
-interface StorefrontPagination {
-    /** Total matching results ("X jobs"). */
-    count?: number;
-    /** The page size used for this response. */
-    limit?: number;
-    /** Number of items skipped before this page. */
-    offset?: number;
-    /** Items hidden behind the candidate paywall for the current viewer; absent/0 when entitled. */
-    gatedCount?: number;
-}
-interface ListEnvelope<T> extends StorefrontPagination {
-    object: 'list';
-    url: string;
-    hasMore: boolean;
-    /** `null` when `hasMore` is false — always present, never undefined. */
-    nextCursor: string | null;
-    data: T[];
-}
-interface SearchEnvelope<T> extends StorefrontPagination {
-    object: 'search_result';
-    url: string;
-    hasMore: boolean;
-    nextCursor: string | null;
-    data: T[];
-}
-
-type PublicJob = Schemas['PublicJob'];
-type PublicJobCard = Schemas['PublicJobCard'];
-type JobCompany = Schemas['JobCompany'];
-type OfficeLocation = Schemas['JobOfficeLocation'];
-type RemoteOption = NonNullable<PublicJob['remoteOption']>;
-type EmploymentType = NonNullable<PublicJob['employmentType']>;
-type Seniority = NonNullable<PublicJob['seniority']>;
-/** Candidate-facing result ordering (ADR-0048); `relevance` is the default. */
-type JobSort = NonNullable<Schemas['PublicSearchJobsBody']['sort']>;
-type EducationRequirement = PublicJob['educationRequirements'][number];
-type RemotePermit = PublicJob['remotePermits'][number];
-type RemoteTimezone = PublicJob['remoteTimezones'][number];
-/**
- * Derived suggestion on a browse list (ADR-0037 §8): jobs surface `category`
- * and `skill` terms; the companies list surfaces `market` terms.
- */
-interface RelatedSearch {
-    type: 'category' | 'skill' | 'market';
-    slug: string;
-    term: string;
-    count: number;
-}
-/** The browse list envelope — `PublicJobCard`s + storefront fields + `relatedSearches`. */
-interface JobCardListEnvelope extends ListEnvelope<PublicJobCard> {
-    relatedSearches?: RelatedSearch[];
-}
-/** The search envelope — `PublicJobCard`s + storefront fields. */
-type JobCardSearchEnvelope = SearchEnvelope<PublicJobCard>;
-type JobsListQuery = {
-    cursor?: string;
-    /** 1–100. */
-    limit?: number;
-    /** Storefront page offset; takes precedence over `cursor`. `offset + limit` ≤ 10,000. */
-    offset?: number;
-    /** Repeated param (up to 10) — OR-matched. Repeat `companyId` per value. */
-    companyId?: string[];
-    remoteOption?: RemoteOption[];
-    employmentType?: EmploymentType[];
-    seniority?: Seniority[];
-    /** Result ordering (ADR-0048). Absent ⇒ `relevance` (the featured-ranked browse). */
-    sort?: JobSort;
-    /** Place slug for a geo radius search; unresolvable slugs are ignored. */
-    location?: string;
-    /** Radius in km around `location` (10–250; default 50). */
-    radius?: number;
-    /** Category slug seed (the `/jobs/[keyword]` page) — server resolves it to the English source name; unresolvable → 404. */
-    category?: string;
-    /** Skill slug seed (the `/jobs/skills/[skill]` page) — server-resolved; unresolvable → 404. */
-    skill?: string;
-    /** Sparse fieldset (Medusa-style `+field`). Only `'+description'` is supported — adds `description` to each card. */
-    fields?: string;
-};
-type JobsSimilarQuery = {
-    /** How many similar jobs to return (1–20; default 5). */
-    limit?: number;
-};
-type JobsSearchBody = Schemas['PublicSearchJobsBody'];
-
 type Awaitable<T> = T | Promise<T>;
 /**
  * Async token storage. The SDK reads the access token from storage on
@@ -3865,7 +3849,9 @@ declare function isConflict(e: unknown): e is BoardApiError;
  * constant because the package is platform-neutral and cannot read
  * package.json at runtime.
  */
-declare const SDK_VERSION = "1.23.0";
+declare const SDK_VERSION = "1.25.0";
+
+type Schemas = components['schemas'];
 
 type BoardUser = Schemas['BoardUser'];
 type BoardAuthSession = Schemas['BoardAuthSession'];
@@ -3889,6 +3875,15 @@ type PublicBoard = Schemas['PublicBoardContext'];
 type PublicBoardFeatures = PublicBoard['features'];
 type PublicBoardAnalytics = PublicBoard['analytics'];
 type PublicBoardTheme = NonNullable<PublicBoard['theme']>;
+/**
+ * An operator-defined custom job-field definition (CAV-294). Board-wide;
+ * use it to render and localize a job's opaque `customFieldValues` (resolve
+ * option `key`s → labels, honour field `type` and display order). Shared with
+ * the Operator API's custom-field surface (one canonical schema).
+ */
+type CustomFieldDefinition = Schemas['CustomFieldDefinition'];
+type CustomFieldType = CustomFieldDefinition['type'];
+type CustomFieldOption = Schemas['CustomFieldOption'];
 
 /**
  * The public SEO-infra payload (`board.seo()`) — the values a headless
@@ -3898,6 +3893,107 @@ type PublicBoardTheme = NonNullable<PublicBoard['theme']>;
  */
 type BoardSeo = Schemas['BoardSeo'];
 
+/**
+ * Stripe-shaped success envelopes (`01-conventions.md` §5.1). The
+ * server MAY add top-level fields; consumers MUST ignore unknown
+ * fields.
+ */
+/**
+ * Medusa-style storefront pagination fields (ADR-0037 §7), populated only by
+ * the board jobs catalog reads (browse / search / company-jobs); absent on
+ * every other list/search. `nextCursor` is preserved alongside (offset-encoded).
+ */
+interface StorefrontPagination {
+    /** Total matching results ("X jobs"). */
+    count?: number;
+    /** The page size used for this response. */
+    limit?: number;
+    /** Number of items skipped before this page. */
+    offset?: number;
+    /** Items hidden behind the candidate paywall for the current viewer; absent/0 when entitled. */
+    gatedCount?: number;
+}
+interface ListEnvelope<T> extends StorefrontPagination {
+    object: 'list';
+    url: string;
+    hasMore: boolean;
+    /** `null` when `hasMore` is false — always present, never undefined. */
+    nextCursor: string | null;
+    data: T[];
+}
+interface SearchEnvelope<T> extends StorefrontPagination {
+    object: 'search_result';
+    url: string;
+    hasMore: boolean;
+    nextCursor: string | null;
+    data: T[];
+}
+
+type PublicJob = Schemas['PublicJob'];
+type PublicJobCard = Schemas['PublicJobCard'];
+/**
+ * A job's opaque, display-only custom-field values (CAV-294), keyed by each
+ * field's `key`. Resolve labels via the board's `CustomFieldDefinition`s
+ * (`board.context().customFields`).
+ */
+type CustomFieldValues = PublicJob['customFieldValues'];
+type CustomFieldValue = CustomFieldValues[string];
+type JobCompany = Schemas['JobCompany'];
+type OfficeLocation = Schemas['JobOfficeLocation'];
+type RemoteOption = NonNullable<PublicJob['remoteOption']>;
+type EmploymentType = NonNullable<PublicJob['employmentType']>;
+type Seniority = NonNullable<PublicJob['seniority']>;
+/** Candidate-facing result ordering (ADR-0048); `relevance` is the default. */
+type JobSort = NonNullable<Schemas['PublicSearchJobsBody']['sort']>;
+type EducationRequirement = PublicJob['educationRequirements'][number];
+type RemotePermit = PublicJob['remotePermits'][number];
+type RemoteTimezone = PublicJob['remoteTimezones'][number];
+/**
+ * Derived suggestion on a browse list (ADR-0037 §8): jobs surface `category`
+ * and `skill` terms; the companies list surfaces `market` terms.
+ */
+interface RelatedSearch {
+    type: 'category' | 'skill' | 'market';
+    slug: string;
+    term: string;
+    count: number;
+}
+/** The browse list envelope — `PublicJobCard`s + storefront fields + `relatedSearches`. */
+interface JobCardListEnvelope extends ListEnvelope<PublicJobCard> {
+    relatedSearches?: RelatedSearch[];
+}
+/** The search envelope — `PublicJobCard`s + storefront fields. */
+type JobCardSearchEnvelope = SearchEnvelope<PublicJobCard>;
+type JobsListQuery = {
+    cursor?: string;
+    /** 1–100. */
+    limit?: number;
+    /** Storefront page offset; takes precedence over `cursor`. `offset + limit` ≤ 10,000. */
+    offset?: number;
+    /** Repeated param (up to 10) — OR-matched. Repeat `companyId` per value. */
+    companyId?: string[];
+    remoteOption?: RemoteOption[];
+    employmentType?: EmploymentType[];
+    seniority?: Seniority[];
+    /** Result ordering (ADR-0048). Absent ⇒ `relevance` (the featured-ranked browse). */
+    sort?: JobSort;
+    /** Place slug for a geo radius search; unresolvable slugs are ignored. */
+    location?: string;
+    /** Radius in km around `location` (10–250; default 50). */
+    radius?: number;
+    /** Category slug seed (the `/jobs/[keyword]` page) — server resolves it to the English source name; unresolvable → 404. */
+    category?: string;
+    /** Skill slug seed (the `/jobs/skills/[skill]` page) — server-resolved; unresolvable → 404. */
+    skill?: string;
+    /** Sparse fieldset (Medusa-style `+field`). Only `'+description'` is supported — adds `description` to each card. */
+    fields?: string;
+};
+type JobsSimilarQuery = {
+    /** How many similar jobs to return (1–20; default 5). */
+    limit?: number;
+};
+type JobsSearchBody = Schemas['PublicSearchJobsBody'];
+
 type EmbedJobsQuery = {
     /** Free-text search query, up to 200 characters. */
     q?: string;
@@ -4051,6 +4147,26 @@ type PlansListQuery = {
 type PlanListEnvelope = ListEnvelope<Plan>;
 type SalesLedPlanListEnvelope = ListEnvelope<SalesLedPlan>;
 
+/** An enabled candidate-access paywall offer tier (public). */
+type PaywallOffer = Schemas['PaywallOffer'];
+/**
+ * The connected-account embedded-checkout mount kit returned by
+ * `board.me.access.checkout`. Mount with `loadStripe(publishableKey, {
+ * stripeAccount: stripeAccountId })` then `initEmbeddedCheckout({ clientSecret })`.
+ */
+type AccessCheckoutSession = Schemas['AccessCheckoutSession'];
+/** The polled state of a checkout session (`board.me.access.retrieveCheckout`). */
+type AccessCheckoutSessionState = Schemas['AccessCheckoutSessionState'];
+/** The viewer's candidate-access entitlement (`board.me.access.grant`). */
+type AccessGrant = Schemas['AccessGrant'];
+/** A minted Stripe billing-portal session (`board.me.access.portal`). */
+type AccessPortalSession = Schemas['AccessPortalSession'];
+/** Body for `board.me.access.checkout`. */
+type AccessCheckoutBody = Schemas['AccessCheckoutBody'];
+/** Body for `board.me.access.portal`. */
+type AccessPortalBody = Schemas['AccessPortalBody'];
+type PaywallOfferListEnvelope = ListEnvelope<PaywallOffer>;
+
 type SavedJob = Schemas['SavedJob'];
 type SavedJobsListQuery = {
     cursor?: string;
@@ -4429,6 +4545,7 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
                 };
             };
         } | null;
+        customFields: components["schemas"]["CustomFieldDefinition"][];
     }>;
     /**
      * Board SEO infra — `ads.txt`, IndexNow key, Google site-verification, and
@@ -4514,6 +4631,9 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
                 slug: string;
                 name: string;
             }[];
+            customFieldValues: {
+                [key: string]: string | string[] | boolean | number;
+            };
         }>;
         search(body: JobsSearchBody, query?: Record<string, never>, options?: FetchOptions): Promise<JobCardSearchEnvelope>;
         similar(jobSlug: string, query?: JobsSimilarQuery, options?: FetchOptions): Promise<ListEnvelope<{
@@ -5898,6 +6018,34 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
                 blocked: boolean;
             }>;
         };
+        access: {
+            checkout(body: AccessCheckoutBody, options?: FetchOptions): Promise<{
+                object: "checkout_session";
+                sessionId: string;
+                clientSecret: string;
+                stripeAccountId: string;
+                publishableKey: string;
+                offerType: "recurring" | "lifetime";
+            }>;
+            retrieveCheckout(sessionId: string, options?: FetchOptions): Promise<{
+                object: "checkout_session_state";
+                status: "open" | "complete" | "expired";
+                clientSecret: string | null;
+            }>;
+            grant(options?: FetchOptions): Promise<{
+                object: "access_grant";
+                hasAccess: boolean;
+                status: "active" | "past_due" | "unpaid" | "incomplete" | "incomplete_expired" | "canceled" | "pending" | null;
+                offerType: "recurring" | "lifetime" | null;
+                offerKey: string | null;
+                currentPeriodEnd: string | null;
+                cancelAtPeriodEnd: boolean;
+            }>;
+            portal(body?: AccessPortalBody, options?: FetchOptions): Promise<{
+                object: "portal_session";
+                url: string;
+            }>;
+        };
     };
     password: {
         verify(password: string, options?: FetchOptions): Promise<BoardAccessGrant>;
@@ -6594,7 +6742,10 @@ declare function createBoardClient(options: CreateBoardClientOptions): {
         list(query?: PlansListQuery, options?: FetchOptions): Promise<PlanListEnvelope>;
         salesLed(options?: FetchOptions): Promise<SalesLedPlanListEnvelope>;
     };
+    paywall: {
+        offers(options?: FetchOptions): Promise<PaywallOfferListEnvelope>;
+    };
 };
 type BoardSdk = ReturnType<typeof createBoardClient>;
 
-export { ACCESS_TOKEN_KEY, type AddApplicantNoteBody, type Alert, type AlertBody, type Application, type ApplicationsListQuery, type ApplyBody, type Awaitable, BOARD_ACCESS_GRANT_KEY, type Block, type BlockStatus, type BlockUserBody, type BlockedUser, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type BulkMoveApplicantsBody, type BulkRejectApplicantsBody, type CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type ClaimableCompany, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanyMembership, type CompanySalary, type CompanySimilarQuery, type ConfirmWorkEmailBody, type ConsumeMagicLinkBody, type Conversation, type ConversationArchive, type ConversationDetail, type ConversationRef, type ConversationsListQuery, type CreateBoardClientOptions, type CreateCompanyBody, type CreateEducationBody, type CreateEmployerJobBody, type CreateExperienceBody, type CreateJobPostingInput, type CreatePipelineStageBody, type CustomStorage, type EditMessageBody, type EducationRequirement, type EmbedJobsQuery, type EmployerApplicant, type EmployerBillingOption, type EmployerCheckout, type EmployerCheckoutBody, type EmployerCompany, type EmployerCompanySearchQuery, type EmployerJob, type EmployerJobSummary, type EmployerJobsListQuery, type EmployerPipeline, type EmployerPipelineQuery, type EmployerPipelineStage, type EmploymentType, type FetchOptions, type FindExistingConversationQuery, type ForgotPasswordBody, type HandleAvailability, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobPostingBillingCheck, type JobPostingBillingOptions, type JobPostingBillingVerification, type JobPostingLogoResult, type JobPostingPlan, type JobPostingResult, type JobPostingSubscriptionEntitlements, type JobSort, type JobsListQuery, type JobsSearchBody, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type LocationSkillsIndex, type LocationTitlesIndex, type Logger, type LoginBody, type LogoutBody, type Message, type ModerationReport, type MoveApplicantStageBody, type NotificationPreference, type OAuthAuthorizationQuery, type OAuthAuthorizationUrl, type OAuthExchangeBody, type OAuthProvider, type OfficeLocation, type PlacesListQuery, type Plan, type PlanListEnvelope, type PlansListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicCompanyDetail, type PublicJob, type PublicJobCard, type PublicLegalPage, type PublicPlace, REFRESH_TOKEN_KEY, type ReadReceipt, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ReorderPipelineStagesBody, type ReplyBody, type ReportBody, type RequestMagicLinkBody, type ResetPasswordBody, type Resume, type ResumeUploadOptions, SDK_VERSION, type SalaryCompany, type SalaryDetailQuery, type SalaryLocation, type SalarySkill, type SalaryTitle, type SalesLedPlan, type SalesLedPlanListEnvelope, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type SendWorkEmailBody, type Seniority, type SkillLocationSalary, type SkillLocationsIndex, type SkillSalaryDetail, type StartAboutApplicationBody, type StartConversationBody, type StorageMode, type StorefrontPagination, type TalentDirectoryEntry, type TalentDirectoryListEnvelope, type TalentDirectoryQuery, type TalentProfile, type TaxonomyGeo, type TaxonomyResolution, type ThreadMessagesQuery, type TitleLocationSalary, type TitleLocationsIndex, type TitleSalaryDetail, type UnreadCount, type UnsubscribeBody, type UpdateApplicationFactsBody, type UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateEmployerCompanyBody, type UpdateEmployerJobBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdatePipelineStageBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };
+export { ACCESS_TOKEN_KEY, type AccessCheckoutBody, type AccessCheckoutSession, type AccessCheckoutSessionState, type AccessGrant, type AccessPortalBody, type AccessPortalSession, type AddApplicantNoteBody, type Alert, type AlertBody, type Application, type ApplicationsListQuery, type ApplyBody, type Awaitable, BOARD_ACCESS_GRANT_KEY, type Block, type BlockStatus, type BlockUserBody, type BlockedUser, type BlogAuthorEmbed, type BlogPostsListQuery, type BlogSearchBody, type BlogSimilarQuery, type BlogTagEmbed, type BoardAccessGrant, BoardApiError, type BoardAuthSession, BoardClient, type BoardRequest, type BoardSdk, type BoardSeo, type BoardUser, type BulkMoveApplicantsBody, type BulkRejectApplicantsBody, type CandidateAvatar, type CandidateEducation, type CandidateExperience, type CandidateLanguage, type CandidateProfile, type CandidateSkill, type ClaimableCompany, type CompaniesListQuery, type CompaniesSearchBody, type CompanyCategorySalary, type CompanyJobsListQuery, type CompanyListEnvelope, type CompanyMarket, type CompanyMarketRef, type CompanyMarketsListQuery, type CompanyMembership, type CompanySalary, type CompanySimilarQuery, type ConfirmWorkEmailBody, type ConsumeMagicLinkBody, type Conversation, type ConversationArchive, type ConversationDetail, type ConversationRef, type ConversationsListQuery, type CreateBoardClientOptions, type CreateCompanyBody, type CreateEducationBody, type CreateEmployerJobBody, type CreateExperienceBody, type CreateJobPostingInput, type CreatePipelineStageBody, type CustomFieldDefinition, type CustomFieldOption, type CustomFieldType, type CustomFieldValue, type CustomFieldValues, type CustomStorage, type EditMessageBody, type EducationRequirement, type EmbedJobsQuery, type EmployerApplicant, type EmployerBillingOption, type EmployerCheckout, type EmployerCheckoutBody, type EmployerCompany, type EmployerCompanySearchQuery, type EmployerJob, type EmployerJobSummary, type EmployerJobsListQuery, type EmployerPipeline, type EmployerPipelineQuery, type EmployerPipelineStage, type EmploymentType, type FetchOptions, type FindExistingConversationQuery, type ForgotPasswordBody, type HandleAvailability, type JobAlertConfirmation, type JobAlertDeletePreferenceInput, type JobAlertFiltersInput, type JobAlertFrequency, type JobAlertManageQuery, type JobAlertManageResult, type JobAlertManageState, type JobAlertManageTokenInput, type JobAlertPreference, type JobAlertRemoteOption, type JobAlertResendResult, type JobAlertStoredFilters, type JobAlertSubscribeInput, type JobAlertSubscription, type JobAlertUpdatePreferenceInput, type JobCardListEnvelope, type JobCardSearchEnvelope, type JobCompany, type JobPostingBillingCheck, type JobPostingBillingOptions, type JobPostingBillingVerification, type JobPostingLogoResult, type JobPostingPlan, type JobPostingResult, type JobPostingSubscriptionEntitlements, type JobSort, type JobsListQuery, type JobsSearchBody, type JobsSimilarQuery, type LegalEntity, type LegalPageType, type ListEnvelope, type LocationSalaryDetail, type LocationSkillsIndex, type LocationTitlesIndex, type Logger, type LoginBody, type LogoutBody, type Message, type ModerationReport, type MoveApplicantStageBody, type NotificationPreference, type OAuthAuthorizationQuery, type OAuthAuthorizationUrl, type OAuthExchangeBody, type OAuthProvider, type OfficeLocation, type PaywallOffer, type PaywallOfferListEnvelope, type PlacesListQuery, type Plan, type PlanListEnvelope, type PlansListQuery, type PublicBlogAdjacentPosts, type PublicBlogAuthor, type PublicBlogPost, type PublicBlogPostSummary, type PublicBlogTag, type PublicBoard, type PublicBoardAnalytics, type PublicBoardFeatures, type PublicBoardTheme, type PublicCompany, type PublicCompanyDetail, type PublicJob, type PublicJobCard, type PublicLegalPage, type PublicPlace, REFRESH_TOKEN_KEY, type ReadReceipt, type RedirectResolution, type RefreshBody, type RegisterBody, type RelatedSearch, type RemoteOption, type RemotePermit, type RemoteTimezone, type ReorderPipelineStagesBody, type ReplyBody, type ReportBody, type RequestMagicLinkBody, type ResetPasswordBody, type Resume, type ResumeUploadOptions, SDK_VERSION, type SalaryCompany, type SalaryDetailQuery, type SalaryLocation, type SalarySkill, type SalaryTitle, type SalesLedPlan, type SalesLedPlanListEnvelope, type SaveJobBody, type SavedJob, type SavedJobsListQuery, type SearchEnvelope, type SendWorkEmailBody, type Seniority, type SkillLocationSalary, type SkillLocationsIndex, type SkillSalaryDetail, type StartAboutApplicationBody, type StartConversationBody, type StorageMode, type StorefrontPagination, type TalentDirectoryEntry, type TalentDirectoryListEnvelope, type TalentDirectoryQuery, type TalentProfile, type TaxonomyGeo, type TaxonomyResolution, type ThreadMessagesQuery, type TitleLocationSalary, type TitleLocationsIndex, type TitleSalaryDetail, type UnreadCount, type UnsubscribeBody, type UpdateApplicationFactsBody, type UpdateCandidateProfileBody, type UpdateEducationBody, type UpdateEmployerCompanyBody, type UpdateEmployerJobBody, type UpdateExperienceBody, type UpdateLanguagesBody, type UpdateNotificationPreferenceBody, type UpdatePipelineStageBody, type UpdateSkillsBody, type VerifyEmailBody, createBoardClient, isBoardApiError, isBoardPasswordRequired, isConflict, isForbidden, isNotFound, isRateLimited, isUnauthorized, isValidationError };

package/dist/index.js

@@ -149,7 +149,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.23.0";
+var SDK_VERSION = "1.25.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -2054,6 +2054,79 @@ function meNamespace(client) {
           { ...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
+        });
+      }
     }
   };
 }
@@ -2082,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 {
@@ -2358,6 +2452,7 @@ function createBoardClient(options) {
     jobPosting: jobPostingNamespace(client),
     salaries: salariesNamespace(client),
     talent: talentNamespace(client),
-    plans: plansNamespace(client)
+    plans: plansNamespace(client),
+    paywall: paywallNamespace(client)
   };
 }

package/dist/index.mjs

@@ -109,7 +109,7 @@ async function clearSession(storage) {
 }
 
 // src/version.ts
-var SDK_VERSION = "1.23.0";
+var SDK_VERSION = "1.25.0";
 
 // src/client.ts
 function isRawBody(body) {
@@ -2014,6 +2014,79 @@ function meNamespace(client) {
           { ...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
+        });
+      }
     }
   };
 }
@@ -2042,6 +2115,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 {
@@ -2318,7 +2412,8 @@ function createBoardClient(options) {
     jobPosting: jobPostingNamespace(client),
     salaries: salariesNamespace(client),
     talent: talentNamespace(client),
-    plans: plansNamespace(client)
+    plans: plansNamespace(client),
+    paywall: paywallNamespace(client)
   };
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cavuno/board",
-  "version": "1.23.0",
+  "version": "1.25.0",
   "description": "Typed isomorphic client for the Cavuno Board API",
   "license": "MIT",
   "repository": {

package/skills/manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.23.0",
+  "version": "1.25.0",
   "skills": [
     {
       "name": "cavuno-board-auth",