@proveanything/smartlinks 1.0.14 → 1.0.16

package/temp-docs/interfaces/ProofResponse.md

@@ -0,0 +1,97 @@
+Represents a Proof object.
+
+## Table of contents
+
+### Properties
+
+- [collectionId](ProofResponse.md#collectionid)
+- [createdAt](ProofResponse.md#createdat)
+- [id](ProofResponse.md#id)
+- [productId](ProofResponse.md#productid)
+- [tokenId](ProofResponse.md#tokenid)
+- [userId](ProofResponse.md#userid)
+- [values](ProofResponse.md#values)
+
+## Properties
+
+### collectionId
+
+• **collectionId**: `string`
+
+Unique identifier for the collection
+
+#### Defined in
+
+[types/proof.ts:7](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L7)
+
+___
+
+### createdAt
+
+• **createdAt**: `string`
+
+Creation timestamp
+
+#### Defined in
+
+[types/proof.ts:9](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L9)
+
+___
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the proof
+
+#### Defined in
+
+[types/proof.ts:11](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L11)
+
+___
+
+### productId
+
+• **productId**: `string`
+
+Unique identifier for the product
+
+#### Defined in
+
+[types/proof.ts:13](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L13)
+
+___
+
+### tokenId
+
+• **tokenId**: `string`
+
+Unique identifier for the token
+
+#### Defined in
+
+[types/proof.ts:15](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L15)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+Unique identifier for the user
+
+#### Defined in
+
+[types/proof.ts:17](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L17)
+
+___
+
+### values
+
+• **values**: `Record`\<`string`, `any`\>
+
+Arbitrary key-value pairs for proof values
+
+#### Defined in
+
+[types/proof.ts:19](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/types/proof.ts#L19)

package/temp-docs/modules/appConfiguration.md

@@ -0,0 +1,151 @@
+## Table of contents
+
+### Functions
+
+- [deleteConfig](appConfiguration.md#deleteconfig)
+- [deleteDataItem](appConfiguration.md#deletedataitem)
+- [getConfig](appConfiguration.md#getconfig)
+- [getData](appConfiguration.md#getdata)
+- [getDataItem](appConfiguration.md#getdataitem)
+- [setConfig](appConfiguration.md#setconfig)
+- [setDataItem](appConfiguration.md#setdataitem)
+
+## Functions
+
+### deleteConfig
+
+▸ **deleteConfig**(`opts`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[api/appConfiguration.ts:74](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L74)
+
+___
+
+### deleteDataItem
+
+▸ **deleteDataItem**(`opts`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[api/appConfiguration.ts:99](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L99)
+
+___
+
+### getConfig
+
+▸ **getConfig**(`opts`): `Promise`\<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+[api/appConfiguration.ts:62](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L62)
+
+___
+
+### getData
+
+▸ **getData**(`opts`): `Promise`\<`any`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`any`[]\>
+
+#### Defined in
+
+[api/appConfiguration.ts:80](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L80)
+
+___
+
+### getDataItem
+
+▸ **getDataItem**(`opts`): `Promise`\<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+[api/appConfiguration.ts:86](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L86)
+
+___
+
+### setConfig
+
+▸ **setConfig**(`opts`): `Promise`\<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+[api/appConfiguration.ts:68](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L68)
+
+___
+
+### setDataItem
+
+▸ **setDataItem**(`opts`): `Promise`\<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `opts` | [`AppConfigOptions`](../modules.md#appconfigoptions) |
+
+#### Returns
+
+`Promise`\<`any`\>
+
+#### Defined in
+
+[api/appConfiguration.ts:93](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/appConfiguration.ts#L93)

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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/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/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/auth.ts#L48)

package/temp-docs/modules/collection.md

@@ -0,0 +1,33 @@
+## Table of contents
+
+### Functions
+
+- [get](collection.md#get)
+
+## Functions
+
+### get
+
+▸ **get**(`collectionId`): `Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)\>
+
+Retrieves a single Collection by its ID.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `collectionId` | `string` | – Identifier of the collection |
+
+#### Returns
+
+`Promise`\<[`CollectionResponse`](../interfaces/CollectionResponse.md)\>
+
+Promise resolving to a CollectionResponse object
+
+**`Throws`**
+
+ErrorResponse if the request fails
+
+#### Defined in
+
+[api/collection.ts:12](https://github.com/Prove-Anything/smartlinks/blob/54a929dabe2ef3c5f4a5a559c656ea584231138a/src/api/collection.ts#L12)