@xfloor/floor-memory-sdk-ts 1.0.0

package/dist/apis/GetFloorInformationApi.js

@@ -0,0 +1,144 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Floor Memory
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants.   This set of APIs are divided into two parts.  - Memory and  - Registration.   The developer has two ways of using the APIs for the app development. Developer can choose to the  Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: contact@ipomo.in
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetFloorInformationApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var GetFloorInformationApi = /** @class */ (function (_super) {
+    __extends(GetFloorInformationApi, _super);
+    function GetFloorInformationApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * This API returns the **basic profile information of a floor**. It is used to fetch all essential metadata required to **render a floor landing page, header, or navigation context**.  The response includes:  * Floor identity and type * Ownership information relative to the requesting user * Floor metadata (title, description, avatar) * List of blocks available in the floor * App association (for pod / developer use cases)  This API does **not** return posts or content; it only provides **structural and descriptive information** about the floor.  ---  ## Typical Use Cases  * Render floor header (title, logo, description) * Decide UI permissions (owner vs non-owner) * Display available blocks (Feeds, Blog, Quiz, etc.) * Pod discovery or developer-managed floor rendering * Lightweight floor metadata fetch before loading content  ---  ## Authorization & Context  * The API may be called by authenticated or unauthenticated users (depending on floor visibility). * The `is_owner` field is calculated **relative to the requesting user context** (if authenticated).  ---  ## Response Format  `application/json`  ---  ## Response Structure  ### Top-Level Fields  | Field        | Type                   | Description                                                      | | ------------ | ---------------------- | ---------------------------------------------------------------- | | `floor_id`   | String                 | Public, human-readable identifier of the floor                   | | `floor_uid`  | String                 | Internal unique identifier of the floor                          | | `title`      | String                 | Display title of the floor                                       | | `details`    | String                 | Short description or summary of the floor                        | | `floor_type` | String                 | Type of floor (`PUBLIC`, `PRIVATE`, `POD`)                       | | `is_owner`   | String (`\"0\"` / `\"1\"`) | Indicates whether the requesting user is the owner               | | `blocks`     | Array                  | List of blocks available in the floor                            | | `avatar`     | Object                 | Floor logo / avatar metadata                                     | | `app_id`     | String                 | Associated application ID (used mainly for pod/developer floors) |  ---  ## Ownership Indicator  ### `is_owner`  ```json \"is_owner\": \"0\" ```  | Value | Meaning                                   | | ----- | ----------------------------------------- | | `\"1\"` | Requesting user is the owner of the floor | | `\"0\"` | Requesting user is not the owner          |  This field is typically used by clients to:  * Enable or disable edit/settings UI * Show owner-only actions  ---  ## Blocks Object  ```json \"blocks\": [   {     \"BID\": \"1765960948723\",     \"type\": \"1\",     \"title\": \"Feeds\"   } ] ```  Each block represents a **content category or service** available inside the floor.  ### Block Fields  | Field   | Type   | Description                                           | | ------- | ------ | ----------------------------------------------------- | | `BID`   | String | Unique identifier of the block                        | | `type`  | String | Block type identifier (e.g., feed, blog, forum, quiz) | | `title` | String | Display name of the block                             |  ---  ## Avatar Object  ```json \"avatar\": {   \"id\": \"1767009204367\",   \"url\": \"https://...\" } ```  | Field | Type   | Description                    | | ----- | ------ | ------------------------------ | | `id`  | String | Media identifier of the avatar | | `url` | String | CDN URL of the floor logo      |  Used to render the floor’s profile image or banner.  ---  ## Floor Type  ```json \"floor_type\": \"POD\" ```  | Value     | Meaning                               | | --------- | ------------------------------------- | | `PUBLIC`  | Open floor visible to everyone        | | `PRIVATE` | Restricted floor                      | | `POD`     | Aggregated or developer-managed floor |  `POD` floors are often associated with an `app_id` and may aggregate or serve content programmatically.  ---  ## Sample Success Response  ```json {   \"is_owner\": \"0\",   \"blocks\": [     {       \"BID\": \"1765960948723\",       \"type\": \"1\",       \"title\": \"Feeds\"     }   ],   \"floor_uid\": \"1765960956967\",   \"floor_id\": \"raghupodfloor1\",   \"details\": \"raghu\",   \"avatar\": {     \"id\": \"1767009204367\",     \"url\": \"https://d2e5822u5ecuq8.cloudfront.net/room/1765960956967/logo/1765960956967.jpg\"   },   \"title\": \"raghu\",   \"floor_type\": \"POD\",   \"app_id\": \"1765949734005\" } ```  ---  ## Notes for Developers  * This is a **lightweight metadata API** and is safe to call frequently. * Use this API **before** loading posts or analytics. * `blocks` ordering can be used directly for navigation UI. * `floor_type` + `is_owner` together determine which UI actions are allowed.  ---  ## Common Error Scenarios  ### Floor Not Found  ```json {   \"status\": \"ERROR\",   \"message\": \"Floor not found\" } ```  ### Access Restricted  ```json {   \"status\": \"ERROR\",   \"message\": \"Access denied for this floor\" } ```  ---  ### Final Mental Model  > **This API answers: “What is this floor, who owns it, and what can I do here?”**
+     * Basic information of a floor
+     */
+    GetFloorInformationApi.prototype.getFloorInformationRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, urlPath, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['floorId'] == null) {
+                            throw new runtime.RequiredError('floorId', 'Required parameter "floorId" was null or undefined when calling getFloorInformation().');
+                        }
+                        queryParameters = {};
+                        if (requestParameters['userId'] != null) {
+                            queryParameters['user_id'] = requestParameters['userId'];
+                        }
+                        if (requestParameters['appId'] != null) {
+                            queryParameters['app_id'] = requestParameters['appId'];
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2:
+                        urlPath = "/api/memory/floor/info/{floor_id}";
+                        urlPath = urlPath.replace("{".concat("floor_id", "}"), encodeURIComponent(String(requestParameters['floorId'])));
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GetFloorInformation200ResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * This API returns the **basic profile information of a floor**. It is used to fetch all essential metadata required to **render a floor landing page, header, or navigation context**.  The response includes:  * Floor identity and type * Ownership information relative to the requesting user * Floor metadata (title, description, avatar) * List of blocks available in the floor * App association (for pod / developer use cases)  This API does **not** return posts or content; it only provides **structural and descriptive information** about the floor.  ---  ## Typical Use Cases  * Render floor header (title, logo, description) * Decide UI permissions (owner vs non-owner) * Display available blocks (Feeds, Blog, Quiz, etc.) * Pod discovery or developer-managed floor rendering * Lightweight floor metadata fetch before loading content  ---  ## Authorization & Context  * The API may be called by authenticated or unauthenticated users (depending on floor visibility). * The `is_owner` field is calculated **relative to the requesting user context** (if authenticated).  ---  ## Response Format  `application/json`  ---  ## Response Structure  ### Top-Level Fields  | Field        | Type                   | Description                                                      | | ------------ | ---------------------- | ---------------------------------------------------------------- | | `floor_id`   | String                 | Public, human-readable identifier of the floor                   | | `floor_uid`  | String                 | Internal unique identifier of the floor                          | | `title`      | String                 | Display title of the floor                                       | | `details`    | String                 | Short description or summary of the floor                        | | `floor_type` | String                 | Type of floor (`PUBLIC`, `PRIVATE`, `POD`)                       | | `is_owner`   | String (`\"0\"` / `\"1\"`) | Indicates whether the requesting user is the owner               | | `blocks`     | Array                  | List of blocks available in the floor                            | | `avatar`     | Object                 | Floor logo / avatar metadata                                     | | `app_id`     | String                 | Associated application ID (used mainly for pod/developer floors) |  ---  ## Ownership Indicator  ### `is_owner`  ```json \"is_owner\": \"0\" ```  | Value | Meaning                                   | | ----- | ----------------------------------------- | | `\"1\"` | Requesting user is the owner of the floor | | `\"0\"` | Requesting user is not the owner          |  This field is typically used by clients to:  * Enable or disable edit/settings UI * Show owner-only actions  ---  ## Blocks Object  ```json \"blocks\": [   {     \"BID\": \"1765960948723\",     \"type\": \"1\",     \"title\": \"Feeds\"   } ] ```  Each block represents a **content category or service** available inside the floor.  ### Block Fields  | Field   | Type   | Description                                           | | ------- | ------ | ----------------------------------------------------- | | `BID`   | String | Unique identifier of the block                        | | `type`  | String | Block type identifier (e.g., feed, blog, forum, quiz) | | `title` | String | Display name of the block                             |  ---  ## Avatar Object  ```json \"avatar\": {   \"id\": \"1767009204367\",   \"url\": \"https://...\" } ```  | Field | Type   | Description                    | | ----- | ------ | ------------------------------ | | `id`  | String | Media identifier of the avatar | | `url` | String | CDN URL of the floor logo      |  Used to render the floor’s profile image or banner.  ---  ## Floor Type  ```json \"floor_type\": \"POD\" ```  | Value     | Meaning                               | | --------- | ------------------------------------- | | `PUBLIC`  | Open floor visible to everyone        | | `PRIVATE` | Restricted floor                      | | `POD`     | Aggregated or developer-managed floor |  `POD` floors are often associated with an `app_id` and may aggregate or serve content programmatically.  ---  ## Sample Success Response  ```json {   \"is_owner\": \"0\",   \"blocks\": [     {       \"BID\": \"1765960948723\",       \"type\": \"1\",       \"title\": \"Feeds\"     }   ],   \"floor_uid\": \"1765960956967\",   \"floor_id\": \"raghupodfloor1\",   \"details\": \"raghu\",   \"avatar\": {     \"id\": \"1767009204367\",     \"url\": \"https://d2e5822u5ecuq8.cloudfront.net/room/1765960956967/logo/1765960956967.jpg\"   },   \"title\": \"raghu\",   \"floor_type\": \"POD\",   \"app_id\": \"1765949734005\" } ```  ---  ## Notes for Developers  * This is a **lightweight metadata API** and is safe to call frequently. * Use this API **before** loading posts or analytics. * `blocks` ordering can be used directly for navigation UI. * `floor_type` + `is_owner` together determine which UI actions are allowed.  ---  ## Common Error Scenarios  ### Floor Not Found  ```json {   \"status\": \"ERROR\",   \"message\": \"Floor not found\" } ```  ### Access Restricted  ```json {   \"status\": \"ERROR\",   \"message\": \"Access denied for this floor\" } ```  ---  ### Final Mental Model  > **This API answers: “What is this floor, who owns it, and what can I do here?”**
+     * Basic information of a floor
+     */
+    GetFloorInformationApi.prototype.getFloorInformation = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getFloorInformationRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return GetFloorInformationApi;
+}(runtime.BaseAPI));
+exports.GetFloorInformationApi = GetFloorInformationApi;

