update docs

masa-finance · Jan 19, 2023 · 2e4b05c · 2e4b05c
1 parent 4c020f2
commit 2e4b05c
Show file tree

Hide file tree

Showing 27 changed files with 96 additions and 74 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v1.0.4 / [Exports](modules.md)
+ - v1.1.0 / [Exports](modules.md)
 
 ---
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / Masa
+ - v1.1.0](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -28,13 +28,13 @@
 
 ### constructor
 
-• **new Masa**(`__namedParameters`)
+• **new Masa**(`«destructured»`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `__namedParameters` | [`MasaArgs`](../interfaces/MasaArgs.md) |
+| `«destructured»` | [`MasaArgs`](../interfaces/MasaArgs.md) |
 
 ## Properties
 

diff --git a/docs/classes/Masa2FA.md b/docs/classes/Masa2FA.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / Masa2FA
+ - v1.1.0](../README.md) / [Exports](../modules.md) / Masa2FA
 
 # Class: Masa2FA
 

diff --git a/docs/classes/MasaAccount.md b/docs/classes/MasaAccount.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaAccount
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaAccount
 
 # Class: MasaAccount
 

diff --git a/docs/classes/MasaArweave.md b/docs/classes/MasaArweave.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaArweave
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaArweave
 
 # Class: MasaArweave
 

diff --git a/docs/classes/MasaClient.md b/docs/classes/MasaClient.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaClient
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 
@@ -37,15 +37,15 @@
 
 ### constructor
 
-• **new MasaClient**(`__namedParameters`)
+• **new MasaClient**(`«destructured»`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `__namedParameters` | `Object` |
-| `__namedParameters.apiUrl` | `string` |
-| `__namedParameters.cookie?` | `string` |
+| `«destructured»` | `Object` |
+| › `apiUrl` | `string` |
+| › `cookie?` | `string` |
 
 ## Properties
 
@@ -128,11 +128,11 @@ ___
 
 ### getChallenge
 
-▸ **getChallenge**(): `Promise`<`any`\>
+▸ **getChallenge**(): `Promise`<`undefined` \| { `challenge`: `string` ; `cookie?`: `string` ; `expires`: `string`  }\>
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`<`undefined` \| { `challenge`: `string` ; `cookie?`: `string` ; `expires`: `string`  }\>
 
 ___
 
@@ -228,7 +228,7 @@ ___
 
 ### updateCreditScore
 
-▸ **updateCreditScore**(`transactionHash`): `Promise`<`undefined` \| { `creditScore?`: `any` ; `message`: `string` ; `signature?`: `string` ; `status`: `string` ; `success`: `boolean`  }\>
+▸ **updateCreditScore**(`transactionHash`): `Promise`<`undefined` \| { `message`: `string` ; `signature?`: `string` ; `status`: `string` ; `success`: `boolean`  }\>
 
 #### Parameters
 
@@ -238,4 +238,4 @@ ___
 
 #### Returns
 
-`Promise`<`undefined` \| { `creditScore?`: `any` ; `message`: `string` ; `signature?`: `string` ; `status`: `string` ; `success`: `boolean`  }\>
+`Promise`<`undefined` \| { `message`: `string` ; `signature?`: `string` ; `status`: `string` ; `success`: `boolean`  }\>
diff --git a/docs/classes/MasaContracts.md b/docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 
@@ -205,7 +205,7 @@ ___
 
 ### purchaseIdentityAndName
 
-▸ **purchaseIdentityAndName**(`signer`, `paymentMethod`, `name`, `nameLength`, `duration?`, `metadataURL`, `authorityAddress`, `signature`): `Promise`<`ContractTransaction`\>
+▸ **purchaseIdentityAndName**(`signer`, `paymentMethod`, `name`, `nameLength`, `duration?`, `metadataURL`, `authorityAddress`, `signature`, `debug?`): `Promise`<`ContractTransaction`\>
 
 #### Parameters
 
@@ -219,6 +219,7 @@ ___
 | `metadataURL` | `string` | `undefined` |
 | `authorityAddress` | `string` | `undefined` |
 | `signature` | `string` | `undefined` |
+| `debug` | `boolean` | `false` |
 
 #### Returns
 
@@ -228,7 +229,7 @@ ___
 
 ### purchaseName
 
-▸ **purchaseName**(`signer`, `paymentMethod`, `name`, `nameLength`, `duration?`, `metadataURL`, `authorityAddress`, `signature`): `Promise`<`ContractTransaction`\>
+▸ **purchaseName**(`signer`, `paymentMethod`, `name`, `nameLength`, `duration?`, `metadataURL`, `authorityAddress`, `signature`, `debug?`): `Promise`<`ContractTransaction`\>
 
 #### Parameters
 
@@ -242,6 +243,7 @@ ___
 | `metadataURL` | `string` | `undefined` |
 | `authorityAddress` | `string` | `undefined` |
 | `signature` | `string` | `undefined` |
+| `debug` | `boolean` | `false` |
 
 #### Returns
 

diff --git a/docs/classes/MasaCreditScore.md b/docs/classes/MasaCreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaCreditScore
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaCreditScore
 
 # Class: MasaCreditScore
 

diff --git a/docs/classes/MasaIdentity.md b/docs/classes/MasaIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaIdentity
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaIdentity
 
 # Class: MasaIdentity
 

diff --git a/docs/classes/MasaSession.md b/docs/classes/MasaSession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaSession
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaSession
 
 # Class: MasaSession
 
@@ -74,11 +74,11 @@ ___
 
 ### login
 
-▸ **login**(): `Promise`<`undefined` \| { `address`: `string` ; `cookie`: `string` ; `userId`: `string` \| `BigNumber`  }\>
+▸ **login**(): `Promise`<`undefined` \| { `address`: `string` ; `cookie?`: `string` ; `userId`: `string` \| `BigNumber`  }\>
 
 #### Returns
 
-`Promise`<`undefined` \| { `address`: `string` ; `cookie`: `string` ; `userId`: `string` \| `BigNumber`  }\>
+`Promise`<`undefined` \| { `address`: `string` ; `cookie?`: `string` ; `userId`: `string` \| `BigNumber`  }\>
 
 ___
 

diff --git a/docs/classes/MasaSoulLinker.md b/docs/classes/MasaSoulLinker.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaSoulLinker
 
 # Class: MasaSoulLinker
 

diff --git a/docs/classes/MasaSoulName.md b/docs/classes/MasaSoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 
@@ -100,7 +100,7 @@ ___
 
 ### list
 
-▸ **list**(`address?`): `Promise`<{ `index`: `number` ; `metadata`: `undefined` \| [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `undefined` \| `string` ; `tokenDetails`: `undefined` \| [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `undefined` \| `string`  }[]\>
+▸ **list**(`address?`): `Promise`<[`SoulNameDetails`](../interfaces/SoulNameDetails.md)[]\>
 
 #### Parameters
 
@@ -110,13 +110,13 @@ ___
 
 #### Returns
 
-`Promise`<{ `index`: `number` ; `metadata`: `undefined` \| [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `undefined` \| `string` ; `tokenDetails`: `undefined` \| [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `undefined` \| `string`  }[]\>
+`Promise`<[`SoulNameDetails`](../interfaces/SoulNameDetails.md)[]\>
 
 ___
 
 ### loadSoulNameByName
 
-▸ **loadSoulNameByName**(`soulName`): `Promise`<`undefined` \| { `metadata`: [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `string` ; `tokenDetails`: [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `string`  }\>
+▸ **loadSoulNameByName**(`soulName`): `Promise`<`undefined` \| [`SoulNameDetails`](../interfaces/SoulNameDetails.md)\>
 
 #### Parameters
 
@@ -126,13 +126,13 @@ ___
 
 #### Returns
 
-`Promise`<`undefined` \| { `metadata`: [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `string` ; `tokenDetails`: [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `string`  }\>
+`Promise`<`undefined` \| [`SoulNameDetails`](../interfaces/SoulNameDetails.md)\>
 
 ___
 
 ### loadSoulNameByTokenId
 
-▸ **loadSoulNameByTokenId**(`tokenId`): `Promise`<`undefined` \| { `metadata`: [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `string` ; `tokenDetails`: [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `string`  }\>
+▸ **loadSoulNameByTokenId**(`tokenId`): `Promise`<`undefined` \| [`SoulNameDetails`](../interfaces/SoulNameDetails.md)\>
 
 #### Parameters
 
@@ -142,13 +142,13 @@ ___
 
 #### Returns
 
-`Promise`<`undefined` \| { `metadata`: [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `string` ; `tokenDetails`: [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `string`  }\>
+`Promise`<`undefined` \| [`SoulNameDetails`](../interfaces/SoulNameDetails.md)\>
 
 ___
 
 ### loadSoulNamesByIdentityId
 
-▸ **loadSoulNamesByIdentityId**(`identityId`): `Promise`<{ `index`: `number` ; `metadata`: `undefined` \| [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `undefined` \| `string` ; `tokenDetails`: `undefined` \| [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `undefined` \| `string`  }[]\>
+▸ **loadSoulNamesByIdentityId**(`identityId`): `Promise`<[`SoulNameDetails`](../interfaces/SoulNameDetails.md)[]\>
 
 #### Parameters
 
@@ -158,7 +158,7 @@ ___
 
 #### Returns
 
-`Promise`<{ `index`: `number` ; `metadata`: `undefined` \| [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `undefined` \| `string` ; `tokenDetails`: `undefined` \| [`string`, `boolean`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `linked`: `boolean` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `undefined` \| `string`  }[]\>
+`Promise`<[`SoulNameDetails`](../interfaces/SoulNameDetails.md)[]\>
 
 ___
 

diff --git a/docs/interfaces/Addresses.md b/docs/interfaces/Addresses.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / Addresses
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / Attribute
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / BaseResult
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / Create2FAResult
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v1.1.0](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
 
 # Interface: CreateSoulNameResult
 

diff --git a/docs/interfaces/ICreditScore.md b/docs/interfaces/ICreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / IIdentity
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v1.1.0](../README.md) / [Exports](../modules.md) / IIdentityContracts
 
 # Interface: IIdentityContracts
 

diff --git a/docs/interfaces/IPassport.md b/docs/interfaces/IPassport.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / IPassport
+ - v1.1.0](../README.md) / [Exports](../modules.md) / IPassport
 
 # Interface: IPassport
 

diff --git a/docs/interfaces/ISession.md b/docs/interfaces/ISession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.0.4](../README.md) / [Exports](../modules.md) / ISession
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / ISoulName
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v1.1.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
- - v1.0.4](../README.md) / [Exports](../modules.md) / MasaConfig
+ - v1.1.0](../README.md) / [Exports](../modules.md) / MasaConfig
 
 # Interface: MasaConfig