Skip to content

Commit

Permalink
Update vocdoni-sdk docs by commit 2244934
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcvelmer @arabot-1
marcvelmer authored and arabot-1 committed Mar 27, 2024
1 parent 3aaf35f commit 6d2b2fa
Show file tree
Hide file tree
Showing 146 changed files with 1,527 additions and 1,488 deletions.
54 changes: 27 additions & 27 deletions docs/sdk/reference/classes/Account.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Constructs an account

#### Defined in

[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L33)
[types/account.ts:33](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L33)

## Properties

Expand All @@ -67,7 +67,7 @@ Constructs an account

#### Defined in

[types/account.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L24)
[types/account.ts:24](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L24)

___

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

#### Defined in

[types/account.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L21)
[types/account.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L21)

___

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

#### Defined in

[types/account.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L22)
[types/account.ts:22](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L22)

___

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

#### Defined in

[types/account.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L23)
[types/account.ts:23](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L23)

___

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

#### Defined in

[types/account.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L19)
[types/account.ts:19](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L19)

___

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

#### Defined in

[types/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L25)
[types/account.ts:25](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L25)

___

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

#### Defined in

[types/account.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L26)
[types/account.ts:26](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L26)

___

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

#### Defined in

[types/account.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L20)
[types/account.ts:20](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L20)

## Accessors

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

#### Defined in

[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L108)
[types/account.ts:108](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L108)

• `set` **avatar**(`value`): `void`

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

#### Defined in

[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L112)
[types/account.ts:112](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L112)

___

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

#### Defined in

[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L92)
[types/account.ts:92](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L92)

• `set` **description**(`value`): `void`

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

#### Defined in

[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L96)
[types/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L96)

___

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

#### Defined in

[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L124)
[types/account.ts:124](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L124)

• `set` **feed**(`value`): `void`

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

#### Defined in

[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L128)
[types/account.ts:128](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L128)

___

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

#### Defined in

[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L100)
[types/account.ts:100](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L100)

• `set` **header**(`value`): `void`

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

#### Defined in

[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L104)
[types/account.ts:104](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L104)

___

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

#### Defined in

[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L140)
[types/account.ts:140](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L140)

• `set` **languages**(`value`): `void`

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

#### Defined in

[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L144)
[types/account.ts:144](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L144)

___

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

#### Defined in

[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L116)
[types/account.ts:116](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L116)

• `set` **logo**(`value`): `void`

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

#### Defined in

[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L120)
[types/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L120)

___

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

#### Defined in

[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L132)
[types/account.ts:132](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L132)

• `set` **meta**(`value`): `void`

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

#### Defined in

[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L136)
[types/account.ts:136](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L136)

___

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

#### Defined in

[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L84)
[types/account.ts:84](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L84)

• `set` **name**(`value`): `void`

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

#### Defined in

[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L88)
[types/account.ts:88](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L88)

## Methods

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

#### Defined in

[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L65)
[types/account.ts:65](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L65)

___

Expand All @@ -413,4 +413,4 @@ Returns an account object

#### Defined in

[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/types/account.ts#L61)
[types/account.ts:61](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/types/account.ts#L61)
22 changes: 11 additions & 11 deletions docs/sdk/reference/classes/AccountAPI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ API.constructor

#### Defined in

[api/account.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L109)
[api/account.ts:109](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L109)

## Methods

Expand All @@ -67,7 +67,7 @@ Returns the number of accounts

#### Defined in

[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L133)
[api/account.ts:133](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L133)

___

Expand All @@ -91,7 +91,7 @@ Returns paginated list of elections for a specific account

#### Defined in

[api/account.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L220)
[api/account.ts:220](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L220)

___

Expand All @@ -114,7 +114,7 @@ Fetches an Account information

#### Defined in

[api/account.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L147)
[api/account.ts:147](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L147)

___

Expand All @@ -138,7 +138,7 @@ API.isApiError

#### Defined in

[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L21)
[api/api.ts:21](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L21)

___

Expand All @@ -163,7 +163,7 @@ API.isUndefinedError

#### Defined in

[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/api.ts#L64)
[api/api.ts:64](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/api.ts#L64)

___

Expand All @@ -186,7 +186,7 @@ Returns paginated list of accounts

#### Defined in

[api/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L120)
[api/account.ts:120](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L120)

___

Expand All @@ -209,7 +209,7 @@ Fetches the account metadata

#### Defined in

[api/account.ts:161](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L161)
[api/account.ts:161](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L161)

___

Expand All @@ -233,7 +233,7 @@ Sets Account information

#### Defined in

[api/account.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L176)
[api/account.ts:176](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L176)

___

Expand All @@ -256,7 +256,7 @@ Returns the account's transfers count

#### Defined in

[api/account.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L205)
[api/account.ts:205](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L205)

___

Expand All @@ -280,4 +280,4 @@ Returns paginated list of transfers for a specific account

#### Defined in

[api/account.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/api/account.ts#L191)
[api/account.ts:191](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/api/account.ts#L191)
12 changes: 6 additions & 6 deletions docs/sdk/reference/classes/AccountService.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Instantiate the election service.

#### Defined in

[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L45)
[services/account.ts:45](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L45)

## Properties

Expand All @@ -67,7 +67,7 @@ AccountServiceProperties.chainService

#### Defined in

[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L38)
[services/account.ts:38](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L38)

___

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

#### Defined in

[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/service.ts#L6)
[services/service.ts:6](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/service.ts#L6)

## Methods

Expand All @@ -103,7 +103,7 @@ Fetches account information.

#### Defined in

[services/account.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L56)
[services/account.ts:56](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L56)

___

Expand All @@ -128,7 +128,7 @@ The transaction hash

#### Defined in

[services/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L96)
[services/account.ts:96](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L96)

___

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

#### Defined in

[services/account.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/0a4464c/src/services/account.ts#L101)
[services/account.ts:101](https://github.com/vocdoni/vocdoni-sdk/blob/2244934/src/services/account.ts#L101)
Loading

0 comments on commit 6d2b2fa

Please sign in to comment.