update docs

masa-finance · Nov 7, 2022 · f55fa42 · f55fa42
1 parent bb346c9
commit f55fa42
Show file tree

Hide file tree

Showing 15 changed files with 63 additions and 18 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v0.2.3 / [Exports](modules.md)
+ - v0.2.6 / [Exports](modules.md)
 
 ---
 

diff --git a/docs/classes/ContractService.md b/docs/classes/ContractService.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.2.3](../README.md) / [Exports](../modules.md) / ContractService
+ - v0.2.6](../README.md) / [Exports](../modules.md) / ContractService
 
 # Class: ContractService
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.2.3](../README.md) / [Exports](../modules.md) / Masa
+ - v0.2.6](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -167,10 +167,10 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `burn` | (`twofaId`: `number`) => `Promise`<`boolean`\> |
-| `create` | () => `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\> |
+| `create` | (`phoneNumber`: `string`) => `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\> |
 | `list` | (`address?`: `string`) => `Promise`<`undefined` \| { `metadata`: [`I2fa`](../interfaces/I2fa.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[]\> |
 | `load` | (`identityId`: `BigNumber`) => `Promise`<{ `metadata`: [`I2fa`](../interfaces/I2fa.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[]\> |
-| `mint` | (`address`: `string`, `signature`: `string`) => `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\> |
+| `mint` | (`address`: `string`, `phoneNumber`: `string`, `signature`: `string`) => `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\> |
 
 ___
 

diff --git a/docs/classes/MasaClient.md b/docs/classes/MasaClient.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.2.3](../README.md) / [Exports](../modules.md) / MasaClient
+ - v0.2.6](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 
@@ -152,13 +152,14 @@ ___
 
 ### twofaMint
 
-▸ **twofaMint**(`address`, `signature`): `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\>
+▸ **twofaMint**(`address`, `phoneNumber`, `signature`): `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `address` | `string` |
+| `phoneNumber` | `string` |
 | `signature` | `string` |
 
 #### Returns

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

diff --git a/docs/interfaces/I2fa.md b/docs/interfaces/I2fa.md
@@ -0,0 +1,44 @@
+[# Masa SDK
+ - v0.2.6](../README.md) / [Exports](../modules.md) / I2fa
+
+# Interface: I2fa
+
+## Table of contents
+
+### Properties
+
+- [description](I2fa.md#description)
+- [image](I2fa.md#image)
+- [name](I2fa.md#name)
+- [properties](I2fa.md#properties)
+
+## Properties
+
+### description
+
+• **description**: ``"A decentralized 2fa"``
+
+___
+
+### image
+
+• **image**: ``"https://metadata.masa.finance/v1.0/2fa/2fa.png"``
+
+___
+
+### name
+
+• **name**: ``"Masa Soulbound 2FA v1.0.0"``
+
+___
+
+### properties
+
+• **properties**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `account?` | `string` |
+| `tokenId` | `string` |
diff --git a/docs/interfaces/ICreditReport.md b/docs/interfaces/ICreditReport.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.2.3](../README.md) / [Exports](../modules.md) / ICreditReport
+ - v0.2.6](../README.md) / [Exports](../modules.md) / ICreditReport
 
 # Interface: ICreditReport
 

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

diff --git a/docs/interfaces/ISoulName.md b/docs/interfaces/ISoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.2.3](../README.md) / [Exports](../modules.md) / ISoulName
+ - v0.2.6](../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.2.3](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v0.2.6](../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.2.3](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v0.2.6](../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.2.3](../README.md) / [Exports](../modules.md) / MasaConfig
+ - v0.2.6](../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.2.3](README.md) / Exports
+ - v0.2.6](README.md) / Exports
 
 # # Masa SDK
- - v0.2.3
+ - v0.2.6
 
 ## Table of contents