@proveanything/smartlinks 1.0.16 → 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7795 -93
- package/build-docs.ts +41 -0
- package/dist/api/claimSet.d.ts +14 -0
- package/dist/api/claimSet.js +24 -0
- package/dist/api/collection.d.ts +9 -1
- package/dist/api/collection.js +16 -2
- package/dist/api/crate.d.ts +22 -0
- package/dist/api/crate.js +44 -0
- package/dist/api/form.d.ts +34 -0
- package/dist/api/form.js +58 -0
- package/dist/api/index.d.ts +3 -0
- package/dist/api/index.js +3 -0
- package/dist/build-docs.js +35 -0
- package/dist/http.d.ts +7 -0
- package/dist/http.js +24 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/README.md +7898 -89
- package/docs/assets/highlight.css +12 -33
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/documentation.json +2626 -1178
- package/docs/functions/appConfiguration.deleteConfig.html +1 -1
- package/docs/functions/appConfiguration.deleteDataItem.html +1 -1
- package/docs/functions/appConfiguration.getConfig.html +1 -1
- package/docs/functions/appConfiguration.getData.html +1 -1
- package/docs/functions/appConfiguration.getDataItem.html +1 -1
- package/docs/functions/appConfiguration.setConfig.html +1 -1
- package/docs/functions/appConfiguration.setDataItem.html +1 -1
- package/docs/functions/asset.getForCollection.html +1 -1
- package/docs/functions/asset.getForProduct.html +1 -1
- package/docs/functions/asset.getForProof.html +1 -1
- package/docs/functions/asset.listForCollection.html +1 -1
- package/docs/functions/asset.listForProduct.html +1 -1
- package/docs/functions/asset.listForProof.html +1 -1
- package/docs/functions/asset.uploadAsset.html +1 -1
- package/docs/functions/attestation.create.html +1 -1
- package/docs/functions/attestation.get.html +1 -1
- package/docs/functions/attestation.list.html +1 -1
- package/docs/functions/attestation.remove.html +1 -1
- package/docs/functions/attestation.update.html +1 -1
- package/docs/functions/auth.getAccount.html +1 -1
- package/docs/functions/auth.login.html +1 -1
- package/docs/functions/auth.logout.html +1 -1
- package/docs/functions/auth.verifyToken.html +1 -1
- package/docs/functions/claimSet.assignClaims.html +4 -0
- package/docs/functions/claimSet.updateClaimData.html +4 -0
- package/docs/functions/collection.get.html +3 -2
- package/docs/functions/collection.list.html +5 -0
- package/docs/functions/crate.create.html +2 -0
- package/docs/functions/crate.get.html +2 -0
- package/docs/functions/crate.list.html +2 -0
- package/docs/functions/crate.remove.html +2 -0
- package/docs/functions/crate.update.html +2 -0
- package/docs/functions/form.create.html +4 -0
- package/docs/functions/form.get.html +5 -0
- package/docs/functions/form.list.html +4 -0
- package/docs/functions/form.remove.html +4 -0
- package/docs/functions/form.update.html +5 -0
- package/docs/functions/initializeApi.html +1 -1
- package/docs/functions/product.get.html +1 -1
- package/docs/functions/product.list.html +1 -1
- package/docs/functions/proof.get.html +1 -1
- package/docs/functions/proof.list.html +1 -1
- package/docs/functions/request.html +1 -1
- package/docs/functions/sendCustomProxyMessage.html +5 -0
- package/docs/index.html +4 -112
- package/docs/interfaces/AppConfigurationResponse.html +4 -4
- package/docs/interfaces/AssetResponse.html +2 -2
- package/docs/interfaces/AttestationCreateRequest.html +2 -2
- package/docs/interfaces/AttestationResponse.html +2 -2
- package/docs/interfaces/AttestationUpdateRequest.html +2 -2
- package/docs/interfaces/CollectionResponse.html +5 -5
- package/docs/interfaces/ErrorResponse.html +3 -3
- package/docs/interfaces/ProductResponse.html +5 -5
- package/docs/interfaces/ProofResponse.html +8 -8
- package/docs/modules/appConfiguration.html +1 -1
- package/docs/modules/asset.html +1 -1
- package/docs/modules/attestation.html +1 -1
- package/docs/modules/auth.html +1 -1
- package/docs/modules/claimSet.html +3 -0
- package/docs/modules/collection.html +2 -1
- package/docs/modules/crate.html +6 -0
- package/docs/modules/form.html +6 -0
- package/docs/modules/product.html +1 -1
- package/docs/modules/proof.html +1 -1
- package/docs/modules.html +4 -0
- package/docs/types/AccountInfoResponse.html +1 -1
- package/docs/types/AppConfigOptions.html +1 -1
- package/docs/types/LoginResponse.html +1 -1
- package/docs/types/VerifyTokenResponse.html +1 -1
- package/package.json +3 -2
- package/scripts/copy-docs.js +11 -0
- package/src/api/claimSet.ts +23 -0
- package/src/api/collection.ts +17 -3
- package/src/api/crate.ts +43 -0
- package/src/api/form.ts +57 -0
- package/src/api/index.ts +3 -0
- package/src/http.ts +25 -0
- package/src/index.ts +1 -1
- package/temp-docs/README.md +7867 -93
- package/temp-docs/interfaces/AppConfigurationResponse.md +3 -3
- package/temp-docs/interfaces/AssetResponse.md +3 -3
- package/temp-docs/interfaces/AttestationCreateRequest.md +3 -3
- package/temp-docs/interfaces/AttestationResponse.md +6 -6
- package/temp-docs/interfaces/AttestationUpdateRequest.md +2 -2
- package/temp-docs/interfaces/CollectionResponse.md +4 -4
- package/temp-docs/interfaces/ErrorResponse.md +2 -2
- package/temp-docs/interfaces/ProductResponse.md +4 -4
- package/temp-docs/interfaces/ProofResponse.md +7 -7
- package/temp-docs/modules/appConfiguration.md +7 -7
- package/temp-docs/modules/asset.md +7 -7
- package/temp-docs/modules/attestation.md +5 -5
- package/temp-docs/modules/auth.md +4 -4
- package/temp-docs/modules/claimSet.md +52 -0
- package/temp-docs/modules/collection.md +32 -2
- package/temp-docs/modules/crate.md +124 -0
- package/temp-docs/modules/form.md +126 -0
- package/temp-docs/modules/product.md +2 -2
- package/temp-docs/modules/proof.md +2 -2
- package/temp-docs/modules.md +41 -6
|
@@ -18,7 +18,7 @@ Unique identifier for the app configuration
|
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[types/appConfiguration.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
21
|
+
[types/appConfiguration.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/appConfiguration.ts#L7)
|
|
22
22
|
|
|
23
23
|
___
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Name of the app configuration
|
|
|
30
30
|
|
|
31
31
|
#### Defined in
|
|
32
32
|
|
|
33
|
-
[types/appConfiguration.ts:9](https://github.com/Prove-Anything/smartlinks/blob/
|
|
33
|
+
[types/appConfiguration.ts:9](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/appConfiguration.ts#L9)
|
|
34
34
|
|
|
35
35
|
___
|
|
36
36
|
|
|
@@ -42,4 +42,4 @@ Key-value pairs representing configuration settings
|
|
|
42
42
|
|
|
43
43
|
#### Defined in
|
|
44
44
|
|
|
45
|
-
[types/appConfiguration.ts:11](https://github.com/Prove-Anything/smartlinks/blob/
|
|
45
|
+
[types/appConfiguration.ts:11](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/appConfiguration.ts#L11)
|
|
@@ -16,7 +16,7 @@ Represents an Asset object.
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[types/asset.ts:5](https://github.com/Prove-Anything/smartlinks/blob/
|
|
19
|
+
[types/asset.ts:5](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/asset.ts#L5)
|
|
20
20
|
|
|
21
21
|
___
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ ___
|
|
|
26
26
|
|
|
27
27
|
#### Defined in
|
|
28
28
|
|
|
29
|
-
[types/asset.ts:6](https://github.com/Prove-Anything/smartlinks/blob/
|
|
29
|
+
[types/asset.ts:6](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/asset.ts#L6)
|
|
30
30
|
|
|
31
31
|
___
|
|
32
32
|
|
|
@@ -36,4 +36,4 @@ ___
|
|
|
36
36
|
|
|
37
37
|
#### Defined in
|
|
38
38
|
|
|
39
|
-
[types/asset.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
39
|
+
[types/asset.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/asset.ts#L7)
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
#### Defined in
|
|
16
16
|
|
|
17
|
-
[types/attestation.ts:12](https://github.com/Prove-Anything/smartlinks/blob/
|
|
17
|
+
[types/attestation.ts:12](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L12)
|
|
18
18
|
|
|
19
19
|
___
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ ___
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[types/attestation.ts:13](https://github.com/Prove-Anything/smartlinks/blob/
|
|
27
|
+
[types/attestation.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L13)
|
|
28
28
|
|
|
29
29
|
___
|
|
30
30
|
|
|
@@ -34,4 +34,4 @@ ___
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[types/attestation.ts:11](https://github.com/Prove-Anything/smartlinks/blob/
|
|
37
|
+
[types/attestation.ts:11](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L11)
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
#### Defined in
|
|
19
19
|
|
|
20
|
-
[types/attestation.ts:3](https://github.com/Prove-Anything/smartlinks/blob/
|
|
20
|
+
[types/attestation.ts:3](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L3)
|
|
21
21
|
|
|
22
22
|
___
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ ___
|
|
|
27
27
|
|
|
28
28
|
#### Defined in
|
|
29
29
|
|
|
30
|
-
[types/attestation.ts:2](https://github.com/Prove-Anything/smartlinks/blob/
|
|
30
|
+
[types/attestation.ts:2](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L2)
|
|
31
31
|
|
|
32
32
|
___
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ ___
|
|
|
37
37
|
|
|
38
38
|
#### Defined in
|
|
39
39
|
|
|
40
|
-
[types/attestation.ts:6](https://github.com/Prove-Anything/smartlinks/blob/
|
|
40
|
+
[types/attestation.ts:6](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L6)
|
|
41
41
|
|
|
42
42
|
___
|
|
43
43
|
|
|
@@ -47,7 +47,7 @@ ___
|
|
|
47
47
|
|
|
48
48
|
#### Defined in
|
|
49
49
|
|
|
50
|
-
[types/attestation.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
50
|
+
[types/attestation.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L7)
|
|
51
51
|
|
|
52
52
|
___
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ ___
|
|
|
57
57
|
|
|
58
58
|
#### Defined in
|
|
59
59
|
|
|
60
|
-
[types/attestation.ts:5](https://github.com/Prove-Anything/smartlinks/blob/
|
|
60
|
+
[types/attestation.ts:5](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L5)
|
|
61
61
|
|
|
62
62
|
___
|
|
63
63
|
|
|
@@ -67,4 +67,4 @@ ___
|
|
|
67
67
|
|
|
68
68
|
#### Defined in
|
|
69
69
|
|
|
70
|
-
[types/attestation.ts:4](https://github.com/Prove-Anything/smartlinks/blob/
|
|
70
|
+
[types/attestation.ts:4](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L4)
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
#### Defined in
|
|
15
15
|
|
|
16
|
-
[types/attestation.ts:18](https://github.com/Prove-Anything/smartlinks/blob/
|
|
16
|
+
[types/attestation.ts:18](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L18)
|
|
17
17
|
|
|
18
18
|
___
|
|
19
19
|
|
|
@@ -23,4 +23,4 @@ ___
|
|
|
23
23
|
|
|
24
24
|
#### Defined in
|
|
25
25
|
|
|
26
|
-
[types/attestation.ts:17](https://github.com/Prove-Anything/smartlinks/blob/
|
|
26
|
+
[types/attestation.ts:17](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/attestation.ts#L17)
|
|
@@ -19,7 +19,7 @@ Unique identifier for the collection
|
|
|
19
19
|
|
|
20
20
|
#### Defined in
|
|
21
21
|
|
|
22
|
-
[types/collection.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
22
|
+
[types/collection.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/collection.ts#L7)
|
|
23
23
|
|
|
24
24
|
___
|
|
25
25
|
|
|
@@ -31,7 +31,7 @@ URL to the collection’s logo image
|
|
|
31
31
|
|
|
32
32
|
#### Defined in
|
|
33
33
|
|
|
34
|
-
[types/collection.ts:13](https://github.com/Prove-Anything/smartlinks/blob/
|
|
34
|
+
[types/collection.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/collection.ts#L13)
|
|
35
35
|
|
|
36
36
|
___
|
|
37
37
|
|
|
@@ -43,7 +43,7 @@ Machine-readable name of the collection
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[types/collection.ts:9](https://github.com/Prove-Anything/smartlinks/blob/
|
|
46
|
+
[types/collection.ts:9](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/collection.ts#L9)
|
|
47
47
|
|
|
48
48
|
___
|
|
49
49
|
|
|
@@ -55,4 +55,4 @@ Human-readable title of the collection
|
|
|
55
55
|
|
|
56
56
|
#### Defined in
|
|
57
57
|
|
|
58
|
-
[types/collection.ts:11](https://github.com/Prove-Anything/smartlinks/blob/
|
|
58
|
+
[types/collection.ts:11](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/collection.ts#L11)
|
|
@@ -17,7 +17,7 @@ Numeric error code
|
|
|
17
17
|
|
|
18
18
|
#### Defined in
|
|
19
19
|
|
|
20
|
-
[types/error.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
20
|
+
[types/error.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/error.ts#L7)
|
|
21
21
|
|
|
22
22
|
___
|
|
23
23
|
|
|
@@ -29,4 +29,4 @@ Human-readable error message
|
|
|
29
29
|
|
|
30
30
|
#### Defined in
|
|
31
31
|
|
|
32
|
-
[types/error.ts:9](https://github.com/Prove-Anything/smartlinks/blob/
|
|
32
|
+
[types/error.ts:9](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/error.ts#L9)
|
|
@@ -19,7 +19,7 @@ Detailed description of the product
|
|
|
19
19
|
|
|
20
20
|
#### Defined in
|
|
21
21
|
|
|
22
|
-
[types/product.ts:11](https://github.com/Prove-Anything/smartlinks/blob/
|
|
22
|
+
[types/product.ts:11](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/product.ts#L11)
|
|
23
23
|
|
|
24
24
|
___
|
|
25
25
|
|
|
@@ -31,7 +31,7 @@ URL to the product’s hero image
|
|
|
31
31
|
|
|
32
32
|
#### Defined in
|
|
33
33
|
|
|
34
|
-
[types/product.ts:13](https://github.com/Prove-Anything/smartlinks/blob/
|
|
34
|
+
[types/product.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/product.ts#L13)
|
|
35
35
|
|
|
36
36
|
___
|
|
37
37
|
|
|
@@ -43,7 +43,7 @@ Unique identifier for the product
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[types/product.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
46
|
+
[types/product.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/product.ts#L7)
|
|
47
47
|
|
|
48
48
|
___
|
|
49
49
|
|
|
@@ -55,4 +55,4 @@ Name of the product
|
|
|
55
55
|
|
|
56
56
|
#### Defined in
|
|
57
57
|
|
|
58
|
-
[types/product.ts:9](https://github.com/Prove-Anything/smartlinks/blob/
|
|
58
|
+
[types/product.ts:9](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/product.ts#L9)
|
|
@@ -22,7 +22,7 @@ Unique identifier for the collection
|
|
|
22
22
|
|
|
23
23
|
#### Defined in
|
|
24
24
|
|
|
25
|
-
[types/proof.ts:7](https://github.com/Prove-Anything/smartlinks/blob/
|
|
25
|
+
[types/proof.ts:7](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L7)
|
|
26
26
|
|
|
27
27
|
___
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Creation timestamp
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[types/proof.ts:9](https://github.com/Prove-Anything/smartlinks/blob/
|
|
37
|
+
[types/proof.ts:9](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L9)
|
|
38
38
|
|
|
39
39
|
___
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ Unique identifier for the proof
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[types/proof.ts:11](https://github.com/Prove-Anything/smartlinks/blob/
|
|
49
|
+
[types/proof.ts:11](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L11)
|
|
50
50
|
|
|
51
51
|
___
|
|
52
52
|
|
|
@@ -58,7 +58,7 @@ Unique identifier for the product
|
|
|
58
58
|
|
|
59
59
|
#### Defined in
|
|
60
60
|
|
|
61
|
-
[types/proof.ts:13](https://github.com/Prove-Anything/smartlinks/blob/
|
|
61
|
+
[types/proof.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L13)
|
|
62
62
|
|
|
63
63
|
___
|
|
64
64
|
|
|
@@ -70,7 +70,7 @@ Unique identifier for the token
|
|
|
70
70
|
|
|
71
71
|
#### Defined in
|
|
72
72
|
|
|
73
|
-
[types/proof.ts:15](https://github.com/Prove-Anything/smartlinks/blob/
|
|
73
|
+
[types/proof.ts:15](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L15)
|
|
74
74
|
|
|
75
75
|
___
|
|
76
76
|
|
|
@@ -82,7 +82,7 @@ Unique identifier for the user
|
|
|
82
82
|
|
|
83
83
|
#### Defined in
|
|
84
84
|
|
|
85
|
-
[types/proof.ts:17](https://github.com/Prove-Anything/smartlinks/blob/
|
|
85
|
+
[types/proof.ts:17](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L17)
|
|
86
86
|
|
|
87
87
|
___
|
|
88
88
|
|
|
@@ -94,4 +94,4 @@ Arbitrary key-value pairs for proof values
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[types/proof.ts:19](https://github.com/Prove-Anything/smartlinks/blob/
|
|
97
|
+
[types/proof.ts:19](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/types/proof.ts#L19)
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
|
|
29
29
|
#### Defined in
|
|
30
30
|
|
|
31
|
-
[api/appConfiguration.ts:74](https://github.com/Prove-Anything/smartlinks/blob/
|
|
31
|
+
[api/appConfiguration.ts:74](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L74)
|
|
32
32
|
|
|
33
33
|
___
|
|
34
34
|
|
|
@@ -48,7 +48,7 @@ ___
|
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[api/appConfiguration.ts:99](https://github.com/Prove-Anything/smartlinks/blob/
|
|
51
|
+
[api/appConfiguration.ts:99](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L99)
|
|
52
52
|
|
|
53
53
|
___
|
|
54
54
|
|
|
@@ -68,7 +68,7 @@ ___
|
|
|
68
68
|
|
|
69
69
|
#### Defined in
|
|
70
70
|
|
|
71
|
-
[api/appConfiguration.ts:62](https://github.com/Prove-Anything/smartlinks/blob/
|
|
71
|
+
[api/appConfiguration.ts:62](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L62)
|
|
72
72
|
|
|
73
73
|
___
|
|
74
74
|
|
|
@@ -88,7 +88,7 @@ ___
|
|
|
88
88
|
|
|
89
89
|
#### Defined in
|
|
90
90
|
|
|
91
|
-
[api/appConfiguration.ts:80](https://github.com/Prove-Anything/smartlinks/blob/
|
|
91
|
+
[api/appConfiguration.ts:80](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L80)
|
|
92
92
|
|
|
93
93
|
___
|
|
94
94
|
|
|
@@ -108,7 +108,7 @@ ___
|
|
|
108
108
|
|
|
109
109
|
#### Defined in
|
|
110
110
|
|
|
111
|
-
[api/appConfiguration.ts:86](https://github.com/Prove-Anything/smartlinks/blob/
|
|
111
|
+
[api/appConfiguration.ts:86](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L86)
|
|
112
112
|
|
|
113
113
|
___
|
|
114
114
|
|
|
@@ -128,7 +128,7 @@ ___
|
|
|
128
128
|
|
|
129
129
|
#### Defined in
|
|
130
130
|
|
|
131
|
-
[api/appConfiguration.ts:68](https://github.com/Prove-Anything/smartlinks/blob/
|
|
131
|
+
[api/appConfiguration.ts:68](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L68)
|
|
132
132
|
|
|
133
133
|
___
|
|
134
134
|
|
|
@@ -148,4 +148,4 @@ ___
|
|
|
148
148
|
|
|
149
149
|
#### Defined in
|
|
150
150
|
|
|
151
|
-
[api/appConfiguration.ts:93](https://github.com/Prove-Anything/smartlinks/blob/
|
|
151
|
+
[api/appConfiguration.ts:93](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/appConfiguration.ts#L93)
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
#### Defined in
|
|
31
31
|
|
|
32
|
-
[api/asset.ts:6](https://github.com/Prove-Anything/smartlinks/blob/
|
|
32
|
+
[api/asset.ts:6](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L6)
|
|
33
33
|
|
|
34
34
|
___
|
|
35
35
|
|
|
@@ -51,7 +51,7 @@ ___
|
|
|
51
51
|
|
|
52
52
|
#### Defined in
|
|
53
53
|
|
|
54
|
-
[api/asset.ts:22](https://github.com/Prove-Anything/smartlinks/blob/
|
|
54
|
+
[api/asset.ts:22](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L22)
|
|
55
55
|
|
|
56
56
|
___
|
|
57
57
|
|
|
@@ -74,7 +74,7 @@ ___
|
|
|
74
74
|
|
|
75
75
|
#### Defined in
|
|
76
76
|
|
|
77
|
-
[api/asset.ts:40](https://github.com/Prove-Anything/smartlinks/blob/
|
|
77
|
+
[api/asset.ts:40](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L40)
|
|
78
78
|
|
|
79
79
|
___
|
|
80
80
|
|
|
@@ -94,7 +94,7 @@ ___
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[api/asset.ts:14](https://github.com/Prove-Anything/smartlinks/blob/
|
|
97
|
+
[api/asset.ts:14](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L14)
|
|
98
98
|
|
|
99
99
|
___
|
|
100
100
|
|
|
@@ -115,7 +115,7 @@ ___
|
|
|
115
115
|
|
|
116
116
|
#### Defined in
|
|
117
117
|
|
|
118
|
-
[api/asset.ts:31](https://github.com/Prove-Anything/smartlinks/blob/
|
|
118
|
+
[api/asset.ts:31](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L31)
|
|
119
119
|
|
|
120
120
|
___
|
|
121
121
|
|
|
@@ -138,7 +138,7 @@ ___
|
|
|
138
138
|
|
|
139
139
|
#### Defined in
|
|
140
140
|
|
|
141
|
-
[api/asset.ts:50](https://github.com/Prove-Anything/smartlinks/blob/
|
|
141
|
+
[api/asset.ts:50](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L50)
|
|
142
142
|
|
|
143
143
|
___
|
|
144
144
|
|
|
@@ -168,4 +168,4 @@ Promise resolving to an AssetResponse object
|
|
|
168
168
|
|
|
169
169
|
#### Defined in
|
|
170
170
|
|
|
171
|
-
[api/asset.ts:74](https://github.com/Prove-Anything/smartlinks/blob/
|
|
171
|
+
[api/asset.ts:74](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L74)
|
|
@@ -31,7 +31,7 @@ Create a new attestation for a proof.
|
|
|
31
31
|
|
|
32
32
|
#### Defined in
|
|
33
33
|
|
|
34
|
-
[api/attestation.ts:33](https://github.com/Prove-Anything/smartlinks/blob/
|
|
34
|
+
[api/attestation.ts:33](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L33)
|
|
35
35
|
|
|
36
36
|
___
|
|
37
37
|
|
|
@@ -56,7 +56,7 @@ Get a single attestation by ID.
|
|
|
56
56
|
|
|
57
57
|
#### Defined in
|
|
58
58
|
|
|
59
|
-
[api/attestation.ts:20](https://github.com/Prove-Anything/smartlinks/blob/
|
|
59
|
+
[api/attestation.ts:20](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L20)
|
|
60
60
|
|
|
61
61
|
___
|
|
62
62
|
|
|
@@ -80,7 +80,7 @@ List all attestations for a proof.
|
|
|
80
80
|
|
|
81
81
|
#### Defined in
|
|
82
82
|
|
|
83
|
-
[api/attestation.ts:8](https://github.com/Prove-Anything/smartlinks/blob/
|
|
83
|
+
[api/attestation.ts:8](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L8)
|
|
84
84
|
|
|
85
85
|
___
|
|
86
86
|
|
|
@@ -105,7 +105,7 @@ Delete an attestation.
|
|
|
105
105
|
|
|
106
106
|
#### Defined in
|
|
107
107
|
|
|
108
|
-
[api/attestation.ts:60](https://github.com/Prove-Anything/smartlinks/blob/
|
|
108
|
+
[api/attestation.ts:60](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L60)
|
|
109
109
|
|
|
110
110
|
___
|
|
111
111
|
|
|
@@ -131,4 +131,4 @@ Update an attestation.
|
|
|
131
131
|
|
|
132
132
|
#### Defined in
|
|
133
133
|
|
|
134
|
-
[api/attestation.ts:46](https://github.com/Prove-Anything/smartlinks/blob/
|
|
134
|
+
[api/attestation.ts:46](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L46)
|
|
@@ -22,7 +22,7 @@ Returns user, owner, account, and location objects.
|
|
|
22
22
|
|
|
23
23
|
#### Defined in
|
|
24
24
|
|
|
25
|
-
[api/auth.ts:65](https://github.com/Prove-Anything/smartlinks/blob/
|
|
25
|
+
[api/auth.ts:65](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L65)
|
|
26
26
|
|
|
27
27
|
___
|
|
28
28
|
|
|
@@ -46,7 +46,7 @@ Sets the bearerToken for subsequent API calls.
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
[api/auth.ts:31](https://github.com/Prove-Anything/smartlinks/blob/
|
|
49
|
+
[api/auth.ts:31](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L31)
|
|
50
50
|
|
|
51
51
|
___
|
|
52
52
|
|
|
@@ -62,7 +62,7 @@ Logout (clears bearerToken for future API calls).
|
|
|
62
62
|
|
|
63
63
|
#### Defined in
|
|
64
64
|
|
|
65
|
-
[api/auth.ts:40](https://github.com/Prove-Anything/smartlinks/blob/
|
|
65
|
+
[api/auth.ts:40](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L40)
|
|
66
66
|
|
|
67
67
|
___
|
|
68
68
|
|
|
@@ -85,4 +85,4 @@ Returns user/account info if valid.
|
|
|
85
85
|
|
|
86
86
|
#### Defined in
|
|
87
87
|
|
|
88
|
-
[api/auth.ts:48](https://github.com/Prove-Anything/smartlinks/blob/
|
|
88
|
+
[api/auth.ts:48](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L48)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
## Table of contents
|
|
2
|
+
|
|
3
|
+
### Functions
|
|
4
|
+
|
|
5
|
+
- [assignClaims](claimSet.md#assignclaims)
|
|
6
|
+
- [updateClaimData](claimSet.md#updateclaimdata)
|
|
7
|
+
|
|
8
|
+
## Functions
|
|
9
|
+
|
|
10
|
+
### assignClaims
|
|
11
|
+
|
|
12
|
+
▸ **assignClaims**(`collectionId`, `data`): `Promise`\<`any`\>
|
|
13
|
+
|
|
14
|
+
Assign claims to a claim set.
|
|
15
|
+
|
|
16
|
+
#### Parameters
|
|
17
|
+
|
|
18
|
+
| Name | Type | Description |
|
|
19
|
+
| :------ | :------ | :------ |
|
|
20
|
+
| `collectionId` | `string` | – The collection identifier |
|
|
21
|
+
| `data` | `any` | – The claims data to assign |
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`Promise`\<`any`\>
|
|
26
|
+
|
|
27
|
+
#### Defined in
|
|
28
|
+
|
|
29
|
+
api/claimSet.ts:9
|
|
30
|
+
|
|
31
|
+
___
|
|
32
|
+
|
|
33
|
+
### updateClaimData
|
|
34
|
+
|
|
35
|
+
▸ **updateClaimData**(`collectionId`, `data`): `Promise`\<`any`\>
|
|
36
|
+
|
|
37
|
+
Update claim data for a collection.
|
|
38
|
+
|
|
39
|
+
#### Parameters
|
|
40
|
+
|
|
41
|
+
| Name | Type | Description |
|
|
42
|
+
| :------ | :------ | :------ |
|
|
43
|
+
| `collectionId` | `string` | – The collection identifier |
|
|
44
|
+
| `data` | `any` | – The claim data to update |
|
|
45
|
+
|
|
46
|
+
#### Returns
|
|
47
|
+
|
|
48
|
+
`Promise`\<`any`\>
|
|
49
|
+
|
|
50
|
+
#### Defined in
|
|
51
|
+
|
|
52
|
+
api/claimSet.ts:19
|
|
@@ -3,12 +3,13 @@
|
|
|
3
3
|
### Functions
|
|
4
4
|
|
|
5
5
|
- [get](collection.md#get)
|
|
6
|
+
- [list](collection.md#list)
|
|
6
7
|
|
|
7
8
|
## Functions
|
|
8
9
|
|
|
9
10
|
### get
|
|
10
11
|
|
|
11
|
-
▸ **get**(`collectionId`): `Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)\>
|
|
12
|
+
▸ **get**(`collectionId`, `admin?`): `Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)\>
|
|
12
13
|
|
|
13
14
|
Retrieves a single Collection by its ID.
|
|
14
15
|
|
|
@@ -17,6 +18,7 @@ Retrieves a single Collection by its ID.
|
|
|
17
18
|
| Name | Type | Description |
|
|
18
19
|
| :------ | :------ | :------ |
|
|
19
20
|
| `collectionId` | `string` | – Identifier of the collection |
|
|
21
|
+
| `admin?` | `boolean` | – If true, fetches from the admin endpoint |
|
|
20
22
|
|
|
21
23
|
#### Returns
|
|
22
24
|
|
|
@@ -30,4 +32,32 @@ ErrorResponse if the request fails
|
|
|
30
32
|
|
|
31
33
|
#### Defined in
|
|
32
34
|
|
|
33
|
-
[api/collection.ts:
|
|
35
|
+
[api/collection.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/collection.ts#L13)
|
|
36
|
+
|
|
37
|
+
___
|
|
38
|
+
|
|
39
|
+
### list
|
|
40
|
+
|
|
41
|
+
▸ **list**(`admin?`): `Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)[]\>
|
|
42
|
+
|
|
43
|
+
Retrieves all Collections.
|
|
44
|
+
|
|
45
|
+
#### Parameters
|
|
46
|
+
|
|
47
|
+
| Name | Type | Description |
|
|
48
|
+
| :------ | :------ | :------ |
|
|
49
|
+
| `admin?` | `boolean` | – If true, fetches from the admin endpoint |
|
|
50
|
+
|
|
51
|
+
#### Returns
|
|
52
|
+
|
|
53
|
+
`Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)[]\>
|
|
54
|
+
|
|
55
|
+
Promise resolving to an array of CollectionResponse objects
|
|
56
|
+
|
|
57
|
+
**`Throws`**
|
|
58
|
+
|
|
59
|
+
ErrorResponse if the request fails
|
|
60
|
+
|
|
61
|
+
#### Defined in
|
|
62
|
+
|
|
63
|
+
[api/collection.ts:25](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/collection.ts#L25)
|