Finalize documentation on models.

This commit is contained in:
Spencer Ofwiti
2021-05-12 10:52:28 +03:00
parent ca985d7af7
commit 948a735baf
49 changed files with 1308 additions and 473 deletions

View File

@@ -132,6 +132,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account details </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -161,6 +167,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Meta store id </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -190,6 +202,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Signature used during write. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -198,11 +216,17 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface AccountDetails {
/** Account registration day */
date_registered: number;
/** User&#x27;s gender */
gender: string;
/** Age of user */
age?: string;
/** Type of account */
type?: string;
/** Token balance on account */
balance?: number;
/** Account identifiers */
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: string[];
@@ -211,13 +235,17 @@
latitude: number;
longitude: number;
};
/** User&#x27;s location */
location: {
area?: string;
area_name: string;
area_type?: string;
};
/** Products or services provided by user. */
products: string[];
/** Business category of user. */
category?: string;
/** Personal identifying information of user */
vcard: {
email: [
{
@@ -252,22 +280,31 @@
/** Meta signature interface */
interface Signature {
/** Algorithm used */
algo: string;
/** Data that was signed. */
data: string;
/** Message digest */
digest: string;
/** Encryption engine used. */
engine: string;
}
/** Meta object interface */
interface Meta {
/** Account details */
data: AccountDetails;
/** Meta store id */
id: string;
/** Signature used during write. */
signature: Signature;
}
/** Meta response interface */
interface MetaResponse {
/** Meta store id */
id: string;
/** Meta object */
m: Meta;
}