The account's address. An address typically refers to a
human-readable series of 39 characters, starting either with
a T, for TESTNET addresses, or with a N, for MAINNET addresses.
This field is required and indexed.
The total amount of tokens that the address of this schema
has received. Amount is in absolute format.
This field is required and not indexed.
This field contains the mongo collection name for entries
that are stored using AccountIntegrationDocument or the model
AccountIntegrationModel.
Note that this field is not part of document properties
and used only internally to perform queries that refer to
an individual collection name, e.g. $unionWith.
The document's creation timestamp. This field does not reflect the
date of creation of an integration but rather the date of creation of the
cached database entry.
This field is required and indexed.
The data attached to this statistics document. This can contain any object literal that is defined using one of:
ObjectLiteral: e.g. { just: "a value" }.
The period string representation of this schema. Currently there are 3 types of periods:
| name | description | example | example explained |
|---|---|---|---|
| daily | occurs daily | "20220130" | period occuring between 0:00 AM 30/01/2022 and 0:00 AM Jan 30 2022 |
| weekly | occurs weekly | "202201-02" | period occuring between monday and sunday the second week of Jan 2022 |
| monthly | occurs monthly | "202201" | period occuring between the 1st and 31st of Jan 2022 |
| This field is required and indexed. |
The period format of this statistics schema. Depends on the sub-statistics scheduler it would take a different specific value. Currently there are 3 types of periods:
| value | description |
|---|---|
| "D" | occurs daily |
| "W" | occurs weekly |
| "M" | occurs monthly |
| This field is required and not indexed. |
The position of the user of this schema. This reflects
the position in terms of total rewards (token) amount
this user's address has received.
This field is required and indexed.
The type of this statistics schema. Depends on the
data type it would take a different
specific value.
This field is required and not indexed.
The document's update timestamp. This field does not reflect the
date of update of an integration but rather the date of update of the
cached database entry.
This field is optional and not indexed.
This method implements a specialized query format to query items
individually, as documents, in the collection: account_integrations.
The individual document data that is used in a query.
This static method populates a StatisticsDTO object from the values of a StatisticsDocument as presented by mongoose queries.
The document as received from mongoose.
The DTO object that will be populated with values.
The dto object with fields set.
Generated using TypeDoc
This class defines the exact fields that are stored in the corresponding MongoDB documents. It should be used whenever database documents are being handled or read for the
activitiescollection.Note that this class uses the generic Transferable trait to enable a
toDTO()method on the model.Timestamp fields should be numbers to avoid timezone issues.
v0.3.2