@businessdash/sdk 0.9.81 → 0.9.90

package/dist/client.d.ts

@@ -1,8 +1,8 @@
 import { z } from "zod";
-import { type AddressDetailsResponse, type AddressFormValues, type AddressSearchInput, type AddressSearchResponse, type AddressVerifyResponse, type AiVisibilityInput, type AiVisibilityResponse, type AttributionHeartbeatInput, type AttributionHeartbeatResponse, type AttributionPolicy, type AuthIntrospectResponse, type BlogCategoryListResponse, type BlogCommentListResponse, type BlogCommentPostInput, type BlogCommentPostResponse, type BlogLikeResponse, type BlogListPostsResponse, type BlogPostBySlugResponse, type BlogSessionInput, type BlogSessionResponse, type BlogTagListResponse, type CartAddItemInput, type CartCouponInput, type CartSessionResponse, type CartSnapshot, type CartUpdateItemInput, type ChatbotAppendMessageInput, type ChatbotAvailability, type ChatbotChatInput, type ChatbotChatResponse, type ChatbotConfig, type ChatbotConfigUpdateInput, type ChatbotFormDefinition, type ChatbotFormSubmitInput, type ChatbotFormSubmitResponse, type ChatbotMessagesResponse, type ChatbotPersistedSessionInput, type ChatbotPersistedSessionResponse, type ChatbotRequestHumanInput, type ChatbotRequestHumanResponse, type ChatbotSessionResponse, type CheckoutSessionInput, type CheckoutSessionResponse, type CheckoutStartInput, type CheckoutStartResponse, type CheckoutStatusResponse, type ConfirmVerificationInput, type ConfirmVerificationResponse, type CouponCreateInput, type CouponCreateResponse, type CouponListResponse, type CouponValidateResponse, type CreateCollectionInput, type CreateCollectionResponse, type CreateEmailTemplateInput, type CreateEmailTemplateResponse, type CreateEmailTemplateVersionInput, type CreateEmailTemplateVersionResponse, type CustomerContactCompanyInput, type CustomerContactCompanyResponse, type CustomerContractDetail, type CustomerContractListResponse, type CustomerContractSignResponse, type CustomerDownloadsResponse, type CustomerInviteResendResponse, type CustomerInvoiceDetail, type CustomerInvoiceListResponse, type CustomerInvoicePayInput, type CustomerInvoicePayResponse, type CustomerInvoicePdf, type CustomerJobActivityResponse, type CustomerJobComment, type CustomerJobCommentPostInput, type CustomerJobCommentsListResponse, type CustomerJobDetail, type CustomerJobEtaResponse, type CustomerNotificationPreferencesResponse, type CustomerNotificationPreferencesUpdateInput, type CustomerNotificationPreferencesUpdateResponse, type CustomerNotReceivedResult, type CustomerOrderDetail, type CustomerOrderListResponse, type CustomerPortalContextResponse, type CustomerPortalMessage, type CustomerPortalMessageListResponse, type CustomerPortalMessagePostInput, type CustomerPortalMessagesMarkReadResponse, type CustomerPortalOtherOrgsResponse, type CustomerPortalProfile, type CustomerPortalQuizResultsResponse, type CustomerPortalUpdateProfileInput, type CustomerPortalUpdateProfileResponse, type CustomerProductReviewCreated, type CustomerProductReviewList, type CustomerPushConfig, type CustomerQuoteActionResponse, type CustomerQuoteDetail, type CustomerQuoteListResponse, type CustomerReferralHistoryResponse, type CustomerReferralPayoutsResponse, type CustomerReferralStats, type CustomerReturnRequestCreated, type CustomerReturnRequestInput, type CustomerReturnRequestListResponse, type CustomerReviewListResponse, type CustomerReviewSubmitInput, type CustomerReviewSubmitResponse, type CustomerShipmentListResponse, type CustomerShipmentTracking, type CustomerSubscriberContentResponse, type CustomerSubscriptionCancelResponse, type CustomerSubscriptionResponse, type CustomerWorkBundle, type DashboardSessionResponse, type ExecuteActionInput, type ExecuteActionResponse, type FollowerEditInput, type FollowerEditResponse, type FollowerJoinInput, type FollowerJoinResponse, type FollowerLeaveInput, type FollowerLeaveResponse, type FollowerMeInput, type FollowerMeResponse, type GetCollectionResponse, type GetEmailTemplateResponse, type GetMarketingLocalesResponse, type GetMarketingPageBundleResponse, type GetPublishedMarketingSchemaResponse, type GetSiteMarketingPageResponse, type GoogleAddress, type JobCategoryListResponse, type JobPosting, type JobPostingListResponse, type LegalDocument, type LegalListResponse, type ListCollectionsResponse, type ListDataModelRecordsInput, type ListDataModelRecordsResponse, type ListEmailTemplatesInput, type ListEmailTemplatesResponse, type ListRowsInput, type ListRowsResponse, type ListSiteMarketingPagesResponse, type NotificationPreferencesResponse, type NotificationPreferencesUpdateInput, type PageViewsInput, type PageViewsResponse, type PublishMarketingSectionsInput, type PublishMarketingSectionsResponse, type QueryRowsInput, type QueryRowsResponse, type ReviewWallListResponse, type SchedulingBookingResult, type SchedulingBookingView, type SchedulingCancelResult, type SchedulingEventTypeDetail, type SchedulingEventTypeList, type SchedulingRescheduleResult, type SchedulingSlotsResponse, type ShippingRatesInput, type ShippingRatesResponse, type ShippingSettingsResponse, type ShippingTrackResponse, type SiteAssetInput, type SiteBranding, type StartVerificationInput, type StartVerificationResponse, type StorefrontAddonsResponse, type StorefrontCategoriesResponse, type StorefrontListProductsResponse, type StorefrontProductDetail, type StorefrontProductReviewsResponse, type StorefrontProductsWithMetaResponse, type StorefrontRelatedProductsResponse, type StorefrontSessionInput, type StorefrontSessionResponse, type StorefrontSort, type StorefrontSyncToStripeResponse, type SubscriptionCheckoutInput, type SubscriptionCheckoutResponse, type SubscriptionOffering, type SubscriptionOfferingsListResponse, type TenantAuthExchangeInput, type TenantAuthExchangeResponse, type TenantAuthMeResponse, type TenantAuthPasswordResetInput, type TenantAuthPasswordResetResponse, type TenantAuthSignOutResponse, type TenantAuthStartInput, type TenantAuthStartResponse, type UploadSiteAssetResponse, type UpsertDraftMarketingSchemaInput, type UpsertDraftMarketingSchemaResponse, type UpsertRowInput, type UpsertRowResponse } from "./contracts.js";
+import { type AddressDetailsResponse, type AddressFormValues, type AddressSearchInput, type AddressSearchResponse, type AddressVerifyResponse, type AiVisibilityInput, type AiVisibilityResponse, type AttributionHeartbeatInput, type AttributionHeartbeatResponse, type AttributionPolicy, type AuthIntrospectResponse, type BlogCategoryListResponse, type BlogCommentListResponse, type BlogCommentPostInput, type BlogCommentPostResponse, type BlogLikeResponse, type BlogListPostsResponse, type BlogPostBySlugResponse, type BlogSessionInput, type BlogSessionResponse, type BlogTagListResponse, type CartAddItemInput, type CartCouponInput, type CartSessionResponse, type CartSnapshot, type CartUpdateItemInput, type ChatbotAppendMessageInput, type ChatbotAvailability, type ChatbotChatInput, type ChatbotChatResponse, type ChatbotConfig, type ChatbotConfigUpdateInput, type ChatbotFormDefinition, type ChatbotFormSubmitInput, type ChatbotFormSubmitResponse, type ChatbotMessagesResponse, type ChatbotPersistedSessionInput, type ChatbotPersistedSessionResponse, type ChatbotRequestHumanInput, type ChatbotRequestHumanResponse, type ChatbotSessionResponse, type CheckoutSessionInput, type CheckoutSessionResponse, type CheckoutStartInput, type CheckoutStartResponse, type CheckoutStatusResponse, type ConfirmVerificationInput, type ConfirmVerificationResponse, type CouponCreateInput, type CouponCreateResponse, type CouponListResponse, type CouponValidateResponse, type CreateCollectionInput, type CreateCollectionResponse, type CreateEmailTemplateInput, type CreateEmailTemplateResponse, type CreateEmailTemplateVersionInput, type CreateEmailTemplateVersionResponse, type CustomerContactCompanyInput, type CustomerContactCompanyResponse, type CustomerContractDetail, type CustomerContractListResponse, type CustomerContractSignResponse, type CustomerDownloadsResponse, type CustomerInviteResendResponse, type CustomerInvoiceDetail, type CustomerInvoiceListResponse, type CustomerInvoicePayInput, type CustomerInvoicePayResponse, type CustomerInvoicePdf, type CustomerJobActivityResponse, type CustomerJobComment, type CustomerJobCommentPostInput, type CustomerJobCommentsListResponse, type CustomerJobDetail, type CustomerJobEtaResponse, type CustomerNotificationPreferencesResponse, type CustomerNotificationPreferencesUpdateInput, type CustomerNotificationPreferencesUpdateResponse, type CustomerNotReceivedResult, type CustomerOrderDetail, type CustomerOrderListResponse, type CustomerPortalContextResponse, type CustomerPortalMessage, type CustomerPortalMessageListResponse, type CustomerPortalMessagePostInput, type CustomerPortalMessagesMarkReadResponse, type CustomerPortalOtherOrgsResponse, type CustomerPortalProfile, type CustomerPortalQuizResultsResponse, type CustomerPortalUpdateProfileInput, type CustomerPortalUpdateProfileResponse, type CustomerProductReviewCreated, type CustomerProductReviewList, type CustomerProposal, type CustomerProposalListResponse, type CustomerPushConfig, type CustomerQuoteActionResponse, type CustomerQuoteDetail, type CustomerQuoteListResponse, type CustomerReferralHistoryResponse, type CustomerReferralPayoutsResponse, type CustomerReferralStats, type CustomerReturnRequestCreated, type CustomerReturnRequestInput, type CustomerReturnRequestListResponse, type CustomerReviewListResponse, type CustomerReviewSubmitInput, type CustomerReviewSubmitResponse, type CustomerShipmentListResponse, type CustomerShipmentTracking, type CustomerSubscriberContentResponse, type CustomerSubscriptionCancelResponse, type CustomerSubscriptionResponse, type CustomerWorkBundle, type DashboardSessionResponse, type ExecuteActionInput, type ExecuteActionResponse, type FollowerEditInput, type FollowerEditResponse, type FollowerJoinInput, type FollowerJoinResponse, type FollowerLeaveInput, type FollowerLeaveResponse, type FollowerMeInput, type FollowerMeResponse, type GetCollectionResponse, type GetEmailTemplateResponse, type GetMarketingLocalesResponse, type GetMarketingPageBundleResponse, type GetPublishedMarketingSchemaResponse, type GetSiteMarketingPageResponse, type GoogleAddress, type JobCategoryListResponse, type JobPosting, type JobPostingListResponse, type LegalDocument, type LegalListResponse, type ListCollectionsResponse, type ListDataModelRecordsInput, type ListDataModelRecordsResponse, type ListEmailTemplatesInput, type ListEmailTemplatesResponse, type ListRowsInput, type ListRowsResponse, type ListSiteMarketingPagesResponse, type NotificationPreferencesResponse, type NotificationPreferencesUpdateInput, type PageViewsInput, type PageViewsResponse, type PublishMarketingSectionsInput, type PublishMarketingSectionsResponse, type QueryRowsInput, type QueryRowsResponse, type ReviewWallListResponse, type SchedulingBookingResult, type SchedulingBookingView, type SchedulingCancelResult, type SchedulingEventTypeDetail, type SchedulingEventTypeList, type SchedulingRescheduleResult, type SchedulingSlotsResponse, type ShippingRatesInput, type ShippingRatesResponse, type ShippingSettingsResponse, type ShippingTrackResponse, type SiteAssetInput, type SiteBranding, type StartVerificationInput, type StartVerificationResponse, type StorefrontAddonsResponse, type StorefrontCategoriesResponse, type StorefrontListProductsResponse, type StorefrontProductDetail, type StorefrontProductReviewsResponse, type StorefrontProductsWithMetaResponse, type StorefrontRelatedProductsResponse, type StorefrontSessionInput, type StorefrontSessionResponse, type StorefrontSort, type StorefrontSyncToStripeResponse, type SubscriptionCheckoutInput, type SubscriptionCheckoutResponse, type SubscriptionOffering, type SubscriptionOfferingsListResponse, type TenantAuthExchangeInput, type TenantAuthExchangeResponse, type TenantAuthMeResponse, type TenantAuthPasswordResetInput, type TenantAuthPasswordResetResponse, type TenantAuthSignOutResponse, type TenantAuthStartInput, type TenantAuthStartResponse, type UploadSiteAssetResponse, type UpsertDraftMarketingSchemaInput, type UpsertDraftMarketingSchemaResponse, type UpsertRowInput, type UpsertRowResponse } from "./contracts.js";
 export type FetchLike = typeof fetch;
