update docs

masa-finance · Jan 4, 2023 · f936920 · f936920
1 parent bc17bf8
commit f936920
Show file tree

Hide file tree

Showing 19 changed files with 80 additions and 35 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v0.8.0-beta / [Exports](modules.md)
+ - v0.8.0 / [Exports](modules.md)
 
 ---
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / Masa
+ - v0.8.0](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -88,7 +88,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `retrieve` | (`url`: `string`) => `Promise`<`undefined` \| [`IIdentity`](../interfaces/IIdentity.md) \| [`ICreditScore`](../interfaces/ICreditScore.md) \| [`I2FA`](../interfaces/I2FA.md)\> |
+| `retrieve` | (`url`: `string`, `additionalHeaders?`: `Record`<`string`, `string`\>) => `Promise`<`undefined` \| [`IIdentity`](../interfaces/IIdentity.md) \| [`ICreditScore`](../interfaces/ICreditScore.md) \| [`I2FA`](../interfaces/I2FA.md)\> |
 | `store` | (`soulName`: `string`) => `Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default`  }\> |
 
 ___

diff --git a/docs/classes/MasaClient.md b/docs/classes/MasaClient.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / MasaClient
+ - v0.8.0](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 
@@ -138,13 +138,14 @@ ___
 
 ### getMetadata
 
-▸ **getMetadata**(`uri`): `Promise`<`undefined` \| [`IIdentity`](../interfaces/IIdentity.md) \| [`ICreditScore`](../interfaces/ICreditScore.md) \| [`I2FA`](../interfaces/I2FA.md)\>
+▸ **getMetadata**(`uri`, `additionalHeaders?`): `Promise`<`undefined` \| [`IIdentity`](../interfaces/IIdentity.md) \| [`ICreditScore`](../interfaces/ICreditScore.md) \| [`I2FA`](../interfaces/I2FA.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `uri` | `string` |
+| `additionalHeaders?` | `Record`<`string`, `string`\> |
 
 #### Returns
 

diff --git a/docs/classes/MasaContracts.md b/docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v0.8.0](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 
@@ -16,7 +16,7 @@
 
 ### Methods
 
-- [addPermission](MasaContracts.md#addpermission)
+- [addLink](MasaContracts.md#addlink)
 - [checkOrGiveAllowance](MasaContracts.md#checkorgiveallowance)
 - [getPaymentAddress](MasaContracts.md#getpaymentaddress)
 - [getPaymentInformation](MasaContracts.md#getpaymentinformation)
@@ -26,6 +26,7 @@
 - [purchaseIdentity](MasaContracts.md#purchaseidentity)
 - [purchaseIdentityAndName](MasaContracts.md#purchaseidentityandname)
 - [purchaseName](MasaContracts.md#purchasename)
+- [queryLink](MasaContracts.md#querylink)
 
 ## Constructors
 
@@ -53,9 +54,9 @@ ___
 
 ## Methods
 
-### addPermission
+### addLink
 
-▸ **addPermission**(`signer`, `tokenAddress`, `paymentMethod`, `receiverIdentityId`, `ownerIdentityId`, `tokenId`, `signatureDate`, `expirationDate`, `signature`): `Promise`<`void`\>
+▸ **addLink**(`signer`, `tokenAddress`, `paymentMethod`, `readerIdentityId`, `ownerIdentityId`, `tokenId`, `signatureDate`, `expirationDate`, `signature`): `Promise`<`boolean`\>
 
 #### Parameters
 
@@ -64,7 +65,7 @@ ___
 | `signer` | `Signer` |
 | `tokenAddress` | `string` |
 | `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
-| `receiverIdentityId` | `BigNumber` |
+| `readerIdentityId` | `BigNumber` |
 | `ownerIdentityId` | `BigNumber` |
 | `tokenId` | `BigNumber` |
 | `signatureDate` | `number` |
@@ -73,7 +74,7 @@ ___
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`<`boolean`\>
 
 ___
 
@@ -237,3 +238,27 @@ ___
 #### Returns
 
 `Promise`<`ContractTransaction`\>
+
+___
+
+### queryLink
+
+▸ **queryLink**(`signer`, `tokenAddress`, `paymentMethod`, `readerIdentityId`, `ownerIdentityId`, `tokenId`, `signatureDate`, `expirationDate`, `signature`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `signer` | `Signer` |
+| `tokenAddress` | `string` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
+| `readerIdentityId` | `BigNumber` |
+| `ownerIdentityId` | `BigNumber` |
+| `tokenId` | `BigNumber` |
+| `signatureDate` | `number` |
+| `expirationDate` | `number` |
+| `signature` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
diff --git a/docs/interfaces/Addresses.md b/docs/interfaces/Addresses.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / Addresses
+ - v0.8.0](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 

diff --git a/docs/interfaces/Attribute.md b/docs/interfaces/Attribute.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / Attribute
+ - v0.8.0](../README.md) / [Exports](../modules.md) / Attribute
 
 # Interface: Attribute
 

diff --git a/docs/interfaces/BaseResult.md b/docs/interfaces/BaseResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / BaseResult
+ - v0.8.0](../README.md) / [Exports](../modules.md) / BaseResult
 
 # Interface: BaseResult
 

diff --git a/docs/interfaces/Create2FAResult.md b/docs/interfaces/Create2FAResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / Create2FAResult
+ - v0.8.0](../README.md) / [Exports](../modules.md) / Create2FAResult
 
 # Interface: Create2FAResult
 

diff --git a/docs/interfaces/CreateSoulNameResult.md b/docs/interfaces/CreateSoulNameResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v0.8.0](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
 
 # Interface: CreateSoulNameResult
 

diff --git a/docs/interfaces/I2fa.md b/docs/interfaces/I2fa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / I2FA
+ - v0.8.0](../README.md) / [Exports](../modules.md) / I2FA
 
 # Interface: I2FA
 

diff --git a/docs/interfaces/ICreditScore.md b/docs/interfaces/ICreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v0.8.0](../README.md) / [Exports](../modules.md) / ICreditScore
 
 # Interface: ICreditScore
 

diff --git a/docs/interfaces/IIdentity.md b/docs/interfaces/IIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / IIdentity
+ - v0.8.0](../README.md) / [Exports](../modules.md) / IIdentity
 
 # Interface: IIdentity
 

diff --git a/docs/interfaces/IIdentityContracts.md b/docs/interfaces/IIdentityContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v0.8.0](../README.md) / [Exports](../modules.md) / IIdentityContracts
 
 # Interface: IIdentityContracts
 

diff --git a/docs/interfaces/ISession.md b/docs/interfaces/ISession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / ISession
+ - v0.8.0](../README.md) / [Exports](../modules.md) / ISession
 
 # Interface: ISession
 

diff --git a/docs/interfaces/ISoulName.md b/docs/interfaces/ISoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / ISoulName
+ - v0.8.0](../README.md) / [Exports](../modules.md) / ISoulName
 
 # Interface: ISoulName
 

diff --git a/docs/interfaces/LoadContractArgs.md b/docs/interfaces/LoadContractArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v0.8.0](../README.md) / [Exports](../modules.md) / LoadContractArgs
 
 # Interface: LoadContractArgs
 

diff --git a/docs/interfaces/MasaArgs.md b/docs/interfaces/MasaArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v0.8.0](../README.md) / [Exports](../modules.md) / MasaArgs
 
 # Interface: MasaArgs
 

diff --git a/docs/interfaces/MasaConfig.md b/docs/interfaces/MasaConfig.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0-beta](../README.md) / [Exports](../modules.md) / MasaConfig
+ - v0.8.0](../README.md) / [Exports](../modules.md) / MasaConfig
 
 # Interface: MasaConfig
 

