Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@H34D
H34D committed Oct 26, 2022
1 parent 65c4abc commit 712d0e9
Show file tree
Hide file tree
Showing 12 changed files with 73 additions and 73 deletions.
20 changes: 10 additions & 10 deletions docs/classes/ContractService.md
View file
Expand Up @@ -37,7 +37,7 @@

#### Defined in

[src/contracts/contractService.ts:11](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L11)
[src/contracts/contractService.ts:11](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L11)

## Properties

Expand All @@ -47,7 +47,7 @@

#### Defined in

[src/contracts/contractService.ts:11](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L11)
[src/contracts/contractService.ts:11](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L11)

## Methods

Expand All @@ -74,7 +74,7 @@

#### Defined in

[src/contracts/contractService.ts:132](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L132)
[src/contracts/contractService.ts:132](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L132)

___

Expand All @@ -94,7 +94,7 @@ ___

#### Defined in

[src/contracts/contractService.ts:13](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L13)
[src/contracts/contractService.ts:13](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L13)

___

Expand All @@ -115,7 +115,7 @@ ___

#### Defined in

[src/contracts/contractService.ts:31](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L31)
[src/contracts/contractService.ts:31](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L31)

___

Expand All @@ -136,7 +136,7 @@ ___

#### Defined in

[src/contracts/contractService.ts:43](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L43)
[src/contracts/contractService.ts:43](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L43)

___

Expand All @@ -158,7 +158,7 @@ ___

#### Defined in

[src/contracts/contractService.ts:173](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L173)
[src/contracts/contractService.ts:173](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L173)

___

Expand All @@ -179,7 +179,7 @@ ___

#### Defined in

[src/contracts/contractService.ts:51](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L51)
[src/contracts/contractService.ts:51](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L51)

___

Expand All @@ -204,7 +204,7 @@ ___

#### Defined in

[src/contracts/contractService.ts:61](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L61)
[src/contracts/contractService.ts:61](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L61)

___

Expand All @@ -229,4 +229,4 @@ ___

#### Defined in

[src/contracts/contractService.ts:95](https://github.com/masa-finance/masa-sdk/blob/3002684/src/contracts/contractService.ts#L95)
[src/contracts/contractService.ts:95](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/contracts/contractService.ts#L95)
26 changes: 13 additions & 13 deletions docs/classes/Masa.md
View file
Expand Up @@ -36,7 +36,7 @@

#### Defined in

[src/masa.ts:16](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L16)
[src/masa.ts:16](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L16)

## Properties

Expand All @@ -52,7 +52,7 @@

#### Defined in

[src/masa.ts:48](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L48)
[src/masa.ts:50](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L50)

___

Expand All @@ -62,7 +62,7 @@ ___

#### Defined in

[src/masa.ts:14](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L14)
[src/masa.ts:14](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L14)

___

Expand All @@ -72,7 +72,7 @@ ___

#### Defined in

[src/masa.ts:13](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L13)
[src/masa.ts:13](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L13)

___

Expand All @@ -82,7 +82,7 @@ ___

#### Defined in

[src/masa.ts:44](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L44)
[src/masa.ts:44](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L44)

___

Expand All @@ -100,7 +100,7 @@ ___

#### Defined in

[src/masa.ts:62](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L62)
[src/masa.ts:51](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L51)

___

Expand All @@ -120,7 +120,7 @@ ___

#### Defined in

[src/masa.ts:56](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L56)
[src/masa.ts:49](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L49)

___

Expand All @@ -139,7 +139,7 @@ ___

#### Defined in

[src/masa.ts:47](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L47)
[src/masa.ts:47](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L47)

___

Expand All @@ -152,11 +152,11 @@ ___
| Name | Type |
| :------ | :------ |
| `retrieve` | (`url`: `string`) => `Promise`<`undefined` \| [`ICreditReport`](../interfaces/ICreditReport.md) \| [`IIdentity`](../interfaces/IIdentity.md)\> |
| `store` | (`soulName`: `string`) => `Promise`<`any`\> |
| `store` | (`soulName`: `string`) => `Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `metadataTransaction`: `default` }\> |

#### Defined in

[src/masa.ts:51](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L51)
[src/masa.ts:52](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L52)

___

Expand All @@ -175,7 +175,7 @@ ___

#### Defined in

[src/masa.ts:46](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L46)
[src/masa.ts:46](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L46)

___

Expand All @@ -194,7 +194,7 @@ ___

#### Defined in

[src/masa.ts:49](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L49)
[src/masa.ts:48](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L48)

___

Expand All @@ -210,4 +210,4 @@ ___

#### Defined in

[src/masa.ts:58](https://github.com/masa-finance/masa-sdk/blob/3002684/src/masa.ts#L58)
[src/masa.ts:56](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/masa.ts#L56)
24 changes: 12 additions & 12 deletions docs/classes/MasaClient.md
View file
Expand Up @@ -39,7 +39,7 @@

#### Defined in

[src/utils/clients/middleware.ts:13](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L13)
[src/utils/clients/middleware.ts:14](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L14)

## Properties

Expand All @@ -49,7 +49,7 @@

#### Defined in

[src/utils/clients/middleware.ts:11](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L11)
[src/utils/clients/middleware.ts:12](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L12)

___

Expand All @@ -59,7 +59,7 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:10](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L10)
[src/utils/clients/middleware.ts:11](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L11)

## Methods

Expand All @@ -81,7 +81,7 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:101](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L101)
[src/utils/clients/middleware.ts:122](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L122)

___

Expand All @@ -102,7 +102,7 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:132](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L132)
[src/utils/clients/middleware.ts:153](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L153)

___

Expand All @@ -116,7 +116,7 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:79](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L79)
[src/utils/clients/middleware.ts:100](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L100)

___

Expand All @@ -136,7 +136,7 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:41](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L41)
[src/utils/clients/middleware.ts:42](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L42)

___

Expand All @@ -150,7 +150,7 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:23](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L23)
[src/utils/clients/middleware.ts:24](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L24)

___

Expand All @@ -164,13 +164,13 @@ ___

#### Defined in

[src/utils/clients/middleware.ts:173](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L173)
[src/utils/clients/middleware.ts:194](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L194)

___

### storeMetadata

▸ **storeMetadata**(`soulName`): `Promise`<`any`\>
▸ **storeMetadata**(`soulName`): `Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `metadataTransaction`: `default` }\>

#### Parameters

Expand All @@ -180,8 +180,8 @@ ___

#### Returns

`Promise`<`any`\>
`Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string` } ; `metadataTransaction`: `default` }\>