-/** Options for {@link BiabDevClient} / {@link createBiabDevClient}. */
-export type BiabDevClientOptions = {
+/** Options for {@link BdApiClient} / {@link createBdApiClient}. */
+export type BdApiClientOptions = {
     baseUrl: string;
     apiKey: string;
     fetch?: FetchLike;
@@ -27,43 +27,43 @@ type RequestOptions<T> = {
     headers?: HeadersInit;
 };
 /**
- * Typed client for the BIAB package HTTP API.
+ * Typed client for the BD package HTTP API.
  *
  * @remarks
  * **Alpha:** This SDK is in alpha. Surfaces and behavior may change without semver guarantees.
  * Do not rely on it for production workloads—use development, staging, or experiments only.
  */
-export declare class BiabDevClient {
+export declare class BdApiClient {
     private readonly baseUrl;
     private readonly apiKey;
     private readonly fetchImpl;
     private readonly defaultHeaders;
-    constructor(options: BiabDevClientOptions);
+    constructor(options: BdApiClientOptions);
     private readonly siteOrigin;
-    site(siteId: string): BiabDevSiteClient;
-    get emailTemplates(): BiabDevEmailTemplatesClient;
-    get dashboard(): BiabDevDashboardClient;
-    get storefront(): BiabDevStorefrontClient;
-    get cart(): BiabDevCartClient;
-    get checkout(): BiabDevCheckoutClient;
-    get coupons(): BiabDevCouponsClient;
-    get subscriptions(): BiabDevSubscriptionsClient;
-    get shipping(): BiabDevShippingClient;
+    site(siteId: string): BdSiteClient;
+    get emailTemplates(): BdEmailTemplatesClient;
+    get dashboard(): BdDashboardClient;
+    get storefront(): BdStorefrontClient;
+    get cart(): BdCartClient;
+    get checkout(): BdCheckoutClient;
+    get coupons(): BdCouponsClient;
+    get subscriptions(): BdSubscriptionsClient;
+    get shipping(): BdShippingClient;
     /** Customer-portal invitations — currently resend. */
-    get customerInvites(): BiabDevCustomerInvitesClient;
-    get notifications(): BiabDevNotificationsClient;
-    get address(): BiabDevAddressClient;
-    get blog(): BiabDevBlogClient;
-    get reviews(): BiabDevReviewsClient;
+    get customerInvites(): BdCustomerInvitesClient;
+    get notifications(): BdNotificationsClient;
+    get address(): BdAddressClient;
+    get blog(): BdBlogClient;
+    get reviews(): BdReviewsClient;
     /**
      * Tracking consent for this org's site.
      *
      * Pair with `@businessdash/sdk/consent`, which handles the visitor cookie
      * and gives you a gate to check before starting analytics.
      */
-    get consent(): BiabDevConsentClient;
+    get consent(): BdConsentClient;
     /** Public job postings — build a careers page on your own domain. */
-    get hiring(): BiabDevHiringClient;
+    get hiring(): BdHiringClient;
     /**
      * The org's published legal pages — privacy, terms, refund policy, whatever
      * they authored in the dashboard.
@@ -71,54 +71,54 @@ export declare class BiabDevClient {
      * Pair with `@businessdash/sdk/legal` to render them without writing a page
      * per document.
      */
-    get legal(): BiabDevLegalClient;
-    get chatbot(): BiabDevChatbotClient;
-    get auth(): BiabDevAuthClient;
+    get legal(): BdLegalClient;
+    get chatbot(): BdChatbotClient;
+    get auth(): BdAuthClient;
     /**
-     * Customer-portal client. Pin to a specific BIAB organization id so the
+     * Customer-portal client. Pin to a specific BD organization id so the
      * caller never sees data from any other org (recommended). Omit
      * `organizationId` to fall back to the user's currently-active session
      * org — only use that on first-party hosts where the host already pins
      * the org.
      */
-    customerPortal(organizationId?: string): BiabDevCustomerPortalClient;
+    customerPortal(organizationId?: string): BdCustomerPortalClient;
     introspect(): Promise<AuthIntrospectResponse>;
     request<T>(options: RequestOptions<T>): Promise<T>;
 }
-export declare class BiabDevSiteClient {
-    readonly client: BiabDevClient;
+export declare class BdSiteClient {
+    readonly client: BdApiClient;
     readonly siteId: string;
-    readonly collections: BiabDevCollectionsClient;
-    readonly rows: BiabDevRowsClient;
+    readonly collections: BdCollectionsClient;
+    readonly rows: BdRowsClient;
     /**
      * The org's custom database — the tables from `defineDataModel()`.
      * Distinct from `collections`/`rows`, which are Site Data. See
-     * {@link BiabDevDataModelClient}.
+     * {@link BdDataModelClient}.
      */
-    readonly dataModel: BiabDevDataModelClient;
+    readonly dataModel: BdDataModelClient;
     /**
      * Read your site's visitor counts back (the counterpart to the
-     * `<BIABAnalytics/>` tracker, which only records). See
-     * {@link BiabDevAnalyticsClient}.
+     * `<BDAnalytics/>` tracker, which only records). See
+     * {@link BdAnalyticsClient}.
      */
-    readonly analytics: BiabDevAnalyticsClient;
+    readonly analytics: BdAnalyticsClient;
     /**
      * The "Powered by BusinessDash" badge's policy + heartbeat. See
-     * {@link BiabDevAttributionClient}.
+     * {@link BdAttributionClient}.
      */
-    readonly attribution: BiabDevAttributionClient;
-    readonly assets: BiabDevAssetsClient;
-    readonly actions: BiabDevActionsClient;
-    readonly followers: BiabDevFollowersClient;
-    readonly marketingPages: BiabDevMarketingPagesClient;
+    readonly attribution: BdAttributionClient;
+    readonly assets: BdAssetsClient;
+    readonly actions: BdActionsClient;
+    readonly followers: BdFollowersClient;
+    readonly marketingPages: BdMarketingPagesClient;
     /**
      * Schema-driven marketing flow (Phase 2). Pair with the SDK's
-     * `defineSiteMarketingSchema()` builder + the `biab-dev sync-schema`
+     * `defineSiteMarketingSchema()` builder + the `bd sync-schema`
      * CLI for the authoring side; this client is the live-site read
      * path (`getPageBundle`) and the upload entry point for the CLI.
      */
-    readonly marketing: BiabDevMarketingClient;
-    readonly parallelPages: BiabDevParallelPagesClient;
+    readonly marketing: BdMarketingClient;
+    readonly parallelPages: BdParallelPagesClient;
     /**
      * Booking and conference calls.
      *
@@ -126,8 +126,8 @@ export declare class BiabDevSiteClient {
      * resource, which is why the OpenAPI generator — which reads this file —
      * never saw it, and why no non-JS starter had scheduling at all.
      */
-    readonly scheduling: BiabDevSchedulingClient;
-    constructor(client: BiabDevClient, siteId: string);
+    readonly scheduling: BdSchedulingClient;
+    constructor(client: BdApiClient, siteId: string);
     /**
      * The org's storefront branding — logo + favicon (site static media) plus
      * the org name + icon. Render the masthead/favicon/og without the org
@@ -389,10 +389,10 @@ export type ParallelPagesRenderResponse = z.infer<typeof parallelPagesRenderResp
  *     return <RenderTemplate bundle={bundle} />;
  *   }
  */
-export declare class BiabDevParallelPagesClient {
+export declare class BdParallelPagesClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     list(): Promise<ParallelPagesListResponse>;
     listVariants(key: string, opts?: {
         locale?: string;
@@ -432,10 +432,10 @@ export declare function clearMarketingCache(siteId: string): void;
  *     checksum = `noop: true`).
  *   - `getLocales()` — enabled locales + brand-token map.
  */
-export declare class BiabDevMarketingClient {
+export declare class BdMarketingClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     getPageBundle(input?: {
         pageKey?: string;
         locale?: string;
@@ -457,15 +457,15 @@ export declare class BiabDevMarketingClient {
     getDraftSchema(): Promise<GetPublishedMarketingSchemaResponse>;
     publishDraftSchema(input: UpsertDraftMarketingSchemaInput): Promise<UpsertDraftMarketingSchemaResponse>;
     /**
-     * Bulk-upsert section values. Used by `biab-dev sync-content` to push
-     * local JSON content to BIAB. Server caps each request at 256 items;
+     * Bulk-upsert section values. Used by `bd sync-content` to push
+     * local JSON content to BD. Server caps each request at 256 items;
      * larger imports are batched by the CLI. Per-item failures are
      * reported in the response (`results[].ok === false`) without aborting
      * the rest of the batch.
      *
      * The CLI's `--lax` flag sets `validate: false` for first-time imports
      * of legacy content that doesn't yet match the published schema —
-     * useful so writers can pull existing content into BIAB and fix
+     * useful so writers can pull existing content into BD and fix
      * validation errors in the dashboard incrementally.
      */
     publishSections(input: PublishMarketingSectionsInput): Promise<PublishMarketingSectionsResponse>;
@@ -492,10 +492,10 @@ export declare function clearMarketingPageCache(siteId: string, pageKey?: string
  * `list()` (no payloads) with `get(pageKey)` / `prefetch(pageKey)` to load
  * pages on demand instead of paying the full-content cost up front.
  */
-export declare class BiabDevMarketingPagesClient {
+export declare class BdMarketingPagesClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     /**
      * Payload-free directory of every marketing page for the site. Use this
      * to render a navigation index without loading any content; call
@@ -529,29 +529,29 @@ export declare class BiabDevMarketingPagesClient {
      */
     prefetch(pageKey?: string): Promise<GetSiteMarketingPageResponse>;
 }
-export declare class BiabDevCollectionsClient {
+export declare class BdCollectionsClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     list(): Promise<ListCollectionsResponse>;
     create(input: CreateCollectionInput): Promise<CreateCollectionResponse>;
     get(slug: string): Promise<GetCollectionResponse>;
 }
-export declare class BiabDevRowsClient {
+export declare class BdRowsClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     list(collectionSlug: string, input?: ListRowsInput): Promise<ListRowsResponse>;
     upsert(collectionSlug: string, input: UpsertRowInput): Promise<UpsertRowResponse>;
     query(collectionSlug: string, input: QueryRowsInput): Promise<QueryRowsResponse>;
 }
 /**
  * Read rows out of the org's CUSTOM DATABASE — the tables you declare with
- * `defineDataModel()` and push with `biab-dev sync-data-model`.
+ * `defineDataModel()` and push with `bd sync-data-model`.
  *
  * ⚠️ Not the same thing as `.collections` / `.rows`. Those read Site Data (the
  * site builder's tables, `site_data_rows`). Rows seeded with
- * `biab-dev sync-records` live in `org_object_records` and are reachable only
+ * `bd sync-records` live in `org_object_records` and are reachable only
  * through here — no `collections:*` call will ever return one.
  *
  * Requires the `metadata:read_records` scope. What a key can actually read is
@@ -567,7 +567,7 @@ export declare class BiabDevRowsClient {
  * private one never is. Open a table by declaring `visibility` in your model.
  *
  * ```ts
- * const result = await biab.site(siteId).dataModel.listRecords({
+ * const result = await bd.site(siteId).dataModel.listRecords({
  *   object: TECH_OBJECT_ID,   // the universalIdentifier from your config
  * });
  * if (!result.available) return <UpgradeCard feature={result.requiredFeature} />;
@@ -577,10 +577,10 @@ export declare class BiabDevRowsClient {
  * }
  * ```
  */
-export declare class BiabDevDataModelClient {
+export declare class BdDataModelClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     /**
      * One page of an object's rows, newest first, with relations expanded.
      *
@@ -608,20 +608,20 @@ export declare class BiabDevDataModelClient {
 /**
  * Read your site's visitor counts back.
  *
- * The `<BIABAnalytics/>` tracker (`@businessdash/sdk/react-analytics`) RECORDS
+ * The `<BDAnalytics/>` tracker (`@businessdash/sdk/react-analytics`) RECORDS
  * pageviews; this READS the totals, so you can put a number on the page instead
  * of only feeding the dashboard.
  *
  * ```ts
  * // Site-wide, all time
- * const all = await biab.site(siteId).analytics.pageViews();
+ * const all = await bd.site(siteId).analytics.pageViews();
  * if (all.available) console.log(`${all.total.views} views`);
  *
  * // One page, last 30 days
- * const home = await biab.site(siteId).analytics.pageViews({ paths: ['/'], days: 30 });
+ * const home = await bd.site(siteId).analytics.pageViews({ paths: ['/'], days: 30 });
  *
  * // A batch of pages in one round-trip
- * const list = await biab.site(siteId).analytics.pageViews({
+ * const list = await bd.site(siteId).analytics.pageViews({
  *   paths: ['/tech/typescript', '/tech/rust'],
  * });
  * // list.paths → [{ path, views, visitors }, …], every requested path present
@@ -631,10 +631,10 @@ export declare class BiabDevDataModelClient {
  * Requires the `analytics.web` entitlement — an org without it gets
  * `{ available: false }`, so branch on `.available`.
  */
-export declare class BiabDevAnalyticsClient {
+export declare class BdAnalyticsClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     /**
      * Pageview + visitor counts. Pass `paths` for a per-path breakdown (plus a
      * combined `total`), or omit them for a site-wide `total`. `days` windows the
@@ -652,7 +652,7 @@ export declare class BiabDevAnalyticsClient {
      * to a 30-day window.
      *
      * ```ts
-     * const ai = await biab.site(siteId).analytics.aiVisibility({ days: 30 });
+     * const ai = await bd.site(siteId).analytics.aiVisibility({ days: 30 });
      * if (ai.available) {
      *   for (const c of ai.crawlers)
      *     console.log(`${c.name}: ${c.fetches} fetches over ${c.distinctPages} pages`);
@@ -672,10 +672,10 @@ export declare class BiabDevAnalyticsClient {
  * verifies the badge by fetching your live domain, not by trusting this call. So
  * don't build logic on the heartbeat; do honor `policy().required`.
  */
-export declare class BiabDevAttributionClient {
+export declare class BdAttributionClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     /**
      * This site's badge policy: `{ siteId, required }`. `required` is `true` on
      * plans that can't remove the badge (launch), `false` otherwise. Build the
@@ -689,48 +689,48 @@ export declare class BiabDevAttributionClient {
      */
     heartbeat(input: AttributionHeartbeatInput): Promise<AttributionHeartbeatResponse>;
 }
-export declare class BiabDevAssetsClient {
+export declare class BdAssetsClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     create(input: SiteAssetInput): Promise<UploadSiteAssetResponse>;
 }
-export declare class BiabDevActionsClient {
+export declare class BdActionsClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     run(actionName: string, input?: ExecuteActionInput): Promise<ExecuteActionResponse>;
 }
-export declare class BiabDevEmailTemplatesClient {
+export declare class BdEmailTemplatesClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     list(input?: ListEmailTemplatesInput): Promise<ListEmailTemplatesResponse>;
     get(templateId: number): Promise<GetEmailTemplateResponse>;
     create(input: CreateEmailTemplateInput): Promise<CreateEmailTemplateResponse>;
     createVersion(templateId: number, input: CreateEmailTemplateVersionInput): Promise<CreateEmailTemplateVersionResponse>;
 }
-export declare class BiabDevFollowersClient {
+export declare class BdFollowersClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     private actionPath;
     join(input: FollowerJoinInput): Promise<FollowerJoinResponse>;
     me(input: FollowerMeInput): Promise<FollowerMeResponse>;
     edit(input: FollowerEditInput): Promise<FollowerEditResponse>;
     leave(input: FollowerLeaveInput): Promise<FollowerLeaveResponse>;
 }
-export declare class BiabDevDashboardClient {
+export declare class BdDashboardClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     createSession(): Promise<DashboardSessionResponse>;
 }
-export declare class BiabDevStorefrontClient {
+export declare class BdStorefrontClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /**
      * Legacy embed-session mint (kept for iframe-widget consumers).
      * The programmatic methods below let consumer sites render their
-     * own native product catalog using BIAB as the data layer.
+     * own native product catalog using BD as the data layer.
      */
     createSession(input?: StorefrontSessionInput): Promise<StorefrontSessionResponse>;
     /**
@@ -753,7 +753,7 @@ export declare class BiabDevStorefrontClient {
      * ```ts
      * let remaining = 1;
      * while (remaining > 0) {
-     *   const res = await biab.storefront.syncToStripe();
+     *   const res = await bd.storefront.syncToStripe();
      *   remaining = res.remaining;
      * }
      * ```
@@ -797,7 +797,7 @@ export declare class BiabDevStorefrontClient {
     listCategories(): Promise<StorefrontCategoriesResponse>;
     /**
      * Full product detail with variants + per-image rows. Returns 404
-     * via `BiabApiError` if the product isn't live or doesn't belong
+     * via `BdApiError` if the product isn't live or doesn't belong
      * to the org bound to the API key.
      */
     /**
@@ -812,7 +812,7 @@ export declare class BiabDevStorefrontClient {
      * The platform withholds the raw URL from every product payload on purpose:
      * CAD files are the largest thing it serves and are the org's intellectual
      * property, so a catalog of naked URLs is a design library published to
-     * anyone willing to write a loop. This endpoint requires a `biab_cad` cookie
+     * anyone willing to write a loop. This endpoint requires a `bd_cad` cookie
      * on the incoming request, rate-limits per IP, and re-checks the
      * `ecommerce.product_3d` entitlement before answering.
      *
@@ -841,23 +841,23 @@ export declare class BiabDevStorefrontClient {
     /** Companion / exclusive cross-sell addons for the "complete your X" rail. */
     getProductAddons(productId: string): Promise<StorefrontAddonsResponse>;
 }
-export declare class BiabDevCartClient {
+export declare class BdCartClient {
     private readonly client;
     private readonly visitorToken;
     private readonly sessionToken;
-    constructor(client: BiabDevClient, visitorToken?: string | null, sessionToken?: string | null);
+    constructor(client: BdApiClient, visitorToken?: string | null, sessionToken?: string | null);
     /**
      * Use an anonymous visitor token (UUID stored in the consumer's
      * own httpOnly cookie). Same shopper across page loads, no
      * sign-in required.
      */
-    forVisitor(visitorToken: string): BiabDevCartClient;
+    forVisitor(visitorToken: string): BdCartClient;
     /**
      * Use a tenantAuth session token instead of a visitor token.
      * Carts are now keyed to the signed-in customer; persists
      * across devices.
      */
-    withSession(sessionToken: string): BiabDevCartClient;
+    withSession(sessionToken: string): BdCartClient;
     private headers;
     /**
      * Legacy embed-session mint (kept for iframe-widget consumers).
@@ -895,22 +895,22 @@ export declare class BiabDevCartClient {
     /** Empty all items + drop the stamped coupon. Keeps the cart row itself. */
     clear(): Promise<CartSnapshot>;
 }
-export declare class BiabDevCheckoutClient {
+export declare class BdCheckoutClient {
     private readonly client;
     private readonly visitorToken;
     private readonly sessionToken;
-    constructor(client: BiabDevClient, visitorToken?: string | null, sessionToken?: string | null);
+    constructor(client: BdApiClient, visitorToken?: string | null, sessionToken?: string | null);
     /**
      * Authenticate the start-from-cart call as an anonymous shopper
      * (visitor-token cart). Same UUID you used with `client.cart.forVisitor(...)`.
      */
-    forVisitor(visitorToken: string): BiabDevCheckoutClient;
+    forVisitor(visitorToken: string): BdCheckoutClient;
     /**
      * Authenticate as a signed-in customer (tenantAuth session token).
      * The Stripe Checkout Session will be created against this
      * customer's saved cart.
      */
-    withSession(sessionToken: string): BiabDevCheckoutClient;
+    withSession(sessionToken: string): BdCheckoutClient;
     private headers;
     /**
      * Legacy iframe-embed mint — gives back a tokenized URL to render
@@ -919,7 +919,7 @@ export declare class BiabDevCheckoutClient {
      */
     createSession(input: CheckoutSessionInput): Promise<CheckoutSessionResponse>;
     /**
-     * Convert the caller's saved BIAB cart (resolved via visitor token
+     * Convert the caller's saved BD cart (resolved via visitor token
      * or session token) into a Stripe Checkout Session. Returns the
      * Stripe-hosted URL; redirect the browser there to collect payment.
      *
@@ -937,7 +937,7 @@ export declare class BiabDevCheckoutClient {
     getStatus(sessionId: string): Promise<CheckoutStatusResponse>;
 }
 /**
- * White-glove Google Places proxy. BIAB owns the API key — consumer
+ * White-glove Google Places proxy. BD owns the API key — consumer
  * code never sees it. Use at the checkout delivery-address input
  * to give shoppers text-search predictions + verify deliverability
  * before submitting the order.
@@ -962,7 +962,7 @@ export declare class BiabDevCheckoutClient {
  * // When user picks a prediction:
  * const detail = await client.address.getDetails(prediction.place_id);
  * if (detail.enabled && detail.address) {
- *   const form = BiabDevAddressClient.googleToFormValues(detail.address);
+ *   const form = BdAddressClient.googleToFormValues(detail.address);
  *   reactHookForm.reset(form);
  * }
  *
@@ -971,9 +971,9 @@ export declare class BiabDevCheckoutClient {
  * if (!v.isVerified) showDidYouMean(v.googleAddress);
  * ```
  */
-export declare class BiabDevAddressClient {
+export declare class BdAddressClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     search(input: AddressSearchInput): Promise<AddressSearchResponse>;
     getDetails(placeId: string): Promise<AddressDetailsResponse>;
     verify(input: AddressFormValues): Promise<AddressVerifyResponse>;
@@ -999,16 +999,16 @@ export declare class BiabDevAddressClient {
  * dashboard's "Sync to Stripe" action — otherwise `startCheckout`
  * returns 409 `subscription_not_synced`.
  */
-export declare class BiabDevSubscriptionsClient {
+export declare class BdSubscriptionsClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     list(): Promise<SubscriptionOfferingsListResponse>;
     get(id: string): Promise<SubscriptionOffering>;
     startCheckout(id: string, input?: SubscriptionCheckoutInput): Promise<SubscriptionCheckoutResponse>;
 }
-export declare class BiabDevCouponsClient {
+export declare class BdCouponsClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /**
      * Validate a coupon code against the org's Stripe-connected
      * account. Returns the discount shape (percent / amount /
@@ -1040,7 +1040,7 @@ export declare class BiabDevCouponsClient {
      * Requires a SECRET key holding `storefront:write`.
      *
      * ```ts
-     * const { coupon, stripeSynced } = await biab.coupons.create({
+     * const { coupon, stripeSynced } = await bd.coupons.create({
      *   code: 'WELCOME10',
      *   discountType: 'percent',
      *   value: 10,
@@ -1058,10 +1058,10 @@ export declare class BiabDevCouponsClient {
 }
 /**
  * Shipping: rate lookups + on-demand tracking. White-glove model —
- * BIAB owns the carrier integration; consumer code never sees the
+ * BD owns the carrier integration; consumer code never sees the
  * underlying provider name. Gated on `ecommerce.shipping` so calls
  * from orgs on the Launch plan return the standard plan-gate body
- * via {@link BiabApiError} (status 403).
+ * via {@link BdApiError} (status 403).
  *
  * @example
  * ```ts
@@ -1078,13 +1078,13 @@ export declare class BiabDevCouponsClient {
  * }
  * ```
  */
-export declare class BiabDevShippingClient {
+export declare class BdShippingClient {
     private readonly client;
     private readonly visitorToken;
     private readonly sessionToken;
-    constructor(client: BiabDevClient, visitorToken?: string | null, sessionToken?: string | null);
-    forVisitor(visitorToken: string): BiabDevShippingClient;
-    withSession(sessionToken: string): BiabDevShippingClient;
+    constructor(client: BdApiClient, visitorToken?: string | null, sessionToken?: string | null);
+    forVisitor(visitorToken: string): BdShippingClient;
+    withSession(sessionToken: string): BdShippingClient;
     private headers;
     /**
      * Fetch shipping rate options for the caller's cart + a delivery
@@ -1131,15 +1131,15 @@ export declare class BiabDevShippingClient {
  *   - `order.return_label_created`
  *
  * The webhook payload is JSON + signed with the customer's saved
- * `webhookSigningSecret` via `X-BIAB-Signature: <hex hmac-sha256>`.
+ * `webhookSigningSecret` via `X-BD-Signature: <hex hmac-sha256>`.
  * Consumer's receiver verifies via:
  *   crypto.createHmac('sha256', secret).update(rawBody).digest('hex')
  */
-export declare class BiabDevNotificationsClient {
+export declare class BdNotificationsClient {
     private readonly client;
     private readonly sessionToken;
-    constructor(client: BiabDevClient, sessionToken?: string | null);
-    withSession(sessionToken: string): BiabDevNotificationsClient;
+    constructor(client: BdApiClient, sessionToken?: string | null);
+    withSession(sessionToken: string): BdNotificationsClient;
     private headers;
     getPreferences(): Promise<CustomerNotificationPreferencesResponse>;
     updatePreferences(input: CustomerNotificationPreferencesUpdateInput): Promise<CustomerNotificationPreferencesUpdateResponse>;
@@ -1159,10 +1159,10 @@ export declare class BiabDevNotificationsClient {
      */
     confirmVerification(input: ConfirmVerificationInput): Promise<ConfirmVerificationResponse>;
 }
-export declare class BiabDevBlogClient {
+export declare class BdBlogClient {
     private readonly client;
     private readonly sessionToken;
-    constructor(client: BiabDevClient, sessionToken?: string | null);
+    constructor(client: BdApiClient, sessionToken?: string | null);
     /**
      * Chainable: return a blog client whose `postComment` + future
      * write methods authenticate via the tenantAuth session token.
@@ -1174,7 +1174,7 @@ export declare class BiabDevBlogClient {
      * await client.blog().withSession(token).postComment(slug, { content });
      * ```
      */
-    withSession(sessionToken: string): BiabDevBlogClient;
+    withSession(sessionToken: string): BdBlogClient;
     private headers;
     /**
      * Legacy embed-session mint (kept for backwards compat with
@@ -1242,9 +1242,9 @@ export declare class BiabDevBlogClient {
  * }
  * ```
  */
-export declare class BiabDevReviewsClient {
+export declare class BdReviewsClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /**
      * One page of the org's public reviews, newest-first. `limit` defaults to
      * the server default (10, max 50). Pass the previous response's
@@ -1274,9 +1274,9 @@ export declare class BiabDevReviewsClient {
  * }
  * ```
  */
-export declare class BiabDevHiringClient {
+export declare class BdHiringClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /**
      * One page of open postings, newest-first. `limit` defaults to the server
      * default (25, max 100). Pass the previous response's `nextOffset` to page
@@ -1317,9 +1317,9 @@ export declare class BiabDevHiringClient {
  * const privacy = await client.legal.get("privacy");
  * ```
  */
-export declare class BiabDevLegalClient {
+export declare class BdLegalClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /**
      * Every published document, plus the header/footer presentation.
      *
@@ -1344,13 +1344,13 @@ export declare class BiabDevLegalClient {
  * that could read or write another org's consent — consent is given to a
  * controller, and one controller's record is not another's to act on.
  *
- * The visitor is identified by an `x-biab-visitor` header carrying an opaque id
+ * The visitor is identified by an `x-bd-visitor` header carrying an opaque id
  * from the caller's own first-party cookie. `@businessdash/sdk/consent` manages
  * that for you; these methods are the transport underneath it.
  */
-export declare class BiabDevConsentClient {
+export declare class BdConsentClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /** The notice to show, and what this visitor currently allows. */
     get(visitorKey?: string | null): Promise<{
         categories: string[];
@@ -1375,9 +1375,9 @@ export declare class BiabDevConsentClient {
         ok: boolean;
     }>;
 }
-export declare class BiabDevChatbotClient {
+export declare class BdChatbotClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /** Returns the iframe URL for `<Chatbot/>`. */
     createSession(): Promise<ChatbotSessionResponse>;
     /** Reads the org's persisted chatbot config (system prompt, KB, model). */
@@ -1497,12 +1497,12 @@ export declare class BiabDevChatbotClient {
      */
     requestHuman(input: ChatbotRequestHumanInput): Promise<ChatbotRequestHumanResponse>;
 }
-export declare class BiabDevCustomerPortalClient {
+export declare class BdCustomerPortalClient {
     private readonly client;
     private readonly organizationId;
     /**
      * Optional tenantAuth session token. When set, requests include
-     * an `X-BIAB-Session-Token` header and the BIAB customer-portal
+     * an `X-BD-Session-Token` header and the BD customer-portal
      * routes resolve the calling user via the session payload
      * instead of the API key's user binding.
      *
@@ -1515,10 +1515,10 @@ export declare class BiabDevCustomerPortalClient {
      * customer-scoped call.
      */
     private readonly sessionToken;
-    constructor(client: BiabDevClient, organizationId: string | null, 
+    constructor(client: BdApiClient, organizationId: string | null, 
     /**
      * Optional tenantAuth session token. When set, requests include
-     * an `X-BIAB-Session-Token` header and the BIAB customer-portal
+     * an `X-BD-Session-Token` header and the BD customer-portal
      * routes resolve the calling user via the session payload
      * instead of the API key's user binding.
      *
@@ -1545,7 +1545,7 @@ export declare class BiabDevCustomerPortalClient {
      *   .getWork();
      * ```
      */
-    withSession(sessionToken: string): BiabDevCustomerPortalClient;
+    withSession(sessionToken: string): BdCustomerPortalClient;
     private headers;
     context(): Promise<CustomerPortalContextResponse>;
     getProfile(): Promise<CustomerPortalProfile>;
@@ -1611,6 +1611,17 @@ export declare class BiabDevCustomerPortalClient {
     getWork(): Promise<CustomerWorkBundle>;
     /** Read a single job the signed-in customer owns. */
     getJob(jobId: string): Promise<CustomerJobDetail>;
+    /**
+     * Designed proposals the customer has been sent.
+     *
+     * Separate from `listQuotes` because a proposal is the document built
+     * around a quote, not the quote: `kind` decides whether a consumer offers
+     * a download or frames a page, and a UI that guessed would get one of the
+     * two wrong every time.
+     */
+    listProposals(): Promise<CustomerProposalListResponse>;
+    /** One proposal the customer owns. */
+    getProposal(proposalId: string): Promise<CustomerProposal>;
     /** Read a single quote the signed-in customer owns. */
     getQuote(quoteId: string): Promise<CustomerQuoteDetail>;
     /** Naming alias for {@link getQuote} — read a single quote the customer owns. */
@@ -1670,7 +1681,7 @@ export declare class BiabDevCustomerPortalClient {
     /**
      * Begin signing a contract the customer owns. Returns a ready, absolute
      * signing URL on the org's branded hostname — redirect the customer there
-     * to BIAB's hosted e-sign page, which captures the signature and generates
+     * to BD's hosted e-sign page, which captures the signature and generates
      * the executed PDF. No signature payload is collected client-side, so the
      * legal record stays consistent across consumers.
      *
@@ -2000,7 +2011,7 @@ export declare class BiabDevCustomerPortalClient {
     /**
      * List the digital downloads the customer is entitled to for a paid order
      * (P10d). Each item is a ready-to-use URL — a short-lived presigned link for
-     * BIAB-hosted files (`expiresInSeconds` set) or the org's external link.
+     * BD-hosted files (`expiresInSeconds` set) or the org's external link.
      * Returns an empty list until the order's payment settles.
      *
      * @example
@@ -2087,21 +2098,21 @@ export declare class BiabDevCustomerPortalClient {
     getJobActivity(jobId: string): Promise<CustomerJobActivityResponse>;
 }
 /**
- * Creates a {@link BiabDevClient} for the given host `baseUrl` and package API key.
+ * Creates a {@link BdApiClient} for the given host `baseUrl` and package API key.
  *
  * @remarks
  * **Alpha:** This package is still in alpha release. APIs may change; it is **not** intended
  * for production use yet. Prefer non-production environments until a stable major is published.
  */
-export declare function createBiabDevClient(options: BiabDevClientOptions): BiabDevClient;
+export declare function createBdApiClient(options: BdApiClientOptions): BdApiClient;
 /**
  * Per-tenant auth: hosted sign-in/sign-up scoped to the org bound to
  * the API key. Used by the SDK's `createAuthHandler` (server) and
  * `<SignIn />` / `<SignUp />` / `<SignOut />` components (client).
  */
-export declare class BiabDevAuthClient {
+export declare class BdAuthClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     start(input: TenantAuthStartInput): Promise<TenantAuthStartResponse>;
     /**
      * Ergonomic shortcut for `start({ intent: "sign-in", ... })`. Returns
@@ -2174,9 +2185,9 @@ export declare class BiabDevAuthClient {
  *
  * For an org running its own admin tooling rather than the dashboard.
  */
-export declare class BiabDevCustomerInvitesClient {
+export declare class BdCustomerInvitesClient {
     private readonly client;
-    constructor(client: BiabDevClient);
+    constructor(client: BdApiClient);
     /**
      * Hand an invite link out again.
      *
@@ -2201,10 +2212,10 @@ export declare class BiabDevCustomerInvitesClient {
         expiresInDays?: number | null;
     }): Promise<CustomerInviteResendResponse>;
 }
-export declare class BiabDevSchedulingClient {
+export declare class BdSchedulingClient {
     private readonly client;
     private readonly siteId;
-    constructor(client: BiabDevClient, siteId: string);
+    constructor(client: BdApiClient, siteId: string);
     private path;
     /** What the org offers to book. */
     listEventTypes(): Promise<SchedulingEventTypeList>;