SDK Reference

    @proveanything/smartlinks

    npm install @proveanything/smartlinks
    View on npm →

    Namespaces

    NFC, Proofs & Claims

    claimSet

    Manage claim sets and tag assignments; queries, reports, and updates.

    15 functions9 types

    getAll

    Get all claim sets. When collectionId is provided, returns claim sets for that collection. When omitted, returns all claim sets owned by the authenticated user.

    public
    getAll(collectionId?: string) → Promise<any[]>

    get

    Get a specific claim set by ID.

    public
    get(claimSetId: string, collectionId?: string) → Promise<any>

    create

    Create a new claim set. When collectionId is provided, creates it scoped to that collection. When omitted, creates a global user-owned claim set.

    public
    create(params: , collectionId?: string) → Promise<any>

    update

    Update a claim set.

    public
    update(claimSetId: string, params: any, collectionId?: string) → Promise<any>

    remove

    Delete (soft-delete) a claim set.

    public
    remove(claimSetId: string, collectionId?: string) → Promise<any>

    getAllTags

    Get all tags for a claim set (including data).

    public
    getAllTags(claimSetId: string, collectionId?: string) → Promise<any>

    getAssignedTags

    Get assigned tags for a claim set — tags soft-assigned to a collection or product.

    public
    getAssignedTags(claimSetId: string, collectionId?: string) → Promise<any>

    createTag

    Create a single tag inside a claim set.

    public
    createTag(claimSetId: string,
    data: ,
    collectionId?: string) → Promise<>

    importTags

    Bulk import tags into a claim set.

    public
    importTags(claimSetId: string,
    data: ,
    collectionId?: string) → Promise<>

    getReport

    Get a report for a claim set (collection-scoped).

    public
    getReport(collectionId: string, claimSetId: string) → Promise<any>

    getTagSummary

    Get tag summary for a collection.

    public
    getTagSummary(collectionId: string) → Promise<any>

    tagQuery

    Perform a tag query for a collection.

    public
    tagQuery(collectionId: string, data: any) → Promise<any>

    makeClaim

    Make a claim against a claim set (collection-scoped).

    public
    makeClaim(collectionId: string, params: any) → Promise<any>

    assignClaims

    Assign claims to codes or ranges within a collection.

    public
    assignClaims(collectionId: string, data: ) → Promise<any>

    updateClaimData

    Update claim data for a claim set (collection-scoped).

    public
    updateClaimData(collectionId: string, data: ) → Promise<any>