UNPKG

@proveanything/smartlinks

Version:

Official JavaScript/TypeScript SDK for the Smartlinks API

1,735 lines (1,732 loc) 380 kB
# @proveanything/smartlinks This README is auto-generated from the TypeScript API documentation. ## API Reference ```json { "id": 0, "name": "@proveanything/smartlinks", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 90, "name": "AppConfigOptions", "variant": "declaration", "kind": 2097152, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 91, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 92, "name": "appId", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 93, "name": "collectionId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 94, "name": "productId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 95, "name": "variantId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 96, "name": "batchId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 97, "name": "itemId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 98, "name": "user", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 99, "name": "userData", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 100, "name": "admin", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 101, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 102, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Properties", "children": [ 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102 ] } ] } } }, { "id": 177, "name": "appConfiguration", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { "id": 178, "name": "getConfig", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 179, "name": "getConfig", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 180, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 181, "name": "setConfig", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 182, "name": "setConfig", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 183, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 184, "name": "deleteConfig", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 185, "name": "deleteConfig", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 186, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 187, "name": "getData", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 188, "name": "getData", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 189, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 190, "name": "getDataItem", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 191, "name": "getDataItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 192, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 193, "name": "setDataItem", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 194, "name": "setDataItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 195, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 196, "name": "deleteDataItem", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 197, "name": "deleteDataItem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 198, "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 90, "name": "AppConfigOptions", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Functions", "children": [ 178, 181, 184, 187, 190, 193, 196 ] } ] }, { "id": 199, "name": "appRecord", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { "id": 200, "name": "get", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 201, "name": "get", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 202, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 203, "name": "appId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 204, "name": "create", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 205, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 206, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 207, "name": "appId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 208, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 209, "name": "update", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 210, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 211, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 212, "name": "appId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 213, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 214, "name": "remove", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 215, "name": "remove", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 216, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 217, "name": "appId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Functions", "children": [ 200, 204, 209, 214 ] } ] }, { "id": 218, "name": "asset", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { "id": 219, "name": "getForCollection", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 220, "name": "getForCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 221, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 222, "name": "assetId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 223, "name": "listForCollection", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 224, "name": "listForCollection", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 225, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 226, "name": "getForProduct", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 227, "name": "getForProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 228, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 229, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 230, "name": "assetId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 231, "name": "listForProduct", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 232, "name": "listForProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 233, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 234, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 235, "name": "getForProof", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 236, "name": "getForProof", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 237, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 238, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 239, "name": "proofId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 240, "name": "assetId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 241, "name": "listForProof", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 242, "name": "listForProof", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 243, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 244, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 245, "name": "proofId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 246, "name": "appId", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 247, "name": "uploadAsset", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 248, "name": "uploadAsset", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Uploads an asset file to a proof, with optional extraData as JSON.\r\nSupports progress reporting via onProgress callback (browser only)." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise resolving to an AssetResponse object" } ] } ] }, "parameters": [ { "id": 249, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The collection ID" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 250, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The product ID" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 251, "name": "proofId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The proof ID" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 252, "name": "file", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file to upload" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "File" }, "name": "File", "package": "typescript" } }, { "id": 253, "name": "extraData", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Arbitrary extra data to include (will be stringified as JSON)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 254, "name": "onProgress", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional callback for upload progress (0-100)" } ] }, "type": { "type": "reflection", "declaration": { "id": 255, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 256, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 257, "name": "percent", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 555, "name": "AssetResponse", "package": "@proveanything/smartlinks" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Functions", "children": [ 219, 223, 226, 231, 235, 241, 247 ] } ] }, { "id": 258, "name": "attestation", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { "id": 259, "name": "list", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 260, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "List all attestations for a proof." } ] }, "parameters": [ { "id": 261, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 262, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 263, "name": "proofId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 70, "name": "AttestationResponse", "package": "@proveanything/smartlinks" } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 264, "name": "get", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 265, "name": "get", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get a single attestation by ID." } ] }, "parameters": [ { "id": 266, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 267, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 268, "name": "proofId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "name": "attestationId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 70, "name": "AttestationResponse", "package": "@proveanything/smartlinks" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 270, "name": "create", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 271, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new attestation for a proof." } ] }, "parameters": [ { "id": 272, "name": "collectionId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 273, "name": "productId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 274, "name": "proofId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 275, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 77, "name": "AttestationCreateRequest", "package": "@proveanything/smartlinks" } } ], "type": { "type": "reference", "target": { "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 70, "name": "AttestationResponse", "package": "@proveanything/smartlinks" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 276, "name": "update", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 277, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Update an attestation." } ] }, "parameters": [ { "id": 278, "name": "collectionId", "variant": "param", "kind":