@oasisomniverse/web4-api 2.0.0

package/docs/modules/Social.md

@@ -0,0 +1,190 @@
+# Social — `oasis.social`
+
+Source controller: [`SocialController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SocialController.cs)
+Route prefix: `api/social`
+4 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `getRegisteredProviders`
+
+Get registered social providers for the current avatar
+
+**GET** `api/social/registered-providers`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `SocialProvider` (array)
+
+| Field | Type |
+| --- | --- |
+| `Id` | `string` |
+| `Name` | `string` |
+| `AccessToken` | `string` |
+| `AvatarId` | `Guid` |
+| `IsActive` | `bool` |
+| `RegisteredAt` | `DateTime` |
+| `Settings` | `Dictionary<string, object>` |
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.social.getRegisteredProviders({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": [{ "Id": "example string", "Name": "example string", "AccessToken": "example string", "AvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "IsActive": true, "RegisteredAt": "2026-01-01T00:00:00Z", "Settings": { "<string>": {} } }]
+}
+```
+
+---
+
+### `getSocialFeed`
+
+Get's the social feed from all registered social providers for the currently logged in avatar
+
+**GET** `api/social/social-feed`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `SocialPost` (array)
+
+| Field | Type |
+| --- | --- |
+| `Id` | `string` |
+| `ProviderId` | `string` |
+| `ProviderName` | `string` |
+| `Content` | `string` |
+| `Timestamp` | `DateTime` |
+| `AvatarId` | `Guid` |
+| `Metadata` | `Dictionary<string, object>` |
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.social.getSocialFeed({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": [{ "Id": "example string", "ProviderId": "example string", "ProviderName": "example string", "Content": "example string", "Timestamp": "2026-01-01T00:00:00Z", "AvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Metadata": { "<string>": {} } }]
+}
+```
+
+---
+
+### `registerSocialProvider`
+
+Register a given social provider (FaceBook, Twitter, Instagram, LinkedIn, etc)
+
+**POST** `api/social/register-social-provider`
+
+**Request**
+
+Body type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `bool`
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.social.registerSocialProvider({
+    providerName: 'example string',
+    accessToken: 'example string',
+    /* ...request body fields */
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": true
+}
+```
+
+---
+
+### `shareHolon`
+
+Share a holon to social media
+
+**POST** `api/social/share-holon`
+
+**Request**
+
+Body type: `string` (array)
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `bool`
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.social.shareHolon({
+    holonId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
+    message: 'example string',
+    /* ...request body fields */
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": true
+}
+```
+

package/docs/modules/Solana.md

@@ -0,0 +1,150 @@
+# Solana — `oasis.solana`
+
+Source controller: [`SolanaController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SolanaController.cs)
+Route prefix: `api/solana`
+2 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `mintNft`
+
+Mint NFT (non-fungible token)
+
+**POST** `api/solana/Mint`
+
+**Request**
+
+Body type: `MintWeb3NFTRequest`
+
+| Field | Type |
+| --- | --- |
+| `CollectionPublicKey` | `string?` |
+| `Price` | `decimal?` |
+| `Discount` | `decimal?` |
+| `RoyaltyPercentage` | `int?` |
+| `NumberToMint` | `int?` |
+| `StoreNFTMetaDataOnChain` | `bool?` |
+| `OffChainProvider` | `ProviderType?` |
+| `OnChainProvider` | `ProviderType?` |
+| `NFTStandardType` | `NFTStandardType?` |
+| `NFTOffChainMetaType` | `NFTOffChainMetaType?` |
+| `NFTTagsMergeStrategy` | `NFTTagsMergeStrategy` |
+| `NFTMetaDataMergeStrategy` | `NFTMetaDataMergeStrategy` |
+| `WaitTillNFTMinted` | `bool?` |
+| `WaitForNFTToMintInSeconds` | `int?` |
+| `AttemptToMintEveryXSeconds` | `int?` |
+| `WaitTillNFTVerified` | `bool?` |
+| `WaitForNFTToVerifyInSeconds` | `int?` |
+| `AttemptToVerifyEveryXSeconds` | `int?` |
+| `WaitTillNFTSent` | `bool?` |
+| `WaitForNFTToSendInSeconds` | `int?` |
+| `AttemptToSendEveryXSeconds` | `int?` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `MintNftResult`
+
+| Field | Type |
+| --- | --- |
+| `MintAccount` | `string` |
+| `Network` | `string` |
+| `VerifyCollectionTransactionHash` | `string` |
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.solana.mintNft({
+    collectionPublicKey: "example string",
+    price: 1.0,
+    discount: 1.0,
+    royaltyPercentage: 1,
+    numberToMint: 1,
+    storeNFTMetaDataOnChain: true,
+    offChainProvider: {  },
+    onChainProvider: {  },
+    nFTStandardType: {  },
+    nFTOffChainMetaType: {  },
+    nFTTagsMergeStrategy: {  },
+    nFTMetaDataMergeStrategy: {  },
+    waitTillNFTMinted: true,
+    waitForNFTToMintInSeconds: 1,
+    attemptToMintEveryXSeconds: 1,
+    waitTillNFTVerified: true,
+    waitForNFTToVerifyInSeconds: 1,
+    attemptToVerifyEveryXSeconds: 1,
+    waitTillNFTSent: true,
+    waitForNFTToSendInSeconds: 1,
+    attemptToSendEveryXSeconds: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "MintAccount": "example string", "Network": "example string", "VerifyCollectionTransactionHash": "example string" }
+}
+```
+
+---
+
+### `sendTransaction`
+
+Handles a transaction between accounts with a specific Lampposts size
+
+**POST** `api/solana/Send`
+
+**Request**
+
+Body type: `SendTransactionRequest`
+
+| Field | Type |
+| --- | --- |
+| `Lampposts` | `ulong` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `SendTransactionResult`
+
+_No fields._
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.solana.sendTransaction({
+    lampposts: /* <ulong> */
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": {  }
+}
+```
+

package/docs/modules/Stats.md

@@ -0,0 +1,359 @@
+# Stats — `oasis.stats`
+
+Source controller: [`StatsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/StatsController.cs)
+Route prefix: `api/stats`
+8 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `getChatStats`
+
+Get chat statistics for an avatar
+
+**GET** `api/stats/chat-stats/{avatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `avatarId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getChatStats({
+    avatarId: '<avatarId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getGiftStats`
+
+Get gift statistics for an avatar
+
+**GET** `api/stats/gift-stats/{avatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `avatarId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getGiftStats({
+    avatarId: '<avatarId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getKarmaHistory`
+
+Get karma history for an avatar
+
+**GET** `api/stats/karma-history/{avatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `avatarId` | `Guid` |
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `limit` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getKarmaHistory({
+    avatarId: '<avatarId>',
+    limit: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getKarmaStats`
+
+Get karma statistics for an avatar
+
+**GET** `api/stats/karma-stats/{avatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `avatarId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getKarmaStats({
+    avatarId: '<avatarId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getKeyStats`
+
+Get key statistics for an avatar
+
+**GET** `api/stats/key-stats/{avatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `avatarId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getKeyStats({
+    avatarId: '<avatarId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getLeaderboardStats`
+
+Get leaderboard statistics for an avatar
+
+**GET** `api/stats/leaderboard-stats/{avatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `avatarId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getLeaderboardStats({
+    avatarId: '<avatarId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getStatsForCurrentLoggedInAvatar`
+
+Get comprehensive stats for the currently logged in avatar
+
+**GET** `api/stats/get-stats-for-current-logged-in-avatar`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getStatsForCurrentLoggedInAvatar({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getSystemStats`
+
+Get system-wide statistics
+
+**GET** `api/stats/system-stats`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Dictionary<string, object>` - a key/value map keyed by `string`, each value a `object`.
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.stats.getSystemStats({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+