@proveanything/smartlinks 1.0.14 → 1.0.17

package/temp-docs/modules/asset.md

@@ -0,0 +1,171 @@
+## Table of contents
+
+### Functions
+
+- [getForCollection](asset.md#getforcollection)
+- [getForProduct](asset.md#getforproduct)
+- [getForProof](asset.md#getforproof)
+- [listForCollection](asset.md#listforcollection)
+- [listForProduct](asset.md#listforproduct)
+- [listForProof](asset.md#listforproof)
+- [uploadAsset](asset.md#uploadasset)
+
+## Functions
+
+### getForCollection
+
+▸ **getForCollection**(`collectionId`, `assetId`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `assetId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+#### Defined in
+
+[api/asset.ts:6](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L6)
+
+___
+
+### getForProduct
+
+▸ **getForProduct**(`collectionId`, `productId`, `assetId`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `assetId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+#### Defined in
+
+[api/asset.ts:22](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L22)
+
+___
+
+### getForProof
+
+▸ **getForProof**(`collectionId`, `productId`, `proofId`, `assetId`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+| `assetId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+#### Defined in
+
+[api/asset.ts:40](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L40)
+
+___
+
+### listForCollection
+
+▸ **listForCollection**(`collectionId`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)[]\>
+
+#### Defined in
+
+[api/asset.ts:14](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L14)
+
+___
+
+### listForProduct
+
+▸ **listForProduct**(`collectionId`, `productId`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)[]\>
+
+#### Defined in
+
+[api/asset.ts:31](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L31)
+
+___
+
+### listForProof
+
+▸ **listForProof**(`collectionId`, `productId`, `proofId`, `appId?`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+| `appId?` | `string` |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)[]\>
+
+#### Defined in
+
+[api/asset.ts:50](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L50)
+
+___
+
+### uploadAsset
+
+▸ **uploadAsset**(`collectionId`, `productId`, `proofId`, `file`, `extraData?`, `onProgress?`): `Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+Uploads an asset file to a proof, with optional extraData as JSON.
+Supports progress reporting via onProgress callback (browser only).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | The collection ID |
+| `productId` | `string` | The product ID |
+| `proofId` | `string` | The proof ID |
+| `file` | `File` | The file to upload |
+| `extraData?` | `Record`\<`string`, `any`\> | Arbitrary extra data to include (will be stringified as JSON) |
+| `onProgress?` | (`percent`: `number`) => `void` | Optional callback for upload progress (0-100) |
+
+#### Returns
+
+`Promise`\<[`AssetResponse`](../interfaces/AssetResponse.md)\>
+
+Promise resolving to an AssetResponse object
+
+#### Defined in
+
+[api/asset.ts:74](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/asset.ts#L74)

package/temp-docs/modules/attestation.md

@@ -0,0 +1,134 @@
+## Table of contents
+
+### Functions
+
+- [create](attestation.md#create)
+- [get](attestation.md#get)
+- [list](attestation.md#list)
+- [remove](attestation.md#remove)
+- [update](attestation.md#update)
+
+## Functions
+
+### create
+
+▸ **create**(`collectionId`, `productId`, `proofId`, `data`): `Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)\>
+
+Create a new attestation for a proof.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+| `data` | [`AttestationCreateRequest`](../interfaces/AttestationCreateRequest.md) |
+
+#### Returns
+
+`Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)\>
+
+#### Defined in
+
+[api/attestation.ts:33](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L33)
+
+___
+
+### get
+
+▸ **get**(`collectionId`, `productId`, `proofId`, `attestationId`): `Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)\>
+
+Get a single attestation by ID.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+| `attestationId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)\>
+
+#### Defined in
+
+[api/attestation.ts:20](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L20)
+
+___
+
+### list
+
+▸ **list**(`collectionId`, `productId`, `proofId`): `Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)[]\>
+
+List all attestations for a proof.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+
+#### Returns
+
+`Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)[]\>
+
+#### Defined in
+
+[api/attestation.ts:8](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L8)
+
+___
+
+### remove
+
+▸ **remove**(`collectionId`, `productId`, `proofId`, `attestationId`): `Promise`\<`void`\>
+
+Delete an attestation.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+| `attestationId` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[api/attestation.ts:60](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L60)
+
+___
+
+### update
+
+▸ **update**(`collectionId`, `productId`, `proofId`, `attestationId`, `data`): `Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)\>
+
+Update an attestation.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `collectionId` | `string` |
+| `productId` | `string` |
+| `proofId` | `string` |
+| `attestationId` | `string` |
+| `data` | [`AttestationUpdateRequest`](../interfaces/AttestationUpdateRequest.md) |
+
+#### Returns
+
+`Promise`\<[`AttestationResponse`](../interfaces/AttestationResponse.md)\>
+
+#### Defined in
+
+[api/attestation.ts:46](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/attestation.ts#L46)

package/temp-docs/modules/auth.md

@@ -0,0 +1,88 @@
+## Table of contents
+
+### Functions
+
+- [getAccount](auth.md#getaccount)
+- [login](auth.md#login)
+- [logout](auth.md#logout)
+- [verifyToken](auth.md#verifytoken)
+
+## Functions
+
+### getAccount
+
+▸ **getAccount**(): `Promise`\<[`AccountInfoResponse`](../modules.md#accountinforesponse)\>
+
+Gets current account information for the logged in user.
+Returns user, owner, account, and location objects.
+
+#### Returns
+
+`Promise`\<[`AccountInfoResponse`](../modules.md#accountinforesponse)\>
+
+#### Defined in
+
+[api/auth.ts:65](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L65)
+
+___
+
+### login
+
+▸ **login**(`email`, `password`): `Promise`\<[`LoginResponse`](../modules.md#loginresponse)\>
+
+Login with email and password.
+Sets the bearerToken for subsequent API calls.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `email` | `string` |
+| `password` | `string` |
+
+#### Returns
+
+`Promise`\<[`LoginResponse`](../modules.md#loginresponse)\>
+
+#### Defined in
+
+[api/auth.ts:31](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L31)
+
+___
+
+### logout
+
+▸ **logout**(): `void`
+
+Logout (clears bearerToken for future API calls).
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[api/auth.ts:40](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L40)
+
+___
+
+### verifyToken
+
+▸ **verifyToken**(`token?`): `Promise`\<[`VerifyTokenResponse`](../modules.md#verifytokenresponse)\>
+
+Verifies the current bearerToken (or a provided token).
+Returns user/account info if valid.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token?` | `string` |
+
+#### Returns
+
+`Promise`\<[`VerifyTokenResponse`](../modules.md#verifytokenresponse)\>
+
+#### Defined in
+
+[api/auth.ts:48](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/auth.ts#L48)

package/temp-docs/modules/claimSet.md

@@ -0,0 +1,52 @@
+## Table of contents
+
+### Functions
+
+- [assignClaims](claimSet.md#assignclaims)
+- [updateClaimData](claimSet.md#updateclaimdata)
+
+## Functions
+
+### assignClaims
+
+▸ **assignClaims**(`collectionId`, `data`): `Promise`\<`any`\>
+
+Assign claims to a claim set.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `data` | `any` | – The claims data to assign |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+api/claimSet.ts:9
+
+___
+
+### updateClaimData
+
+▸ **updateClaimData**(`collectionId`, `data`): `Promise`\<`any`\>
+
+Update claim data for a collection.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `data` | `any` | – The claim data to update |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+api/claimSet.ts:19

package/temp-docs/modules/collection.md

@@ -0,0 +1,63 @@
+## Table of contents
+
+### Functions
+
+- [get](collection.md#get)
+- [list](collection.md#list)
+
+## Functions
+
+### get
+
+▸ **get**(`collectionId`, `admin?`): `Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)\>
+
+Retrieves a single Collection by its ID.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – Identifier of the collection |
+| `admin?` | `boolean` | – If true, fetches from the admin endpoint |
+
+#### Returns
+
+`Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)\>
+
+Promise resolving to a CollectionResponse object
+
+**`Throws`**
+
+ErrorResponse if the request fails
+
+#### Defined in
+
+[api/collection.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/collection.ts#L13)
+
+___
+
+### list
+
+▸ **list**(`admin?`): `Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)[]\>
+
+Retrieves all Collections.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `admin?` | `boolean` | – If true, fetches from the admin endpoint |
+
+#### Returns
+
+`Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)[]\>
+
+Promise resolving to an array of CollectionResponse objects
+
+**`Throws`**
+
+ErrorResponse if the request fails
+
+#### Defined in
+
+[api/collection.ts:25](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/collection.ts#L25)

package/temp-docs/modules/form.md

@@ -0,0 +1,126 @@
+## Table of contents
+
+### Functions
+
+- [create](form.md#create)
+- [get](form.md#get)
+- [list](form.md#list)
+- [remove](form.md#remove)
+- [update](form.md#update)
+
+## Functions
+
+### create
+
+▸ **create**(`collectionId`, `data`): `Promise`\<`any`\>
+
+Create a new form for a collection (admin only).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `data` | `any` | – The form data |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+api/form.ts:32
+
+___
+
+### get
+
+▸ **get**(`collectionId`, `formId`, `admin?`): `Promise`\<`any`\>
+
+Get a single form by ID for a collection.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `formId` | `string` | – The form identifier |
+| `admin?` | `boolean` | – If true, use admin endpoint; otherwise, use public |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+api/form.ts:10
+
+___
+
+### list
+
+▸ **list**(`collectionId`, `admin?`): `Promise`\<`any`[]\>
+
+List all forms for a collection.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `admin?` | `boolean` | – If true, use admin endpoint; otherwise, use public |
+
+#### Returns
+
+`Promise`\<`any`[]\>
+
+#### Defined in
+
+api/form.ts:21
+
+___
+
+### remove
+
+▸ **remove**(`collectionId`, `formId`): `Promise`\<`void`\>
+
+Delete a form for a collection (admin only).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `formId` | `string` | – The form identifier |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+api/form.ts:53
+
+___
+
+### update
+
+▸ **update**(`collectionId`, `formId`, `data`): `Promise`\<`any`\>
+
+Update a form for a collection (admin only).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – The collection identifier |
+| `formId` | `string` | – The form identifier |
+| `data` | `any` | – The form data |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+api/form.ts:43

package/temp-docs/modules/product.md

@@ -0,0 +1,63 @@
+## Table of contents
+
+### Functions
+
+- [get](product.md#get)
+- [list](product.md#list)
+
+## Functions
+
+### get
+
+▸ **get**(`collectionId`, `productId`): `Promise`\<[`ProductResponse`](../interfaces/ProductResponse.md)\>
+
+Retrieves a single Product Item by Collection ID and Product ID.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – Identifier of the parent collection |
+| `productId` | `string` | – Identifier of the product item |
+
+#### Returns
+
+`Promise`\<[`ProductResponse`](../interfaces/ProductResponse.md)\>
+
+Promise resolving to a ProductResponse object
+
+**`Throws`**
+
+ErrorResponse if the request fails
+
+#### Defined in
+
+[api/product.ts:13](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/product.ts#L13)
+
+___
+
+### list
+
+▸ **list**(`collectionId`): `Promise`\<[`ProductResponse`](../interfaces/ProductResponse.md)[]\>
+
+List all Product Items for a Collection.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – Identifier of the parent collection |
+
+#### Returns
+
+`Promise`\<[`ProductResponse`](../interfaces/ProductResponse.md)[]\>
+
+Promise resolving to an array of ProductResponse objects
+
+**`Throws`**
+
+ErrorResponse if the request fails
+
+#### Defined in
+
+[api/product.ts:29](https://github.com/Prove-Anything/smartlinks/blob/2322afa091763cbb81ba4db4b90e49b576099120/src/api/product.ts#L29)