@pindownai/client-js 1.2.0 → 1.3.2

package/dist/index.d.cts

@@ -3,11 +3,9 @@
  * Aligned with backend-api/src/lib/pin-types.ts + pin-config-schemas.ts.
  * Import per-type *PinConfig interfaces for typed CRUD payloads.
  */
-declare const PRODUCT_PIN_TYPES: readonly ["markdown", "image", "gallery", "table", "charts", "mermaid", "embed", "pdf-viewer", "excel-viewer", "stat-cards", "timeline", "json-viewer", "json-list", "links", "steps", "csv-viewer", "user-story", "chat", "intro", "mastra", "text-media", "file-upload", "kanban-board", "checklist", "calendar", "roadmap", "realtime-canvas"];
-declare const LEGACY_PIN_TYPES: readonly ["line-chart", "tree"];
-declare const ALL_PIN_TYPES: readonly ["markdown", "image", "gallery", "table", "charts", "mermaid", "embed", "pdf-viewer", "excel-viewer", "stat-cards", "timeline", "json-viewer", "json-list", "links", "steps", "csv-viewer", "user-story", "chat", "intro", "mastra", "text-media", "file-upload", "kanban-board", "checklist", "calendar", "roadmap", "realtime-canvas", "line-chart", "tree"];
+declare const PRODUCT_PIN_TYPES: readonly ["markdown", "image", "gallery", "table", "charts", "mermaid", "code", "embed", "pdf-viewer", "excel-viewer", "stat-cards", "timeline", "json-viewer", "json-list", "links", "qr-code", "social-handles", "steps", "trace", "plan", "notes", "csv-viewer", "user-story", "chat", "intro", "mastra", "text-media", "business-card", "video", "audio", "file-upload", "kanban-board", "checklist", "comparison", "calendar", "roadmap", "realtime-canvas"];
+declare const ALL_PIN_TYPES: readonly ["markdown", "image", "gallery", "table", "charts", "mermaid", "code", "embed", "pdf-viewer", "excel-viewer", "stat-cards", "timeline", "json-viewer", "json-list", "links", "qr-code", "social-handles", "steps", "trace", "plan", "notes", "csv-viewer", "user-story", "chat", "intro", "mastra", "text-media", "business-card", "video", "audio", "file-upload", "kanban-board", "checklist", "comparison", "calendar", "roadmap", "realtime-canvas"];
 type ProductPinTypeId = (typeof PRODUCT_PIN_TYPES)[number];
-type LegacyPinTypeId = (typeof LEGACY_PIN_TYPES)[number];
 type PinTypeId = (typeof ALL_PIN_TYPES)[number];
 type PinLayout = '1x1' | '1x2' | '2x1' | '2x2' | '3x1' | '3x2' | '3x3' | '4x4';
 type PinDataType = 'markdown' | 'json' | 'text' | 'pin-card';
@@ -59,12 +57,6 @@ interface StepItem {
     description?: string;
     [key: string]: unknown;
 }
