@xfloor/floor-memory-sdk-js 1.0.4 → 1.0.5
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 +155 -36
- package/dist/ApiClient.js +5 -3
- package/dist/api/DefaultApi.js +214 -9
- package/dist/api/EditFloorApi.js +4 -2
- package/dist/api/EventApi.js +5 -3
- package/dist/api/GetFloorInformationApi.js +5 -3
- package/dist/api/GetRecentEventsApi.js +4 -2
- package/dist/api/QueryApi.js +4 -2
- package/dist/index.js +112 -0
- package/dist/model/BlockDetails.js +16 -14
- package/dist/model/ChangePassword200Response.js +4 -2
- package/dist/model/ConversationThreads200Response.js +146 -0
- package/dist/model/ConversationThreads200ResponseThreadsInner.js +142 -0
- package/dist/model/EditFloor400Response.js +4 -2
- package/dist/model/EditFloor400ResponseError.js +4 -2
- package/dist/model/Event400Response.js +4 -2
- package/dist/model/Event400ResponseError.js +4 -2
- package/dist/model/EventResponse.js +4 -2
- package/dist/model/FloorInfo.js +4 -2
- package/dist/model/GetConversations200Response.js +160 -0
- package/dist/model/GetConversations200ResponseConversationInner.js +107 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistant.js +228 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInner.js +141 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.js +212 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.js +128 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.js +128 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.js +188 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.js +218 -0
- package/dist/model/GetConversations200ResponseConversationInnerUser.js +172 -0
- package/dist/model/GetConversations200ResponseConversationInnerUserContext.js +170 -0
- package/dist/model/GetFloorInformation200Response.js +4 -2
- package/dist/model/GetRecentEvents200Response.js +4 -2
- package/dist/model/GetRecentEvents200ResponseItemsInner.js +4 -2
- package/dist/model/GetRecentEvents200ResponseItemsInnerAuthor.js +4 -2
- package/dist/model/GetRecentEvents400Response.js +4 -2
- package/dist/model/GetRecentEvents400ResponseError.js +4 -2
- package/dist/model/Media.js +4 -2
- package/dist/model/Model400ErrorCode.js +4 -2
- package/dist/model/PostAdd.js +175 -0
- package/dist/model/Query422Response.js +4 -2
- package/dist/model/Query422ResponseError.js +4 -2
- package/dist/model/QueryRequest.js +4 -2
- package/dist/model/QueryRequestFilters.js +4 -2
- package/dist/model/QueryResponse.js +4 -2
- package/dist/model/QueryResponseItemsInner.js +4 -2
- package/dist/model/ResetPassword200Response.js +4 -2
- package/dist/model/ResetPassword400Response.js +4 -2
- package/dist/model/SendSignInValidationCode200Response.js +143 -0
- package/dist/model/SendValidationCode200Response.js +4 -2
- package/dist/model/SendValidationCodeRequest.js +4 -2
- package/dist/model/SignInWithEmail200Response.js +4 -2
- package/dist/model/SignInWithEmail200ResponsePodInfo.js +4 -2
- package/dist/model/SignInWithEmail200ResponseProfile.js +4 -2
- package/dist/model/SignInWithEmail200ResponseProfileAvatar.js +4 -2
- package/dist/model/SignUp200Response.js +4 -2
- package/dist/model/SignUpResponse.js +4 -2
- package/dist/model/Threads.js +142 -0
- package/dist/model/UserDetails.js +4 -2
- package/dist/model/ValidateCode400Response.js +4 -2
- package/dist/model/ValidateCode400ResponseError.js +4 -2
- package/dist/model/ValidateCode412Response.js +4 -2
- package/dist/model/ValidateCodeRequest.js +4 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,16 +7,16 @@ This set of APIs are divided into two parts.
|
|
|
7
7
|
- Memory and
|
|
8
8
|
- Registration.
|
|
9
9
|
|
|
10
|
-
The developer has two ways of using the APIs for the app development. Developer can choose to the
|
|
10
|
+
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.
|
|
11
11
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
12
12
|
|
|
13
13
|
- API version: 1.0.0
|
|
14
|
-
- Package version: 1.0.
|
|
14
|
+
- Package version: 1.0.5
|
|
15
15
|
- Generator version: 7.18.0
|
|
16
16
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
17
17
|
For more information, please visit [https://xfloor.ai/ipomo/blog1551084548304/](https://xfloor.ai/ipomo/blog1551084548304/)
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
### Installation
|
|
20
20
|
|
|
21
21
|
### For [Node.js](https://nodejs.org/)
|
|
22
22
|
|
|
@@ -101,21 +101,19 @@ module: {
|
|
|
101
101
|
}
|
|
102
102
|
```
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
### Getting Started
|
|
105
105
|
|
|
106
106
|
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
107
107
|
|
|
108
108
|
```javascript
|
|
109
109
|
var XfloorFloorMemorySdkJs = require('@xfloor/floor-memory-sdk-js');
|
|
110
110
|
|
|
111
|
-
var defaultClient = XfloorFloorMemorySdkJs.ApiClient.instance;
|
|
112
|
-
// Configure Bearer access token for authorization: bearer
|
|
113
|
-
var bearer = defaultClient.authentications['bearer'];
|
|
114
|
-
bearer.accessToken = "YOUR ACCESS TOKEN"
|
|
115
111
|
|
|
116
112
|
var api = new XfloorFloorMemorySdkJs.DefaultApi()
|
|
117
|
-
var
|
|
118
|
-
var
|
|
113
|
+
var inputInfo = "inputInfo_example"; // {String}
|
|
114
|
+
var opts = {
|
|
115
|
+
'icon': "/path/to/file" // {File}
|
|
116
|
+
};
|
|
119
117
|
var callback = function(error, data, response) {
|
|
120
118
|
if (error) {
|
|
121
119
|
console.error(error);
|
|
@@ -123,46 +121,164 @@ var callback = function(error, data, response) {
|
|
|
123
121
|
console.log('API called successfully. Returned data: ' + data);
|
|
124
122
|
}
|
|
125
123
|
};
|
|
126
|
-
api.
|
|
124
|
+
api.apiDeveloperCreateAppPost(inputInfo, opts, callback);
|
|
127
125
|
|
|
128
126
|
```
|
|
129
127
|
|
|
130
|
-
|
|
128
|
+
### Documentation for API Endpoints
|
|
131
129
|
|
|
132
130
|
All URIs are relative to *https://appfloor.in*
|
|
133
131
|
|
|
134
|
-
Class
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
*XfloorFloorMemorySdkJs.
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
132
|
+
Class
|
|
133
|
+
|
|
134
|
+
| Method | HTTP request |
|
|
135
|
+
|
|
136
|
+
Description
|
|
137
|
+
------------
|
|
138
|
+
|
|
139
|
+
| ------------- | ------------- |
|
|
140
|
+
|
|
141
|
+
-------------
|
|
142
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
143
|
+
|
|
144
|
+
| [**apiDeveloperCreateAppPost**](docs/DefaultApi.md#apiDeveloperCreateAppPost) | **POST** /api/developer/create/app |
|
|
145
|
+
|
|
146
|
+
Create App
|
|
147
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
148
|
+
|
|
149
|
+
| [**apiDeveloperModifyAppPost**](docs/DefaultApi.md#apiDeveloperModifyAppPost) | **POST** /api/developer/modify/app |
|
|
150
|
+
|
|
151
|
+
Modify Floorpod App
|
|
152
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
153
|
+
|
|
154
|
+
| [**changeEmail**](docs/DefaultApi.md#changeEmail) | **POST** /auth-service/change/email |
|
|
155
|
+
|
|
156
|
+
Change email ID
|
|
157
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
158
|
+
|
|
159
|
+
| [**changeMobileNumber**](docs/DefaultApi.md#changeMobileNumber) | **POST** /auth-service/change/mobile |
|
|
160
|
+
|
|
161
|
+
Change Mobile number
|
|
162
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
163
|
+
|
|
164
|
+
| [**changePassword**](docs/DefaultApi.md#changePassword) | **POST** /auth-service/password/change |
|
|
165
|
+
|
|
166
|
+
Change Password
|
|
167
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
168
|
+
|
|
169
|
+
| [**conversationThreads**](docs/DefaultApi.md#conversationThreads) | **GET** /agent/memory/threads |
|
|
170
|
+
|
|
171
|
+
Get the conversational threads
|
|
172
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
173
|
+
|
|
174
|
+
| [**getConversations**](docs/DefaultApi.md#getConversations) | **GET** /agent/memory/conversations |
|
|
175
|
+
|
|
176
|
+
Conversations
|
|
177
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
178
|
+
|
|
179
|
+
| [**makeFloorPrivate**](docs/DefaultApi.md#makeFloorPrivate) | **POST** /api/memory/make/floor/private |
|
|
180
|
+
|
|
181
|
+
Make floor Private
|
|
182
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
183
|
+
|
|
184
|
+
| [**makeFloorPublic**](docs/DefaultApi.md#makeFloorPublic) | **POST** /api/memory/make/floor/public |
|
|
185
|
+
|
|
186
|
+
Make floor public
|
|
187
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
188
|
+
|
|
189
|
+
| [**registerExternalUserIdentity**](docs/DefaultApi.md#registerExternalUserIdentity) | **POST** /memory/identity/external-user |
|
|
190
|
+
|
|
191
|
+
External User Registration
|
|
192
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
193
|
+
|
|
194
|
+
| [**renameFloor**](docs/DefaultApi.md#renameFloor) | **POST** /api/memory/change/floor/id |
|
|
195
|
+
|
|
196
|
+
Rename floor
|
|
197
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
198
|
+
|
|
199
|
+
| [**resetPassword**](docs/DefaultApi.md#resetPassword) | **POST** /auth-service/password/reset |
|
|
200
|
+
|
|
201
|
+
Reset Password
|
|
202
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
203
|
+
|
|
204
|
+
| [**sendSignInValidationCode**](docs/DefaultApi.md#sendSignInValidationCode) | **POST** /auth-service/send/sign/in/validation/code |
|
|
205
|
+
|
|
206
|
+
Send Sign-In Validation Code (OTP)
|
|
207
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
208
|
+
|
|
209
|
+
| [**sendValidationCode**](docs/DefaultApi.md#sendValidationCode) | **POST** /auth-service/send/validation/code |
|
|
210
|
+
|
|
211
|
+
Send Validation code
|
|
212
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
213
|
+
|
|
214
|
+
| [**signInWithEmail**](docs/DefaultApi.md#signInWithEmail) | **POST** /auth-service/sign/in/with/email |
|
|
215
|
+
|
|
216
|
+
Sign In with email ID
|
|
217
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
218
|
+
|
|
219
|
+
| [**signInWithMobileNumber**](docs/DefaultApi.md#signInWithMobileNumber) | **POST** /auth-service/sign/in/with/mobile/number |
|
|
220
|
+
|
|
221
|
+
Sign In with Mobile number
|
|
222
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
223
|
+
|
|
224
|
+
| [**signUp**](docs/DefaultApi.md#signUp) | **POST** /auth-service/sign/up |
|
|
225
|
+
|
|
226
|
+
Sign Up
|
|
227
|
+
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
228
|
+
|
|
229
|
+
| [**validateCode**](docs/DefaultApi.md#validateCode) | **POST** /auth-service/validate/activation/code |
|
|
230
|
+
|
|
231
|
+
Validation
|
|
232
|
+
*XfloorFloorMemorySdkJs.EditFloorApi*
|
|
233
|
+
|
|
234
|
+
| [**editFloor**](docs/EditFloorApi.md#editFloor) | **POST** /api/memory/edit/floor/{floor_id} |
|
|
235
|
+
|
|
236
|
+
Edit floor
|
|
237
|
+
*XfloorFloorMemorySdkJs.EventApi*
|
|
238
|
+
|
|
239
|
+
| [**event**](docs/EventApi.md#event) | **POST** /api/memory/events |
|
|
240
|
+
|
|
241
|
+
Create Event (Post Content)
|
|
242
|
+
*XfloorFloorMemorySdkJs.GetFloorInformationApi*
|
|
243
|
+
|
|
244
|
+
| [**getFloorInformation**](docs/GetFloorInformationApi.md#getFloorInformation) | **GET** /api/memory/floor/info/{floor_id} |
|
|
245
|
+
|
|
246
|
+
Basic information of a floor
|
|
247
|
+
*XfloorFloorMemorySdkJs.GetRecentEventsApi*
|
|
248
|
+
|
|
249
|
+
| [**getRecentEvents**](docs/GetRecentEventsApi.md#getRecentEvents) | **GET** /api/memory/recent/events |
|
|
250
|
+
|
|
251
|
+
Recent Events
|
|
252
|
+
*XfloorFloorMemorySdkJs.QueryApi*
|
|
253
|
+
|
|
254
|
+
| [**query**](docs/QueryApi.md#query) | **POST** /agent/memory/query |
|
|
255
|
+
|
|
256
|
+
Query (Primary API)
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
### Documentation for Models
|
|
157
260
|
|
|
158
261
|
- [XfloorFloorMemorySdkJs.BlockDetails](docs/BlockDetails.md)
|
|
159
262
|
- [XfloorFloorMemorySdkJs.ChangePassword200Response](docs/ChangePassword200Response.md)
|
|
263
|
+
- [XfloorFloorMemorySdkJs.ConversationThreads200Response](docs/ConversationThreads200Response.md)
|
|
264
|
+
- [XfloorFloorMemorySdkJs.ConversationThreads200ResponseThreadsInner](docs/ConversationThreads200ResponseThreadsInner.md)
|
|
160
265
|
- [XfloorFloorMemorySdkJs.EditFloor400Response](docs/EditFloor400Response.md)
|
|
161
266
|
- [XfloorFloorMemorySdkJs.EditFloor400ResponseError](docs/EditFloor400ResponseError.md)
|
|
162
267
|
- [XfloorFloorMemorySdkJs.Event400Response](docs/Event400Response.md)
|
|
163
268
|
- [XfloorFloorMemorySdkJs.Event400ResponseError](docs/Event400ResponseError.md)
|
|
164
269
|
- [XfloorFloorMemorySdkJs.EventResponse](docs/EventResponse.md)
|
|
165
270
|
- [XfloorFloorMemorySdkJs.FloorInfo](docs/FloorInfo.md)
|
|
271
|
+
- [XfloorFloorMemorySdkJs.GetConversations200Response](docs/GetConversations200Response.md)
|
|
272
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInner](docs/GetConversations200ResponseConversationInner.md)
|
|
273
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistant](docs/GetConversations200ResponseConversationInnerAssistant.md)
|
|
274
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInner](docs/GetConversations200ResponseConversationInnerAssistantChoicesInner.md)
|
|
275
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.md)
|
|
276
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.md)
|
|
277
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.md)
|
|
278
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.md)
|
|
279
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.md)
|
|
280
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerUser](docs/GetConversations200ResponseConversationInnerUser.md)
|
|
281
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerUserContext](docs/GetConversations200ResponseConversationInnerUserContext.md)
|
|
166
282
|
- [XfloorFloorMemorySdkJs.GetFloorInformation200Response](docs/GetFloorInformation200Response.md)
|
|
167
283
|
- [XfloorFloorMemorySdkJs.GetRecentEvents200Response](docs/GetRecentEvents200Response.md)
|
|
168
284
|
- [XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInner](docs/GetRecentEvents200ResponseItemsInner.md)
|
|
@@ -171,6 +287,7 @@ Class | Method | HTTP request | Description
|
|
|
171
287
|
- [XfloorFloorMemorySdkJs.GetRecentEvents400ResponseError](docs/GetRecentEvents400ResponseError.md)
|
|
172
288
|
- [XfloorFloorMemorySdkJs.Media](docs/Media.md)
|
|
173
289
|
- [XfloorFloorMemorySdkJs.Model400ErrorCode](docs/Model400ErrorCode.md)
|
|
290
|
+
- [XfloorFloorMemorySdkJs.PostAdd](docs/PostAdd.md)
|
|
174
291
|
- [XfloorFloorMemorySdkJs.Query422Response](docs/Query422Response.md)
|
|
175
292
|
- [XfloorFloorMemorySdkJs.Query422ResponseError](docs/Query422ResponseError.md)
|
|
176
293
|
- [XfloorFloorMemorySdkJs.QueryRequest](docs/QueryRequest.md)
|
|
@@ -179,6 +296,7 @@ Class | Method | HTTP request | Description
|
|
|
179
296
|
- [XfloorFloorMemorySdkJs.QueryResponseItemsInner](docs/QueryResponseItemsInner.md)
|
|
180
297
|
- [XfloorFloorMemorySdkJs.ResetPassword200Response](docs/ResetPassword200Response.md)
|
|
181
298
|
- [XfloorFloorMemorySdkJs.ResetPassword400Response](docs/ResetPassword400Response.md)
|
|
299
|
+
- [XfloorFloorMemorySdkJs.SendSignInValidationCode200Response](docs/SendSignInValidationCode200Response.md)
|
|
182
300
|
- [XfloorFloorMemorySdkJs.SendValidationCode200Response](docs/SendValidationCode200Response.md)
|
|
183
301
|
- [XfloorFloorMemorySdkJs.SendValidationCodeRequest](docs/SendValidationCodeRequest.md)
|
|
184
302
|
- [XfloorFloorMemorySdkJs.SignInWithEmail200Response](docs/SignInWithEmail200Response.md)
|
|
@@ -187,6 +305,7 @@ Class | Method | HTTP request | Description
|
|
|
187
305
|
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponseProfileAvatar](docs/SignInWithEmail200ResponseProfileAvatar.md)
|
|
188
306
|
- [XfloorFloorMemorySdkJs.SignUp200Response](docs/SignUp200Response.md)
|
|
189
307
|
- [XfloorFloorMemorySdkJs.SignUpResponse](docs/SignUpResponse.md)
|
|
308
|
+
- [XfloorFloorMemorySdkJs.Threads](docs/Threads.md)
|
|
190
309
|
- [XfloorFloorMemorySdkJs.UserDetails](docs/UserDetails.md)
|
|
191
310
|
- [XfloorFloorMemorySdkJs.ValidateCode400Response](docs/ValidateCode400Response.md)
|
|
192
311
|
- [XfloorFloorMemorySdkJs.ValidateCode400ResponseError](docs/ValidateCode400ResponseError.md)
|
|
@@ -194,7 +313,7 @@ Class | Method | HTTP request | Description
|
|
|
194
313
|
- [XfloorFloorMemorySdkJs.ValidateCodeRequest](docs/ValidateCodeRequest.md)
|
|
195
314
|
|
|
196
315
|
|
|
197
|
-
|
|
316
|
+
### Documentation for Authorization
|
|
198
317
|
|
|
199
318
|
|
|
200
319
|
Authentication schemes defined for the API:
|
package/dist/ApiClient.js
CHANGED
|
@@ -13,7 +13,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
13
13
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
14
14
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
15
15
|
* Floor Memory
|
|
16
|
-
* The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
16
|
+
* 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.
|
|
17
|
+
* - Memory and
|
|
18
|
+
* - 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.
|
|
17
19
|
*
|
|
18
20
|
* The version of the OpenAPI document: 1.0.0
|
|
19
21
|
* Contact: contact@ipomo.in
|
|
@@ -25,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
25
27
|
*/
|
|
26
28
|
/**
|
|
27
29
|
* @module ApiClient
|
|
28
|
-
* @version 1.0.
|
|
30
|
+
* @version 1.0.5
|
|
29
31
|
*/
|
|
30
32
|
/**
|
|
31
33
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
@@ -66,7 +68,7 @@ var ApiClient = /*#__PURE__*/function () {
|
|
|
66
68
|
* @default {}
|
|
67
69
|
*/
|
|
68
70
|
this.defaultHeaders = {
|
|
69
|
-
'User-Agent': 'OpenAPI-Generator/1.0.
|
|
71
|
+
'User-Agent': 'OpenAPI-Generator/1.0.5/Javascript'
|
|
70
72
|
};
|
|
71
73
|
|
|
72
74
|
/**
|
package/dist/api/DefaultApi.js
CHANGED
|
@@ -6,11 +6,14 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
8
|
var _ChangePassword200Response = _interopRequireDefault(require("../model/ChangePassword200Response"));
|
|
9
|
+
var _ConversationThreads200Response = _interopRequireDefault(require("../model/ConversationThreads200Response"));
|
|
9
10
|
var _EditFloor400Response = _interopRequireDefault(require("../model/EditFloor400Response"));
|
|
11
|
+
var _GetConversations200Response = _interopRequireDefault(require("../model/GetConversations200Response"));
|
|
10
12
|
var _GetFloorInformation200Response = _interopRequireDefault(require("../model/GetFloorInformation200Response"));
|
|
11
13
|
var _GetRecentEvents400Response = _interopRequireDefault(require("../model/GetRecentEvents400Response"));
|
|
12
14
|
var _ResetPassword200Response = _interopRequireDefault(require("../model/ResetPassword200Response"));
|
|
13
15
|
var _ResetPassword400Response = _interopRequireDefault(require("../model/ResetPassword400Response"));
|
|
16
|
+
var _SendSignInValidationCode200Response = _interopRequireDefault(require("../model/SendSignInValidationCode200Response"));
|
|
14
17
|
var _SendValidationCode200Response = _interopRequireDefault(require("../model/SendValidationCode200Response"));
|
|
15
18
|
var _SendValidationCodeRequest = _interopRequireDefault(require("../model/SendValidationCodeRequest"));
|
|
16
19
|
var _SignInWithEmail200Response = _interopRequireDefault(require("../model/SignInWithEmail200Response"));
|
|
@@ -27,7 +30,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
27
30
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
28
31
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
29
32
|
* Floor Memory
|
|
30
|
-
* The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
33
|
+
* 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.
|
|
34
|
+
* - Memory and
|
|
35
|
+
* - 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.
|
|
31
36
|
*
|
|
32
37
|
* The version of the OpenAPI document: 1.0.0
|
|
33
38
|
* Contact: contact@ipomo.in
|
|
@@ -40,7 +45,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
40
45
|
/**
|
|
41
46
|
* Default service.
|
|
42
47
|
* @module api/DefaultApi
|
|
43
|
-
* @version 1.0.
|
|
48
|
+
* @version 1.0.5
|
|
44
49
|
*/
|
|
45
50
|
var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
46
51
|
/**
|
|
@@ -56,22 +61,102 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
56
61
|
}
|
|
57
62
|
|
|
58
63
|
/**
|
|
59
|
-
* Callback function to receive the result of the
|
|
60
|
-
* @callback module:api/DefaultApi~
|
|
64
|
+
* Callback function to receive the result of the apiDeveloperCreateAppPost operation.
|
|
65
|
+
* @callback module:api/DefaultApi~apiDeveloperCreateAppPostCallback
|
|
61
66
|
* @param {String} error Error message, if any.
|
|
62
67
|
* @param {Object} data The data returned by the service call.
|
|
63
68
|
* @param {String} response The complete HTTP response.
|
|
64
69
|
*/
|
|
65
70
|
|
|
66
71
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* @param {String}
|
|
70
|
-
* @param {
|
|
71
|
-
* @param {
|
|
72
|
+
* Create App
|
|
73
|
+
* Create a custom app using APIs. A 13 digit app ID gets created which takes title and description the app. An icon of specified size needs to be uploaded.
|
|
74
|
+
* @param {String} inputInfo
|
|
75
|
+
* @param {Object} opts Optional parameters
|
|
76
|
+
* @param {File} [icon]
|
|
77
|
+
* @param {module:api/DefaultApi~apiDeveloperCreateAppPostCallback} callback The callback function, accepting three arguments: error, data, response
|
|
72
78
|
* data is of type: {@link Object}
|
|
73
79
|
*/
|
|
74
80
|
return _createClass(DefaultApi, [{
|
|
81
|
+
key: "apiDeveloperCreateAppPost",
|
|
82
|
+
value: function apiDeveloperCreateAppPost(inputInfo, opts, callback) {
|
|
83
|
+
opts = opts || {};
|
|
84
|
+
var postBody = null;
|
|
85
|
+
// verify the required parameter 'inputInfo' is set
|
|
86
|
+
if (inputInfo === undefined || inputInfo === null) {
|
|
87
|
+
throw new Error("Missing the required parameter 'inputInfo' when calling apiDeveloperCreateAppPost");
|
|
88
|
+
}
|
|
89
|
+
var pathParams = {};
|
|
90
|
+
var queryParams = {};
|
|
91
|
+
var headerParams = {};
|
|
92
|
+
var formParams = {
|
|
93
|
+
'input_info': inputInfo,
|
|
94
|
+
'icon': opts['icon']
|
|
95
|
+
};
|
|
96
|
+
var authNames = [];
|
|
97
|
+
var contentTypes = ['multipart/form-data'];
|
|
98
|
+
var accepts = ['application/json'];
|
|
99
|
+
var returnType = Object;
|
|
100
|
+
return this.apiClient.callApi('/api/developer/create/app', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Callback function to receive the result of the apiDeveloperModifyAppPost operation.
|
|
105
|
+
* @callback module:api/DefaultApi~apiDeveloperModifyAppPostCallback
|
|
106
|
+
* @param {String} error Error message, if any.
|
|
107
|
+
* @param {Object} data The data returned by the service call.
|
|
108
|
+
* @param {String} response The complete HTTP response.
|
|
109
|
+
*/
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Modify Floorpod App
|
|
113
|
+
* Modify title, details or the app icon
|
|
114
|
+
* @param {String} inputInfo User ID, App ID, Title, Details. User ID and App ID are required parameters. Title/details are optional.
|
|
115
|
+
* @param {Object} opts Optional parameters
|
|
116
|
+
* @param {File} [file] Upload the new PNG icon file.
|
|
117
|
+
* @param {module:api/DefaultApi~apiDeveloperModifyAppPostCallback} callback The callback function, accepting three arguments: error, data, response
|
|
118
|
+
* data is of type: {@link Object}
|
|
119
|
+
*/
|
|
120
|
+
}, {
|
|
121
|
+
key: "apiDeveloperModifyAppPost",
|
|
122
|
+
value: function apiDeveloperModifyAppPost(inputInfo, opts, callback) {
|
|
123
|
+
opts = opts || {};
|
|
124
|
+
var postBody = null;
|
|
125
|
+
// verify the required parameter 'inputInfo' is set
|
|
126
|
+
if (inputInfo === undefined || inputInfo === null) {
|
|
127
|
+
throw new Error("Missing the required parameter 'inputInfo' when calling apiDeveloperModifyAppPost");
|
|
128
|
+
}
|
|
129
|
+
var pathParams = {};
|
|
130
|
+
var queryParams = {};
|
|
131
|
+
var headerParams = {};
|
|
132
|
+
var formParams = {
|
|
133
|
+
'input_info': inputInfo,
|
|
134
|
+
'file': opts['file']
|
|
135
|
+
};
|
|
136
|
+
var authNames = [];
|
|
137
|
+
var contentTypes = ['multipart/form-data'];
|
|
138
|
+
var accepts = ['application/json'];
|
|
139
|
+
var returnType = Object;
|
|
140
|
+
return this.apiClient.callApi('/api/developer/modify/app', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Callback function to receive the result of the changeEmail operation.
|
|
145
|
+
* @callback module:api/DefaultApi~changeEmailCallback
|
|
146
|
+
* @param {String} error Error message, if any.
|
|
147
|
+
* @param {Object} data The data returned by the service call.
|
|
148
|
+
* @param {String} response The complete HTTP response.
|
|
149
|
+
*/
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Change email ID
|
|
153
|
+
* Updates the email ID associated with an existing user account after validating a one-time activation code sent to the **new email address**. This operation can only be performed by a **logged-in user**. When a user initiates an email change, an activation code is sent to the newly provided email ID. The email update takes effect only after the activation code is successfully validated. If the activation code validation fails, the email ID remains unchanged. --- ### **Authentication** This endpoint requires **Bearer Token authentication**. ``` Authorization: Bearer <access_token> ``` --- ### **Request Body** ```json { \"user_id\": \"string\", \"new_email_id\": \"string\", \"activation_code\": \"string\", \"app_id\":\"string\" } ``` **Field Description** * `user_id` – Unique identifier of the logged-in user * `new_email_id` – New email address to be associated with the account * `activation_code` – One-time activation code sent to the new email ID for verification --- ### **Flow Summary** 1. User is authenticated and logged in 2. User requests to change email ID 3. System sends an activation code to the **new email address** 4. User submits the activation code via this API 5. On successful validation, the email ID is updated --- ### **Successful Response** On successful validation: * The activation code is verified * The user’s email ID is updated immediately * A `success` string is returned confirming the email change --- ### **Error Response** The API returns an error response if: * The activation code is invalid or expired * The activation code does not match the user or email * The new email ID is already in use * Authorization fails or the bearer token is missing or invalid In all error cases, the existing email ID remains unchanged. --- ### **Behavior Notes** * Requires a prior call to `/auth-service/send/validation/code` with the proper mode. --- ### **Security Notes (Recommended)** * Activation codes are single-use and time-bound * Email changes require prior authentication * Rate limiting may be applied to prevent abuse --- ### **One-Line Summary** > Changes a user’s email ID after validating an activation code sent to the new email address.
|
|
154
|
+
* @param {String} newEmailId New Email ID
|
|
155
|
+
* @param {String} activationCode Validation code
|
|
156
|
+
* @param {module:api/DefaultApi~changeEmailCallback} callback The callback function, accepting three arguments: error, data, response
|
|
157
|
+
* data is of type: {@link Object}
|
|
158
|
+
*/
|
|
159
|
+
}, {
|
|
75
160
|
key: "changeEmail",
|
|
76
161
|
value: function changeEmail(newEmailId, activationCode, callback) {
|
|
77
162
|
var postBody = null;
|
|
@@ -177,6 +262,84 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
177
262
|
return this.apiClient.callApi('/auth-service/password/change', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
178
263
|
}
|
|
179
264
|
|
|
265
|
+
/**
|
|
266
|
+
* Callback function to receive the result of the conversationThreads operation.
|
|
267
|
+
* @callback module:api/DefaultApi~conversationThreadsCallback
|
|
268
|
+
* @param {String} error Error message, if any.
|
|
269
|
+
* @param {module:model/ConversationThreads200Response} data The data returned by the service call.
|
|
270
|
+
* @param {String} response The complete HTTP response.
|
|
271
|
+
*/
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Get the conversational threads
|
|
275
|
+
* ### Conversation Model - A **Thread** represents a single conversational context. - A **Conversation** is the ordered exchange of messages within a thread. - Threads are scoped per user and per floor. This API retrieves the list of **conversational threads** associated with a specific **user** within a specific **floor**. A **thread** represents a persistent conversation context between the user and the system (agent/assistant) inside a floor. Each thread maintains its own history and state, allowing users to resume previous conversations without losing context. The API returns **only thread metadata**, not the message content itself. This makes it suitable for: * Displaying a conversation list or sidebar * Allowing users to select and resume past conversations * Managing conversational memory per floor --- ## Key Concepts * **Thread**: A long-lived conversational context tied to a user and a floor * **Floor-scoped memory**: Conversations are isolated per floor; threads from one floor are not visible in another * **User-specific**: Threads are private to the requesting user --- ## Request Method `GET` --- ## Request Parameters (Query Parameters) | Parameter Name | Type | Required | Description | | -------------- | ------ | -------- | ---------------------------------------------------------------------------- | | `user_id` | String | **Yes** | Unique identifier of the user whose conversation threads are being requested | | `floor_id` | String | **Yes** | Identifier of the floor in which the conversations exist | --- ## Authorization & Access Rules * The caller must be authenticated as the given `user_id` * A user can retrieve **only their own threads** * Threads are scoped to the provided `floor_id` * Threads from other floors or other users are not accessible --- ## Response Format `application/json` --- ## Response Description The response contains: * The `user_id` for which threads were fetched * A list of thread metadata objects, sorted by **most recently updated first** --- ## Response Structure ### Top-Level Fields | Field | Type | Description | | --------- | ------ | ------------------------------------------------------------------------- | | `user_id` | String | Identifier of the user | | `threads` | Array | List of conversation threads belonging to the user in the specified floor | --- ### Thread Object (`threads[]`) | Field | Type | Description | | -------------- | ------------------- | ------------------------------------------------- | | `thread_id` | String | Unique identifier of the conversation thread | | `title` | String | Human-readable title summarizing the conversation | | `last_updated` | String (YYYY-MM-DD) | Date when the thread was last updated | --- ## Sample Success Response ```json { \"user_id\": \"59\", \"threads\": [ { \"thread_id\": \"55\", \"title\": \"elegant potentially hopelessly ambitious sneak\", \"last_updated\": \"2025-04-26\" }, { \"thread_id\": \"79\", \"title\": \"sans profitable alienated by even overstay miserly practical\", \"last_updated\": \"2025-04-24\" }, { \"thread_id\": \"89\", \"title\": \"although light uh-huh despite instead vol sorrowful\", \"last_updated\": \"2025-02-16\" } ] } ``` --- ## Typical Use Cases * Show a **list of past conversations** in a chat UI * Allow users to **resume a previous thread** * Display conversation history grouped by floor * Build agent dashboards with user-specific memory --- ## Notes * This API returns **metadata only**; message history is retrieved using a separate thread-messages API * If no threads exist, the `threads` array will be empty * Thread titles may be system-generated or user-editable depending on implementation --- ## Common Error Responses (Examples) ### Missing Parameters ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` ### Unauthorised Access ```json { \"status\": \"ERROR\", \"message\": \"Unauthorized access to conversation threads\" } ```
|
|
276
|
+
* @param {String} userId User ID
|
|
277
|
+
* @param {String} floorId Floor ID
|
|
278
|
+
* @param {module:api/DefaultApi~conversationThreadsCallback} callback The callback function, accepting three arguments: error, data, response
|
|
279
|
+
* data is of type: {@link module:model/ConversationThreads200Response}
|
|
280
|
+
*/
|
|
281
|
+
}, {
|
|
282
|
+
key: "conversationThreads",
|
|
283
|
+
value: function conversationThreads(userId, floorId, callback) {
|
|
284
|
+
var postBody = null;
|
|
285
|
+
// verify the required parameter 'userId' is set
|
|
286
|
+
if (userId === undefined || userId === null) {
|
|
287
|
+
throw new Error("Missing the required parameter 'userId' when calling conversationThreads");
|
|
288
|
+
}
|
|
289
|
+
// verify the required parameter 'floorId' is set
|
|
290
|
+
if (floorId === undefined || floorId === null) {
|
|
291
|
+
throw new Error("Missing the required parameter 'floorId' when calling conversationThreads");
|
|
292
|
+
}
|
|
293
|
+
var pathParams = {};
|
|
294
|
+
var queryParams = {
|
|
295
|
+
'user_id': userId,
|
|
296
|
+
'floor_id': floorId
|
|
297
|
+
};
|
|
298
|
+
var headerParams = {};
|
|
299
|
+
var formParams = {};
|
|
300
|
+
var authNames = ['bearer'];
|
|
301
|
+
var contentTypes = [];
|
|
302
|
+
var accepts = ['application/json'];
|
|
303
|
+
var returnType = _ConversationThreads200Response["default"];
|
|
304
|
+
return this.apiClient.callApi('/agent/memory/threads', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Callback function to receive the result of the getConversations operation.
|
|
309
|
+
* @callback module:api/DefaultApi~getConversationsCallback
|
|
310
|
+
* @param {String} error Error message, if any.
|
|
311
|
+
* @param {module:model/GetConversations200Response} data The data returned by the service call.
|
|
312
|
+
* @param {String} response The complete HTTP response.
|
|
313
|
+
*/
|
|
314
|
+
|
|
315
|
+
/**
|
|
316
|
+
* Conversations
|
|
317
|
+
* This API returns the **full conversation history** for a specific **thread** belonging to a user within a floor. A **thread** represents a persistent conversation session. Each item in the returned `conversation` array contains: * The **user request payload** (user query + context) * The **assistant response payload** (full LLM completion object) * The **retrieval trace** (metadata of posts fetched/used for the answer, including scores and identifiers) This endpoint is intended for **developers** building custom conversational UIs and tooling that require: * Full conversation replay * Debug visibility into the assistant output object (`choices`, model info, etc.) * RAG explainability via `fetch_multiple_posts.results[]` --- ## Request Method `GET` --- ## Query Parameters | Parameter | Type | Required | Description | | ----------- | ------ | -------- | --------------------------------------------------------------------------- | | `user_id` | String | **Yes** | Owner of the conversation thread. The thread must belong to this user. | | `floor_id` | String | **Yes** | Floor identifier in which the thread exists. Threads are scoped to a floor. | | `thread_id` | String | **Yes** | Thread identifier whose conversations should be returned. | --- ## Authorization & Access Rules * The caller must be authenticated as the given `user_id` (or have equivalent developer/system permission). * A user can access **only their own threads**. * Cross-user or cross-floor access must be rejected. --- ## Response Format `application/json` --- ## Response Description Returns the thread-level conversation payload: * `user_id`: the user who owns the thread * `thread_id`: the requested thread * `conversation`: ordered list of conversation entries (each entry = user object + assistant object) --- ## Response Schema ### Top-Level Fields | Field | Type | Description | | -------------- | ------ | ---------------------------- | | `user_id` | String | Owner of the thread | | `thread_id` | String | Thread identifier | | `conversation` | Array | List of conversation entries | --- ## `conversation[]` Entry Structure Each entry contains two objects: `user` and `assistant`. --- ### `user` Object | Field | Type | Description | | ------------------ | ------ | ------------------------------------------------------------------- | | `context` | Object | Context used when processing the query (floor metadata, mode, etc.) | | `user_query` | String | The user’s query message | | `user_id` | String | User identifier (should match top-level `user_id`) | | `user_thread` | String | Thread identifier (should match top-level `thread_id`) | | `recorded_content` | String | Persisted user content (often same as `user_query`) | #### `user.context` | Field | Type | Description | | ---------------- | ------ | ---------------------------------------------- | | `floor_id` | String | Floor UID/slug where the conversation occurred | | `title` | String | Floor title at the time of the query | | `fid` | String | Immutable internal floor ID | | `floor_category` | String | Floor category identifier | | `floor_mode` | String | Floor mode indicator (example: `\"1\"`) | --- ### `assistant` Object This contains the **full completion response** plus retrieval details. | Field | Type | Description | | ---------------------- | ------ | --------------------------------------------------- | | `id` | String | Completion id (e.g., `chatcmpl-*`) | | `object` | String | Response type (e.g., `chat.completion`) | | `created` | Number | Timestamp when response was created (epoch seconds) | | `floor_mode` | String | Floor mode applied for generation | | `model` | String | Model identifier used | | `choices` | Array | Generated outputs and metadata | | `fetch_multiple_posts` | Object | Retrieval trace (if retrieval was performed) | | `content_type` | String | Retrieved content type (e.g., `post`) | --- ## `assistant.choices[]` | Field | Type | Description | | ------------------ | ------ | -------------------------------------------------------------------------- | | `index` | Number | Choice index | | `message` | Object | Assistant message content | | `finish_reason` | String | Why generation stopped (`stop`, `length`, etc.) | | `ai_model_details` | Object | Model runtime parameters (temperature, top_p, max_tokens, penalties, etc.) | | `prompt_details` | Object | Prompt configuration used (system prompt, system_prompt_id, etc.) | > **Note:** `prompt_details.system_prompt` may be large and is returned as-is for developer inspection. --- ## `assistant.fetch_multiple_posts` Describes the retrieval operation performed for the query. | Field | Type | Description | | -------------- | ------ | -------------------------------------- | | `content_type` | String | Type of retrieved content (`post`) | | `query` | String | Query used for retrieval | | `status` | String | Retrieval status (`success`, `failed`) | | `message` | String | Retrieval message | | `results` | Array | List of matched posts and metadata | --- ## `assistant.fetch_multiple_posts.results[]` | Field | Type | Description | | ------------ | ------ | ----------------------------------------------------------------- | | `from_floor` | String | Indicates source floor relation (e.g., same floor / linked floor) | | `content` | String | Raw JSON string of the matched post metadata/content | | `author` | String | Author id of the matched post | | `block_type` | Number | Block type of the matched post | | `pid` | String | Post/document id | | `bid` | String | Block id containing the post | | `fid` | String | Floor internal id where the post belongs | | `score` | Number | Similarity score | | `match_type` | String | Match type (`text`, etc.) | --- ## Sample Success Response Your provided payload is the canonical example. It includes: * the user query and floor context * the full assistant completion object * the full retrieval results with post metadata * the response shown covers a few important items. --- ## Common Error Responses ### Missing Parameters ```json { \"status\": \"ERROR\", \"message\": \"user_id, floor_id, and thread_id are required\" } ``` ### Unauthorized Access ```json { \"status\": \"ERROR\", \"message\": \"Unauthorized access to thread\" } ``` ### Thread Not Found ```json { \"status\": \"ERROR\", \"message\": \"Thread not found\" } ``` --- ## Developer Notes (Important) * The `content` field inside retrieval results is a **stringified JSON**. Developers may parse it to access fields such as `post_title`, `post_details`, etc. * `choices` may contain multiple outputs depending on backend configuration. * This API returns a “full debug payload” suitable for developers. If you later create a lightweight UI endpoint, it should strip execution details and return only `user_query`, `assistant.content`, and curated post references.
|
|
318
|
+
* @param {Object} opts Optional parameters
|
|
319
|
+
* @param {String} [userId]
|
|
320
|
+
* @param {String} [threadId]
|
|
321
|
+
* @param {module:api/DefaultApi~getConversationsCallback} callback The callback function, accepting three arguments: error, data, response
|
|
322
|
+
* data is of type: {@link module:model/GetConversations200Response}
|
|
323
|
+
*/
|
|
324
|
+
}, {
|
|
325
|
+
key: "getConversations",
|
|
326
|
+
value: function getConversations(opts, callback) {
|
|
327
|
+
opts = opts || {};
|
|
328
|
+
var postBody = null;
|
|
329
|
+
var pathParams = {};
|
|
330
|
+
var queryParams = {
|
|
331
|
+
'user_id': opts['userId'],
|
|
332
|
+
'thread_id': opts['threadId']
|
|
333
|
+
};
|
|
334
|
+
var headerParams = {};
|
|
335
|
+
var formParams = {};
|
|
336
|
+
var authNames = ['bearer'];
|
|
337
|
+
var contentTypes = [];
|
|
338
|
+
var accepts = ['application/json'];
|
|
339
|
+
var returnType = _GetConversations200Response["default"];
|
|
340
|
+
return this.apiClient.callApi('/agent/memory/conversations', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
341
|
+
}
|
|
342
|
+
|
|
180
343
|
/**
|
|
181
344
|
* Callback function to receive the result of the makeFloorPrivate operation.
|
|
182
345
|
* @callback module:api/DefaultApi~makeFloorPrivateCallback
|
|
@@ -377,6 +540,48 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
377
540
|
return this.apiClient.callApi('/auth-service/password/reset', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
378
541
|
}
|
|
379
542
|
|
|
543
|
+
/**
|
|
544
|
+
* Callback function to receive the result of the sendSignInValidationCode operation.
|
|
545
|
+
* @callback module:api/DefaultApi~sendSignInValidationCodeCallback
|
|
546
|
+
* @param {String} error Error message, if any.
|
|
547
|
+
* @param {module:model/SendSignInValidationCode200Response} data The data returned by the service call.
|
|
548
|
+
* @param {String} response The complete HTTP response.
|
|
549
|
+
*/
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Send Sign-In Validation Code (OTP)
|
|
553
|
+
* This API initiates the **sign-in validation process** by sending a **one-time validation code (OTP)** to the user. The OTP is delivered to **either the mobile number or the email address** provided in the request. This endpoint is typically called **before completing sign-in**, to verify that the user owns the supplied contact identifier. The calling application is responsible for: * Collecting the OTP from the user * Submitting it to the OTP verification API (handled separately) --- ## **Use Case** * User attempts to sign in * User provides **mobile number or email** * System sends a **validation code (OTP)** * User enters OTP to complete sign-in --- ## **Request Method** `POST` --- ## **Formdata Parameters** | Parameter Name | Type | Required | Description | | --------------- | ------ | --------- | ------------------------------------------- | | `mobile_number` | String | Optional* | Mobile number to which the OTP will be sent | | `email_id` | String | Optional* | Email address to which the OTP will be sent | | `app_id` | String | Optional | Identifier of the calling application | * **Either `mobile_number` or `email_id` must be provided.** Providing both is allowed; the system may choose one based on configuration. --- ## **Request Rules** * At least **one** of `mobile_number` or `email_id` is mandatory * If both are missing, the request will be rejected * OTP delivery channel depends on the provided identifier --- ## **Response Format** `application/json` --- ## **Sample Success Response** ```json { \"status\": \"SUCCESS\", \"message\": \"Validation code sent successfully\" } ``` --- ## **Sample Error Responses** ### Missing Identifier ```json { \"status\": \"ERROR\", \"message\": \"Either mobile_number or email_id must be provided\" } ``` ### Invalid Identifier ```json { \"status\": \"ERROR\", \"message\": \"Invalid mobile number or email address\" } ``` --- ## **Notes** * This API **only sends** the validation code * OTP verification must be performed using the corresponding **verify validation code** API * Rate limiting and retry restrictions may apply to prevent abuse
|
|
554
|
+
* @param {String} appId App ID
|
|
555
|
+
* @param {Object} opts Optional parameters
|
|
556
|
+
* @param {String} [mobileNumber] Mobile number
|
|
557
|
+
* @param {String} [emailId] Email ID
|
|
558
|
+
* @param {module:api/DefaultApi~sendSignInValidationCodeCallback} callback The callback function, accepting three arguments: error, data, response
|
|
559
|
+
* data is of type: {@link module:model/SendSignInValidationCode200Response}
|
|
560
|
+
*/
|
|
561
|
+
}, {
|
|
562
|
+
key: "sendSignInValidationCode",
|
|
563
|
+
value: function sendSignInValidationCode(appId, opts, callback) {
|
|
564
|
+
opts = opts || {};
|
|
565
|
+
var postBody = null;
|
|
566
|
+
// verify the required parameter 'appId' is set
|
|
567
|
+
if (appId === undefined || appId === null) {
|
|
568
|
+
throw new Error("Missing the required parameter 'appId' when calling sendSignInValidationCode");
|
|
569
|
+
}
|
|
570
|
+
var pathParams = {};
|
|
571
|
+
var queryParams = {};
|
|
572
|
+
var headerParams = {};
|
|
573
|
+
var formParams = {
|
|
574
|
+
'mobile_number': opts['mobileNumber'],
|
|
575
|
+
'email_id': opts['emailId'],
|
|
576
|
+
'app_id': appId
|
|
577
|
+
};
|
|
578
|
+
var authNames = ['bearer'];
|
|
579
|
+
var contentTypes = ['multipart/form-data'];
|
|
580
|
+
var accepts = ['application/json'];
|
|
581
|
+
var returnType = _SendSignInValidationCode200Response["default"];
|
|
582
|
+
return this.apiClient.callApi('/auth-service/send/sign/in/validation/code', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
583
|
+
}
|
|
584
|
+
|
|
380
585
|
/**
|
|
381
586
|
* Callback function to receive the result of the sendValidationCode operation.
|
|
382
587
|
* @callback module:api/DefaultApi~sendValidationCodeCallback
|
package/dist/api/EditFloorApi.js
CHANGED
|
@@ -15,7 +15,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
17
17
|
* Floor Memory
|
|
18
|
-
* The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
18
|
+
* 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.
|
|
19
|
+
* - Memory and
|
|
20
|
+
* - 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.
|
|
19
21
|
*
|
|
20
22
|
* The version of the OpenAPI document: 1.0.0
|
|
21
23
|
* Contact: contact@ipomo.in
|
|
@@ -28,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
30
|
/**
|
|
29
31
|
* EditFloor service.
|
|
30
32
|
* @module api/EditFloorApi
|
|
31
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.5
|
|
32
34
|
*/
|
|
33
35
|
var EditFloorApi = exports["default"] = /*#__PURE__*/function () {
|
|
34
36
|
/**
|