package/dist/apis/GetRecentEventsApi.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Floor Memory
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants.   This set of APIs are divided into two parts.  - Memory and  - Registration.   The developer has two ways of using the APIs for the app development. Developer can choose to the  Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: contact@ipomo.in
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { GetRecentEvents200Response } from '../models/index';
+export interface GetRecentEventsRequest {
+    floorId: string;
+    userId?: string;
+    appId?: string;
+}
+/**
+ *
+ */
+export declare class GetRecentEventsApi extends runtime.BaseAPI {
+    /**
+     * This API retrieves the **latest posts (events)** from a specified floor.  The behaviour of the API changes based on whether a **user ID** is provided:  * **If `user_id` is provided**   → The API returns **recent posts relevant to that user**, scoped within the given floor.   This includes posts from:    * Floors the user follows   * Floors created by the user   * Pod floors associated with the user (if applicable)  * **If `user_id` is NOT provided**   → The API returns the **most recent posts available in the specified floor**, without user-specific filtering.  This makes the API suitable for:  * Personalized activity feeds * Floor-level public timelines * Pod-based content aggregation * Developer-built pods and custom clients  ---  ## **Key Concepts**  * A **floor** represents a content space (independent floor, followed floor, or pod floor) * A **pod floor** may aggregate content across multiple related floors * Posts are returned **in reverse chronological order** (latest first) * Each post belongs to a specific **block** within the floor  ---  ## **Request Method**  `GET`  ---  ## **Request Parameters (Query Params)**  | Parameter Name | Type   | Required | Description                                                                                                                | | -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- | | `floor_id`     | String | **Yes**  | Floor identifier from which events should be fetched. Can be a pod floor ID, followed floor ID, or an independent floor ID | | `user_id`      | String | No       | If provided, returns posts relevant to the user within the given floor                                                     | | `app_id`       | String | No       | Identifier for external developers or pod-based applications consuming this API                                            |  ---  ## **Behavior Summary**  | Scenario               | Result                                    | | ---------------------- | ----------------------------------------- | | `floor_id` only        | Latest posts from the specified floor     | | `floor_id` + `user_id` | User-relevant posts within that floor     | | Pod floor ID           | Aggregated posts across pod-linked floors | | Independent floor ID   | Posts only from that floor                |  ---  ## **Response Format**  `application/json`  ---  ## **Response Structure**  ### **Top-Level Fields**  | Field        | Type   | Description                    | | ------------ | ------ | ------------------------------ | | `post_count` | String | Total number of posts returned | | `items`      | Array  | List of recent post objects    |  ---  ### **Post Object (`items[]`)**  | Field           | Type   | Description                                                               | | --------------- | ------ | ------------------------------------------------------------------------- | | `event_id`      | String | Unique identifier of the post/event                                       | | `block_type`    | String | Type of block where the post was created (e.g., blog, forum, audio, etc.) | | `block_id`      | String | Identifier of the block within the floor                                  | | `floor_uid`     | String | Floor identifier where the post belongs                                   | | `title`         | String | Title of the post (may be empty)                                          | | `text`          | String | Text or HTML content of the post                                          | | `media`         | Array  | Media objects (audio, image, etc.), if any                                | | `created_at_ms` | String | Post creation time in milliseconds (epoch)                                |  ---  ### **Author Object**  | Field       | Type   | Description                  | | ----------- | ------ | ---------------------------- | | `name`      | String | Display name of the author   | | `floor_uid` | String | Author’s floor/user handle   | | `avatar`    | Object | Author profile image details |  ---  ### **Media Object**  | Field  | Type   | Description                         | | ------ | ------ | ----------------------------------- | | `type` | String | Media type (e.g., `AUDIO`, `IMAGE`) | | `url`  | String | Public URL of the media file        |  ---  ## **Sample Success Response**  *(structure abbreviated for clarity)*  ```json {   \"post_count\": \"18\",   \"items\": [     {       \"event_id\": \"1766557274836\",       \"block_type\": \"0\",       \"title\": \"voice-note-1766557272764.wav\",       \"text\": \"You\",       \"created_at_ms\": \"1766557275000\",       \"author\": {         \"name\": \"MEGHANA G\",         \"floor_uid\": \"meghanag\",         \"avatar\": {           \"type\": \"IMAGE\",           \"url\": \"https://...\"         }       },       \"media\": [         {           \"type\": \"AUDIO\",           \"url\": \"https://...\"         }       ]     }   ] } ```  ---  ## **Notes**  * Posts may contain **plain text or HTML** * Media is optional and may be absent * Ordering is **latest first** * The API is read-only and does not require authentication by default * Access control (public/private floors) is enforced internally  ---  ## **Typical Use Cases**  * Floor activity feed * Pod-level dashboards * User-personalized timelines * Public floor landing pages * External developer pods using `app_id`
+     * Recent Events
+     */
+    getRecentEventsRaw(requestParameters: GetRecentEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRecentEvents200Response>>;
+    /**
+     * This API retrieves the **latest posts (events)** from a specified floor.  The behaviour of the API changes based on whether a **user ID** is provided:  * **If `user_id` is provided**   → The API returns **recent posts relevant to that user**, scoped within the given floor.   This includes posts from:    * Floors the user follows   * Floors created by the user   * Pod floors associated with the user (if applicable)  * **If `user_id` is NOT provided**   → The API returns the **most recent posts available in the specified floor**, without user-specific filtering.  This makes the API suitable for:  * Personalized activity feeds * Floor-level public timelines * Pod-based content aggregation * Developer-built pods and custom clients  ---  ## **Key Concepts**  * A **floor** represents a content space (independent floor, followed floor, or pod floor) * A **pod floor** may aggregate content across multiple related floors * Posts are returned **in reverse chronological order** (latest first) * Each post belongs to a specific **block** within the floor  ---  ## **Request Method**  `GET`  ---  ## **Request Parameters (Query Params)**  | Parameter Name | Type   | Required | Description                                                                                                                | | -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- | | `floor_id`     | String | **Yes**  | Floor identifier from which events should be fetched. Can be a pod floor ID, followed floor ID, or an independent floor ID | | `user_id`      | String | No       | If provided, returns posts relevant to the user within the given floor                                                     | | `app_id`       | String | No       | Identifier for external developers or pod-based applications consuming this API                                            |  ---  ## **Behavior Summary**  | Scenario               | Result                                    | | ---------------------- | ----------------------------------------- | | `floor_id` only        | Latest posts from the specified floor     | | `floor_id` + `user_id` | User-relevant posts within that floor     | | Pod floor ID           | Aggregated posts across pod-linked floors | | Independent floor ID   | Posts only from that floor                |  ---  ## **Response Format**  `application/json`  ---  ## **Response Structure**  ### **Top-Level Fields**  | Field        | Type   | Description                    | | ------------ | ------ | ------------------------------ | | `post_count` | String | Total number of posts returned | | `items`      | Array  | List of recent post objects    |  ---  ### **Post Object (`items[]`)**  | Field           | Type   | Description                                                               | | --------------- | ------ | ------------------------------------------------------------------------- | | `event_id`      | String | Unique identifier of the post/event                                       | | `block_type`    | String | Type of block where the post was created (e.g., blog, forum, audio, etc.) | | `block_id`      | String | Identifier of the block within the floor                                  | | `floor_uid`     | String | Floor identifier where the post belongs                                   | | `title`         | String | Title of the post (may be empty)                                          | | `text`          | String | Text or HTML content of the post                                          | | `media`         | Array  | Media objects (audio, image, etc.), if any                                | | `created_at_ms` | String | Post creation time in milliseconds (epoch)                                |  ---  ### **Author Object**  | Field       | Type   | Description                  | | ----------- | ------ | ---------------------------- | | `name`      | String | Display name of the author   | | `floor_uid` | String | Author’s floor/user handle   | | `avatar`    | Object | Author profile image details |  ---  ### **Media Object**  | Field  | Type   | Description                         | | ------ | ------ | ----------------------------------- | | `type` | String | Media type (e.g., `AUDIO`, `IMAGE`) | | `url`  | String | Public URL of the media file        |  ---  ## **Sample Success Response**  *(structure abbreviated for clarity)*  ```json {   \"post_count\": \"18\",   \"items\": [     {       \"event_id\": \"1766557274836\",       \"block_type\": \"0\",       \"title\": \"voice-note-1766557272764.wav\",       \"text\": \"You\",       \"created_at_ms\": \"1766557275000\",       \"author\": {         \"name\": \"MEGHANA G\",         \"floor_uid\": \"meghanag\",         \"avatar\": {           \"type\": \"IMAGE\",           \"url\": \"https://...\"         }       },       \"media\": [         {           \"type\": \"AUDIO\",           \"url\": \"https://...\"         }       ]     }   ] } ```  ---  ## **Notes**  * Posts may contain **plain text or HTML** * Media is optional and may be absent * Ordering is **latest first** * The API is read-only and does not require authentication by default * Access control (public/private floors) is enforced internally  ---  ## **Typical Use Cases**  * Floor activity feed * Pod-level dashboards * User-personalized timelines * Public floor landing pages * External developer pods using `app_id`
+     * Recent Events
+     */
+    getRecentEvents(requestParameters: GetRecentEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRecentEvents200Response>;
+}

package/dist/apis/GetRecentEventsApi.js

@@ -0,0 +1,146 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Floor Memory
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants.   This set of APIs are divided into two parts.  - Memory and  - Registration.   The developer has two ways of using the APIs for the app development. Developer can choose to the  Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: contact@ipomo.in
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetRecentEventsApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var GetRecentEventsApi = /** @class */ (function (_super) {
+    __extends(GetRecentEventsApi, _super);
+    function GetRecentEventsApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * This API retrieves the **latest posts (events)** from a specified floor.  The behaviour of the API changes based on whether a **user ID** is provided:  * **If `user_id` is provided**   → The API returns **recent posts relevant to that user**, scoped within the given floor.   This includes posts from:    * Floors the user follows   * Floors created by the user   * Pod floors associated with the user (if applicable)  * **If `user_id` is NOT provided**   → The API returns the **most recent posts available in the specified floor**, without user-specific filtering.  This makes the API suitable for:  * Personalized activity feeds * Floor-level public timelines * Pod-based content aggregation * Developer-built pods and custom clients  ---  ## **Key Concepts**  * A **floor** represents a content space (independent floor, followed floor, or pod floor) * A **pod floor** may aggregate content across multiple related floors * Posts are returned **in reverse chronological order** (latest first) * Each post belongs to a specific **block** within the floor  ---  ## **Request Method**  `GET`  ---  ## **Request Parameters (Query Params)**  | Parameter Name | Type   | Required | Description                                                                                                                | | -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- | | `floor_id`     | String | **Yes**  | Floor identifier from which events should be fetched. Can be a pod floor ID, followed floor ID, or an independent floor ID | | `user_id`      | String | No       | If provided, returns posts relevant to the user within the given floor                                                     | | `app_id`       | String | No       | Identifier for external developers or pod-based applications consuming this API                                            |  ---  ## **Behavior Summary**  | Scenario               | Result                                    | | ---------------------- | ----------------------------------------- | | `floor_id` only        | Latest posts from the specified floor     | | `floor_id` + `user_id` | User-relevant posts within that floor     | | Pod floor ID           | Aggregated posts across pod-linked floors | | Independent floor ID   | Posts only from that floor                |  ---  ## **Response Format**  `application/json`  ---  ## **Response Structure**  ### **Top-Level Fields**  | Field        | Type   | Description                    | | ------------ | ------ | ------------------------------ | | `post_count` | String | Total number of posts returned | | `items`      | Array  | List of recent post objects    |  ---  ### **Post Object (`items[]`)**  | Field           | Type   | Description                                                               | | --------------- | ------ | ------------------------------------------------------------------------- | | `event_id`      | String | Unique identifier of the post/event                                       | | `block_type`    | String | Type of block where the post was created (e.g., blog, forum, audio, etc.) | | `block_id`      | String | Identifier of the block within the floor                                  | | `floor_uid`     | String | Floor identifier where the post belongs                                   | | `title`         | String | Title of the post (may be empty)                                          | | `text`          | String | Text or HTML content of the post                                          | | `media`         | Array  | Media objects (audio, image, etc.), if any                                | | `created_at_ms` | String | Post creation time in milliseconds (epoch)                                |  ---  ### **Author Object**  | Field       | Type   | Description                  | | ----------- | ------ | ---------------------------- | | `name`      | String | Display name of the author   | | `floor_uid` | String | Author’s floor/user handle   | | `avatar`    | Object | Author profile image details |  ---  ### **Media Object**  | Field  | Type   | Description                         | | ------ | ------ | ----------------------------------- | | `type` | String | Media type (e.g., `AUDIO`, `IMAGE`) | | `url`  | String | Public URL of the media file        |  ---  ## **Sample Success Response**  *(structure abbreviated for clarity)*  ```json {   \"post_count\": \"18\",   \"items\": [     {       \"event_id\": \"1766557274836\",       \"block_type\": \"0\",       \"title\": \"voice-note-1766557272764.wav\",       \"text\": \"You\",       \"created_at_ms\": \"1766557275000\",       \"author\": {         \"name\": \"MEGHANA G\",         \"floor_uid\": \"meghanag\",         \"avatar\": {           \"type\": \"IMAGE\",           \"url\": \"https://...\"         }       },       \"media\": [         {           \"type\": \"AUDIO\",           \"url\": \"https://...\"         }       ]     }   ] } ```  ---  ## **Notes**  * Posts may contain **plain text or HTML** * Media is optional and may be absent * Ordering is **latest first** * The API is read-only and does not require authentication by default * Access control (public/private floors) is enforced internally  ---  ## **Typical Use Cases**  * Floor activity feed * Pod-level dashboards * User-personalized timelines * Public floor landing pages * External developer pods using `app_id`
+     * Recent Events
+     */
+    GetRecentEventsApi.prototype.getRecentEventsRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, urlPath, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['floorId'] == null) {
+                            throw new runtime.RequiredError('floorId', 'Required parameter "floorId" was null or undefined when calling getRecentEvents().');
+                        }
+                        queryParameters = {};
+                        if (requestParameters['userId'] != null) {
+                            queryParameters['user_id'] = requestParameters['userId'];
+                        }
+                        if (requestParameters['floorId'] != null) {
+                            queryParameters['floor_id'] = requestParameters['floorId'];
+                        }
+                        if (requestParameters['appId'] != null) {
+                            queryParameters['app_id'] = requestParameters['appId'];
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2:
+                        urlPath = "/api/memory/recent/events";
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GetRecentEvents200ResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * This API retrieves the **latest posts (events)** from a specified floor.  The behaviour of the API changes based on whether a **user ID** is provided:  * **If `user_id` is provided**   → The API returns **recent posts relevant to that user**, scoped within the given floor.   This includes posts from:    * Floors the user follows   * Floors created by the user   * Pod floors associated with the user (if applicable)  * **If `user_id` is NOT provided**   → The API returns the **most recent posts available in the specified floor**, without user-specific filtering.  This makes the API suitable for:  * Personalized activity feeds * Floor-level public timelines * Pod-based content aggregation * Developer-built pods and custom clients  ---  ## **Key Concepts**  * A **floor** represents a content space (independent floor, followed floor, or pod floor) * A **pod floor** may aggregate content across multiple related floors * Posts are returned **in reverse chronological order** (latest first) * Each post belongs to a specific **block** within the floor  ---  ## **Request Method**  `GET`  ---  ## **Request Parameters (Query Params)**  | Parameter Name | Type   | Required | Description                                                                                                                | | -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- | | `floor_id`     | String | **Yes**  | Floor identifier from which events should be fetched. Can be a pod floor ID, followed floor ID, or an independent floor ID | | `user_id`      | String | No       | If provided, returns posts relevant to the user within the given floor                                                     | | `app_id`       | String | No       | Identifier for external developers or pod-based applications consuming this API                                            |  ---  ## **Behavior Summary**  | Scenario               | Result                                    | | ---------------------- | ----------------------------------------- | | `floor_id` only        | Latest posts from the specified floor     | | `floor_id` + `user_id` | User-relevant posts within that floor     | | Pod floor ID           | Aggregated posts across pod-linked floors | | Independent floor ID   | Posts only from that floor                |  ---  ## **Response Format**  `application/json`  ---  ## **Response Structure**  ### **Top-Level Fields**  | Field        | Type   | Description                    | | ------------ | ------ | ------------------------------ | | `post_count` | String | Total number of posts returned | | `items`      | Array  | List of recent post objects    |  ---  ### **Post Object (`items[]`)**  | Field           | Type   | Description                                                               | | --------------- | ------ | ------------------------------------------------------------------------- | | `event_id`      | String | Unique identifier of the post/event                                       | | `block_type`    | String | Type of block where the post was created (e.g., blog, forum, audio, etc.) | | `block_id`      | String | Identifier of the block within the floor                                  | | `floor_uid`     | String | Floor identifier where the post belongs                                   | | `title`         | String | Title of the post (may be empty)                                          | | `text`          | String | Text or HTML content of the post                                          | | `media`         | Array  | Media objects (audio, image, etc.), if any                                | | `created_at_ms` | String | Post creation time in milliseconds (epoch)                                |  ---  ### **Author Object**  | Field       | Type   | Description                  | | ----------- | ------ | ---------------------------- | | `name`      | String | Display name of the author   | | `floor_uid` | String | Author’s floor/user handle   | | `avatar`    | Object | Author profile image details |  ---  ### **Media Object**  | Field  | Type   | Description                         | | ------ | ------ | ----------------------------------- | | `type` | String | Media type (e.g., `AUDIO`, `IMAGE`) | | `url`  | String | Public URL of the media file        |  ---  ## **Sample Success Response**  *(structure abbreviated for clarity)*  ```json {   \"post_count\": \"18\",   \"items\": [     {       \"event_id\": \"1766557274836\",       \"block_type\": \"0\",       \"title\": \"voice-note-1766557272764.wav\",       \"text\": \"You\",       \"created_at_ms\": \"1766557275000\",       \"author\": {         \"name\": \"MEGHANA G\",         \"floor_uid\": \"meghanag\",         \"avatar\": {           \"type\": \"IMAGE\",           \"url\": \"https://...\"         }       },       \"media\": [         {           \"type\": \"AUDIO\",           \"url\": \"https://...\"         }       ]     }   ] } ```  ---  ## **Notes**  * Posts may contain **plain text or HTML** * Media is optional and may be absent * Ordering is **latest first** * The API is read-only and does not require authentication by default * Access control (public/private floors) is enforced internally  ---  ## **Typical Use Cases**  * Floor activity feed * Pod-level dashboards * User-personalized timelines * Public floor landing pages * External developer pods using `app_id`
+     * Recent Events
+     */
+    GetRecentEventsApi.prototype.getRecentEvents = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getRecentEventsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return GetRecentEventsApi;
+}(runtime.BaseAPI));
+exports.GetRecentEventsApi = GetRecentEventsApi;

package/dist/apis/QueryApi.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Floor Memory
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants.   This set of APIs are divided into two parts.  - Memory and  - Registration.   The developer has two ways of using the APIs for the app development. Developer can choose to the  Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: contact@ipomo.in
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { QueryRequest, QueryResponse } from '../models/index';
+export interface QueryOperationRequest {
+    queryRequest: QueryRequest;
+}
+/**
+ *
+ */
+export declare class QueryApi extends runtime.BaseAPI {
+    /**
+     * # **Conversational Query API** This is the **core API** of xfloor.  It accepts a natural language query and returns a conversational response derived from: - Content ingested into the specified Floor - The user’s prior conversation history (if provided) - Relevant metadata and context  This API is designed for **multi-turn conversations** and can be used to build: - AI chatbots - Knowledge assistants - Floor-specific copilots  This API enables **conversational, context-aware querying** over data stored within xfloor.  It accepts a natural language query (for example, *“What options do I have in your institute?”*) and returns relevant information derived from the specified floors and their associated content.  The API is designed for **multi-turn conversations**. Follow-up questions from the same user automatically build upon prior context, allowing the system to refine, expand, or clarify results across successive calls.  ---  ## **Core Capabilities**  * Interprets **natural language queries** * Retrieves relevant information from one or more floors * Applies **time-, type-, and tag-based filters** * Supports **Top-K retrieval** for result control * Optionally includes metadata with responses * Can generate **summarized responses** when requested * Maintains **conversation continuity** across multiple queries from the same user  ---  ## **Authentication & Identity**  * A valid `user_id` is **required** * User authentication is assumed to be completed **before** calling this API * `app_id` identifies the calling application context * Conversational continuity is maintained **per `user_id`**  > **Note:** All queries from the same `user_id` are treated as part of a single conversational context unless explicitly reset by the application.  ---  ## **Request Contract**  ### **HTTP Method**  `POST`  ### **Content-Type**  ``` application/json ```  > **Important:** > This API accepts **JSON requests only**. > `multipart/form-data` is **not supported**.  ---  ## **Request Body (JSON)**  ### **Field Descriptions**  | Field               | Type                    | Required | Description                                                                                    | | ------------------- | ----------------------- | -------- | ---------------------------------------------------------------------------------------------- | | `user_id`           | string                  | Yes      | Unique xfloor user identifier. Used to maintain conversational continuity and personalization. | | `query`             | string                  | Yes      | Natural language query provided by the user.                                                   | | `floor_ids`         | array of strings        | Yes      | List of floor identifiers that define the search scope. Must be provided as a JSON array.      | | `filters`           | object                  | Optional | Additional constraints to narrow search results.                                               | | `filters.time_from` | string (ISO-8601)       | Optional | Start timestamp for filtering content by creation or update time.                              | | `filters.time_to`   | string (ISO-8601)       | Optional | End timestamp for filtering content by creation or update time.                                | | `filters.types`     | array of strings        | Optional | Content types to include (e.g., `post`, `blog`, `forum`).                                      | | `filters.tags`      | array of strings        | Optional | Tags used to further refine results.                                                           | | `k`                 | integer                 | Optional | Maximum number of results to retrieve (Top-K). Defaults to system-defined behavior if omitted. | | `include_metadata`  | string (`\"0\"` or `\"1\"`) | Optional | Whether to include metadata (source, timestamps, tags) in the response. Defaults to `\"0\"`.     | | `summary_needed`    | string (`\"0\"` or `\"1\"`) | Optional | Whether a summarized conversational answer should be generated. Defaults to `\"0\"`.             | | `app_id`            | string                  | Optional | Identifies the application invoking the API. Useful for multi-app integrations.                |  ---  ### **Important Encoding Rules**  * `floor_ids` **must** be provided as a JSON array    ```json   \"floor_ids\": [\"floor_1\", \"floor_2\"]   ``` * Boolean-style flags (`include_metadata`, `summary_needed`) are encoded as **string values**: `\"0\"` or `\"1\"` * `filters` must be provided as a **JSON object**, not a string  ---  ### **Canonical Request Example**  ```json {   \"user_id\": \"xf_user_123\",   \"query\": \"What options do I have in your institute?\",   \"floor_ids\": [\"institute_floor\"],   \"filters\": {     \"types\": [\"post\", \"blog\"],     \"tags\": [\"admissions\"]   },   \"k\": 5,   \"include_metadata\": \"1\",   \"summary_needed\": \"1\",   \"app_id\": \"student_portal\" } ```  ---  ## **Behavior**  1. The query is analyzed using conversational and semantic understanding. 2. Relevant content is retrieved from the specified floors. 3. Filters (time, type, tags) are applied if provided. 4. Results are ranked and limited based on `k`. 5. If `summary_needed = \"1\"`, a synthesized conversational summary is generated. 6. If `include_metadata = \"1\"`, metadata is attached to each result item. 7. The response is returned in a conversational format suitable for follow-up questions.  ---  ## **Response Contract**  ### **High-Level Response Structure**  ```json {   \"answer\": \"Assistant-generated conversational response\",   \"items\": [     {       \"id\": \"content_id\",       \"type\": \"post\",       \"text\": \"Original content snippet\",       \"metadata\": { }     }   ] } ```  ---  ### **Response Field Semantics**  | Field              | Always Present     | Description                                 | Rendering Guidance     | | ------------------ | ------------------ | ------------------------------------------- | ---------------------- | | `answer`           | Yes                | Assistant-generated conversational response | **Render prominently** | | `items`            | Yes (may be empty) | List of matched content used for grounding  | Render optionally      | | `items[].metadata` | Conditional        | Included only if `include_metadata = \"1\"`   | Render on demand       |  > **No-Result Case:** > If no relevant content is found, `items` will be an empty array and `answer` will contain a conversational fallback response.  ---  ## **Conversation Continuity**  * Conversation state is maintained **per `user_id`** * Follow-up queries automatically reference prior context * The API does not require explicit conversation IDs * Applications may reset conversation context by using a new `user_id`  ---  ## **Error Handling**  The API may return errors in the following cases:  * Missing or invalid `user_id` * Empty or unsupported `query` * Invalid or inaccessible `floor_ids` * Authorization or application context errors * Internal processing failures  All errors are returned with appropriate HTTP status codes and descriptive messages.  ---  ## **Typical Use Case Flow**  1. User asks an initial question    *“What options do I have in your institute?”* 2. Application calls `/agent/memory/query` 3. Results are displayed to the user 4. User asks a follow-up    *“Which ones are available on weekends?”* 5. Application calls the same API again with the new query 6. Conversation continues seamlessly using prior context  ---  ## **One-Line Summary**  > Executes a conversational query over xfloor content, returning context-aware, filtered, and optionally summarized results with support for multi-turn interactions.
+     * Query (Primary API)
+     */
+    queryRaw(requestParameters: QueryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryResponse>>;
+    /**
+     * # **Conversational Query API** This is the **core API** of xfloor.  It accepts a natural language query and returns a conversational response derived from: - Content ingested into the specified Floor - The user’s prior conversation history (if provided) - Relevant metadata and context  This API is designed for **multi-turn conversations** and can be used to build: - AI chatbots - Knowledge assistants - Floor-specific copilots  This API enables **conversational, context-aware querying** over data stored within xfloor.  It accepts a natural language query (for example, *“What options do I have in your institute?”*) and returns relevant information derived from the specified floors and their associated content.  The API is designed for **multi-turn conversations**. Follow-up questions from the same user automatically build upon prior context, allowing the system to refine, expand, or clarify results across successive calls.  ---  ## **Core Capabilities**  * Interprets **natural language queries** * Retrieves relevant information from one or more floors * Applies **time-, type-, and tag-based filters** * Supports **Top-K retrieval** for result control * Optionally includes metadata with responses * Can generate **summarized responses** when requested * Maintains **conversation continuity** across multiple queries from the same user  ---  ## **Authentication & Identity**  * A valid `user_id` is **required** * User authentication is assumed to be completed **before** calling this API * `app_id` identifies the calling application context * Conversational continuity is maintained **per `user_id`**  > **Note:** All queries from the same `user_id` are treated as part of a single conversational context unless explicitly reset by the application.  ---  ## **Request Contract**  ### **HTTP Method**  `POST`  ### **Content-Type**  ``` application/json ```  > **Important:** > This API accepts **JSON requests only**. > `multipart/form-data` is **not supported**.  ---  ## **Request Body (JSON)**  ### **Field Descriptions**  | Field               | Type                    | Required | Description                                                                                    | | ------------------- | ----------------------- | -------- | ---------------------------------------------------------------------------------------------- | | `user_id`           | string                  | Yes      | Unique xfloor user identifier. Used to maintain conversational continuity and personalization. | | `query`             | string                  | Yes      | Natural language query provided by the user.                                                   | | `floor_ids`         | array of strings        | Yes      | List of floor identifiers that define the search scope. Must be provided as a JSON array.      | | `filters`           | object                  | Optional | Additional constraints to narrow search results.                                               | | `filters.time_from` | string (ISO-8601)       | Optional | Start timestamp for filtering content by creation or update time.                              | | `filters.time_to`   | string (ISO-8601)       | Optional | End timestamp for filtering content by creation or update time.                                | | `filters.types`     | array of strings        | Optional | Content types to include (e.g., `post`, `blog`, `forum`).                                      | | `filters.tags`      | array of strings        | Optional | Tags used to further refine results.                                                           | | `k`                 | integer                 | Optional | Maximum number of results to retrieve (Top-K). Defaults to system-defined behavior if omitted. | | `include_metadata`  | string (`\"0\"` or `\"1\"`) | Optional | Whether to include metadata (source, timestamps, tags) in the response. Defaults to `\"0\"`.     | | `summary_needed`    | string (`\"0\"` or `\"1\"`) | Optional | Whether a summarized conversational answer should be generated. Defaults to `\"0\"`.             | | `app_id`            | string                  | Optional | Identifies the application invoking the API. Useful for multi-app integrations.                |  ---  ### **Important Encoding Rules**  * `floor_ids` **must** be provided as a JSON array    ```json   \"floor_ids\": [\"floor_1\", \"floor_2\"]   ``` * Boolean-style flags (`include_metadata`, `summary_needed`) are encoded as **string values**: `\"0\"` or `\"1\"` * `filters` must be provided as a **JSON object**, not a string  ---  ### **Canonical Request Example**  ```json {   \"user_id\": \"xf_user_123\",   \"query\": \"What options do I have in your institute?\",   \"floor_ids\": [\"institute_floor\"],   \"filters\": {     \"types\": [\"post\", \"blog\"],     \"tags\": [\"admissions\"]   },   \"k\": 5,   \"include_metadata\": \"1\",   \"summary_needed\": \"1\",   \"app_id\": \"student_portal\" } ```  ---  ## **Behavior**  1. The query is analyzed using conversational and semantic understanding. 2. Relevant content is retrieved from the specified floors. 3. Filters (time, type, tags) are applied if provided. 4. Results are ranked and limited based on `k`. 5. If `summary_needed = \"1\"`, a synthesized conversational summary is generated. 6. If `include_metadata = \"1\"`, metadata is attached to each result item. 7. The response is returned in a conversational format suitable for follow-up questions.  ---  ## **Response Contract**  ### **High-Level Response Structure**  ```json {   \"answer\": \"Assistant-generated conversational response\",   \"items\": [     {       \"id\": \"content_id\",       \"type\": \"post\",       \"text\": \"Original content snippet\",       \"metadata\": { }     }   ] } ```  ---  ### **Response Field Semantics**  | Field              | Always Present     | Description                                 | Rendering Guidance     | | ------------------ | ------------------ | ------------------------------------------- | ---------------------- | | `answer`           | Yes                | Assistant-generated conversational response | **Render prominently** | | `items`            | Yes (may be empty) | List of matched content used for grounding  | Render optionally      | | `items[].metadata` | Conditional        | Included only if `include_metadata = \"1\"`   | Render on demand       |  > **No-Result Case:** > If no relevant content is found, `items` will be an empty array and `answer` will contain a conversational fallback response.  ---  ## **Conversation Continuity**  * Conversation state is maintained **per `user_id`** * Follow-up queries automatically reference prior context * The API does not require explicit conversation IDs * Applications may reset conversation context by using a new `user_id`  ---  ## **Error Handling**  The API may return errors in the following cases:  * Missing or invalid `user_id` * Empty or unsupported `query` * Invalid or inaccessible `floor_ids` * Authorization or application context errors * Internal processing failures  All errors are returned with appropriate HTTP status codes and descriptive messages.  ---  ## **Typical Use Case Flow**  1. User asks an initial question    *“What options do I have in your institute?”* 2. Application calls `/agent/memory/query` 3. Results are displayed to the user 4. User asks a follow-up    *“Which ones are available on weekends?”* 5. Application calls the same API again with the new query 6. Conversation continues seamlessly using prior context  ---  ## **One-Line Summary**  > Executes a conversational query over xfloor content, returning context-aware, filtered, and optionally summarized results with support for multi-turn interactions.
+     * Query (Primary API)
+     */
+    query(requestParameters: QueryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryResponse>;
+}