Update vocdoni-sdk docs by commit 6ae2250

vocdoni · Jul 19, 2024 · 730f12c · 730f12c
1 parent 0626d60
commit 730f12c
Show file tree

Hide file tree

Showing 166 changed files with 1,846 additions and 1,418 deletions.
diff --git a/docs/sdk/reference/changelog.md b/docs/sdk/reference/changelog.md
@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.3] - 2024-06-12
+
+### Added
+
+- Added new transaction for changing an election duration.
+- Added new functions `changeElectionEndDate` and `changeElectionDuration`.
+- Added new raw information when election data is not complete.
+
+### Changed
+
+- Census3 `getStrategyHolders` changed for using queues instead of direct endpoint call.
+
+## [0.8.2] - 2024-06-12
+
+### Added
+
+- Added API fees calls functions for checking all fees and account fees.
+- Added new function to modify an election maximum census size.
+- Added new `delta` parameter when checking for next election identifiers.
+
+### Changed
+
+- Census publishing is done async to avoid 502 errors when uploading large censuses.
+- Modified change census function to accept a new maximum census size.
+
 ## [0.8.1] - 2024-05-21
 
 ### Added
@@ -473,6 +498,8 @@ which extend from the abstract `Election` class.
 
 - First unstable version of the SDK for testing purposes
 
+[0.8.3]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.3
+[0.8.2]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.2
 [0.8.1]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.1
 [0.8.0]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.8.0
 [0.7.5]: https://github.com/vocdoni/vocdoni-sdk/releases/tag/v0.7.5

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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L108)
+[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L112)
+[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L112)
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L92)
+[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L96)
+[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L96)
 
 ___
 
@@ -98,7 +98,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L124)
+[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L128)
+[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L128)
 
 ___
 
@@ -128,7 +128,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L100)
+[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L104)
+[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L104)
 
 ___
 
@@ -158,7 +158,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L140)
+[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L144)
+[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L144)
 
 ___
 
@@ -188,7 +188,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L116)
+[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L120)
+[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L120)
 
 ___
 
@@ -218,7 +218,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L132)
+[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L136)
+[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L136)
 
 ___
 
@@ -248,7 +248,7 @@ ___
 
 #### Defined in
 
-[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L84)
+[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L88)
+[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L33)
+[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L65)
+[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/types/account.ts#L61)
+[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/types/account.ts#L61)
diff --git a/docs/sdk/reference/classes/AccountAPI.md b/docs/sdk/reference/classes/AccountAPI.md
@@ -42,7 +42,7 @@ Returns the number of accounts
 
 #### Defined in
 
-[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L133)
+[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L133)
 
 ___
 
@@ -66,7 +66,7 @@ Returns paginated list of elections for a specific account
 
 #### Defined in
 
-[api/account.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L214)
+[api/account.ts:214](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L214)
 
 ___
 
@@ -90,13 +90,13 @@ Returns the list of fees by account
 
 #### Defined in
 
-[api/account.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L228)
+[api/account.ts:228](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L228)
 
 ___
 
 ### info
 
-▸ **info**(`url`, `accountId`): `Promise`\<`IAccountInfoResponse`\>
+▸ **info**(`url`, `accountId`): `Promise`\<[`IAccountInfoResponse`](../interfaces/IAccountInfoResponse)\>
 
 Fetches an Account information
 
@@ -109,11 +109,11 @@ Fetches an Account information
 
 #### Returns
 
-`Promise`\<`IAccountInfoResponse`\>
+`Promise`\<[`IAccountInfoResponse`](../interfaces/IAccountInfoResponse)\>
 
 #### Defined in
 
-[api/account.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L146)
+[api/account.ts:146](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L146)
 
 ___
 
@@ -136,7 +136,7 @@ Returns paginated list of accounts
 
 #### Defined in
 
-[api/account.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L121)
+[api/account.ts:121](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L121)
 
 ___
 
@@ -159,7 +159,7 @@ Fetches the account metadata
 
 #### Defined in
 
-[api/account.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L159)
+[api/account.ts:159](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L159)
 
 ___
 
@@ -183,7 +183,7 @@ Sets Account information
 
 #### Defined in
 
-[api/account.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L173)
+[api/account.ts:173](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L173)
 
 ___
 
@@ -206,13 +206,13 @@ Returns the account's transfers count
 
 #### Defined in
 
-[api/account.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L200)
+[api/account.ts:200](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/api/account.ts#L200)
 
 ___
 
 ### transfersList
 
-▸ **transfersList**(`url`, `accountId`, `page?`): `Promise`\<`IAccountTransfersResponse`\>
+▸ **transfersList**(`url`, `accountId`, `page?`): `Promise`\<[`IAccountTransfersResponse`](../interfaces/IAccountTransfersResponse)\>
 
 Returns paginated list of transfers for a specific account
 
@@ -226,8 +226,8 @@ Returns paginated list of transfers for a specific account
 
 #### Returns
 
-`Promise`\<`IAccountTransfersResponse`\>
+`Promise`\<[`IAccountTransfersResponse`](../interfaces/IAccountTransfersResponse)\>
 
 #### Defined in
 
-[api/account.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/api/account.ts#L187)
+[api/account.ts:187](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L45)
+[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L55)
+[services/account.ts:55](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L95)
+[services/account.ts:95](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/services/account.ts#L95)
 
 ___
 
@@ -122,7 +122,7 @@ ___
 
 #### Defined in
 
-[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L100)
+[services/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/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/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/account.ts#L38)
+[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/services/account.ts#L38)
 
 ___
 
@@ -150,4 +150,4 @@ ___
 
 #### Defined in
 
-[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2ec9544f0d792289a6e591f4f269c47a23ca40a1/src/services/service.ts#L6)
+[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/6ae2250aeb5405ccad3a71d9f84d58b06d7252d4/src/services/service.ts#L6)