@xfloor/floor-memory-sdk-ts 1.0.20 → 1.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -52
- package/dist/apis/{DefaultApi.d.ts → AuthApi.d.ts} +10 -56
- package/dist/apis/{DefaultApi.js → AuthApi.js} +28 -246
- package/dist/apis/EventApi.d.ts +16 -1
- package/dist/apis/EventApi.js +69 -0
- package/dist/apis/FloorApi.d.ts +99 -0
- package/dist/apis/FloorApi.js +460 -0
- package/dist/apis/index.d.ts +2 -4
- package/dist/apis/index.js +2 -4
- package/dist/models/{GetFloorInformation200Response.d.ts → EditFloor200Response.d.ts} +17 -17
- package/dist/models/{GetFloorInformation200Response.js → EditFloor200Response.js} +13 -13
- package/dist/models/SignInResponse.d.ts +48 -0
- package/dist/models/SignInResponse.js +61 -0
- package/dist/models/UserDetails.d.ts +6 -6
- package/dist/models/UserDetails.js +6 -6
- package/dist/models/{SignInWithEmail200ResponsePodInfo.d.ts → UserDetailsPodInfo.d.ts} +16 -16
- package/dist/models/{SignInWithEmail200ResponsePodInfo.js → UserDetailsPodInfo.js} +13 -13
- package/dist/models/{SignInWithEmail200ResponseProfile.d.ts → UserDetailsProfile.d.ts} +20 -20
- package/dist/models/{SignInWithEmail200ResponseProfile.js → UserDetailsProfile.js} +16 -16
- package/dist/models/UserDetailsProfileAvatar.d.ts +40 -0
- package/dist/models/{SignInWithEmail200ResponseProfileAvatar.js → UserDetailsProfileAvatar.js} +13 -13
- package/dist/models/index.d.ts +5 -5
- package/dist/models/index.js +5 -5
- package/package.json +1 -1
- package/dist/apis/EditFloorApi.d.ts +0 -38
- package/dist/apis/EditFloorApi.js +0 -175
- package/dist/apis/GetFloorInformationApi.d.ts +0 -35
- package/dist/apis/GetFloorInformationApi.js +0 -149
- package/dist/apis/GetRecentEventsApi.d.ts +0 -35
- package/dist/apis/GetRecentEventsApi.js +0 -151
- package/dist/models/SignInWithEmail200Response.d.ts +0 -48
- package/dist/models/SignInWithEmail200Response.js +0 -61
- package/dist/models/SignInWithEmail200ResponseProfileAvatar.d.ts +0 -40
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Floor Memory
|
|
3
|
-
* 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.
|
|
4
|
-
* - Memory and
|
|
5
|
-
* - 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.
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
* Contact: contact@ipomo.in
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
import * as runtime from '../runtime';
|
|
15
|
-
import type { GetRecentEvents200Response } from '../models/index';
|
|
16
|
-
export interface GetRecentEventsRequest {
|
|
17
|
-
floorId: string;
|
|
18
|
-
appId: string;
|
|
19
|
-
userId?: string;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
*
|
|
23
|
-
*/
|
|
24
|
-
export declare class GetRecentEventsApi extends runtime.BaseAPI {
|
|
25
|
-
/**
|
|
26
|
-
* 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`
|
|
27
|
-
* Recent Events
|
|
28
|
-
*/
|
|
29
|
-
getRecentEventsRaw(requestParameters: GetRecentEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRecentEvents200Response>>;
|
|
30
|
-
/**
|
|
31
|
-
* 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`
|
|
32
|
-
* Recent Events
|
|
33
|
-
*/
|
|
34
|
-
getRecentEvents(requestParameters: GetRecentEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRecentEvents200Response>;
|
|
35
|
-
}
|
|
@@ -1,151 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* Floor Memory
|
|
6
|
-
* 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.
|
|
7
|
-
* - Memory and
|
|
8
|
-
* - 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.
|
|
9
|
-
*
|
|
10
|
-
* The version of the OpenAPI document: 1.0.0
|
|
11
|
-
* Contact: contact@ipomo.in
|
|
12
|
-
*
|
|
13
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
14
|
-
* https://openapi-generator.tech
|
|
15
|
-
* Do not edit the class manually.
|
|
16
|
-
*/
|
|
17
|
-
var __extends = (this && this.__extends) || (function () {
|
|
18
|
-
var extendStatics = function (d, b) {
|
|
19
|
-
extendStatics = Object.setPrototypeOf ||
|
|
20
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
21
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
22
|
-
return extendStatics(d, b);
|
|
23
|
-
};
|
|
24
|
-
return function (d, b) {
|
|
25
|
-
if (typeof b !== "function" && b !== null)
|
|
26
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
27
|
-
extendStatics(d, b);
|
|
28
|
-
function __() { this.constructor = d; }
|
|
29
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
30
|
-
};
|
|
31
|
-
})();
|
|
32
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
33
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
34
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
35
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
36
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
37
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
38
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
39
|
-
});
|
|
40
|
-
};
|
|
41
|
-
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
42
|
-
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);
|
|
43
|
-
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
44
|
-
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
45
|
-
function step(op) {
|
|
46
|
-
if (f) throw new TypeError("Generator is already executing.");
|
|
47
|
-
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
48
|
-
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;
|
|
49
|
-
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
50
|
-
switch (op[0]) {
|
|
51
|
-
case 0: case 1: t = op; break;
|
|
52
|
-
case 4: _.label++; return { value: op[1], done: false };
|
|
53
|
-
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
54
|
-
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
55
|
-
default:
|
|
56
|
-
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
57
|
-
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
58
|
-
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
59
|
-
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
60
|
-
if (t[2]) _.ops.pop();
|
|
61
|
-
_.trys.pop(); continue;
|
|
62
|
-
}
|
|
63
|
-
op = body.call(thisArg, _);
|
|
64
|
-
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
65
|
-
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
66
|
-
}
|
|
67
|
-
};
|
|
68
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
69
|
-
exports.GetRecentEventsApi = void 0;
|
|
70
|
-
var runtime = require("../runtime");
|
|
71
|
-
var index_1 = require("../models/index");
|
|
72
|
-
/**
|
|
73
|
-
*
|
|
74
|
-
*/
|
|
75
|
-
var GetRecentEventsApi = /** @class */ (function (_super) {
|
|
76
|
-
__extends(GetRecentEventsApi, _super);
|
|
77
|
-
function GetRecentEventsApi() {
|
|
78
|
-
return _super !== null && _super.apply(this, arguments) || this;
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* 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`
|
|
82
|
-
* Recent Events
|
|
83
|
-
*/
|
|
84
|
-
GetRecentEventsApi.prototype.getRecentEventsRaw = function (requestParameters, initOverrides) {
|
|
85
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
86
|
-
var queryParameters, headerParameters, token, tokenString, urlPath, response;
|
|
87
|
-
return __generator(this, function (_a) {
|
|
88
|
-
switch (_a.label) {
|
|
89
|
-
case 0:
|
|
90
|
-
if (requestParameters['floorId'] == null) {
|
|
91
|
-
throw new runtime.RequiredError('floorId', 'Required parameter "floorId" was null or undefined when calling getRecentEvents().');
|
|
92
|
-
}
|
|
93
|
-
if (requestParameters['appId'] == null) {
|
|
94
|
-
throw new runtime.RequiredError('appId', 'Required parameter "appId" was null or undefined when calling getRecentEvents().');
|
|
95
|
-
}
|
|
96
|
-
queryParameters = {};
|
|
97
|
-
if (requestParameters['userId'] != null) {
|
|
98
|
-
queryParameters['user_id'] = requestParameters['userId'];
|
|
99
|
-
}
|
|
100
|
-
if (requestParameters['floorId'] != null) {
|
|
101
|
-
queryParameters['floor_id'] = requestParameters['floorId'];
|
|
102
|
-
}
|
|
103
|
-
if (requestParameters['appId'] != null) {
|
|
104
|
-
queryParameters['app_id'] = requestParameters['appId'];
|
|
105
|
-
}
|
|
106
|
-
headerParameters = {};
|
|
107
|
-
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
108
|
-
token = this.configuration.accessToken;
|
|
109
|
-
return [4 /*yield*/, token("bearer", [])];
|
|
110
|
-
case 1:
|
|
111
|
-
tokenString = _a.sent();
|
|
112
|
-
if (tokenString) {
|
|
113
|
-
headerParameters["Authorization"] = "Bearer ".concat(tokenString);
|
|
114
|
-
}
|
|
115
|
-
_a.label = 2;
|
|
116
|
-
case 2:
|
|
117
|
-
urlPath = "/api/memory/recent/events";
|
|
118
|
-
return [4 /*yield*/, this.request({
|
|
119
|
-
path: urlPath,
|
|
120
|
-
method: 'GET',
|
|
121
|
-
headers: headerParameters,
|
|
122
|
-
query: queryParameters,
|
|
123
|
-
}, initOverrides)];
|
|
124
|
-
case 3:
|
|
125
|
-
response = _a.sent();
|
|
126
|
-
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GetRecentEvents200ResponseFromJSON)(jsonValue); })];
|
|
127
|
-
}
|
|
128
|
-
});
|
|
129
|
-
});
|
|
130
|
-
};
|
|
131
|
-
/**
|
|
132
|
-
* 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`
|
|
133
|
-
* Recent Events
|
|
134
|
-
*/
|
|
135
|
-
GetRecentEventsApi.prototype.getRecentEvents = function (requestParameters, initOverrides) {
|
|
136
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
137
|
-
var response;
|
|
138
|
-
return __generator(this, function (_a) {
|
|
139
|
-
switch (_a.label) {
|
|
140
|
-
case 0: return [4 /*yield*/, this.getRecentEventsRaw(requestParameters, initOverrides)];
|
|
141
|
-
case 1:
|
|
142
|
-
response = _a.sent();
|
|
143
|
-
return [4 /*yield*/, response.value()];
|
|
144
|
-
case 2: return [2 /*return*/, _a.sent()];
|
|
145
|
-
}
|
|
146
|
-
});
|
|
147
|
-
});
|
|
148
|
-
};
|
|
149
|
-
return GetRecentEventsApi;
|
|
150
|
-
}(runtime.BaseAPI));
|
|
151
|
-
exports.GetRecentEventsApi = GetRecentEventsApi;
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Floor Memory
|
|
3
|
-
* 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.
|
|
4
|
-
* - Memory and
|
|
5
|
-
* - 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.
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
* Contact: contact@ipomo.in
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
import type { SignInWithEmail200ResponsePodInfo } from './SignInWithEmail200ResponsePodInfo';
|
|
15
|
-
import type { SignInWithEmail200ResponseProfile } from './SignInWithEmail200ResponseProfile';
|
|
16
|
-
/**
|
|
17
|
-
*
|
|
18
|
-
* @export
|
|
19
|
-
* @interface SignInWithEmail200Response
|
|
20
|
-
*/
|
|
21
|
-
export interface SignInWithEmail200Response {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {SignInWithEmail200ResponseProfile}
|
|
25
|
-
* @memberof SignInWithEmail200Response
|
|
26
|
-
*/
|
|
27
|
-
profile: SignInWithEmail200ResponseProfile;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {SignInWithEmail200ResponsePodInfo}
|
|
31
|
-
* @memberof SignInWithEmail200Response
|
|
32
|
-
*/
|
|
33
|
-
podInfo: SignInWithEmail200ResponsePodInfo;
|
|
34
|
-
/**
|
|
35
|
-
* App ID
|
|
36
|
-
* @type {string}
|
|
37
|
-
* @memberof SignInWithEmail200Response
|
|
38
|
-
*/
|
|
39
|
-
appId?: string;
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Check if a given object implements the SignInWithEmail200Response interface.
|
|
43
|
-
*/
|
|
44
|
-
export declare function instanceOfSignInWithEmail200Response(value: object): value is SignInWithEmail200Response;
|
|
45
|
-
export declare function SignInWithEmail200ResponseFromJSON(json: any): SignInWithEmail200Response;
|
|
46
|
-
export declare function SignInWithEmail200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignInWithEmail200Response;
|
|
47
|
-
export declare function SignInWithEmail200ResponseToJSON(json: any): SignInWithEmail200Response;
|
|
48
|
-
export declare function SignInWithEmail200ResponseToJSONTyped(value?: SignInWithEmail200Response | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* Floor Memory
|
|
6
|
-
* 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.
|
|
7
|
-
* - Memory and
|
|
8
|
-
* - 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.
|
|
9
|
-
*
|
|
10
|
-
* The version of the OpenAPI document: 1.0.0
|
|
11
|
-
* Contact: contact@ipomo.in
|
|
12
|
-
*
|
|
13
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
14
|
-
* https://openapi-generator.tech
|
|
15
|
-
* Do not edit the class manually.
|
|
16
|
-
*/
|
|
17
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.instanceOfSignInWithEmail200Response = instanceOfSignInWithEmail200Response;
|
|
19
|
-
exports.SignInWithEmail200ResponseFromJSON = SignInWithEmail200ResponseFromJSON;
|
|
20
|
-
exports.SignInWithEmail200ResponseFromJSONTyped = SignInWithEmail200ResponseFromJSONTyped;
|
|
21
|
-
exports.SignInWithEmail200ResponseToJSON = SignInWithEmail200ResponseToJSON;
|
|
22
|
-
exports.SignInWithEmail200ResponseToJSONTyped = SignInWithEmail200ResponseToJSONTyped;
|
|
23
|
-
var SignInWithEmail200ResponsePodInfo_1 = require("./SignInWithEmail200ResponsePodInfo");
|
|
24
|
-
var SignInWithEmail200ResponseProfile_1 = require("./SignInWithEmail200ResponseProfile");
|
|
25
|
-
/**
|
|
26
|
-
* Check if a given object implements the SignInWithEmail200Response interface.
|
|
27
|
-
*/
|
|
28
|
-
function instanceOfSignInWithEmail200Response(value) {
|
|
29
|
-
if (!('profile' in value) || value['profile'] === undefined)
|
|
30
|
-
return false;
|
|
31
|
-
if (!('podInfo' in value) || value['podInfo'] === undefined)
|
|
32
|
-
return false;
|
|
33
|
-
return true;
|
|
34
|
-
}
|
|
35
|
-
function SignInWithEmail200ResponseFromJSON(json) {
|
|
36
|
-
return SignInWithEmail200ResponseFromJSONTyped(json, false);
|
|
37
|
-
}
|
|
38
|
-
function SignInWithEmail200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
-
if (json == null) {
|
|
40
|
-
return json;
|
|
41
|
-
}
|
|
42
|
-
return {
|
|
43
|
-
'profile': (0, SignInWithEmail200ResponseProfile_1.SignInWithEmail200ResponseProfileFromJSON)(json['profile']),
|
|
44
|
-
'podInfo': (0, SignInWithEmail200ResponsePodInfo_1.SignInWithEmail200ResponsePodInfoFromJSON)(json['pod_info']),
|
|
45
|
-
'appId': json['app_id'] == null ? undefined : json['app_id'],
|
|
46
|
-
};
|
|
47
|
-
}
|
|
48
|
-
function SignInWithEmail200ResponseToJSON(json) {
|
|
49
|
-
return SignInWithEmail200ResponseToJSONTyped(json, false);
|
|
50
|
-
}
|
|
51
|
-
function SignInWithEmail200ResponseToJSONTyped(value, ignoreDiscriminator) {
|
|
52
|
-
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
53
|
-
if (value == null) {
|
|
54
|
-
return value;
|
|
55
|
-
}
|
|
56
|
-
return {
|
|
57
|
-
'profile': (0, SignInWithEmail200ResponseProfile_1.SignInWithEmail200ResponseProfileToJSON)(value['profile']),
|
|
58
|
-
'pod_info': (0, SignInWithEmail200ResponsePodInfo_1.SignInWithEmail200ResponsePodInfoToJSON)(value['podInfo']),
|
|
59
|
-
'app_id': value['appId'],
|
|
60
|
-
};
|
|
61
|
-
}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Floor Memory
|
|
3
|
-
* 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.
|
|
4
|
-
* - Memory and
|
|
5
|
-
* - 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.
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.0
|
|
8
|
-
* Contact: contact@ipomo.in
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
/**
|
|
15
|
-
* Profile Pick details
|
|
16
|
-
* @export
|
|
17
|
-
* @interface SignInWithEmail200ResponseProfileAvatar
|
|
18
|
-
*/
|
|
19
|
-
export interface SignInWithEmail200ResponseProfileAvatar {
|
|
20
|
-
/**
|
|
21
|
-
* Image URL
|
|
22
|
-
* @type {string}
|
|
23
|
-
* @memberof SignInWithEmail200ResponseProfileAvatar
|
|
24
|
-
*/
|
|
25
|
-
url: string;
|
|
26
|
-
/**
|
|
27
|
-
* Image ID
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof SignInWithEmail200ResponseProfileAvatar
|
|
30
|
-
*/
|
|
31
|
-
id: string;
|
|
32
|
-
}
|
|
33
|
-
/**
|
|
34
|
-
* Check if a given object implements the SignInWithEmail200ResponseProfileAvatar interface.
|
|
35
|
-
*/
|
|
36
|
-
export declare function instanceOfSignInWithEmail200ResponseProfileAvatar(value: object): value is SignInWithEmail200ResponseProfileAvatar;
|
|
37
|
-
export declare function SignInWithEmail200ResponseProfileAvatarFromJSON(json: any): SignInWithEmail200ResponseProfileAvatar;
|
|
38
|
-
export declare function SignInWithEmail200ResponseProfileAvatarFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignInWithEmail200ResponseProfileAvatar;
|
|
39
|
-
export declare function SignInWithEmail200ResponseProfileAvatarToJSON(json: any): SignInWithEmail200ResponseProfileAvatar;
|
|
40
|
-
export declare function SignInWithEmail200ResponseProfileAvatarToJSONTyped(value?: SignInWithEmail200ResponseProfileAvatar | null, ignoreDiscriminator?: boolean): any;
|