@xfloor/floor-memory-sdk-ts 1.0.20 → 1.0.21
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 +56 -50
- package/dist/apis/{DefaultApi.d.ts → AuthApi.d.ts} +21 -51
- package/dist/apis/{DefaultApi.js → AuthApi.js} +57 -196
- 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/ChangeEmail200Response.d.ts +48 -0
- package/dist/models/ChangeEmail200Response.js +61 -0
- package/dist/models/{SignInWithEmail200ResponsePodInfo.d.ts → ChangeEmail200ResponsePodInfo.d.ts} +16 -16
- package/dist/models/{SignInWithEmail200ResponsePodInfo.js → ChangeEmail200ResponsePodInfo.js} +13 -13
- package/dist/models/{SignInWithEmail200ResponseProfile.d.ts → ChangeEmail200ResponseProfile.d.ts} +20 -20
- package/dist/models/{SignInWithEmail200ResponseProfile.js → ChangeEmail200ResponseProfile.js} +16 -16
- package/dist/models/ChangeEmail200ResponseProfileAvatar.d.ts +40 -0
- package/dist/models/{SignInWithEmail200ResponseProfileAvatar.js → ChangeEmail200ResponseProfileAvatar.js} +13 -13
- 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/index.d.ts +6 -5
- package/dist/models/index.js +6 -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
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @xfloor/floor-memory-sdk-ts@1.0.
|
|
1
|
+
# @xfloor/floor-memory-sdk-ts@1.0.21
|
|
2
2
|
A TypeScript SDK client for the appfloor.in API.
|
|
3
3
|
|
|
4
4
|
### Usage
|
|
@@ -15,7 +15,7 @@ Next, try it out.
|
|
|
15
15
|
```ts
|
|
16
16
|
import {
|
|
17
17
|
Configuration,
|
|
18
|
-
|
|
18
|
+
AuthApi,
|
|
19
19
|
} from '@xfloor/floor-memory-sdk-ts';
|
|
20
20
|
import type { ChangeEmailRequest } from '@xfloor/floor-memory-sdk-ts';
|
|
21
21
|
|
|
@@ -25,7 +25,7 @@ async function example() {
|
|
|
25
25
|
// Configure HTTP bearer authorization: bearer
|
|
26
26
|
accessToken: "YOUR BEARER TOKEN",
|
|
27
27
|
});
|
|
28
|
-
const api = new
|
|
28
|
+
const api = new AuthApi(config);
|
|
29
29
|
|
|
30
30
|
const body = {
|
|
31
31
|
// string | New Email ID
|
|
@@ -59,86 +59,91 @@ Description
|
|
|
59
59
|
| ----- | ------ | ------------ |
|
|
60
60
|
|
|
61
61
|
-------------
|
|
62
|
-
*
|
|
62
|
+
*AuthApi*
|
|
63
63
|
|
|
64
|
-
| [**changeEmail**](docs/
|
|
64
|
+
| [**changeEmail**](docs/AuthApi.md#changeemail) | **POST** /auth-service/change/email |
|
|
65
65
|
|
|
66
66
|
Change email ID
|
|
67
|
-
*
|
|
67
|
+
*AuthApi*
|
|
68
68
|
|
|
69
|
-
| [**changeMobileNumber**](docs/
|
|
69
|
+
| [**changeMobileNumber**](docs/AuthApi.md#changemobilenumber) | **POST** /auth-service/change/mobile |
|
|
70
70
|
|
|
71
71
|
Change Mobile number
|
|
72
|
-
*
|
|
72
|
+
*AuthApi*
|
|
73
73
|
|
|
74
|
-
| [**changePassword**](docs/
|
|
74
|
+
| [**changePassword**](docs/AuthApi.md#changepassword) | **POST** /auth-service/password/change |
|
|
75
75
|
|
|
76
76
|
Change Password
|
|
77
|
-
*
|
|
77
|
+
*AuthApi*
|
|
78
78
|
|
|
79
|
-
| [**
|
|
79
|
+
| [**registerExternalUserIdentity**](docs/AuthApi.md#registerexternaluseridentity) | **POST** /memory/identity/external-user |
|
|
80
80
|
|
|
81
|
-
|
|
82
|
-
*
|
|
83
|
-
|
|
84
|
-
| [**makeFloorPublic**](docs/DefaultApi.md#makefloorpublic) | **POST** /api/memory/make/floor/public/{floor_id} |
|
|
85
|
-
|
|
86
|
-
Make floor public
|
|
87
|
-
*DefaultApi*
|
|
88
|
-
|
|
89
|
-
| [**renameFloor**](docs/DefaultApi.md#renamefloor) | **POST** /api/memory/change/floor/id |
|
|
90
|
-
|
|
91
|
-
Rename floor
|
|
92
|
-
*DefaultApi*
|
|
81
|
+
External User Registration
|
|
82
|
+
*AuthApi*
|
|
93
83
|
|
|
94
|
-
| [**resetPassword**](docs/
|
|
84
|
+
| [**resetPassword**](docs/AuthApi.md#resetpassword) | **POST** /auth-service/password/reset |
|
|
95
85
|
|
|
96
86
|
Reset Password
|
|
97
|
-
*
|
|
87
|
+
*AuthApi*
|
|
98
88
|
|
|
99
|
-
| [**sendValidationCode**](docs/
|
|
89
|
+
| [**sendValidationCode**](docs/AuthApi.md#sendvalidationcode) | **POST** /auth-service/send/validation/code |
|
|
100
90
|
|
|
101
91
|
Send Validation code
|
|
102
|
-
*
|
|
92
|
+
*AuthApi*
|
|
103
93
|
|
|
104
|
-
| [**signInWithEmail**](docs/
|
|
94
|
+
| [**signInWithEmail**](docs/AuthApi.md#signinwithemail) | **POST** /auth-service/sign/in/with/email |
|
|
105
95
|
|
|
106
96
|
Sign In with email ID
|
|
107
|
-
*
|
|
97
|
+
*AuthApi*
|
|
108
98
|
|
|
109
|
-
| [**signInWithMobileNumber**](docs/
|
|
99
|
+
| [**signInWithMobileNumber**](docs/AuthApi.md#signinwithmobilenumber) | **POST** /auth-service/sign/in/with/mobile/number |
|
|
110
100
|
|
|
111
101
|
Sign In with Mobile number
|
|
112
|
-
*
|
|
102
|
+
*AuthApi*
|
|
113
103
|
|
|
114
|
-
| [**signUp**](docs/
|
|
104
|
+
| [**signUp**](docs/AuthApi.md#signup) | **POST** /auth-service/sign/up |
|
|
115
105
|
|
|
116
106
|
Sign Up
|
|
117
|
-
*
|
|
107
|
+
*AuthApi*
|
|
118
108
|
|
|
119
|
-
| [**validateCode**](docs/
|
|
109
|
+
| [**validateCode**](docs/AuthApi.md#validatecode) | **POST** /auth-service/validate/activation/code |
|
|
120
110
|
|
|
121
111
|
Validation
|
|
122
|
-
*EditFloorApi*
|
|
123
|
-
|
|
124
|
-
| [**editFloor**](docs/EditFloorApi.md#editfloor) | **POST** /api/memory/edit/floor/{floor_id} |
|
|
125
|
-
|
|
126
|
-
Edit floor
|
|
127
112
|
*EventApi*
|
|
128
113
|
|
|
129
114
|
| [**event**](docs/EventApi.md#event) | **POST** /api/memory/events |
|
|
130
115
|
|
|
131
116
|
Create Event (Post Content)
|
|
132
|
-
*
|
|
117
|
+
*EventApi*
|
|
118
|
+
|
|
119
|
+
| [**getRecentEvents**](docs/EventApi.md#getrecentevents) | **GET** /api/memory/recent/events |
|
|
133
120
|
|
|
134
|
-
|
|
121
|
+
Recent Events
|
|
122
|
+
*FloorApi*
|
|
123
|
+
|
|
124
|
+
| [**editFloor**](docs/FloorApi.md#editfloor) | **POST** /api/memory/edit/floor/{floor_id} |
|
|
125
|
+
|
|
126
|
+
Edit floor
|
|
127
|
+
*FloorApi*
|
|
128
|
+
|
|
129
|
+
| [**getFloorInformation**](docs/FloorApi.md#getfloorinformation) | **GET** /api/memory/floor/info/{floor_id} |
|
|
135
130
|
|
|
136
131
|
Basic information of a floor
|
|
137
|
-
*
|
|
132
|
+
*FloorApi*
|
|
138
133
|
|
|
139
|
-
| [**
|
|
134
|
+
| [**makeFloorPrivate**](docs/FloorApi.md#makefloorprivate) | **POST** /api/memory/make/floor/private/{floor_id} |
|
|
140
135
|
|
|
141
|
-
|
|
136
|
+
Make floor Private
|
|
137
|
+
*FloorApi*
|
|
138
|
+
|
|
139
|
+
| [**makeFloorPublic**](docs/FloorApi.md#makefloorpublic) | **POST** /api/memory/make/floor/public/{floor_id} |
|
|
140
|
+
|
|
141
|
+
Make floor public
|
|
142
|
+
*FloorApi*
|
|
143
|
+
|
|
144
|
+
| [**renameFloor**](docs/FloorApi.md#renamefloor) | **POST** /api/memory/change/floor/id |
|
|
145
|
+
|
|
146
|
+
Rename floor
|
|
142
147
|
*QueryApi*
|
|
143
148
|
|
|
144
149
|
| [**query**](docs/QueryApi.md#queryoperation) | **POST** /agent/memory/query |
|
|
@@ -149,14 +154,18 @@ Query (Primary API)
|
|
|
149
154
|
### Models
|
|
150
155
|
|
|
151
156
|
- [BlockDetails](docs/BlockDetails.md)
|
|
157
|
+
- [ChangeEmail200Response](docs/ChangeEmail200Response.md)
|
|
158
|
+
- [ChangeEmail200ResponsePodInfo](docs/ChangeEmail200ResponsePodInfo.md)
|
|
159
|
+
- [ChangeEmail200ResponseProfile](docs/ChangeEmail200ResponseProfile.md)
|
|
160
|
+
- [ChangeEmail200ResponseProfileAvatar](docs/ChangeEmail200ResponseProfileAvatar.md)
|
|
152
161
|
- [ChangePassword200Response](docs/ChangePassword200Response.md)
|
|
162
|
+
- [EditFloor200Response](docs/EditFloor200Response.md)
|
|
153
163
|
- [EditFloor400Response](docs/EditFloor400Response.md)
|
|
154
164
|
- [EditFloor400ResponseError](docs/EditFloor400ResponseError.md)
|
|
155
165
|
- [Event400Response](docs/Event400Response.md)
|
|
156
166
|
- [Event400ResponseError](docs/Event400ResponseError.md)
|
|
157
167
|
- [EventResponse](docs/EventResponse.md)
|
|
158
168
|
- [FloorInfo](docs/FloorInfo.md)
|
|
159
|
-
- [GetFloorInformation200Response](docs/GetFloorInformation200Response.md)
|
|
160
169
|
- [GetRecentEvents200Response](docs/GetRecentEvents200Response.md)
|
|
161
170
|
- [GetRecentEvents200ResponseItemsInner](docs/GetRecentEvents200ResponseItemsInner.md)
|
|
162
171
|
- [GetRecentEvents200ResponseItemsInnerAuthor](docs/GetRecentEvents200ResponseItemsInnerAuthor.md)
|
|
@@ -174,10 +183,7 @@ Query (Primary API)
|
|
|
174
183
|
- [ResetPassword200Response](docs/ResetPassword200Response.md)
|
|
175
184
|
- [ResetPassword400Response](docs/ResetPassword400Response.md)
|
|
176
185
|
- [SendValidationCode200Response](docs/SendValidationCode200Response.md)
|
|
177
|
-
- [
|
|
178
|
-
- [SignInWithEmail200ResponsePodInfo](docs/SignInWithEmail200ResponsePodInfo.md)
|
|
179
|
-
- [SignInWithEmail200ResponseProfile](docs/SignInWithEmail200ResponseProfile.md)
|
|
180
|
-
- [SignInWithEmail200ResponseProfileAvatar](docs/SignInWithEmail200ResponseProfileAvatar.md)
|
|
186
|
+
- [SignInResponse](docs/SignInResponse.md)
|
|
181
187
|
- [SignUp200Response](docs/SignUp200Response.md)
|
|
182
188
|
- [SignUpResponse](docs/SignUpResponse.md)
|
|
183
189
|
- [UserDetails](docs/UserDetails.md)
|
|
@@ -202,7 +208,7 @@ and is automatically generated by the
|
|
|
202
208
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
203
209
|
|
|
204
210
|
- API version: `1.0.0`
|
|
205
|
-
- Package version: `1.0.
|
|
211
|
+
- Package version: `1.0.21`
|
|
206
212
|
- Generator version: `7.18.0`
|
|
207
213
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
208
214
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import * as runtime from '../runtime';
|
|
15
|
-
import type {
|
|
15
|
+
import type { ChangeEmail200Response, ChangePassword200Response, ResetPassword200Response, SendValidationCode200Response, SignInResponse, SignUp200Response, UserDetails } from '../models/index';
|
|
16
16
|
export interface ChangeEmailRequest {
|
|
17
17
|
newEmailId: string;
|
|
18
18
|
activationCode: string;
|
|
@@ -26,21 +26,11 @@ export interface ChangePasswordRequest {
|
|
|
26
26
|
activationCode: string;
|
|
27
27
|
userId?: string;
|
|
28
28
|
}
|
|
29
|
-
export interface
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
export interface MakeFloorPublicRequest {
|
|
35
|
-
floorId: string;
|
|
36
|
-
userId: string;
|
|
37
|
-
appId: string;
|
|
38
|
-
}
|
|
39
|
-
export interface RenameFloorRequest {
|
|
40
|
-
userId: string;
|
|
41
|
-
appId: string;
|
|
42
|
-
from: string;
|
|
43
|
-
to: string;
|
|
29
|
+
export interface RegisterExternalUserIdentityRequest {
|
|
30
|
+
mobileNumber?: string;
|
|
31
|
+
emailId?: string;
|
|
32
|
+
name?: string;
|
|
33
|
+
appId?: string;
|
|
44
34
|
}
|
|
45
35
|
export interface ResetPasswordRequest {
|
|
46
36
|
newPassword: string;
|
|
@@ -84,27 +74,27 @@ export interface ValidateCodeRequest {
|
|
|
84
74
|
/**
|
|
85
75
|
*
|
|
86
76
|
*/
|
|
87
|
-
export declare class
|
|
77
|
+
export declare class AuthApi extends runtime.BaseAPI {
|
|
88
78
|
/**
|
|
89
79
|
* 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.
|
|
90
80
|
* Change email ID
|
|
91
81
|
*/
|
|
92
|
-
changeEmailRaw(requestParameters: ChangeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
82
|
+
changeEmailRaw(requestParameters: ChangeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChangeEmail200Response>>;
|
|
93
83
|
/**
|
|
94
84
|
* 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.
|
|
95
85
|
* Change email ID
|
|
96
86
|
*/
|
|
97
|
-
changeEmail(requestParameters: ChangeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
87
|
+
changeEmail(requestParameters: ChangeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangeEmail200Response>;
|
|
98
88
|
/**
|
|
99
89
|
* Updates the mobile number associated with an existing user account after validating a one-time activation code sent to the **new mobile number**. This operation can only be performed by a **logged-in user**. When a user initiates a mobile number change, an activation code is sent to the newly provided mobile number. The mobile number update takes effect only after the activation code is successfully validated. If the activation code validation fails, the mobile number remains unchanged. --- ### **Authentication** This endpoint requires **Bearer Token authentication**. ``` Authorization: Bearer <access_token> ``` --- ### **Request Body** ```json { \"user_id\": \"string\", \"new_mobile_number\": \"string\", \"activation_code\": \"string\" } ``` **Field Description** * `user_id` – Unique identifier of the logged-in user * `new_mobile_number` – New mobile number to be associated with the account * `activation_code` – One-time activation code sent to the new mobile number for verification --- ### **Flow Summary** 1. User is authenticated and logged in 2. User requests to change mobile number 3. System sends an activation code to the **new mobile number** 4. User submits the activation code via this API 5. On successful validation, the mobile number is updated --- ### **Successful Response** On successful validation: * The activation code is verified * The user’s mobile number is updated immediately * A `success` string is returned confirming the mobile number 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 mobile number * The new mobile number is already in use * Authorization fails or the bearer token is missing or invalid In all error cases, the existing mobile number 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 * Mobile number changes require prior authentication * Rate limiting may be applied to prevent abuse --- ### **One-Line Summary** > Changes a user’s mobile number after validating an activation code sent to the new mobile number.
|
|
100
90
|
* Change Mobile number
|
|
101
91
|
*/
|
|
102
|
-
changeMobileNumberRaw(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
92
|
+
changeMobileNumberRaw(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChangeEmail200Response>>;
|
|
103
93
|
/**
|
|
104
94
|
* Updates the mobile number associated with an existing user account after validating a one-time activation code sent to the **new mobile number**. This operation can only be performed by a **logged-in user**. When a user initiates a mobile number change, an activation code is sent to the newly provided mobile number. The mobile number update takes effect only after the activation code is successfully validated. If the activation code validation fails, the mobile number remains unchanged. --- ### **Authentication** This endpoint requires **Bearer Token authentication**. ``` Authorization: Bearer <access_token> ``` --- ### **Request Body** ```json { \"user_id\": \"string\", \"new_mobile_number\": \"string\", \"activation_code\": \"string\" } ``` **Field Description** * `user_id` – Unique identifier of the logged-in user * `new_mobile_number` – New mobile number to be associated with the account * `activation_code` – One-time activation code sent to the new mobile number for verification --- ### **Flow Summary** 1. User is authenticated and logged in 2. User requests to change mobile number 3. System sends an activation code to the **new mobile number** 4. User submits the activation code via this API 5. On successful validation, the mobile number is updated --- ### **Successful Response** On successful validation: * The activation code is verified * The user’s mobile number is updated immediately * A `success` string is returned confirming the mobile number 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 mobile number * The new mobile number is already in use * Authorization fails or the bearer token is missing or invalid In all error cases, the existing mobile number 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 * Mobile number changes require prior authentication * Rate limiting may be applied to prevent abuse --- ### **One-Line Summary** > Changes a user’s mobile number after validating an activation code sent to the new mobile number.
|
|
105
95
|
* Change Mobile number
|
|
106
96
|
*/
|
|
107
|
-
changeMobileNumber(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
97
|
+
changeMobileNumber(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangeEmail200Response>;
|
|
108
98
|
/**
|
|
109
99
|
* ## 1) `POST /password/change` — Change Password (Logged-in User) Changes the password of an **authenticated user** who is currently logged in. This endpoint is used when a user is already signed in and wants to update their password as a security or preference action. The system validates a **one-time password-change verification code** (`activation_code`) issued specifically for the change-password flow. If the code is valid and not expired, the user’s password is updated to `new_password` and takes effect immediately. If verification fails, the password remains unchanged and an error response is returned. ### Authentication ✅ **Required**: Bearer token for the logged-in session ``` Authorization: Bearer <access_token> ``` ### Request Body (Form Data) * `user_id` (optional if derived from token) * `activation_code` (required) * `new_password` (required) ### Behavior Notes * Typically requires a prior call to **send a verification code** for password change (mode = password change). * `user_id` can be taken from the access token; include it only if your system requires it explicitly. ### One-Line Summary > Changes the password for a logged-in user after validating a one-time password-change code.
|
|
110
100
|
* Change Password
|
|
@@ -116,35 +106,15 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
116
106
|
*/
|
|
117
107
|
changePassword(requestParameters: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangePassword200Response>;
|
|
118
108
|
/**
|
|
119
|
-
* This API
|
|
120
|
-
*
|
|
121
|
-
*/
|
|
122
|
-
makeFloorPrivateRaw(requestParameters: MakeFloorPrivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFloorInformation200Response>>;
|
|
123
|
-
/**
|
|
124
|
-
* This API changes a floor’s visibility to **PRIVATE**. It is used when a floor owner wants to **restrict access** to a floor that is currently public. After the update, the floor becomes private and is no longer accessible to non-authorized users (based on your platform’s access rules). This endpoint is **state-changing**: * If the floor is **PUBLIC**, it will be converted to **PRIVATE** * If the floor is already **PRIVATE**, the API returns success (idempotent) or an “already private” response depending on implementation This API is commonly used in: * Floor settings → “Privacy” toggle * Developer-managed pod workflows (app_id context) * Admin tools (if applicable) --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or `multipart/form-data` if your system uses form-data) *(Document whichever you actually accept; below assumes standard form fields.)* --- ## Request Parameters (Form Fields) | Field | Type | Required | Description | | ---------- | ------ | -------- | -------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the change. Must be the **owner** of the floor. | | `floor_id` | String | **Yes** | Public identifier of the floor to update. | | `app_id` | String | No | Calling application identifier (used for developer/pod integration). | --- ## Authorization Rules (Critical) * The caller must be authenticated as `user_id` * **Only the floor owner** can change floor visibility * If the user is not the owner, the request must be rejected --- ## Behavior Rules * Converts visibility from **PUBLIC → PRIVATE** * Does not modify floor content or blocks * Access enforcement for private floors is applied immediately after the change **Idempotency** * Calling this API multiple times should not cause repeated changes * If already private, the API should either: * return success with a message like `\"already private\"`, or * return a specific error/status indicating no-op --- ## Response Format `application/json` --- ## Sample Success Response *(Example — adjust to match your actual response format)* ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PRIVATE\", \"message\": \"Floor is now private\" } ``` --- ## Sample No-Op Response (Already Private) ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PRIVATE\", \"message\": \"Floor is already private\" } ``` --- ## Error Responses (Examples) ### Not Authorized (Not Owner) ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can change floor visibility\" } ``` ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Floor not found\" } ``` ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` --- ## Notes * This API is intended to control floor visibility only; membership/invite rules (for private floors) are handled elsewhere. * `app_id` is provided for developer/pod applications and is optional unless enforced by your app model. * If you support floor types like `POD`, document whether pods are allowed to be private or not (some platforms restrict this).
|
|
125
|
-
* Make floor Private
|
|
126
|
-
*/
|
|
127
|
-
makeFloorPrivate(requestParameters: MakeFloorPrivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFloorInformation200Response>;
|
|
128
|
-
/**
|
|
129
|
-
* This API changes a floor’s visibility to **PUBLIC**. It is used when a floor owner wants to **make a private floor accessible to everyone**. After the update, the floor becomes public and can be viewed and discovered by any user, subject to platform rules (search, feeds, pods, etc.). This endpoint performs a **visibility state transition**: * **PRIVATE → PUBLIC** * If the floor is already public, the operation is treated as **idempotent** (no state change). This API is typically used from: * Floor settings → Privacy / Visibility controls * Owner or admin tools * Developer or pod-based applications using `app_id` --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or `multipart/form-data`, depending on your implementation) --- ## Request Parameters (Form Fields) | Field | Type | Required | Description | | ---------- | ------ | -------- | ------------------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the change. Must be the **owner** of the floor. | | `floor_id` | String | **Yes** | Public identifier of the floor whose visibility is to be changed. | | `app_id` | String | No | Identifier of the calling application (used mainly for pod/developer contexts). | --- ## Authorization Rules (Critical) * The caller must be authenticated as `user_id` * **Only the floor owner** is allowed to change the floor’s visibility * Requests from non-owners must be rejected --- ## Behavior Rules * Converts floor visibility from **PRIVATE → PUBLIC** * Does not modify floor content, blocks, or ownership * Visibility change takes effect immediately ### Idempotency * If the floor is already public, the API should: * Return success with a message indicating no change, or * Return a specific “already public” status (implementation-dependent) --- ## Response Format `application/json` --- ## Sample Success Response ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PUBLIC\", \"message\": \"Floor is now public\" } ``` --- ## Sample No-Op Response (Already Public) ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PUBLIC\", \"message\": \"Floor is already public\" } ``` --- ## Error Responses (Examples) ### Not Authorized (Not Owner) ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can change floor visibility\" } ``` --- ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Floor not found\" } ``` --- ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` --- ## Notes for Developers * This API controls **visibility only**. Membership, invitations, and moderation rules are handled by separate APIs. * `app_id` is optional and primarily used for developer-managed or pod floors. * Clients should refresh floor metadata (e.g., via `/api/floor/info`) after a successful visibility change. --- ### Mental Model (One Line) > **This API answers: “Make this floor visible to everyone.”**
|
|
130
|
-
* Make floor public
|
|
131
|
-
*/
|
|
132
|
-
makeFloorPublicRaw(requestParameters: MakeFloorPublicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFloorInformation200Response>>;
|
|
133
|
-
/**
|
|
134
|
-
* This API changes a floor’s visibility to **PUBLIC**. It is used when a floor owner wants to **make a private floor accessible to everyone**. After the update, the floor becomes public and can be viewed and discovered by any user, subject to platform rules (search, feeds, pods, etc.). This endpoint performs a **visibility state transition**: * **PRIVATE → PUBLIC** * If the floor is already public, the operation is treated as **idempotent** (no state change). This API is typically used from: * Floor settings → Privacy / Visibility controls * Owner or admin tools * Developer or pod-based applications using `app_id` --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or `multipart/form-data`, depending on your implementation) --- ## Request Parameters (Form Fields) | Field | Type | Required | Description | | ---------- | ------ | -------- | ------------------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the change. Must be the **owner** of the floor. | | `floor_id` | String | **Yes** | Public identifier of the floor whose visibility is to be changed. | | `app_id` | String | No | Identifier of the calling application (used mainly for pod/developer contexts). | --- ## Authorization Rules (Critical) * The caller must be authenticated as `user_id` * **Only the floor owner** is allowed to change the floor’s visibility * Requests from non-owners must be rejected --- ## Behavior Rules * Converts floor visibility from **PRIVATE → PUBLIC** * Does not modify floor content, blocks, or ownership * Visibility change takes effect immediately ### Idempotency * If the floor is already public, the API should: * Return success with a message indicating no change, or * Return a specific “already public” status (implementation-dependent) --- ## Response Format `application/json` --- ## Sample Success Response ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PUBLIC\", \"message\": \"Floor is now public\" } ``` --- ## Sample No-Op Response (Already Public) ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PUBLIC\", \"message\": \"Floor is already public\" } ``` --- ## Error Responses (Examples) ### Not Authorized (Not Owner) ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can change floor visibility\" } ``` --- ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Floor not found\" } ``` --- ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` --- ## Notes for Developers * This API controls **visibility only**. Membership, invitations, and moderation rules are handled by separate APIs. * `app_id` is optional and primarily used for developer-managed or pod floors. * Clients should refresh floor metadata (e.g., via `/api/floor/info`) after a successful visibility change. --- ### Mental Model (One Line) > **This API answers: “Make this floor visible to everyone.”**
|
|
135
|
-
* Make floor public
|
|
136
|
-
*/
|
|
137
|
-
makeFloorPublic(requestParameters: MakeFloorPublicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFloorInformation200Response>;
|
|
138
|
-
/**
|
|
139
|
-
* This API renames a floor by changing knowing the **floor identifier (floor_id)**. It allows the **floor owner** to update the public-facing floor ID (slug/handle) from an old value to a new value. This is typically used when the owner wants to rebrand, reorganize, or correct the floor’s identifier. ⚠️ **This operation affects how the floor is accessed and referenced externally**, so it must be performed carefully. --- ## Ownership & Authorization (Critical) * The caller **must be authenticated** * **Only the floor owner** is allowed to rename a floor * Members, followers, or non-owners **cannot** perform this operation * Ownership is validated internally using `user_id` > If the user is not the owner, the request must be rejected. --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or equivalent form-data encoding) --- ## Request Parameters (Form Fields) | Parameter | Type | Required | Description | | --------- | ------ | -------- | ------------------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the rename. Must be the **owner** of the floor. | | `from` | String | **Yes** | Existing floor ID (current identifier to be renamed). | | `to` | String | **Yes** | New floor ID to assign to the floor. | | `app_id` | String | No | Identifier of the calling application (used mainly for pod/developer contexts). | --- ## Rename Rules & Constraints * The `from` floor ID **must exist** * The `to` floor ID **must be unique** and not already in use * The rename operation updates **only the floor ID** * Floor ownership, blocks, posts, and internal `fid` remain unchanged * Any links or references using the old floor ID may no longer be valid after rename --- ## Behavior Summary | Scenario | Result | | ---------------------------- | ------------------------------------------------- | | Valid owner + unique new ID | Floor ID renamed successfully | | Non-owner user | Request rejected | | `from` floor ID not found | Error | | `to` floor ID already exists | Error | | `from` == `to` | No-op or validation error (implementation choice) | --- ## Response Format `application/json` --- ## Sample Success Response ```json { \"status\": \"SUCCESS\", \"old_floor_id\": \"oldfloorid\", \"new_floor_id\": \"newfloorid\", \"message\": \"Floor ID renamed successfully\" } ``` --- ## Sample Error Responses ### Not Floor Owner ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can rename the floor\" } ``` --- ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Source floor ID does not exist\" } ``` --- ### Floor ID Already Exists ```json { \"status\": \"ERROR\", \"message\": \"Target floor ID is already in use\" } ``` --- ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id, from, and to are required\" } ``` --- ## Notes for Developers * This API **renames the public identifier only**; the internal immutable floor ID (`fid`) is not affected. * Clients should refresh cached floor metadata after a successful rename. * If your platform supports deep links or bookmarks, consider redirect or alias handling for old floor IDs (if supported). --- ### One-Line Mental Model > **This API answers: “Change the public identity (ID) of a floor, owner-only.”**
|
|
140
|
-
* Rename floor
|
|
109
|
+
* This API allows a calling application to **pass externally authenticated user identity information to xfloor** after completing authentication within its own system. xfloor **does not perform authentication, credential verification, or session management** as part of this API. The calling application is fully responsible for validating the user and ensuring the correctness of the identity data provided. Upon invocation, xfloor will: * **Create a new user profile** if no matching user exists, or * **Update the existing user profile** if the user is already present. xfloor returns a unique `xfloor_user_id`, which serves as the **canonical user identifier** and must be used in all subsequent xfloor APIs, including floors, blocks, conversations, memory interactions, and analytics.
|
|
110
|
+
* External User Registration
|
|
141
111
|
*/
|
|
142
|
-
|
|
112
|
+
registerExternalUserIdentityRaw(requestParameters: RegisterExternalUserIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChangeEmail200Response>>;
|
|
143
113
|
/**
|
|
144
|
-
* This API
|
|
145
|
-
*
|
|
114
|
+
* This API allows a calling application to **pass externally authenticated user identity information to xfloor** after completing authentication within its own system. xfloor **does not perform authentication, credential verification, or session management** as part of this API. The calling application is fully responsible for validating the user and ensuring the correctness of the identity data provided. Upon invocation, xfloor will: * **Create a new user profile** if no matching user exists, or * **Update the existing user profile** if the user is already present. xfloor returns a unique `xfloor_user_id`, which serves as the **canonical user identifier** and must be used in all subsequent xfloor APIs, including floors, blocks, conversations, memory interactions, and analytics.
|
|
115
|
+
* External User Registration
|
|
146
116
|
*/
|
|
147
|
-
|
|
117
|
+
registerExternalUserIdentity(requestParameters?: RegisterExternalUserIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangeEmail200Response>;
|
|
148
118
|
/**
|
|
149
119
|
* --- ## Reset Password (Forgot Password, Not Logged In) Resets the password of a user who **cannot log in** and is using a **forgot-password** flow. This endpoint is used when the user is not authenticated and requests a password reset using a verified identity channel such as **email** or **mobile number**. The system validates a **one-time reset verification code** (`activation_code`) issued for the reset-password flow. If valid and not expired, the password is updated to `new_password` and takes effect immediately. If verification fails, the password remains unchanged and an error response is returned. ### Authentication ✅ **Recommended** (better security): a short-lived **reset token** issued after initiating reset ``` Authorization: Bearer <reset_token> ``` > If you don’t use a reset token, you must enforce strong rate limiting + OTP attempt throttling on this endpoint. ### Request Body (Form Data) * `email_id` or `mobile_number` (required to identify user) * `activation_code` (required) * `new_password` (required) * `user_id` (optional, if your reset flow already resolved it) ### Behavior Notes * Requires a prior call to **initiate reset** and send OTP/code (mode = forgot password). * Must enforce code attempt limits and expiration strictly. ### One-Line Summary > Resets a user’s password (forgot-password flow) after validating a one-time reset code sent to email or mobile.
|
|
150
120
|
* Reset Password
|
|
@@ -169,22 +139,22 @@ export declare class DefaultApi extends runtime.BaseAPI {
|
|
|
169
139
|
* Authenticates a user using a registered email ID. The authentication mechanism is determined by the specified `mode`. * When `login_type` is set to **`1`**, the user is authenticated using the provided **password**. * When `login_type` is set to **`2`**, the user is authenticated using a **one-time activation code (OTP)**. For OTP-based authentication (`login_type = 2`), the client **must first invoke the Send Validation Code API** with the appropriate login mode to generate and deliver the activation code to the user. --- ### **Request Body** | Field | Type | Required | Description | | ------------ | ------------- | -------- | ----------------------------------------------------------------- | | `email_id` | string | Yes | Email ID | | `pass_code` | string | Yes | Password/Validation code depending on the login_type| | `login_type` | string | Yes | login type 1 for password 2 for validation code| |`app_id` | string | Yes | App ID | **Field Description** * `email_id` – Registered email address of the user * `pass_code` – password or activation code (this is password if it is 1 and 2 it is validation code) * `app_id` - App ID which is a 13 digit numeric value * `login_type` – Login type * `1` → Password-based login * `2` → Activation code (OTP)–based login --- ### **Behavior Notes** * When `login_type = 2`, password validation is bypassed. * OTP-based login requires a prior call to ` /auth-service/send/sign/in/validation/code`. * If the required credentials for the selected mode are missing or invalid, authentication fails. --- ### **Successful Response** On successful authentication, the user is signed in and a success response is returned as per the authentication flow. --- ### **Error Response** The API returns an error response if: * The email ID is not registered * The password is incorrect (`login_type = 1 `) * The activation code is missing, invalid, or expired (`login_type = 2`) * The mode value is invalid or unsupported --- ### **One-Line Summary** > Signs in a user using an email ID with either password-based or OTP-based authentication, based on the selected mode.
|
|
170
140
|
* Sign In with email ID
|
|
171
141
|
*/
|
|
172
|
-
signInWithEmailRaw(requestParameters: SignInWithEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
142
|
+
signInWithEmailRaw(requestParameters: SignInWithEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignInResponse>>;
|
|
173
143
|
/**
|
|
174
144
|
* Authenticates a user using a registered email ID. The authentication mechanism is determined by the specified `mode`. * When `login_type` is set to **`1`**, the user is authenticated using the provided **password**. * When `login_type` is set to **`2`**, the user is authenticated using a **one-time activation code (OTP)**. For OTP-based authentication (`login_type = 2`), the client **must first invoke the Send Validation Code API** with the appropriate login mode to generate and deliver the activation code to the user. --- ### **Request Body** | Field | Type | Required | Description | | ------------ | ------------- | -------- | ----------------------------------------------------------------- | | `email_id` | string | Yes | Email ID | | `pass_code` | string | Yes | Password/Validation code depending on the login_type| | `login_type` | string | Yes | login type 1 for password 2 for validation code| |`app_id` | string | Yes | App ID | **Field Description** * `email_id` – Registered email address of the user * `pass_code` – password or activation code (this is password if it is 1 and 2 it is validation code) * `app_id` - App ID which is a 13 digit numeric value * `login_type` – Login type * `1` → Password-based login * `2` → Activation code (OTP)–based login --- ### **Behavior Notes** * When `login_type = 2`, password validation is bypassed. * OTP-based login requires a prior call to ` /auth-service/send/sign/in/validation/code`. * If the required credentials for the selected mode are missing or invalid, authentication fails. --- ### **Successful Response** On successful authentication, the user is signed in and a success response is returned as per the authentication flow. --- ### **Error Response** The API returns an error response if: * The email ID is not registered * The password is incorrect (`login_type = 1 `) * The activation code is missing, invalid, or expired (`login_type = 2`) * The mode value is invalid or unsupported --- ### **One-Line Summary** > Signs in a user using an email ID with either password-based or OTP-based authentication, based on the selected mode.
|
|
175
145
|
* Sign In with email ID
|
|
176
146
|
*/
|
|
177
|
-
signInWithEmail(requestParameters: SignInWithEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
147
|
+
signInWithEmail(requestParameters: SignInWithEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignInResponse>;
|
|
178
148
|
/**
|
|
179
149
|
* Authenticates a user using a registered mobile number. The authentication method is determined by the specified `mode`. * When `login_type` is set to **`1`**, the user is authenticated using the **password** associated with the account. * When `login_type` is set to **`2`**, the user is authenticated using a **one-time activation code (OTP)** sent to the registered mobile number. For OTP-based authentication (`login_type = 1`), the client **must first call the Send Validation Code API** with the appropriate login mode to generate and deliver the activation code. --- ### **Request Formdata** | Field | Type | Required | Description | | ------------ | ------------- | -------- | ----------------------------------------------------------------- | | `mobile_number` | string | Yes | Mobile number| | `pass_code` | string | Yes | Password/Validation code depending on the login_type| | `login_type` | string | Yes | login type 1 for password 2 for validation code| |`app_id` | string | Yes | App ID | **Field Description** * `mobile_number` – Registered mobile number of the user * `pass_code` – Password / Validation code (password when `login_type= 1`; validation code when `login_type = 2`) * `login_type` – Login type * `1` → Password-based login * `2` → Activation code (OTP)–based login --- ### **Behavior Notes** * When `login_type = 2`, password validation is skipped. * OTP-based login requires a prior call to `/auth-service/send/sign/in/validation/code`. * Missing or invalid credentials for the selected mode will result in authentication failure. --- ### **Successful Response** On successful authentication, the user is signed in and a success response is returned according to the authentication flow. --- ### **Error Response** The API returns an error response if: * The mobile number is not registered * The password is incorrect (`login_type = 1`) * The activation code is missing, invalid, or expired (`login_type = 2`) * An invalid or unsupported mode is provided --- ### **One-Line Summary** > Signs in a user using a mobile number with either password-based or OTP-based authentication, based on the selected mode.
|
|
180
150
|
* Sign In with Mobile number
|
|
181
151
|
*/
|
|
182
|
-
signInWithMobileNumberRaw(requestParameters: SignInWithMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
152
|
+
signInWithMobileNumberRaw(requestParameters: SignInWithMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignInResponse>>;
|
|
183
153
|
/**
|
|
184
154
|
* Authenticates a user using a registered mobile number. The authentication method is determined by the specified `mode`. * When `login_type` is set to **`1`**, the user is authenticated using the **password** associated with the account. * When `login_type` is set to **`2`**, the user is authenticated using a **one-time activation code (OTP)** sent to the registered mobile number. For OTP-based authentication (`login_type = 1`), the client **must first call the Send Validation Code API** with the appropriate login mode to generate and deliver the activation code. --- ### **Request Formdata** | Field | Type | Required | Description | | ------------ | ------------- | -------- | ----------------------------------------------------------------- | | `mobile_number` | string | Yes | Mobile number| | `pass_code` | string | Yes | Password/Validation code depending on the login_type| | `login_type` | string | Yes | login type 1 for password 2 for validation code| |`app_id` | string | Yes | App ID | **Field Description** * `mobile_number` – Registered mobile number of the user * `pass_code` – Password / Validation code (password when `login_type= 1`; validation code when `login_type = 2`) * `login_type` – Login type * `1` → Password-based login * `2` → Activation code (OTP)–based login --- ### **Behavior Notes** * When `login_type = 2`, password validation is skipped. * OTP-based login requires a prior call to `/auth-service/send/sign/in/validation/code`. * Missing or invalid credentials for the selected mode will result in authentication failure. --- ### **Successful Response** On successful authentication, the user is signed in and a success response is returned according to the authentication flow. --- ### **Error Response** The API returns an error response if: * The mobile number is not registered * The password is incorrect (`login_type = 1`) * The activation code is missing, invalid, or expired (`login_type = 2`) * An invalid or unsupported mode is provided --- ### **One-Line Summary** > Signs in a user using a mobile number with either password-based or OTP-based authentication, based on the selected mode.
|
|
185
155
|
* Sign In with Mobile number
|
|
186
156
|
*/
|
|
187
|
-
signInWithMobileNumber(requestParameters: SignInWithMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
157
|
+
signInWithMobileNumber(requestParameters: SignInWithMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignInResponse>;
|
|
188
158
|
/**
|
|
189
159
|
* Creates a new user account in the Floor POD using **either a mobile number or an email ID**. At least **one of `mobile_number` or `email_id` is required** to register a user. Both may be provided if available. The API registers the user under the specified application context and prepares the account for subsequent authentication and usage. Upon successful registration, the API returns: - a unique user_id identifying the newly created user, and - a success string indicating the outcome of the sign-up operation. The user account is created under the specified application context and can be used for subsequent interactions with Floor POD APIs. --- ### **Parameter Clarification (Recommended)** * `name` is mandatory for user profile creation * Either `mobile_number` **or** `email_id` must be present * `app_id` is optional and used to associate the user with a specific application
|
|
190
160
|
* Sign Up
|