updated docs

masa-finance · May 3, 2023 · 7c370ff · 7c370ff
1 parent 039af5d
commit 7c370ff
Show file tree

Hide file tree

Showing 59 changed files with 149 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,17 @@ 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).
 
+#### [v1.15.2](https://github.com/masa-finance/masa-sdk/compare/v1.15.1...v1.15.2)
+
+> 3 May 2023
+
+- Bump typedoc-plugin-markdown from 3.15.2 to 3.15.3 [`#67`](https://github.com/masa-finance/masa-sdk/pull/67)
+- Bump @types/chai from 4.3.4 to 4.3.5 [`#66`](https://github.com/masa-finance/masa-sdk/pull/66)
+- Bump axios from 1.3.6 to 1.4.0 [`#68`](https://github.com/masa-finance/masa-sdk/pull/68)
+- added generic access methods to masa-client [`8e6b3ad`](https://github.com/masa-finance/masa-sdk/commit/8e6b3ad3ea3df30970b0392f562c775b6c333c11)
+- update docs [`2e365ab`](https://github.com/masa-finance/masa-sdk/commit/2e365ab43c784722dbfad84fdd4e8dfaa14fca2b)
+- update readme [`71a3833`](https://github.com/masa-finance/masa-sdk/commit/71a3833fd50a3e720788339e19d0dfcdb3cbd0ef)
+
 #### [v1.15.1](https://github.com/masa-finance/masa-sdk/compare/v1.15.0...v1.15.1)
 
 > 28 April 2023

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

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

diff --git a/docs/classes/ERC20__factory.md b/docs/classes/ERC20__factory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.15.1](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v1.15.2](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
 
 # Class: ERC20\_\_factory
 

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

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

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

diff --git a/docs/classes/MasaAccount.md b/docs/classes/MasaAccount.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.15.1](../README.md) / [Exports](../modules.md) / MasaAccount
+ - v1.15.2](../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.15.1](../README.md) / [Exports](../modules.md) / MasaArweave
+ - v1.15.2](../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.15.1](../README.md) / [Exports](../modules.md) / MasaClient
+ - v1.15.2](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 
@@ -30,6 +30,12 @@
 
 - [cookie](MasaClient.md#cookie)
 
+### Methods
+
+- [get](MasaClient.md#get)
+- [patch](MasaClient.md#patch)
+- [post](MasaClient.md#post)
+
 ## Constructors
 
 ### constructor
@@ -145,3 +151,76 @@ ___
 #### Returns
 
 `undefined` \| `string`
+
+## Methods
+
+### get
+
+▸ **get**<`Result`\>(`endpoint`, `silent?`): `Promise`<`undefined` \| `Result`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `Result` |
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `endpoint` | `string` | `undefined` |
+| `silent` | `boolean` | `false` |
+
+#### Returns
+
+`Promise`<`undefined` \| `Result`\>
+
+___
+
+### patch
+
+▸ **patch**<`Payload`, `Result`\>(`endpoint`, `data`, `silent?`): `Promise`<`undefined` \| `Result`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `Payload` |
+| `Result` |
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `endpoint` | `string` | `undefined` |
+| `data` | `Payload` | `undefined` |
+| `silent` | `boolean` | `false` |
+
+#### Returns
+
+`Promise`<`undefined` \| `Result`\>
+
+___
+
+### post
+
+▸ **post**<`Payload`, `Result`\>(`endpoint`, `data`, `silent?`): `Promise`<`undefined` \| `Result`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `Payload` |
+| `Result` |
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `endpoint` | `string` | `undefined` |
+| `data` | `Payload` | `undefined` |
+| `silent` | `boolean` | `false` |
+
+#### Returns
+
+`Promise`<`undefined` \| `Result`\>
diff --git a/docs/classes/MasaContracts.md b/docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.15.1](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v1.15.2](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 

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

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

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

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

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

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

diff --git a/docs/classes/MasaSoulLinker.md b/docs/classes/MasaSoulLinker.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.15.1](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v1.15.2](../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.15.1](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v1.15.2](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 

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

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

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

diff --git a/docs/enums/SoulNameErrorCodes.md b/docs/enums/SoulNameErrorCodes.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.15.1](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
+ - v1.15.2](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
 
 # Enumeration: SoulNameErrorCodes
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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