update docs

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.5.2](https://github.com/masa-finance/masa-sdk/compare/v0.5.1...v0.5.2)
+
+> 16 November 2022
+
+- properly type create workflows [`d153cb8`](https://github.com/masa-finance/masa-sdk/commit/d153cb8719eefddcf807c9fb7ec7eaca5e184a6f)
+- update docs [`a93e8ea`](https://github.com/masa-finance/masa-sdk/commit/a93e8ea200e5aa14f32bc994a98000210f3a930b)
+
 #### [v0.5.1](https://github.com/masa-finance/masa-sdk/compare/v0.5.0...v0.5.1)
 
 > 16 November 2022

docs/README.md

@@ -1,5 +1,5 @@
 # Masa SDK
- - v0.5.1 / [Exports](modules.md)
+ - v0.5.2 / [Exports](modules.md)
 
 ---
 

docs/classes/Masa.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / Masa
+ - v0.5.2](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -83,7 +83,7 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `burn` | (`creditReportId`: `number`) => `Promise`<`boolean`\> |
-| `create` | () => `Promise`<[`CreateCreditScoreResult`](../interfaces/CreateCreditScoreResult.md)\> |
+| `create` | () => `Promise`<[`BaseResult`](../interfaces/BaseResult.md)\> |
 | `list` | (`address?`: `string`) => `Promise`<{ `metadata?`: [`ICreditScore`](../interfaces/ICreditScore.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[]\> |
 | `load` | (`identityId`: `BigNumber`) => `Promise`<{ `metadata?`: [`ICreditScore`](../interfaces/ICreditScore.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[]\> |
 | `mint` | (`address`: `string`, `signature`: `string`) => `Promise`<`undefined` \| { `message`: `string` ; `success`: `boolean` ; `tokenId`: `string` \| `BigNumber`  }\> |
@@ -144,7 +144,7 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `burn` | (`soulName`: `string`) => `Promise`<`void`\> |
-| `create` | (`soulName`: `string`, `duration`: `number`, `paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod)) => `Promise`<`void`\> |
+| `create` | (`soulName`: `string`, `duration`: `number`, `paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod)) => `Promise`<[`CreateSoulNameResult`](../interfaces/CreateSoulNameResult.md)\> |
 | `getRegistrationPrice` | (`soulName`: `string`, `duration`: `number`, `paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod)) => `Promise`<`string` \| `BigNumber`\> |
 | `list` | (`address?`: `string`) => `Promise`<{ `index`: `number` ; `metadata`: `undefined` \| [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `string` ; `tokenDetails`: [`string`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `string`  }[]\> |
 | `loadSoulNameByName` | (`soulName`: `string`) => `Promise`<{ `metadata`: `undefined` \| [`ISoulName`](../interfaces/ISoulName.md) ; `owner`: `string` ; `tokenDetails`: [`string`, `BigNumber`, `BigNumber`, `BigNumber`, `boolean`] & { `active`: `boolean` ; `expirationDate`: `BigNumber` ; `identityId`: `BigNumber` ; `sbtName`: `string` ; `tokenId`: `BigNumber`  } ; `tokenUri`: `string`  }\> |

docs/classes/MasaClient.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / MasaClient
+ - v0.5.2](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 

docs/classes/MasaContracts.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v0.5.2](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 

docs/interfaces/Addresses.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / Addresses
+ - v0.5.2](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 

docs/interfaces/Attribute.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / Attribute
+ - v0.5.2](../README.md) / [Exports](../modules.md) / Attribute
 
 # Interface: Attribute
 

docs/interfaces/BaseResult.md

@@ -0,0 +1,38 @@
+[# Masa SDK
+ - v0.5.2](../README.md) / [Exports](../modules.md) / BaseResult
+
+# Interface: BaseResult
+
+## Hierarchy
+
+- **`BaseResult`**
+
+  ↳ [`CreateSoulNameResult`](CreateSoulNameResult.md)
+
+  ↳ [`Create2FAResult`](Create2FAResult.md)
+
+## Table of contents
+
+### Properties
+
+- [message](BaseResult.md#message)
+- [success](BaseResult.md#success)
+- [tokenId](BaseResult.md#tokenid)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+___
+
+### success
+
+• **success**: `boolean`
+
+___
+
+### tokenId
+
+• `Optional` **tokenId**: `string` \| `BigNumber`

docs/interfaces/Create2FAResult.md

@@ -1,8 +1,14 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / Create2FAResult
+ - v0.5.2](../README.md) / [Exports](../modules.md) / Create2FAResult
 
 # Interface: Create2FAResult
 
+## Hierarchy
+
+- [`BaseResult`](BaseResult.md)
+
+  ↳ **`Create2FAResult`**
+
 ## Table of contents
 
 ### Properties
@@ -16,7 +22,11 @@
 
 ### message
 
-• `Optional` **message**: `string`
+• **message**: `string`
+
+#### Inherited from
+
+[BaseResult](BaseResult.md).[message](BaseResult.md#message)
 
 ___
 
@@ -30,8 +40,16 @@ ___
 
 • **success**: `boolean`
 
+#### Inherited from
+
+[BaseResult](BaseResult.md).[success](BaseResult.md#success)
+
 ___
 
 ### tokenId
 
 • `Optional` **tokenId**: `string` \| `BigNumber`
+
+#### Inherited from
+
+[BaseResult](BaseResult.md).[tokenId](BaseResult.md#tokenid)

docs/interfaces/CreateSoulNameResult.md

@@ -0,0 +1,55 @@
+[# Masa SDK
+ - v0.5.2](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+
+# Interface: CreateSoulNameResult
+
+## Hierarchy
+
+- [`BaseResult`](BaseResult.md)
+
+  ↳ **`CreateSoulNameResult`**
+
+## Table of contents
+
+### Properties
+
+- [message](CreateSoulNameResult.md#message)
+- [soulName](CreateSoulNameResult.md#soulname)
+- [success](CreateSoulNameResult.md#success)
+- [tokenId](CreateSoulNameResult.md#tokenid)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[BaseResult](BaseResult.md).[message](BaseResult.md#message)
+
+___
+
+### soulName
+
+• `Optional` **soulName**: `string`
+
+___
+
+### success
+
+• **success**: `boolean`
+
+#### Inherited from
+
+[BaseResult](BaseResult.md).[success](BaseResult.md#success)
+
+___
+
+### tokenId
+
+• `Optional` **tokenId**: `string` \| `BigNumber`
+
+#### Inherited from
+
+[BaseResult](BaseResult.md).[tokenId](BaseResult.md#tokenid)

docs/interfaces/I2fa.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / I2FA
+ - v0.5.2](../README.md) / [Exports](../modules.md) / I2FA
 
 # Interface: I2FA
 
@@ -41,4 +41,5 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `account?` | `string` |
+| `identityId?` | `string` |
 | `tokenId` | `string` |

docs/interfaces/ICreditScore.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v0.5.2](../README.md) / [Exports](../modules.md) / ICreditScore
 
 # Interface: ICreditScore
 
@@ -42,6 +42,7 @@ ___
 | :------ | :------ |
 | `account?` | `string` |
 | `decile?` | `string` |
+| `identityId?` | `string` |
 | `lastUpdated?` | `string` |
 | `model_version?` | `string` |
 | `tokenId` | `string` |

docs/interfaces/IIdentity.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / IIdentity
+ - v0.5.2](../README.md) / [Exports](../modules.md) / IIdentity
 
 # Interface: IIdentity
 

docs/interfaces/IIdentityContracts.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v0.5.2](../README.md) / [Exports](../modules.md) / IIdentityContracts
 
 # Interface: IIdentityContracts
 

docs/interfaces/ISoulName.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / ISoulName
+ - v0.5.2](../README.md) / [Exports](../modules.md) / ISoulName
 
 # Interface: ISoulName
 

docs/interfaces/LoadContractArgs.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v0.5.2](../README.md) / [Exports](../modules.md) / LoadContractArgs
 
 # Interface: LoadContractArgs
 

docs/interfaces/MasaArgs.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v0.5.2](../README.md) / [Exports](../modules.md) / MasaArgs
 
 # Interface: MasaArgs
 

docs/interfaces/MasaConfig.md

@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.1](../README.md) / [Exports](../modules.md) / MasaConfig
+ - v0.5.2](../README.md) / [Exports](../modules.md) / MasaConfig
 
 # Interface: MasaConfig
 

docs/modules.md

@@ -1,8 +1,8 @@
 [# Masa SDK
- - v0.5.1](README.md) / Exports
+ - v0.5.2](README.md) / Exports
 
 # # Masa SDK
- - v0.5.1
+ - v0.5.2
 
 ## Table of contents
 
@@ -16,8 +16,9 @@
 
 - [Addresses](interfaces/Addresses.md)
 - [Attribute](interfaces/Attribute.md)
+- [BaseResult](interfaces/BaseResult.md)
 - [Create2FAResult](interfaces/Create2FAResult.md)
-- [CreateCreditScoreResult](interfaces/CreateCreditScoreResult.md)
+- [CreateSoulNameResult](interfaces/CreateSoulNameResult.md)
 - [I2FA](interfaces/I2FA.md)
 - [ICreditScore](interfaces/ICreditScore.md)
 - [IIdentity](interfaces/IIdentity.md)
@@ -29,6 +30,7 @@
 
 ### Type Aliases
 
+- [CreateCreditScoreResult](modules.md#createcreditscoreresult)
 - [Environment](modules.md#environment)
 - [PaymentMethod](modules.md#paymentmethod)
 
@@ -45,6 +47,12 @@
 
 ## Type Aliases
 
+### CreateCreditScoreResult
+
+Ƭ **CreateCreditScoreResult**: [`BaseResult`](interfaces/BaseResult.md)
+
+___
+
 ### Environment
 
 Ƭ **Environment**: { `name`: `string` ; `wallet?`: `ethers.Signer` \| `ethers.Wallet`  } & [`MasaArgs`](interfaces/MasaArgs.md)