@xfloor/floor-memory-sdk-ts 1.0.0

package/LICENSE

@@ -0,0 +1 @@
+MIT License

package/README.md

@@ -0,0 +1,176 @@
+# @xfloor/floor-memory-sdk-ts@1.0.0
+
+A TypeScript SDK client for the appfloor.in API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install @xfloor/floor-memory-sdk-ts --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@xfloor/floor-memory-sdk-ts';
+import type { ChangeEmailRequest } from '@xfloor/floor-memory-sdk-ts';
+
+async function example() {
+  console.log("🚀 Testing @xfloor/floor-memory-sdk-ts SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DefaultApi(config);
+
+  const body = {
+    // string | New Email ID
+    newEmailId: newEmailId_example,
+    // string | Validation code
+    activationCode: activationCode_example,
+  } satisfies ChangeEmailRequest;
+
+  try {
+    const data = await api.changeEmail(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *https://appfloor.in*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*DefaultApi* | [**changeEmail**](docs/DefaultApi.md#changeemail) | **POST** /auth-service/change/email | Change email ID
+*DefaultApi* | [**changeMobileNumber**](docs/DefaultApi.md#changemobilenumber) | **POST** /auth-service/change/mobile | Change Mobile number
+*DefaultApi* | [**changePassword**](docs/DefaultApi.md#changepassword) | **POST** /auth-service/change/password | Change Password
+*DefaultApi* | [**makeFloorPrivate**](docs/DefaultApi.md#makefloorprivate) | **POST** /api/memory/make/floor/private | Make floor Private
+*DefaultApi* | [**makeFloorPublic**](docs/DefaultApi.md#makefloorpublic) | **POST** /api/memory/make/floor/public | Make floor public
+*DefaultApi* | [**registerExternalUserIdentity**](docs/DefaultApi.md#registerexternaluseridentity) | **POST** /memory/identity/external-user | External User Registration
+*DefaultApi* | [**renameFloor**](docs/DefaultApi.md#renamefloor) | **POST** /api/memory/change/floor/id | Rename floor
+*DefaultApi* | [**sendSignInValidationCode**](docs/DefaultApi.md#sendsigninvalidationcode) | **POST** /auth-service/send/sign/in/validation/code | Send Sign-In Validation Code (OTP)
+*DefaultApi* | [**sendValidationCode**](docs/DefaultApi.md#sendvalidationcodeoperation) | **POST** /auth-service/send/validation/code | Send Validation code
+*DefaultApi* | [**signInWithEmail**](docs/DefaultApi.md#signinwithemail) | **POST** /auth-service/sign/in/with/email | Sign In with email ID
+*DefaultApi* | [**signInWithMobileNumber**](docs/DefaultApi.md#signinwithmobilenumber) | **POST** /auth-service/sign/in/with/mobile/number | Sign In with Mobile number
+*DefaultApi* | [**signUp**](docs/DefaultApi.md#signup) | **POST** /auth-service/sign/up | Sign Up
+*DefaultApi* | [**validateCode**](docs/DefaultApi.md#validatecodeoperation) | **POST** /auth-service/validate/activation/code | Validation
+*EditFloorApi* | [**editFloor**](docs/EditFloorApi.md#editfloor) | **POST** /api/memory/edit/floor/{floor_id} | Edit floor
+*EventApi* | [**event**](docs/EventApi.md#event) | **POST** /api/memory/events | Create Event (Post Content)
+*GetFloorInformationApi* | [**getFloorInformation**](docs/GetFloorInformationApi.md#getfloorinformation) | **GET** /api/memory/floor/info/{floor_id} | Basic information of a floor
+*GetRecentEventsApi* | [**getRecentEvents**](docs/GetRecentEventsApi.md#getrecentevents) | **GET** /api/memory/recent/events | Recent Events
+*QueryApi* | [**query**](docs/QueryApi.md#queryoperation) | **POST** /agent/memory/query | Query (Primary API)
+
+
+### Models
+
+- [BlockDetails](docs/BlockDetails.md)
+- [ChangePassword200Response](docs/ChangePassword200Response.md)
+- [EditFloor400Response](docs/EditFloor400Response.md)
+- [EditFloor400ResponseError](docs/EditFloor400ResponseError.md)
+- [Event400Response](docs/Event400Response.md)
+- [Event400ResponseError](docs/Event400ResponseError.md)
+- [EventResponse](docs/EventResponse.md)
+- [FloorInfo](docs/FloorInfo.md)
+- [GetFloorInformation200Response](docs/GetFloorInformation200Response.md)
+- [GetRecentEvents200Response](docs/GetRecentEvents200Response.md)
+- [GetRecentEvents200ResponseItemsInner](docs/GetRecentEvents200ResponseItemsInner.md)
+- [GetRecentEvents200ResponseItemsInnerAuthor](docs/GetRecentEvents200ResponseItemsInnerAuthor.md)
+- [GetRecentEvents400Response](docs/GetRecentEvents400Response.md)
+- [GetRecentEvents400ResponseError](docs/GetRecentEvents400ResponseError.md)
+- [Media](docs/Media.md)
+- [Model400ErrorCode](docs/Model400ErrorCode.md)
+- [Query422Response](docs/Query422Response.md)
+- [Query422ResponseError](docs/Query422ResponseError.md)
+- [QueryRequest](docs/QueryRequest.md)
+- [QueryRequestFilters](docs/QueryRequestFilters.md)
+- [QueryResponse](docs/QueryResponse.md)
+- [QueryResponseItemsInner](docs/QueryResponseItemsInner.md)
+- [SendSignInValidationCode200Response](docs/SendSignInValidationCode200Response.md)
+- [SendSignInValidationCode400Response](docs/SendSignInValidationCode400Response.md)
+- [SendValidationCode200Response](docs/SendValidationCode200Response.md)
+- [SendValidationCodeRequest](docs/SendValidationCodeRequest.md)
+- [SignInWithEmail200Response](docs/SignInWithEmail200Response.md)
+- [SignInWithEmail200ResponseProfile](docs/SignInWithEmail200ResponseProfile.md)
+- [SignInWithEmail200ResponseProfileAvatar](docs/SignInWithEmail200ResponseProfileAvatar.md)
+- [SignUp200Response](docs/SignUp200Response.md)
+- [SignUpResponse](docs/SignUpResponse.md)
+- [UserDetails](docs/UserDetails.md)
+- [ValidateCode400Response](docs/ValidateCode400Response.md)
+- [ValidateCode400ResponseError](docs/ValidateCode400ResponseError.md)
+- [ValidateCode412Response](docs/ValidateCode412Response.md)
+- [ValidateCodeRequest](docs/ValidateCodeRequest.md)
+
+### Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearer"></a>
+#### bearer
+
+
+- **Type**: HTTP Bearer Token authentication
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `1.0.0`
+- Package version: `1.0.0`
+- Generator version: `7.18.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+For more information, please visit [https://xfloor.ai/ipomo/blog1551084548304/](https://xfloor.ai/ipomo/blog1551084548304/)
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[MIT](https://xfloor.ai/ipomo/blog1551084548304/1642341504453)

package/dist/apis/DefaultApi.d.ts

@@ -0,0 +1,209 @@
+/**
+ * Floor Memory
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants.   This set of APIs are divided into two parts.  - Memory and  - Registration.   The developer has two ways of using the APIs for the app development. Developer can choose to the  Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: contact@ipomo.in
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ChangePassword200Response, GetFloorInformation200Response, SendSignInValidationCode200Response, SendValidationCode200Response, SendValidationCodeRequest, SignInWithEmail200Response, SignUp200Response, UserDetails, ValidateCodeRequest } from '../models/index';
+export interface ChangeEmailRequest {
+    newEmailId: string;
+    activationCode: string;
+}
+export interface ChangeMobileNumberRequest {
+    body: object;
+}
+export interface ChangePasswordRequest {
+    userId?: string;
+    newPassword?: string;
+    acticationCode?: string;
+}
+export interface MakeFloorPrivateRequest {
+    floorId?: string;
+    userId?: string;
+    appId?: string;
+}
+export interface MakeFloorPublicRequest {
+    floorId?: string;
+    userId?: string;
+    appId?: string;
+}
+export interface RegisterExternalUserIdentityRequest {
+    mobileNumber?: string;
+    emailId?: string;
+    name?: string;
+    appId?: string;
+}
+export interface RenameFloorRequest {
+    userId?: string;
+    appId?: string;
+    from?: string;
+    to?: string;
+}
+export interface SendSignInValidationCodeRequest {
+    appId: string;
+    mobileNumber?: string;
+    emailId?: string;
+}
+export interface SendValidationCodeOperationRequest {
+    sendValidationCodeRequest: SendValidationCodeRequest;
+}
+export interface SignInWithEmailRequest {
+    emailId: string;
+    passCode: string;
+    loginType: string;
+    appId?: string;
+}
+export interface SignInWithMobileNumberRequest {
+    body: object;
+}
+export interface SignUpRequest {
+    name: string;
+    password: string;
+    emailId?: string;
+    mobileNumber?: string;
+    appId?: string;
+}
+export interface ValidateCodeOperationRequest {
+    validateCodeRequest: ValidateCodeRequest;
+}
+/**
+ *
+ */
+export declare class DefaultApi extends runtime.BaseAPI {
+    /**
+     * 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.
+     * Change email ID
+     */
+    changeEmailRaw(requestParameters: ChangeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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.
+     * Change email ID
+     */
+    changeEmail(requestParameters: ChangeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * 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.
+     * Change Mobile number
+     */
+    changeMobileNumberRaw(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * 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.
+     * Change Mobile number
+     */
+    changeMobileNumber(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Changes the password of an existing user after validating a one-time password change activation code.  This API validates the provided `activation_code` for the given `user_id`. If the activation code is valid and not expired, the user’s password is updated to the supplied `new_password` and takes effect immediately.  If the activation code validation fails, the password remains unchanged and an error response is returned.  ---  ### **Authentication**  This endpoint requires **Bearer Token authentication**.  ``` Authorization: Bearer <access_token> ```  ---  ### **Request Body (Form Data)**  | Field        | Type          | Required | Description                                                       | | ------------ | ------------- | -------- | ----------------------------------------------------------------- | | `user_id` | string | Yes      | User ID | | `new_password` | string | Yes      | New Password | | `activation_code` | string | Yes      | Activation code |   **Field Description**  * `user_id` – Unique identifier of the user requesting the password change * `new_password` – New password to be set for the user * `activation_code` – One-time activation code generated for password change verification  ---  ### **Successful Response**  On successful validation:  * The activation code is verified * The user password is updated immediately * The API returns a `success` string indicating that the password change was completed  ---  ### **Error Response**  The API returns an error response if:  * The activation code is invalid or expired * The activation code does not match the specified user * The password does not meet security or policy requirements * Authorization fails or the bearer token is missing or invalid  In all error cases, the existing password remains unchanged.  --- ### **Behavior Notes**  * Requires a prior call to `/auth-service/send/validation/code` with the proper mode. ---  ### **Security Notes**  * Activation codes are single-use and time-bound * Passwords are never returned in API responses * Rate limiting may be applied to prevent brute-force attempts  ---  ### **One-Line Summary**  > Updates a user’s password after validating a one-time activation code.
+     * Change Password
+     */
+    changePasswordRaw(requestParameters: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChangePassword200Response>>;
+    /**
+     * Changes the password of an existing user after validating a one-time password change activation code.  This API validates the provided `activation_code` for the given `user_id`. If the activation code is valid and not expired, the user’s password is updated to the supplied `new_password` and takes effect immediately.  If the activation code validation fails, the password remains unchanged and an error response is returned.  ---  ### **Authentication**  This endpoint requires **Bearer Token authentication**.  ``` Authorization: Bearer <access_token> ```  ---  ### **Request Body (Form Data)**  | Field        | Type          | Required | Description                                                       | | ------------ | ------------- | -------- | ----------------------------------------------------------------- | | `user_id` | string | Yes      | User ID | | `new_password` | string | Yes      | New Password | | `activation_code` | string | Yes      | Activation code |   **Field Description**  * `user_id` – Unique identifier of the user requesting the password change * `new_password` – New password to be set for the user * `activation_code` – One-time activation code generated for password change verification  ---  ### **Successful Response**  On successful validation:  * The activation code is verified * The user password is updated immediately * The API returns a `success` string indicating that the password change was completed  ---  ### **Error Response**  The API returns an error response if:  * The activation code is invalid or expired * The activation code does not match the specified user * The password does not meet security or policy requirements * Authorization fails or the bearer token is missing or invalid  In all error cases, the existing password remains unchanged.  --- ### **Behavior Notes**  * Requires a prior call to `/auth-service/send/validation/code` with the proper mode. ---  ### **Security Notes**  * Activation codes are single-use and time-bound * Passwords are never returned in API responses * Rate limiting may be applied to prevent brute-force attempts  ---  ### **One-Line Summary**  > Updates a user’s password after validating a one-time activation code.
+     * Change Password
+     */
+    changePassword(requestParameters?: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangePassword200Response>;
+    /**
+     * 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).
+     * Make floor Private
+     */
+    makeFloorPrivateRaw(requestParameters: MakeFloorPrivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFloorInformation200Response>>;
+    /**
+     * 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).
+     * Make floor Private
+     */
+    makeFloorPrivate(requestParameters?: MakeFloorPrivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFloorInformation200Response>;
+    /**
+     * 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.”**
+     * Make floor public
+     */
+    makeFloorPublicRaw(requestParameters: MakeFloorPublicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFloorInformation200Response>>;
+    /**
+     * 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.”**
+     * Make floor public
+     */
+    makeFloorPublic(requestParameters?: MakeFloorPublicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFloorInformation200Response>;
+    /**
+     * 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.
+     * External User Registration
+     */
+    registerExternalUserIdentityRaw(requestParameters: RegisterExternalUserIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignInWithEmail200Response>>;
+    /**
+     * 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.
+     * External User Registration
+     */
+    registerExternalUserIdentity(requestParameters?: RegisterExternalUserIdentityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignInWithEmail200Response>;
+    /**
+     * 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.”**
+     * Rename floor
+     */
+    renameFloorRaw(requestParameters: RenameFloorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFloorInformation200Response>>;
+    /**
+     * 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.”**
+     * Rename floor
+     */
+    renameFloor(requestParameters?: RenameFloorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFloorInformation200Response>;
+    /**
+     * 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
+     * Send Sign-In Validation Code (OTP)
+     */
+    sendSignInValidationCodeRaw(requestParameters: SendSignInValidationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendSignInValidationCode200Response>>;
+    /**
+     * 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
+     * Send Sign-In Validation Code (OTP)
+     */
+    sendSignInValidationCode(requestParameters: SendSignInValidationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendSignInValidationCode200Response>;
+    /**
+     * Generates and sends a one-time validation code to the user for verification of sensitive or critical account operations.  This API is used across multiple authentication and account-management flows. The validation code is delivered to the user via the appropriate channel (**email or mobile number**), based on the requested operation mode and the input provided.  The generated code is **time-bound**, **single-use**, and must be validated using the corresponding verification APIs to complete the requested action.  ---  ### **Usage Scenarios (Mode Definition)**  | Mode | Purpose                       | | ---- | ----------------------------- | | `0`  | Email or mobile number change | | `1`  | Password change               | | `2`  | Delete account                | | `3`  | Clear account                 | | `4`  | Signup Verification           |  **Mode `5` – Signup Verification** For login verification, the validation code is sent to **either the email ID or the mobile number provided in the request**. At least **one of email or mobile number must be supplied** for this mode.  ---  ### **Behavior**  * Generates a secure, one-time validation code * Sends the code to the appropriate channel:    * Email or mobile number, depending on the operation mode and input * Associates the code with:    * User identity (or login identifier)   * Requested operation (`mode`)   * Application context (if applicable) * Validation codes are valid for a limited duration and **cannot be reused**  ---  ### **Authentication**  This endpoint requires **Bearer Token authentication**, **except** where explicitly allowed (for example, login-related flows).  ``` Authorization: Bearer <access_token> ```  ---  ### **Successful Response**  On success, the API confirms that the validation code has been generated and successfully dispatched to the user.  ---  ### **Error Response**  The API returns an error response if:  * The user does not exist or is not eligible for the requested operation * The requested mode is invalid or unsupported * Required identifiers (email or mobile number for login verification) are missing * Rate limits are exceeded * Authorization fails (where applicable)  ---  ### **Security Notes (Recommended)**  * Validation codes are single-use and time-bound * Rate limiting is enforced to prevent abuse * Repeated failures may trigger temporary blocking or additional verification  ---  ### **One-Line Summary**  > Sends a one-time validation code for secure account and authentication operations, including login via email or mobile number.
+     * Send Validation code
+     */
+    sendValidationCodeRaw(requestParameters: SendValidationCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendValidationCode200Response>>;
+    /**
+     * Generates and sends a one-time validation code to the user for verification of sensitive or critical account operations.  This API is used across multiple authentication and account-management flows. The validation code is delivered to the user via the appropriate channel (**email or mobile number**), based on the requested operation mode and the input provided.  The generated code is **time-bound**, **single-use**, and must be validated using the corresponding verification APIs to complete the requested action.  ---  ### **Usage Scenarios (Mode Definition)**  | Mode | Purpose                       | | ---- | ----------------------------- | | `0`  | Email or mobile number change | | `1`  | Password change               | | `2`  | Delete account                | | `3`  | Clear account                 | | `4`  | Signup Verification           |  **Mode `5` – Signup Verification** For login verification, the validation code is sent to **either the email ID or the mobile number provided in the request**. At least **one of email or mobile number must be supplied** for this mode.  ---  ### **Behavior**  * Generates a secure, one-time validation code * Sends the code to the appropriate channel:    * Email or mobile number, depending on the operation mode and input * Associates the code with:    * User identity (or login identifier)   * Requested operation (`mode`)   * Application context (if applicable) * Validation codes are valid for a limited duration and **cannot be reused**  ---  ### **Authentication**  This endpoint requires **Bearer Token authentication**, **except** where explicitly allowed (for example, login-related flows).  ``` Authorization: Bearer <access_token> ```  ---  ### **Successful Response**  On success, the API confirms that the validation code has been generated and successfully dispatched to the user.  ---  ### **Error Response**  The API returns an error response if:  * The user does not exist or is not eligible for the requested operation * The requested mode is invalid or unsupported * Required identifiers (email or mobile number for login verification) are missing * Rate limits are exceeded * Authorization fails (where applicable)  ---  ### **Security Notes (Recommended)**  * Validation codes are single-use and time-bound * Rate limiting is enforced to prevent abuse * Repeated failures may trigger temporary blocking or additional verification  ---  ### **One-Line Summary**  > Sends a one-time validation code for secure account and authentication operations, including login via email or mobile number.
+     * Send Validation code
+     */
+    sendValidationCode(requestParameters: SendValidationCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendValidationCode200Response>;
+    /**
+     * 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.
+     * Sign In with email ID
+     */
+    signInWithEmailRaw(requestParameters: SignInWithEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignInWithEmail200Response>>;
+    /**
+     * 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.
+     * Sign In with email ID
+     */
+    signInWithEmail(requestParameters: SignInWithEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignInWithEmail200Response>;
+    /**
+     * 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.
+     * Sign In with Mobile number
+     */
+    signInWithMobileNumberRaw(requestParameters: SignInWithMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignInWithEmail200Response>>;
+    /**
+     * 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.
+     * Sign In with Mobile number
+     */
+    signInWithMobileNumber(requestParameters: SignInWithMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignInWithEmail200Response>;
+    /**
+     * 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
+     * Sign Up
+     */
+    signUpRaw(requestParameters: SignUpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUp200Response>>;
+    /**
+     * 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
+     * Sign Up
+     */
+    signUp(requestParameters: SignUpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUp200Response>;
+    /**
+     * Validates the activation code submitted by a newly registered user and completes the account activation process.  This API verifies the provided `activation_code` against the specified `user_id` and activation `mode` (e.g., email or mobile). Upon successful validation, the user account is activated and the API returns the associated **POD information** along with the user’s **profile details**.  If the activation code is invalid, expired, or does not match the user context, the API returns an appropriate error response and the account remains inactive.  ---  ### **Authentication**  This endpoint requires **Bearer Token authentication**.  * The token must be included in the `Authorization` header:    ```   Authorization: Bearer <access_token>   ```  ---  ### **Request Body**  ```json {   \"user_id\": \"string\",   \"activation_code\": \"string\",   \"app_id\": \"string\",   \"mode\": \"string\" } ```  **Field Description**  * `user_id` – Unique identifier of the newly registered user * `activation_code` – One-time validation code sent to the user * `app_id` – Application identifier (optional or context-specific) * `mode` – Activation channel used (e.g., `email`, `mobile`)  --- ### **Usage Scenarios (Mode Definition)**  | Mode | Purpose                       | | ---- | ----------------------------- | | `0`  | Email or mobile number change | | `1`  | Password change               | | `2`  | Delete account                | | `3`  | Clear account                 | | `5`  | Login verification            |  ### **Successful Response**  On successful validation:  * The user account is activated * The API returns:    * `pod_info` associated with the user   * User `profile` information  The activated account can now be used for login and other Floor POD operations.  ---  ### **Error Response**  The API returns an error response when:  * The activation code is invalid or expired * The activation code does not match the user or mode * The user is already activated * Authorization fails or the bearer token is missing/invalid  In all error cases, **account activation is not completed**.  ---  ### **One-Line Summary**  > Validates a user’s activation code, activates the account, and returns POD and profile details on success.
+     * Validation
+     */
+    validateCodeRaw(requestParameters: ValidateCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserDetails>>;
+    /**
+     * Validates the activation code submitted by a newly registered user and completes the account activation process.  This API verifies the provided `activation_code` against the specified `user_id` and activation `mode` (e.g., email or mobile). Upon successful validation, the user account is activated and the API returns the associated **POD information** along with the user’s **profile details**.  If the activation code is invalid, expired, or does not match the user context, the API returns an appropriate error response and the account remains inactive.  ---  ### **Authentication**  This endpoint requires **Bearer Token authentication**.  * The token must be included in the `Authorization` header:    ```   Authorization: Bearer <access_token>   ```  ---  ### **Request Body**  ```json {   \"user_id\": \"string\",   \"activation_code\": \"string\",   \"app_id\": \"string\",   \"mode\": \"string\" } ```  **Field Description**  * `user_id` – Unique identifier of the newly registered user * `activation_code` – One-time validation code sent to the user * `app_id` – Application identifier (optional or context-specific) * `mode` – Activation channel used (e.g., `email`, `mobile`)  --- ### **Usage Scenarios (Mode Definition)**  | Mode | Purpose                       | | ---- | ----------------------------- | | `0`  | Email or mobile number change | | `1`  | Password change               | | `2`  | Delete account                | | `3`  | Clear account                 | | `5`  | Login verification            |  ### **Successful Response**  On successful validation:  * The user account is activated * The API returns:    * `pod_info` associated with the user   * User `profile` information  The activated account can now be used for login and other Floor POD operations.  ---  ### **Error Response**  The API returns an error response when:  * The activation code is invalid or expired * The activation code does not match the user or mode * The user is already activated * Authorization fails or the bearer token is missing/invalid  In all error cases, **account activation is not completed**.  ---  ### **One-Line Summary**  > Validates a user’s activation code, activates the account, and returns POD and profile details on success.
+     * Validation
+     */
+    validateCode(requestParameters: ValidateCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserDetails>;
+}