-interface TreeNode {
-    id: string;
-    label: string;
-    children?: TreeNode[];
-    [key: string]: unknown;
-}
 interface MarkdownPinConfig {
     content?: string;
     collaboration?: {
@@ -95,8 +87,15 @@ interface ChartsPinConfig {
     [key: string]: unknown;
 }
 interface MermaidPinConfig {
-    code?: string;
     diagram?: string;
+    code?: string;
+    title?: string;
+    [key: string]: unknown;
+}
+interface CodePinConfig {
+    code: string;
+    language?: string;
+    filename?: string;
     title?: string;
     [key: string]: unknown;
 }
@@ -147,10 +146,112 @@ interface LinksPinConfig {
     links?: LinkItem[];
     [key: string]: unknown;
 }
+interface QrCodePinConfig {
+    url?: string;
+    label?: string;
+    [key: string]: unknown;
+}
+interface SocialHandleItem {
+    id?: string;
+    platform: string;
+    url: string;
+    label?: string;
+    [key: string]: unknown;
+}
+interface SocialHandlesPinConfig {
+    title?: string;
+    showLabels?: boolean;
+    iconSize?: number;
+    handles?: SocialHandleItem[];
+    [key: string]: unknown;
+}
 interface StepsPinConfig {
     steps: StepItem[];
     [key: string]: unknown;
 }
+type TraceSpanStatus = 'completed' | 'running' | 'pending' | 'failed';
+type TraceSpanType = 'system' | 'agent' | 'tool';
+interface TraceSpanItem {
+    id?: string;
+    type?: TraceSpanType;
+    name: string;
+    status: TraceSpanStatus;
+    timestamp?: string;
+    duration?: string;
+    details?: string;
+}
+interface TracePinConfig {
+    title?: string;
+    live?: boolean;
+    spans: TraceSpanItem[];
+    [key: string]: unknown;
+}
+type PlanContentBlock = {
+    type: 'details';
+    title?: string;
+    items: string[];
+} | {
+    type: 'command';
+    command: string;
+    label?: string;
+} | {
+    type: 'code';
+    code: string;
+    language?: string;
+    filename?: string;
+} | {
+    type: 'text';
+    content: string;
+} | {
+    type: 'link';
+    url: string;
+    label?: string;
+} | {
+    type: 'mermaid';
+    diagram: string;
+    title?: string;
+} | {
+    type: 'summary';
+    content: string;
+    title?: string;
+};
+interface PlanTaskItem {
+    id?: string;
+    number?: string;
+    title: string;
+    label?: string;
+    description?: string;
+    blocks?: PlanContentBlock[];
+    [key: string]: unknown;
+}
+interface PlanPhaseItem {
+    id?: string;
+    title: string;
+    status?: 'pending' | 'in-progress' | 'completed';
+    tasks: PlanTaskItem[];
+    [key: string]: unknown;
+}
+interface PlanPinConfig {
+    title?: string;
+    status?: 'draft' | 'in-progress' | 'completed';
+    breadcrumbs?: Array<{
+        label: string;
+    }>;
+    phases: PlanPhaseItem[];
+    [key: string]: unknown;
+}
+interface NoteItem {
+    id?: string;
+    title: string;
+    content?: string;
+    order?: number;
+    createdAt?: number;
+    updatedAt?: number;
+}
+interface NotesPinConfig {
+    notes?: NoteItem[];
+    [key: string]: unknown;
+}
 interface CsvViewerPinConfig {
     csvText?: string;
     csvData?: Array<Record<string, unknown>>;
@@ -166,6 +267,10 @@ interface UserStoryPinConfig {
 interface ChatPinConfig {
     title?: string;
     placeholder?: string;
+    /** Pin this discussion thread is about (commentary / feedback). */
+    linked_pin_id?: string;
+    /** Cached title for display without fetching the linked pin. */
+    linked_pin_title?: string;
     [key: string]: unknown;
 }
 interface IntroPinConfig {
@@ -179,10 +284,69 @@ interface MastraPinConfig {
     workflowId?: string;
     [key: string]: unknown;
 }
+interface BusinessCardField {
+    id: string;
+    key: string;
+    value: string;
+}
+interface BusinessCardPinConfig {
+    sectionTitle?: string;
+    fields?: BusinessCardField[];
+    imageConfig?: {
+        url?: string;
+        alt?: string;
+        fileId?: string;
+        [key: string]: unknown;
+    };
+    imagePosition?: 'left' | 'right' | string;
+    [key: string]: unknown;
+}
+interface VideoPinConfig {
+    url?: string;
+    fileId?: string;
+    fileName?: string;
+    mimeType?: 'video/mp4' | string;
+    caption?: string;
+    size?: number;
+    [key: string]: unknown;
+}
+interface AudioPinTrack {
+    url: string;
+    fileId?: string;
+    fileName?: string;
+    mimeType?: 'audio/mpeg' | 'audio/wav' | 'audio/x-wav' | string;
+    size?: number;
+    [key: string]: unknown;
+}
+interface AudioPinConfig {
+    url?: string;
+    fileId?: string;
+    fileName?: string;
+    mimeType?: 'audio/mpeg' | 'audio/wav' | 'audio/x-wav' | string;
+    caption?: string;
+    size?: number;
+    tracks?: AudioPinTrack[];
+    [key: string]: unknown;
+}
 interface TextMediaPinConfig {
     title?: string;
     text?: string;
+    subtext?: string;
     textPosition?: 'left' | 'right' | string;
+    mediaType?: 'embed' | 'image' | string;
+    embedConfig?: {
+        type?: string;
+        url?: string;
+        aspectRatio?: string;
+        autoplay?: boolean;
+        [key: string]: unknown;
+    };
+    imageConfig?: {
+        url?: string;
+        alt?: string;
+        fileId?: string;
+        [key: string]: unknown;
+    };
     [key: string]: unknown;
 }
 interface FileUploadPinConfig {
@@ -199,6 +363,26 @@ interface ChecklistPinConfig {
     items: ChecklistItem[];
     [key: string]: unknown;
 }
+interface ComparisonSideConfig {
+    label: string;
+    body: string;
+}
+interface ComparisonMatchPair {
+    left: number;
+    right: number;
+}
+interface ComparisonPinConfig {
+    title?: string;
+    left: ComparisonSideConfig;
+    right: ComparisonSideConfig;
+    highlightedLines?: {
+        left?: number[];
+        right?: number[];
+    };
+    matches?: ComparisonMatchPair[];
+    showVsBadge?: boolean;
+    [key: string]: unknown;
+}
 interface CalendarPinConfig {
     weekStartsOn?: number;
     events?: Array<Record<string, unknown>>;
@@ -215,12 +399,6 @@ interface RealtimeCanvasPinConfig {
     roomId?: string;
     [key: string]: unknown;
 }
-interface LineChartPinConfig extends ChartsPinConfig {
-}
-interface TreePinConfig {
-    nodes?: TreeNode[];
-    [key: string]: unknown;
-}
 interface PinConfigByType {
     markdown: MarkdownPinConfig;
     image: ImagePinConfig;
@@ -228,6 +406,7 @@ interface PinConfigByType {
     table: TablePinConfig;
     charts: ChartsPinConfig;
     mermaid: MermaidPinConfig;
+    code: CodePinConfig;
     embed: EmbedPinConfig;
     'pdf-viewer': PdfViewerPinConfig;
     'excel-viewer': ExcelViewerPinConfig;
@@ -236,21 +415,28 @@ interface PinConfigByType {
     'json-viewer': JsonViewerPinConfig;
     'json-list': JsonListPinConfig;
     links: LinksPinConfig;
+    'qr-code': QrCodePinConfig;
+    'social-handles': SocialHandlesPinConfig;
     steps: StepsPinConfig;
+    trace: TracePinConfig;
+    plan: PlanPinConfig;
+    notes: NotesPinConfig;
     'csv-viewer': CsvViewerPinConfig;
     'user-story': UserStoryPinConfig;
     chat: ChatPinConfig;
     intro: IntroPinConfig;
     mastra: MastraPinConfig;
     'text-media': TextMediaPinConfig;
+    'business-card': BusinessCardPinConfig;
+    video: VideoPinConfig;
+    audio: AudioPinConfig;
     'file-upload': FileUploadPinConfig;
     'kanban-board': KanbanBoardPinConfig;
     checklist: ChecklistPinConfig;
+    comparison: ComparisonPinConfig;
     calendar: CalendarPinConfig;
     roadmap: RoadmapPinConfig;
     'realtime-canvas': RealtimeCanvasPinConfig;
-    'line-chart': LineChartPinConfig;
-    tree: TreePinConfig;
 }
 interface PinMetadataBase {
     title: string;
@@ -341,6 +527,13 @@ interface CreateTablePinInput extends PinMetadataBase {
     pin_layout?: PinLayout;
     is_public?: boolean;
 }
+interface UpdateTablePinInput {
+    columns?: TableColumn[];
+    rows?: TableRow[];
+    title?: string;
+    tags?: string[];
+    description?: string;
+}
 interface CreateEmbedPinInput extends PinMetadataBase {
     url: string;
     type?: string;
@@ -349,16 +542,15 @@ interface CreateEmbedPinInput extends PinMetadataBase {
 }
 
 /**
- * API Types for Pindown
+ * API types shared by the v1 Pins client
  */
-
-interface ApiResponse<T = any> {
+interface ApiResponse<T = unknown> {
     success: boolean;
     data: T;
     error?: {
         code: string;
         message: string;
-        details?: any;
+        details?: unknown;
     };
 }
 interface PaginatedResponse<T> {
@@ -367,173 +559,6 @@ interface PaginatedResponse<T> {
     limit: number;
     offset: number;
 }
-interface Pinboard {
-    id: string;
-    user_id: string;
-    title: string;
-    tags?: string[];
-    layout?: Record<string, any>;
-    mobile_layout?: Record<string, any>;
-    pins?: Pin[];
-    is_public: boolean;
-    allow_comments: boolean;
-    require_sign_in: boolean;
-    created_at: string;
-    updated_at: string;
-}
-interface CreatePinboardRequest {
-    title: string;
-    tags?: string[];
-    layout?: Record<string, any>;
-    mobile_layout?: Record<string, any>;
-}
-interface UpdatePinboardRequest {
-    title?: string;
-    tags?: string[];
-    is_public?: boolean;
-    allow_comments?: boolean;
-    require_sign_in?: boolean;
-}
-interface AddPinToPinboardRequest {
-    pin_id: string;
-    position?: {
-        x: number;
-        y: number;
-        w: number;
-        h: number;
-    };
-}
-interface UpdatePinboardLayoutRequest {
-    layout?: Record<string, any>;
-    mobile_layout?: Record<string, any>;
-}
-interface Page {
-    id: string;
-    owner_id: string;
-    is_public: boolean;
-    metadata: {
-        title: string;
-        description?: string;
-        tags: string[];
-        created_at: string;
-        updated_at?: string;
-    };
-    pins: string[];
-    layout?: Record<string, any>;
-    created_at: number;
-    updated_at: number;
-}
-interface CreatePageRequest {
-    metadata: {
-        title: string;
-        description?: string;
-        tags?: string[];
-    };
-    pins?: string[];
-    layout?: Record<string, any>;
-    is_public?: boolean;
-    allow_comments?: boolean;
-    require_sign_in?: boolean;
-    include_datasets?: boolean;
-}
-interface UpdatePageRequest {
-    metadata?: {
-        title?: string;
-        description?: string;
-        tags?: string[];
-    };
-    is_public?: boolean;
-    allow_comments?: boolean;
-    require_sign_in?: boolean;
-    include_datasets?: boolean;
-}
-interface AddPinToPageRequest {
-    pin_id: string;
-}
-interface ListPagesOptions {
-    limit?: number;
-    offset?: number;
-}
-type DatasetType = 'json' | 'markdown';
-interface Dataset {
-    id: string;
-    user_id: string;
-    name: string;
-    type: DatasetType;
-    data: any;
-    created_at: string;
-    updated_at: string;
-}
-interface CreateDatasetRequest {
-    name: string;
-    type: DatasetType;
-    data: any;
-}
-interface UpdateDatasetRequest {
-    name?: string;
-    type?: DatasetType;
-    data?: any;
-}
-type BlockType = 'markdown' | 'mermaid' | 'conditional' | 'image' | 'stat-cards' | 'line-chart' | 'flexible-table' | 'embed';
-interface Block {
-    id: string;
-    pin_id?: string;
-    title: string;
-    type: BlockType;
-    template: string | Record<string, any>;
-    order: number;
-    created_at?: string;
-    updated_at?: string;
-}
-interface CreateBlockRequest {
-    title: string;
-    type: BlockType;
-    template: string | Record<string, any>;
-    order?: number;
-}
-interface UpdateBlockRequest {
-    title?: string;
-    type?: BlockType;
-    template?: string | Record<string, any>;
-    order?: number;
-}
-type CollaboratorRole = 'viewer' | 'editor' | 'owner';
-interface Collaborator {
-    user_id: string;
-    email: string;
-    role: CollaboratorRole;
-    added_at: string;
-}
-interface InviteCollaboratorRequest {
-    email: string;
-    role: CollaboratorRole;
-}
-interface UpdateCollaboratorRoleRequest {
-    role: CollaboratorRole;
-}
-interface Permissions {
-    role: CollaboratorRole;
-    can_view: boolean;
-    can_edit: boolean;
-    can_delete: boolean;
-    can_share: boolean;
-    can_manage_collaborators: boolean;
-}
-interface RateLimitInfo {
-    tier: string;
-    minute: {
-        limit: number;
-        used: number;
-        remaining: number;
-        resetAt: Date;
-    };
-    hour: {
-        limit: number;
-        used: number;
-        remaining: number;
-        resetAt: Date;
-    };
-}
 
 /**
  * Pins API Methods
@@ -586,6 +611,8 @@ declare class PinsMethods {
     createMarkdown(input: CreateMarkdownPinInput): Promise<Pin<'markdown'>>;
     createStatCards(input: CreateStatCardsPinInput): Promise<Pin<'stat-cards'>>;
     createTable(input: CreateTablePinInput): Promise<Pin<'table'>>;
+    /** Partial table pin_config update with typed columns/rows. */
+    updateTable(pinId: string, input: UpdateTablePinInput): Promise<Pin<'table'>>;
     createEmbed(input: CreateEmbedPinInput): Promise<Pin<'embed'>>;
     /**
      * @deprecated Use createMarkdown({ title, content, ... }) — old signature ignored content in title
@@ -594,367 +621,62 @@ declare class PinsMethods {
 }
 
 /**
- * Pinboards API Methods
+ * Configuration for the v1 Pins API client
  */
-
-declare class PinboardsMethods {
-    private client;
-    constructor(client: PindownClient);
-    /**
-     * Create a new pinboard
-     */
-    create(request: CreatePinboardRequest): Promise<Pinboard>;
-    /**
-     * Get a pinboard by ID
-     */
-    get(boardId: string): Promise<Pinboard>;
-    /**
-     * List all pinboards
-     */
-    list(): Promise<Pinboard[]>;
-    /**
-     * Update a pinboard
-     */
-    update(boardId: string, request: UpdatePinboardRequest): Promise<Pinboard>;
-    /**
-     * Delete a pinboard
-     */
-    delete(boardId: string): Promise<void>;
-    /**
-     * Add a pin to a pinboard
-     */
-    addPin(boardId: string, request: AddPinToPinboardRequest): Promise<Pinboard>;
-    /**
-     * Remove a pin from a pinboard
-     */
-    removePin(boardId: string, pinId: string): Promise<void>;
-    /**
-     * Update pinboard layout
-     */
-    updateLayout(boardId: string, request: UpdatePinboardLayoutRequest): Promise<Pinboard>;
-    /**
-     * Update pinboard sharing settings
-     */
-    share(boardId: string, request: {
-        is_public?: boolean;
-        require_sign_in?: boolean;
-        allow_comments?: boolean;
-    }): Promise<Pinboard>;
-    /**
-     * Get multiple pinboards by IDs in a single request (max 100 pinboards)
-     */
-    batchGet(pinboardIds: string[]): Promise<{
-        found: Pinboard[];
-        not_found: string[];
-        permission_denied: string[];
-    }>;
-    /**
-     * Add multiple pins to a pinboard with layout in a single request (max 50 pins)
-     */
-    batchAddPins(boardId: string, pinIds: string[], layout?: Record<string, {
-        x: number;
-        y: number;
-        w: number;
-        h: number;
-    }>): Promise<{
-        added: string[];
-        failed: Array<{
-            id: string;
-            error: string;
-        }>;
-        layout_updated: boolean;
-    }>;
-    /**
-     * Remove multiple pins from a pinboard in a single request (max 50 pins)
-     */
-    batchRemovePins(boardId: string, pinIds: string[]): Promise<{
-        removed: string[];
-        failed: Array<{
-            id: string;
-            error: string;
-        }>;
-    }>;
-    /**
-     * Create a custom role for a pinboard (max 5 roles per pinboard)
-     */
-    createRole(boardId: string, request: {
-        name: string;
-        color: string;
-        permissions?: Record<string, any>;
-    }): Promise<{
-        roleId: string;
-        name: string;
-        color: string;
-    }>;
-    /**
-     * List custom roles for a pinboard
-     */
-    listRoles(boardId: string): Promise<Record<string, any>>;
-    /**
-     * Update a custom role
-     */
-    updateRole(boardId: string, roleId: string, request: {
-        name?: string;
-        color?: string;
-        permissions?: Record<string, any>;
-    }): Promise<void>;
-    /**
-     * Delete a custom role
-     */
-    deleteRole(boardId: string, roleId: string): Promise<void>;
-    /**
-     * Assign custom roles to a user (user must be a collaborator first)
-     */
-    assignUserRoles(boardId: string, userId: string, roleIds: string[]): Promise<void>;
-    /**
-     * Set role requirements for a pin (only users with these roles can see the pin)
-     */
-    setPinRoleRequirements(boardId: string, pinId: string, roleIds: string[]): Promise<void>;
-}
-
-/**
- * Pages API Methods
- */
-
-declare class PagesMethods {
-    private client;
-    constructor(client: PindownClient);
-    /**
-     * Create a new page
-     */
-    create(request: CreatePageRequest): Promise<Page>;
-    /**
-     * Get a page by ID
-     */
-    get(pageId: string): Promise<Page>;
-    /**
-     * List all pages
-     */
-    list(options?: ListPagesOptions): Promise<{
-        pages: Page[];
-        total: number;
-    }>;
-    /**
-     * List pages shared with user
-     */
-    listShared(options?: ListPagesOptions): Promise<{
-        pages: Page[];
-        total: number;
-    }>;
-    /**
-     * Update a page
-     */
-    update(pageId: string, request: UpdatePageRequest): Promise<Page>;
-    /**
-     * Delete a page
-     */
-    delete(pageId: string): Promise<void>;
-    /**
-     * Add a pin to a page
-     */
-    addPin(pageId: string, request: AddPinToPageRequest): Promise<void>;
-    /**
-     * Remove a pin from a page
-     */
-    removePin(pageId: string, pinId: string): Promise<void>;
-    /**
-     * List pins in a page
-     */
-    listPins(pageId: string): Promise<{
-        pins: string[];
-        total: number;
-    }>;
-    /**
-     * Get multiple pages by IDs in a single request (max 100 pages)
-     */
-    batchGet(pageIds: string[]): Promise<{
-        found: Page[];
-        not_found: string[];
-        permission_denied: string[];
-    }>;
-    /**
-     * Create multiple pages in a single request (max 50 pages)
-     */
-    batchCreate(pages: CreatePageRequest[]): Promise<{
-        created: Array<{
-            id: string;
-            index: number;
-            created_at: number;
-        }>;
-        failed: Array<{
-            index: number;
-            error: string;
-        }>;
-    }>;
-    /**
-     * Update multiple pages in a single request (max 50 pages)
-     */
-    batchUpdate(updates: Array<{
-        id: string;
-    } & UpdatePageRequest>): Promise<{
-        updated: string[];
-        failed: Array<{
-            id: string;
-            error: string;
-        }>;
-        updated_at: number;
-    }>;
-    /**
-     * Delete multiple pages in a single request (max 50 pages)
-     */
-    batchDelete(pageIds: string[]): Promise<{
-        deleted: string[];
-        failed: Array<{
-            id: string;
-            error: string;
-        }>;
-    }>;
-}
-
-/**
- * Collaborators API Methods
- */
-
-declare class CollaboratorsMethods {
-    private client;
-    constructor(client: PindownClient);
-    /**
-     * List collaborators for a pin
-     */
-    listForPin(pinId: string): Promise<{
-        owner: Collaborator;
-        collaborators: Collaborator[];
-        pending_invites: Array<{
-            email: string;
-            role: string;
-            invited_at: string;
-        }>;
-    }>;
-    /**
-     * Invite a collaborator to a pin
-     */
-    inviteToPin(pinId: string, request: InviteCollaboratorRequest): Promise<void>;
-    /**
-     * Update a pin collaborator's role
-     */
-    updatePinRole(pinId: string, userId: string, request: UpdateCollaboratorRoleRequest): Promise<void>;
-    /**
-     * Remove a collaborator from a pin
-     */
-    removeFromPin(pinId: string, userId: string): Promise<void>;
-    /**
-     * Get current user's permissions for a pin
-     */
-    getPinPermissions(pinId: string): Promise<Permissions>;
-    /**
-     * List collaborators for a pinboard
-     */
-    listForPinboard(boardId: string): Promise<{
-        owner: Collaborator;
-        collaborators: Collaborator[];
-        pending_invites: Array<{
-            email: string;
-            role: string;
-            invited_at: string;
-        }>;
-    }>;
-    /**
-     * Invite a collaborator to a pinboard
-     */
-    inviteToPinboard(boardId: string, request: InviteCollaboratorRequest): Promise<void>;
-    /**
-     * Update a pinboard collaborator's role
-     */
-    updatePinboardRole(boardId: string, userId: string, request: UpdateCollaboratorRoleRequest): Promise<void>;
-    /**
-     * Remove a collaborator from a pinboard
-     */
-    removeFromPinboard(boardId: string, userId: string): Promise<void>;
-    /**
-     * Get current user's permissions for a pinboard
-     */
-    getPinboardPermissions(boardId: string): Promise<Permissions>;
-}
-
-/**
- * Configuration types for Pindown API Client
- */
-type Tier = 'starter' | 'hobby' | 'pro' | 'teams' | 'agency';
 interface PindownConfig {
-    /**
-     * Your Pindown API key (from https://pindown.ai/api-keys)
-     */
+    /** Workspace-plan API key from https://pindown.ai/api-keys */
     apiKey: string;
-    /**
-     * Your subscription tier (auto-detected from server if not provided)
-     * @internal Only use for testing - production should auto-detect
-     */
-    tier?: Tier;
-    /**
-     * Base URL for the API
-     * @default 'https://api.pindown.ai/v1'
-     */
+    /** @default 'https://api.pindown.ai/v1' */
     baseURL?: string;
-    /**
-     * Enable rate limit tracking
-     * @default true
-     */
-    enableRateLimitTracking?: boolean;
-    /**
-     * Maximum number of retry attempts for failed requests
-     * @default 3
-     */
+    /** @default 3 */
     maxRetries?: number;
-    /**
-     * Timeout for requests in milliseconds
-     * @default 30000 (30 seconds)
-     */
+    /** @default 30000 */
     timeout?: number;
 }
 
 /**
- * Pindown API Client
+ * Pindown API Client — v1 Pins API only
  */
 
 declare class PindownClient {
     private config;
-    private rateLimiter?;
-    private tierDetected;
     readonly pins: PinsMethods;
-    readonly pinboards: PinboardsMethods;
-    readonly pages: PagesMethods;
-    readonly collaborators: CollaboratorsMethods;
     constructor(config: PindownConfig);
-    /**
-     * Core request method
-     */
-    request<T = any>(method: string, endpoint: string, data?: any): Promise<T>;
-    /**
-     * Handle error responses from API
-     */
+    request<T = unknown>(method: string, endpoint: string, data?: unknown): Promise<T>;
     private handleErrorResponse;
-    /**
-     * Detect tier from response headers
-     */
-    private detectTierFromHeaders;
-    /**
-     * Get current rate limit info
-     */
-    getRateLimitInfo(): RateLimitInfo | null;
-    /**
-     * Get current tier
-     */
-    getTier(): Tier | null;
-    /**
-     * Destroy the client (cleanup resources)
-     */
-    destroy(): void;
 }
 
 /**
- * Error classes for Pindown API Client
+ * Runtime hints + minimal examples per pin type.
+ * Use when building API payloads without opening the docs every time.
  */
 
+interface PinConfigFieldHint {
+    path: string;
+    type: string;
+    required: boolean;
+    description: string;
+}
+interface PinConfigHint<T extends PinTypeId = PinTypeId> {
+    pin_type: T;
+    summary: string;
+    required_fields: string[];
+    optional_fields: string[];
+    fields: PinConfigFieldHint[];
+    /** Minimal valid pin_config for create/update */
+    example_config: PinConfigByType[T];
+    /** Typical PUT /v1/pins/:id body (root-level pin_config) */
+    example_update: UpdatePinRequest<T>;
+}
+/** Per-type hints (expand over time; table is fully documented). */
+declare const PIN_CONFIG_HINTS: Partial<Record<PinTypeId, PinConfigHint>>;
+declare function getPinConfigHint<T extends PinTypeId>(pinType: T): PinConfigHint<T> | undefined;
+/** Pretty-print field hints for CLI / logging. */
+declare function formatPinConfigHint(pinType: PinTypeId): string;
+
+/**
+ * Error classes for the v1 Pins API client
+ */
 declare class PindownError extends Error {
     constructor(message: string);
 }
@@ -968,24 +690,11 @@ declare class NotFoundError extends PindownError {
     constructor(resource: string);
 }
 declare class ValidationError extends PindownError {
-    details?: any;
-    constructor(message: string, details?: any);
+    details?: unknown;
+    constructor(message: string, details?: unknown);
 }
 declare class RateLimitError extends PindownError {
-    window: 'minute' | 'hour';
-    limit: number;
-    used: number;
-    remaining: number;
-    resetAt: Date;
-    tier: Tier;
-    constructor(params: {
-        window: 'minute' | 'hour';
-        limit: number;
-        used: number;
-        remaining: number;
-        resetAt: Date;
-        tier: Tier;
-    });
+    constructor(message?: string);
 }
 declare class ServerError extends PindownError {
     statusCode: number;
@@ -995,4 +704,4 @@ declare class NetworkError extends PindownError {
     constructor(message?: string);
 }
 
-export { ALL_PIN_TYPES, type AddPinToPageRequest, type AddPinToPinboardRequest, type ApiResponse, AuthenticationError, type Block, type BlockType, type CalendarPinConfig, type ChartsPinConfig, type ChatPinConfig, type ChecklistItem, type ChecklistPinConfig, type Collaborator, type CollaboratorRole, type CreateBlockRequest, type CreateDatasetRequest, type CreateEmbedPinInput, type CreateMarkdownPinInput, type CreateNestedPinRequest, type CreatePageRequest, type CreatePinRequest, type CreatePinboardRequest, type CreateStatCardsPinInput, type CreateTablePinInput, type CreateTypedPinRequest, type CsvViewerPinConfig, type Dataset, type DatasetType, type EmbedPinConfig, type ExcelViewerPinConfig, type FileUploadPinConfig, ForbiddenError, type GalleryImage, type GalleryPinConfig, type ImagePinConfig, type IntroPinConfig, type InviteCollaboratorRequest, type JsonListPinConfig, type JsonViewerPinConfig, type KanbanBoardPinConfig, type KanbanColumn, LEGACY_PIN_TYPES, type LegacyPinTypeId, type LineChartPinConfig, type LinkItem, type LinksPinConfig, type ListPagesOptions, type ListPinsOptions, type MarkdownPinConfig, type MastraPinConfig, type MermaidPinConfig, NetworkError, NotFoundError, PRODUCT_PIN_TYPES, type Page, type PaginatedResponse, type PdfViewerPinConfig, type Permissions, type Pin, type PinCardType, type PinConfigByType, type PinDataType, type PinLayout, type PinMetadata, type PinMetadataBase, type PinTypeId, type Pinboard, PindownClient, type PindownConfig, PindownError, type ProductPinTypeId, RateLimitError, type RateLimitInfo, type RealtimeCanvasPinConfig, type RoadmapPinConfig, ServerError, type SharePinRequest, type StatCardItem, type StatCardsPinConfig, type StepItem, type StepsPinConfig, type TableColumn, type TablePinConfig, type TableRow, type TextMediaPinConfig, type Tier, type TimelinePinConfig, type TreeNode, type TreePinConfig, type UpdateBlockRequest, type UpdateCollaboratorRoleRequest, type UpdateDatasetRequest, type UpdatePageRequest, type UpdatePinRequest, type UpdatePinboardLayoutRequest, type UpdatePinboardRequest, type UserStoryPinConfig, ValidationError };
+export { ALL_PIN_TYPES, type ApiResponse, type AudioPinConfig, type AudioPinTrack, AuthenticationError, type BusinessCardField, type BusinessCardPinConfig, type CalendarPinConfig, type ChartsPinConfig, type ChatPinConfig, type ChecklistItem, type ChecklistPinConfig, type CreateEmbedPinInput, type CreateMarkdownPinInput, type CreateNestedPinRequest, type CreatePinRequest, type CreateStatCardsPinInput, type CreateTablePinInput, type CreateTypedPinRequest, type CsvViewerPinConfig, type EmbedPinConfig, type ExcelViewerPinConfig, type FileUploadPinConfig, ForbiddenError, type GalleryImage, type GalleryPinConfig, type ImagePinConfig, type IntroPinConfig, type JsonListPinConfig, type JsonViewerPinConfig, type KanbanBoardPinConfig, type KanbanColumn, type LinkItem, type LinksPinConfig, type ListPinsOptions, type MarkdownPinConfig, type MastraPinConfig, type MermaidPinConfig, NetworkError, NotFoundError, PIN_CONFIG_HINTS, PRODUCT_PIN_TYPES, type PaginatedResponse, type PdfViewerPinConfig, type Pin, type PinCardType, type PinConfigByType, type PinConfigFieldHint, type PinConfigHint, type PinDataType, type PinLayout, type PinMetadata, type PinMetadataBase, type PinTypeId, PindownClient, type PindownConfig, PindownError, type ProductPinTypeId, type QrCodePinConfig, RateLimitError, type RealtimeCanvasPinConfig, type RoadmapPinConfig, ServerError, type SharePinRequest, type StatCardItem, type StatCardsPinConfig, type StepItem, type StepsPinConfig, type TableColumn, type TablePinConfig, type TableRow, type TextMediaPinConfig, type TimelinePinConfig, type UpdatePinRequest, type UpdateTablePinInput, type UserStoryPinConfig, ValidationError, type VideoPinConfig, formatPinConfigHint, getPinConfigHint };