Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
H34D committed Jan 27, 2023
1 parent d657f4b commit dc5491b
Show file tree
Hide file tree
Showing 29 changed files with 176 additions and 705 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
@@ -1,5 +1,5 @@
# Masa SDK
- v1.1.1 / [Exports](modules.md)
- v1.2.0-alpha.1 / [Exports](modules.md)

---

Expand Down
18 changes: 9 additions & 9 deletions docs/classes/Masa.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.1.1](../README.md) / [Exports](../modules.md) / Masa
- v1.2.0-alpha.1](../README.md) / [Exports](../modules.md) / Masa

# Class: Masa

Expand All @@ -17,11 +17,11 @@
- [config](Masa.md#config)
- [contracts](Masa.md#contracts)
- [creditScore](Masa.md#creditscore)
- [green](Masa.md#green)
- [identity](Masa.md#identity)
- [metadata](Masa.md#metadata)
- [session](Masa.md#session)
- [soulName](Masa.md#soulname)
- [twoFA](Masa.md#twofa)
- [utils](Masa.md#utils)

## Constructors
Expand Down Expand Up @@ -74,6 +74,12 @@ ___

___

### green

`Readonly` **green**: [`MasaGreen`](MasaGreen.md)

___

### identity

`Readonly` **identity**: [`MasaIdentity`](MasaIdentity.md)
Expand All @@ -88,7 +94,7 @@ ___

| Name | Type |
| :------ | :------ |
| `retrieve` | (`url`: `string`, `additionalHeaders?`: `Record`<`string`, `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) \| [`IGreen`](../interfaces/IGreen.md)\> |
| `store` | (`soulName`: `string`, `receiver`: `string`, `duration`: `number`) => `Promise`<`undefined` \| { `authorityAddress`: `string` ; `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `metadataTransaction`: `default` ; `signature`: `string` }\> |

___
Expand All @@ -105,12 +111,6 @@ ___

___

### twoFA

`Readonly` **twoFA**: [`Masa2FA`](Masa2FA.md)

___

### utils

**utils**: `Object`
Expand Down
148 changes: 0 additions & 148 deletions docs/classes/Masa2FA.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/classes/MasaAccount.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.1.1](../README.md) / [Exports](../modules.md) / MasaAccount
- v1.2.0-alpha.1](../README.md) / [Exports](../modules.md) / MasaAccount

# Class: MasaAccount

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaArweave.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.1.1](../README.md) / [Exports](../modules.md) / MasaArweave
- v1.2.0-alpha.1](../README.md) / [Exports](../modules.md) / MasaArweave

# Class: MasaArweave

Expand Down

0 comments on commit dc5491b

Please sign in to comment.