Update vocdoni-sdk docs by commit 2ec9544

vocdoni · Jun 3, 2024 · acf13d9 · acf13d9
1 parent 941a52b
commit acf13d9
Show file tree

Hide file tree

Showing 159 changed files with 1,440 additions and 1,297 deletions.
diff --git a/docs/sdk/reference/classes/Account.md b/docs/sdk/reference/classes/Account.md
@@ -38,7 +38,7 @@ Represents an account
 
 #### Defined in
 
-[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L108)
+[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L108)
 
 • `set` **avatar**(`value`): `void`
 
@@ -54,7 +54,7 @@ Represents an account
 
 #### Defined in
 
-[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L112)
+[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L112)
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L92)
+[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L92)
 
 • `set` **description**(`value`): `void`
 
@@ -84,7 +84,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L96)
+[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L96)
 
 ___
 
@@ -98,7 +98,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L124)
+[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L124)
 
 • `set` **feed**(`value`): `void`
 
@@ -114,7 +114,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L128)
+[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L128)
 
 ___
 
@@ -128,7 +128,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L100)
+[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L100)
 
 • `set` **header**(`value`): `void`
 
@@ -144,7 +144,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L104)
+[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L104)
 
 ___
 
@@ -158,7 +158,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L140)
+[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L140)
 
 • `set` **languages**(`value`): `void`
 
@@ -174,7 +174,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L144)
+[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L144)
 
 ___
 
@@ -188,7 +188,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L116)
+[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L116)
 
 • `set` **logo**(`value`): `void`
 
@@ -204,7 +204,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L120)
+[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L120)
 
 ___
 
@@ -218,7 +218,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L132)
+[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L132)
 
 • `set` **meta**(`value`): `void`
 
@@ -234,7 +234,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L136)
+[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L136)
 
 ___
 
@@ -248,7 +248,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L84)
+[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L84)
 
 • `set` **name**(`value`): `void`
 
@@ -264,7 +264,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L88)
+[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L88)
 
 ## Constructors
 
@@ -286,7 +286,7 @@ Constructs an account
 
 #### Defined in
 
-[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L33)
+[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L33)
 
 ## Methods
 
@@ -300,7 +300,7 @@ Constructs an account
 
 #### Defined in
 
-[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L65)
+[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L65)
 
 ___
 
@@ -322,4 +322,4 @@ Returns an account object
 
 #### Defined in
 
-[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/types/account.ts#L61)
+[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L61)
diff --git a/docs/sdk/reference/classes/AccountAPI.md b/docs/sdk/reference/classes/AccountAPI.md
@@ -14,6 +14,7 @@
 
 - [count](AccountAPI#count)
 - [electionsList](AccountAPI#electionslist)
+- [fees](AccountAPI#fees)
 - [info](AccountAPI#info)
 - [list](AccountAPI#list)
 - [metadata](AccountAPI#metadata)
@@ -41,7 +42,7 @@ Returns the number of accounts
 
 #### Defined in
 
-[api/account.ts:131](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L131)
+[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L133)
 
 ___
 
@@ -65,7 +66,31 @@ Returns paginated list of elections for a specific account
 
 #### Defined in
 
-[api/account.ts:212](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L212)
+[api/account.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L214)
+
+___
+
+### fees
+
+▸ **fees**(`url`, `account`, `page?`): `Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\>
+
+Returns the list of fees by account
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `url` | `string` | `undefined` | {string} url API endpoint URL |
+| `account` | `string` | `undefined` | {string} account The account |
+| `page` | `number` | `0` | {number} page The page number |
+
+#### Returns
+
+`Promise`\<[`IChainFeesListResponse`](../interfaces/IChainFeesListResponse)\>
+
+#### Defined in
+
+[api/account.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L228)
 
 ___
 
@@ -88,7 +113,7 @@ Fetches an Account information
 
 #### Defined in
 
-[api/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L144)
+[api/account.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L146)
 
 ___
 
@@ -111,7 +136,7 @@ Returns paginated list of accounts
 
 #### Defined in
 
-[api/account.ts:119](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L119)
+[api/account.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L121)
 
 ___
 
@@ -134,7 +159,7 @@ Fetches the account metadata
 
 #### Defined in
 
-[api/account.ts:157](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L157)
+[api/account.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L159)
 
 ___
 
@@ -158,7 +183,7 @@ Sets Account information
 
 #### Defined in
 
-[api/account.ts:171](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L171)
+[api/account.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L173)
 
 ___
 
@@ -181,7 +206,7 @@ Returns the account's transfers count
 
 #### Defined in
 
-[api/account.ts:198](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L198)
+[api/account.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L200)
 
 ___
 
@@ -205,4 +230,4 @@ Returns paginated list of transfers for a specific account
 
 #### Defined in
 
-[api/account.ts:185](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/api/account.ts#L185)
+[api/account.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L187)
diff --git a/docs/sdk/reference/classes/AccountService.md b/docs/sdk/reference/classes/AccountService.md
@@ -53,7 +53,7 @@ Service.constructor
 
 #### Defined in
 
-[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L45)
+[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L45)
 
 ## Methods
 
@@ -75,7 +75,7 @@ Fetches account information.
 
 #### Defined in
 
-[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L55)
+[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L55)
 
 ___
 
@@ -100,7 +100,7 @@ The transaction hash
 
 #### Defined in
 
-[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L95)
+[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L95)
 
 ___
 
@@ -122,7 +122,7 @@ ___
 
 #### Defined in
 
-[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L100)
+[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L100)
 
 ## Properties
 
@@ -136,7 +136,7 @@ AccountServiceProperties.chainService
 
 #### Defined in
 
-[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/account.ts#L38)
+[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L38)
 
 ___
 
@@ -150,4 +150,4 @@ ___
 
 #### Defined in
 
-[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/ee6390524b82e6ef535da03c0e3bb826e450e622/src/services/service.ts#L6)
+[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6)