diff --git a/docs/modules.md b/docs/modules.md
@@ -1,8 +1,8 @@
 [# Masa SDK
- - v0.8.0-beta](README.md) / Exports
+ - v0.8.0](README.md) / Exports
 
 # # Masa SDK
- - v0.8.0-beta
+ - v0.8.0
 
 ## Table of contents
 
@@ -87,6 +87,7 @@
 - [listSoulNames](modules.md#listsoulnames)
 - [load2FAsByIdentityId](modules.md#load2fasbyidentityid)
 - [loadAddressFromIdentityId](modules.md#loadaddressfromidentityid)
+- [loadCreditScoreByTokenId](modules.md#loadcreditscorebytokenid)
 - [loadCreditScoresByIdentityId](modules.md#loadcreditscoresbyidentityid)
 - [loadIdentityByAddress](modules.md#loadidentitybyaddress)
 - [loadIdentityContracts](modules.md#loadidentitycontracts)
@@ -459,7 +460,7 @@ ___
 
 ### createLink
 
-▸ **createLink**(`masa`, `contract`, `tokenId`, `receiverIdentityId`): `Promise`<[`CreateLinkResult`](modules.md#createlinkresult)\>
+▸ **createLink**(`masa`, `contract`, `tokenId`, `readerIdentityId`): `Promise`<[`CreateLinkResult`](modules.md#createlinkresult)\>
 
 #### Parameters
 
@@ -468,7 +469,7 @@ ___
 | `masa` | [`Masa`](classes/Masa.md) |
 | `contract` | `Contract` |
 | `tokenId` | `BigNumber` |
-| `receiverIdentityId` | `BigNumber` |
+| `readerIdentityId` | `BigNumber` |
 
 #### Returns
 
@@ -507,17 +508,18 @@ ___
 
 ### establishLink
 
-▸ **establishLink**(`masa`, `contract`, `tokenId`, `signature`, `paymentMethod`, `signatureDate`, `expirationDate`): `Promise`<[`BaseResult`](interfaces/BaseResult.md)\>
+▸ **establishLink**(`masa`, `contract`, `paymentMethod`, `tokenId`, `readerIdentityId`, `signature`, `signatureDate`, `expirationDate`): `Promise`<[`BaseResult`](interfaces/BaseResult.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `masa` | [`Masa`](classes/Masa.md) |
 | `contract` | `Contract` |
+| `paymentMethod` | [`PaymentMethod`](modules.md#paymentmethod) |
 | `tokenId` | `BigNumber` |
+| `readerIdentityId` | `BigNumber` |
 | `signature` | `string` |
-| `paymentMethod` | [`PaymentMethod`](modules.md#paymentmethod) |
 | `signatureDate` | `number` |
 | `expirationDate` | `number` |
 
@@ -719,6 +721,23 @@ ___
 
 ___
 
+### loadCreditScoreByTokenId
+
+▸ **loadCreditScoreByTokenId**(`masa`, `creditScoreId`): `Promise`<{ `metadata?`: [`ICreditScore`](interfaces/ICreditScore.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `masa` | [`Masa`](classes/Masa.md) |
+| `creditScoreId` | `BigNumber` |
+
+#### Returns
+
+`Promise`<{ `metadata?`: [`ICreditScore`](interfaces/ICreditScore.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }\>
+
+___
+
 ### loadCreditScoresByIdentityId
 
 ▸ **loadCreditScoresByIdentityId**(`masa`, `identityId`): `Promise`<{ `metadata?`: [`ICreditScore`](interfaces/ICreditScore.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[]\>
@@ -738,7 +757,7 @@ ___
 
 ### loadIdentityByAddress
 
-▸ **loadIdentityByAddress**(`masa`, `address?`): `Promise`<{ `address`: `string` ; `identityId?`: `BigNumber`  }\>
+▸ **loadIdentityByAddress**(`masa`, `address?`): `Promise`<{ `address?`: `string` ; `identityId?`: `BigNumber`  }\>
 
 #### Parameters
 
@@ -749,7 +768,7 @@ ___
 
 #### Returns
 
-`Promise`<{ `address`: `string` ; `identityId?`: `BigNumber`  }\>
+`Promise`<{ `address?`: `string` ; `identityId?`: `BigNumber`  }\>
 
 ___
 
@@ -1143,7 +1162,7 @@ ___
 
 ### verifyLink
 
-▸ **verifyLink**(`masa`, `contract`, `tokenId`, `readerIdentityId`): `Promise`<[`VerifyLinkResult`](modules.md#verifylinkresult)\>
+▸ **verifyLink**(`masa`, `contract`, `tokenId`, `readerIdentityId?`): `Promise`<[`VerifyLinkResult`](modules.md#verifylinkresult)\>
 
 #### Parameters
 
@@ -1152,7 +1171,7 @@ ___
 | `masa` | [`Masa`](classes/Masa.md) |
 | `contract` | `Contract` |
 | `tokenId` | `BigNumber` |
-| `readerIdentityId` | `BigNumber` |
+| `readerIdentityId?` | `BigNumber` |
 
 #### Returns