#### Defined in

[src/utils/clients/middleware.ts:56](https://github.com/masa-finance/masa-sdk/blob/3002684/src/utils/clients/middleware.ts#L56)
[src/utils/clients/middleware.ts:57](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/utils/clients/middleware.ts#L57)
6 changes: 3 additions & 3 deletions docs/interfaces/Attribute.md
View file
Expand Up @@ -18,7 +18,7 @@

#### Defined in

[src/interface/soulName.ts:2](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L2)
[src/interface/soulName.ts:2](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L2)

___

Expand All @@ -28,7 +28,7 @@ ___

#### Defined in

[src/interface/soulName.ts:3](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L3)
[src/interface/soulName.ts:3](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L3)

___

Expand All @@ -38,4 +38,4 @@ ___

#### Defined in

[src/interface/soulName.ts:4](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L4)
[src/interface/soulName.ts:4](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L4)
8 changes: 4 additions & 4 deletions docs/interfaces/ICreditReport.md
View file
Expand Up @@ -19,7 +19,7 @@

#### Defined in

[src/interface/creditReport.ts:3](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/creditReport.ts#L3)
[src/interface/creditReport.ts:3](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/creditReport.ts#L3)

___

Expand All @@ -29,7 +29,7 @@ ___

#### Defined in

[src/interface/creditReport.ts:4](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/creditReport.ts#L4)
[src/interface/creditReport.ts:4](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/creditReport.ts#L4)

___

Expand All @@ -39,7 +39,7 @@ ___

#### Defined in

[src/interface/creditReport.ts:2](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/creditReport.ts#L2)
[src/interface/creditReport.ts:2](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/creditReport.ts#L2)

___

Expand All @@ -61,4 +61,4 @@ ___

#### Defined in

[src/interface/creditReport.ts:5](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/creditReport.ts#L5)
[src/interface/creditReport.ts:5](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/creditReport.ts#L5)
10 changes: 5 additions & 5 deletions docs/interfaces/IISoulName.md
View file
Expand Up @@ -20,7 +20,7 @@

#### Defined in

[src/interface/soulName.ts:12](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L12)
[src/interface/soulName.ts:12](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L12)

___

Expand All @@ -30,7 +30,7 @@ ___

#### Defined in

[src/interface/soulName.ts:8](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L8)
[src/interface/soulName.ts:8](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L8)

___

Expand All @@ -40,7 +40,7 @@ ___

#### Defined in

[src/interface/soulName.ts:9](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L9)
[src/interface/soulName.ts:9](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L9)

___

Expand All @@ -50,7 +50,7 @@ ___

#### Defined in

[src/interface/soulName.ts:10](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L10)
[src/interface/soulName.ts:10](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L10)

___

Expand All @@ -60,4 +60,4 @@ ___

#### Defined in

[src/interface/soulName.ts:11](https://github.com/masa-finance/masa-sdk/blob/3002684/src/interface/soulName.ts#L11)
[src/interface/soulName.ts:11](https://github.com/masa-finance/masa-sdk/blob/6151f86/src/interface/soulName.ts#L11)

0 comments on commit 712d0e9

Please sign in to comment.