@oasisomniverse/web4-api 2.0.0

package/docs/modules/Gifts.md

@@ -0,0 +1,306 @@
+# Gifts — `oasis.gifts`
+
+Source controller: [`GiftsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/GiftsController.cs)
+Route prefix: `api/gifts`
+6 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
+
+### `getGiftHistory`
+
+Get gift history for the current avatar
+
+**GET** `api/gifts/history`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `limit` | `int (optional)` |
+| `offset` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `GiftTransaction` (array)
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `GiftId` | `Guid` |
+| `FromAvatarId` | `Guid` |
+| `ToAvatarId` | `Guid` |
+| `TransactionType` | `GiftTransactionType` |
+| `Timestamp` | `DateTime` |
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.gifts.getGiftHistory({
+    limit: 1,
+    offset: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": [{ "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "GiftId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "FromAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ToAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "TransactionType": {  }, "Timestamp": "2026-01-01T00:00:00Z" }]
+}
+```
+
+---
+
+### `getGiftStats`
+
+Get gift statistics for the current avatar
+
+**GET** `api/gifts/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.gifts.getGiftStats({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "<string>": {} }
+}
+```
+
+---
+
+### `getMyGifts`
+
+Get all gifts for the current avatar
+
+**GET** `api/gifts/my-gifts`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `Gift` (array)
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `FromAvatarId` | `Guid` |
+| `ToAvatarId` | `Guid` |
+| `GiftType` | `GiftType` |
+| `Message` | `string` |
+| `SentAt` | `DateTime` |
+| `ReceivedAt` | `DateTime?` |
+| `OpenedAt` | `DateTime?` |
+| `IsReceived` | `bool` |
+| `IsOpened` | `bool` |
+| `Metadata` | `Dictionary<string, object>` |
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.gifts.getMyGifts({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": [{ "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "FromAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ToAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "GiftType": {  }, "Message": "example string", "SentAt": "2026-01-01T00:00:00Z", "ReceivedAt": "2026-01-01T00:00:00Z", "OpenedAt": "2026-01-01T00:00:00Z", "IsReceived": true, "IsOpened": true, "Metadata": { "<string>": {} } }]
+}
+```
+
+---
+
+### `openGift`
+
+Open a received gift
+
+**POST** `api/gifts/open-gift/{giftId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `giftId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `bool`
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.gifts.openGift({
+    giftId: '<giftId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": true
+}
+```
+
+---
+
+### `receiveGift`
+
+Receive a gift
+
+**POST** `api/gifts/receive-gift/{giftId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `giftId` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `bool`
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.gifts.receiveGift({
+    giftId: '<giftId>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": true
+}
+```
+
+---
+
+### `sendGift`
+
+Send a gift to another avatar
+
+**POST** `api/gifts/send-gift/{toAvatarId}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `toAvatarId` | `Guid` |
+
+**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: `Gift`
+
+| Field | Type |
+| --- | --- |
+| `Id` | `Guid` |
+| `FromAvatarId` | `Guid` |
+| `ToAvatarId` | `Guid` |
+| `GiftType` | `GiftType` |
+| `Message` | `string` |
+| `SentAt` | `DateTime` |
+| `ReceivedAt` | `DateTime?` |
+| `OpenedAt` | `DateTime?` |
+| `IsReceived` | `bool` |
+| `IsOpened` | `bool` |
+| `Metadata` | `Dictionary<string, object>` |
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.gifts.sendGift({
+    toAvatarId: '<toAvatarId>',
+    giftType: '<giftType>',
+    message: 'example string',
+    /* ...request body fields */
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "FromAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ToAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "GiftType": {  }, "Message": "example string", "SentAt": "2026-01-01T00:00:00Z", "ReceivedAt": "2026-01-01T00:00:00Z", "OpenedAt": "2026-01-01T00:00:00Z", "IsReceived": true, "IsOpened": true, "Metadata": { "<string>": {} } }
+}
+```
+

package/docs/modules/Health.md

@@ -0,0 +1,90 @@
+# Health — `oasis.health`
+
+Source controller: [`HealthController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HealthController.cs)
+Route prefix: `api/health`
+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
+
+### `get`
+
+Health check endpoint for Railway deployment
+
+**GET** `api/health`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `object`
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.health.get({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": {}
+}
+```
+
+---
+
+### `health`
+
+Health check endpoint for Railway deployment
+
+**GET** `api/health/health`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `object`
+
+**Example**
+
+```js
+const { isError, message, result } = await oasis.health.health({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": {}
+}
+```
+