@xfloor/floor-memory-sdk-ts 1.0.0 → 1.0.2

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 CHANGED
@@ -1,4 +1,4 @@
1
- # @xfloor/floor-memory-sdk-ts@1.0.0
1
+ # @xfloor/floor-memory-sdk-ts@1.0.2
2
2
 
3
3
  A TypeScript SDK client for the appfloor.in API.
4
4
 
@@ -58,12 +58,12 @@ All URIs are relative to *https://appfloor.in*
58
58
  | ----- | ------ | ------------ | -------------
59
59
  *DefaultApi* | [**changeEmail**](docs/DefaultApi.md#changeemail) | **POST** /auth-service/change/email | Change email ID
60
60
  *DefaultApi* | [**changeMobileNumber**](docs/DefaultApi.md#changemobilenumber) | **POST** /auth-service/change/mobile | Change Mobile number
61
- *DefaultApi* | [**changePassword**](docs/DefaultApi.md#changepassword) | **POST** /auth-service/change/password | Change Password
61
+ *DefaultApi* | [**changePassword**](docs/DefaultApi.md#changepassword) | **POST** /auth-service/password/change | Change Password
62
62
  *DefaultApi* | [**makeFloorPrivate**](docs/DefaultApi.md#makefloorprivate) | **POST** /api/memory/make/floor/private | Make floor Private
63
63
  *DefaultApi* | [**makeFloorPublic**](docs/DefaultApi.md#makefloorpublic) | **POST** /api/memory/make/floor/public | Make floor public
64
64
  *DefaultApi* | [**registerExternalUserIdentity**](docs/DefaultApi.md#registerexternaluseridentity) | **POST** /memory/identity/external-user | External User Registration
65
65
  *DefaultApi* | [**renameFloor**](docs/DefaultApi.md#renamefloor) | **POST** /api/memory/change/floor/id | Rename floor
66
- *DefaultApi* | [**sendSignInValidationCode**](docs/DefaultApi.md#sendsigninvalidationcode) | **POST** /auth-service/send/sign/in/validation/code | Send Sign-In Validation Code (OTP)
66
+ *DefaultApi* | [**resetPassword**](docs/DefaultApi.md#resetpassword) | **POST** /auth-service/password/reset | Reset Password
67
67
  *DefaultApi* | [**sendValidationCode**](docs/DefaultApi.md#sendvalidationcodeoperation) | **POST** /auth-service/send/validation/code | Send Validation code
68
68
  *DefaultApi* | [**signInWithEmail**](docs/DefaultApi.md#signinwithemail) | **POST** /auth-service/sign/in/with/email | Sign In with email ID
69
69
  *DefaultApi* | [**signInWithMobileNumber**](docs/DefaultApi.md#signinwithmobilenumber) | **POST** /auth-service/sign/in/with/mobile/number | Sign In with Mobile number
@@ -100,8 +100,8 @@ All URIs are relative to *https://appfloor.in*
100
100
  - [QueryRequestFilters](docs/QueryRequestFilters.md)
101
101
  - [QueryResponse](docs/QueryResponse.md)
102
102
  - [QueryResponseItemsInner](docs/QueryResponseItemsInner.md)
103
- - [SendSignInValidationCode200Response](docs/SendSignInValidationCode200Response.md)
104
- - [SendSignInValidationCode400Response](docs/SendSignInValidationCode400Response.md)
103
+ - [ResetPassword200Response](docs/ResetPassword200Response.md)
104
+ - [ResetPassword400Response](docs/ResetPassword400Response.md)
105
105
  - [SendValidationCode200Response](docs/SendValidationCode200Response.md)
106
106
  - [SendValidationCodeRequest](docs/SendValidationCodeRequest.md)
107
107
  - [SignInWithEmail200Response](docs/SignInWithEmail200Response.md)
@@ -132,7 +132,7 @@ and is automatically generated by the
132
132
  [OpenAPI Generator](https://openapi-generator.tech) project:
133
133
 
134
134
  - API version: `1.0.0`
135
- - Package version: `1.0.0`
135
+ - Package version: `1.0.2`
136
136
  - Generator version: `7.18.0`
137
137
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
138
138
 
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ChangePassword200Response, GetFloorInformation200Response, SendSignInValidationCode200Response, SendValidationCode200Response, SendValidationCodeRequest, SignInWithEmail200Response, SignUp200Response, UserDetails, ValidateCodeRequest } from '../models/index';
13
+ import type { ChangePassword200Response, GetFloorInformation200Response, ResetPassword200Response, SendValidationCode200Response, SendValidationCodeRequest, SignInWithEmail200Response, SignUp200Response, UserDetails, ValidateCodeRequest } from '../models/index';
14
14
  export interface ChangeEmailRequest {
15
15
  newEmailId: string;
16
16
  activationCode: string;
@@ -19,9 +19,9 @@ export interface ChangeMobileNumberRequest {
19
19
  body: object;
20
20
  }
21
21
  export interface ChangePasswordRequest {
22
+ newPassword: string;
23
+ activationCode: string;
22
24
  userId?: string;
23
- newPassword?: string;
24
- acticationCode?: string;
25
25
  }
26
26
  export interface MakeFloorPrivateRequest {
27
27
  floorId?: string;
@@ -45,10 +45,11 @@ export interface RenameFloorRequest {
45
45
  from?: string;
46
46
  to?: string;
47
47
  }
48
- export interface SendSignInValidationCodeRequest {
49
- appId: string;
50
- mobileNumber?: string;
48
+ export interface ResetPasswordRequest {
49
+ activationCode: string;
51
50
  emailId?: string;
51
+ mobileNumber?: string;
52
+ appId?: string;
52
53
  }
53
54
  export interface SendValidationCodeOperationRequest {
54
55
  sendValidationCodeRequest: SendValidationCodeRequest;
@@ -97,15 +98,15 @@ export declare class DefaultApi extends runtime.BaseAPI {
97
98
  */
98
99
  changeMobileNumber(requestParameters: ChangeMobileNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
99
100
  /**
100
- * 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.
101
+ * ## 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.
101
102
  * Change Password
102
103
  */
103
104
  changePasswordRaw(requestParameters: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChangePassword200Response>>;
104
105
  /**
105
- * 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.
106
+ * ## 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.
106
107
  * Change Password
107
108
  */
108
- changePassword(requestParameters?: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangePassword200Response>;
109
+ changePassword(requestParameters: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangePassword200Response>;
109
110
  /**
110
111
  * 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).
111
112
  * Make floor Private
@@ -147,15 +148,15 @@ export declare class DefaultApi extends runtime.BaseAPI {
147
148
  */
148
149
  renameFloor(requestParameters?: RenameFloorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFloorInformation200Response>;
149
150
  /**
150
- * 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
151
- * Send Sign-In Validation Code (OTP)
151
+ * --- ## 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.
152
+ * Reset Password
152
153
  */
153
- sendSignInValidationCodeRaw(requestParameters: SendSignInValidationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendSignInValidationCode200Response>>;
154
+ resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResetPassword200Response>>;
154
155
  /**
155
- * 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
156
- * Send Sign-In Validation Code (OTP)
156
+ * --- ## 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.
157
+ * Reset Password
157
158
  */
158
- sendSignInValidationCode(requestParameters: SendSignInValidationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendSignInValidationCode200Response>;
159
+ resetPassword(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResetPassword200Response>;
159
160
  /**
160
161
  * 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.
161
162
  * Send Validation code
@@ -197,12 +198,12 @@ export declare class DefaultApi extends runtime.BaseAPI {
197
198
  */
198
199
  signUp(requestParameters: SignUpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUp200Response>;
199
200
  /**
200
- * 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.
201
+ * ## **Validate Activation / Verification Code** This API **validates a one-time verification code** submitted by a user and **executes the corresponding account operation** based on the specified **mode**. Depending on the mode, the API may: * Activate a newly registered account * Confirm a login attempt * Verify a password change or reset * Validate email or mobile updates * Confirm account deletion or clearing requests The API verifies the provided `activation_code` against the given `user_id`, `mode`, and application context. If validation succeeds, the requested operation is completed and the API returns the relevant **POD information** and **user profile details** (where applicable). If validation fails, the operation is **not performed** and an appropriate error response is returned. --- ## **Authentication** This endpoint requires **Bearer Token authentication**. **Header** ``` Authorization: Bearer <access_token> ``` --- ## **Request Body** ```json { \"user_id\": \"string\", \"activation_code\": \"string\", \"app_id\": \"string\", \"mode\": \"string\" } ``` ### **Field Descriptions** * **user_id** – Unique identifier of the user initiating the operation * **activation_code** – One-time verification code sent to the user * **app_id** – Application identifier (optional or context-specific) * **mode**Operation context for which the verification is being performed --- ## **Usage Scenarios (Mode Definitions)** | Mode | Purpose | | ---- | ---------------------------------------- | | 0 | Email or mobile number change | | 1 | Password change | | 2 | Delete account | | 3 | Clear account | | 4 | Signup verification (account activation) | | 5 | Login verification | | 6 | Forgot password verification | --- ## **Successful Response** On successful validation: * The requested operation (based on `mode`) is completed * The API returns: * **POD information** associated with the user (if applicable) * **User profile details** (if applicable) Examples: * For **signup verification**, the user account is activated * For **login**, access is confirmed * For **password reset**, the user may proceed to set a new password * For **account deletion**, the request is confirmed --- ## **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 operation mode * The requested operation is already completed (e.g., user already activated) * Authorization fails or the bearer token is missing or invalid ⚠️ In all error cases, **no account state change occurs**. --- ## **One-Line Summary** > Validates a one-time verification code and securely completes the requested user account operation (signup, login, password change, or account actions), returning POD and profile details on success.
201
202
  * Validation
202
203
  */
203
204
  validateCodeRaw(requestParameters: ValidateCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserDetails>>;
204
205
  /**
205
- * 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.
206
+ * ## **Validate Activation / Verification Code** This API **validates a one-time verification code** submitted by a user and **executes the corresponding account operation** based on the specified **mode**. Depending on the mode, the API may: * Activate a newly registered account * Confirm a login attempt * Verify a password change or reset * Validate email or mobile updates * Confirm account deletion or clearing requests The API verifies the provided `activation_code` against the given `user_id`, `mode`, and application context. If validation succeeds, the requested operation is completed and the API returns the relevant **POD information** and **user profile details** (where applicable). If validation fails, the operation is **not performed** and an appropriate error response is returned. --- ## **Authentication** This endpoint requires **Bearer Token authentication**. **Header** ``` Authorization: Bearer <access_token> ``` --- ## **Request Body** ```json { \"user_id\": \"string\", \"activation_code\": \"string\", \"app_id\": \"string\", \"mode\": \"string\" } ``` ### **Field Descriptions** * **user_id** – Unique identifier of the user initiating the operation * **activation_code** – One-time verification code sent to the user * **app_id** – Application identifier (optional or context-specific) * **mode**Operation context for which the verification is being performed --- ## **Usage Scenarios (Mode Definitions)** | Mode | Purpose | | ---- | ---------------------------------------- | | 0 | Email or mobile number change | | 1 | Password change | | 2 | Delete account | | 3 | Clear account | | 4 | Signup verification (account activation) | | 5 | Login verification | | 6 | Forgot password verification | --- ## **Successful Response** On successful validation: * The requested operation (based on `mode`) is completed * The API returns: * **POD information** associated with the user (if applicable) * **User profile details** (if applicable) Examples: * For **signup verification**, the user account is activated * For **login**, access is confirmed * For **password reset**, the user may proceed to set a new password * For **account deletion**, the request is confirmed --- ## **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 operation mode * The requested operation is already completed (e.g., user already activated) * Authorization fails or the bearer token is missing or invalid ⚠️ In all error cases, **no account state change occurs**. --- ## **One-Line Summary** > Validates a one-time verification code and securely completes the requested user account operation (signup, login, password change, or account actions), returning POD and profile details on success.
206
207
  * Validation
207
208
  */
208
209
  validateCode(requestParameters: ValidateCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserDetails>;
@@ -213,7 +213,7 @@ var DefaultApi = /** @class */ (function (_super) {
213
213
  });
214
214
  };
215
215
  /**
216
- * 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.
216
+ * ## 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.
217
217
  * Change Password
218
218
  */
219
219
  DefaultApi.prototype.changePasswordRaw = function (requestParameters, initOverrides) {
@@ -222,6 +222,12 @@ var DefaultApi = /** @class */ (function (_super) {
222
222
  return __generator(this, function (_a) {
223
223
  switch (_a.label) {
224
224
  case 0:
225
+ if (requestParameters['newPassword'] == null) {
226
+ throw new runtime.RequiredError('newPassword', 'Required parameter "newPassword" was null or undefined when calling changePassword().');
227
+ }
228
+ if (requestParameters['activationCode'] == null) {
229
+ throw new runtime.RequiredError('activationCode', 'Required parameter "activationCode" was null or undefined when calling changePassword().');
230
+ }
225
231
  queryParameters = {};
226
232
  headerParameters = {};
227
233
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
@@ -251,10 +257,10 @@ var DefaultApi = /** @class */ (function (_super) {
251
257
  if (requestParameters['newPassword'] != null) {
252
258
  formParams.append('new_password', requestParameters['newPassword']);
253
259
  }
254
- if (requestParameters['acticationCode'] != null) {
255
- formParams.append('actication_code', requestParameters['acticationCode']);
260
+ if (requestParameters['activationCode'] != null) {
261
+ formParams.append('activation_code', requestParameters['activationCode']);
256
262
  }
257
- urlPath = "/auth-service/change/password";
263
+ urlPath = "/auth-service/password/change";
258
264
  return [4 /*yield*/, this.request({
259
265
  path: urlPath,
260
266
  method: 'POST',
@@ -270,13 +276,12 @@ var DefaultApi = /** @class */ (function (_super) {
270
276
  });
271
277
  };
272
278
  /**
273
- * 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.
279
+ * ## 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.
274
280
  * Change Password
275
281
  */
276
- DefaultApi.prototype.changePassword = function () {
277
- return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
282
+ DefaultApi.prototype.changePassword = function (requestParameters, initOverrides) {
283
+ return __awaiter(this, void 0, void 0, function () {
278
284
  var response;
279
- if (requestParameters === void 0) { requestParameters = {}; }
280
285
  return __generator(this, function (_a) {
281
286
  switch (_a.label) {
282
287
  case 0: return [4 /*yield*/, this.changePasswordRaw(requestParameters, initOverrides)];
@@ -553,75 +558,56 @@ var DefaultApi = /** @class */ (function (_super) {
553
558
  });
554
559
  };
555
560
  /**
556
- * 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
557
- * Send Sign-In Validation Code (OTP)
561
+ * --- ## 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.
562
+ * Reset Password
558
563
  */
559
- DefaultApi.prototype.sendSignInValidationCodeRaw = function (requestParameters, initOverrides) {
564
+ DefaultApi.prototype.resetPasswordRaw = function (requestParameters, initOverrides) {
560
565
  return __awaiter(this, void 0, void 0, function () {
561
- var queryParameters, headerParameters, token, tokenString, consumes, canConsumeForm, formParams, useForm, urlPath, response;
566
+ var queryParameters, headerParameters, urlPath, response;
562
567
  return __generator(this, function (_a) {
563
568
  switch (_a.label) {
564
569
  case 0:
565
- if (requestParameters['appId'] == null) {
566
- throw new runtime.RequiredError('appId', 'Required parameter "appId" was null or undefined when calling sendSignInValidationCode().');
570
+ if (requestParameters['activationCode'] == null) {
571
+ throw new runtime.RequiredError('activationCode', 'Required parameter "activationCode" was null or undefined when calling resetPassword().');
567
572
  }
568
573
  queryParameters = {};
569
- headerParameters = {};
570
- if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
571
- token = this.configuration.accessToken;
572
- return [4 /*yield*/, token("bearer", [])];
573
- case 1:
574
- tokenString = _a.sent();
575
- if (tokenString) {
576
- headerParameters["Authorization"] = "Bearer ".concat(tokenString);
577
- }
578
- _a.label = 2;
579
- case 2:
580
- consumes = [
581
- { contentType: 'multipart/form-data' },
582
- ];
583
- canConsumeForm = runtime.canConsumeForm(consumes);
584
- useForm = false;
585
- if (useForm) {
586
- formParams = new FormData();
587
- }
588
- else {
589
- formParams = new URLSearchParams();
574
+ if (requestParameters['emailId'] != null) {
575
+ queryParameters['email_id'] = requestParameters['emailId'];
590
576
  }
591
577
  if (requestParameters['mobileNumber'] != null) {
592
- formParams.append('mobile_number', requestParameters['mobileNumber']);
578
+ queryParameters['mobile_number'] = requestParameters['mobileNumber'];
593
579
  }
594
- if (requestParameters['emailId'] != null) {
595
- formParams.append('email_id', requestParameters['emailId']);
580
+ if (requestParameters['activationCode'] != null) {
581
+ queryParameters['activation_code'] = requestParameters['activationCode'];
596
582
  }
597
583
  if (requestParameters['appId'] != null) {
598
- formParams.append('app_id', requestParameters['appId']);
584
+ queryParameters['app_id'] = requestParameters['appId'];
599
585
  }
600
- urlPath = "/auth-service/send/sign/in/validation/code";
586
+ headerParameters = {};
587
+ urlPath = "/auth-service/password/reset";
601
588
  return [4 /*yield*/, this.request({
602
589
  path: urlPath,
603
590
  method: 'POST',
604
591
  headers: headerParameters,
605
592
  query: queryParameters,
606
- body: formParams,
607
593
  }, initOverrides)];
608
- case 3:
594
+ case 1:
609
595
  response = _a.sent();
610
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.SendSignInValidationCode200ResponseFromJSON)(jsonValue); })];
596
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ResetPassword200ResponseFromJSON)(jsonValue); })];
611
597
  }
612
598
  });
613
599
  });
614
600
  };
615
601
  /**
616
- * 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
617
- * Send Sign-In Validation Code (OTP)
602
+ * --- ## 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.
603
+ * Reset Password
618
604
  */
619
- DefaultApi.prototype.sendSignInValidationCode = function (requestParameters, initOverrides) {
605
+ DefaultApi.prototype.resetPassword = function (requestParameters, initOverrides) {
620
606
  return __awaiter(this, void 0, void 0, function () {
621
607
  var response;
622
608
  return __generator(this, function (_a) {
623
609
  switch (_a.label) {
624
- case 0: return [4 /*yield*/, this.sendSignInValidationCodeRaw(requestParameters, initOverrides)];
610
+ case 0: return [4 /*yield*/, this.resetPasswordRaw(requestParameters, initOverrides)];
625
611
  case 1:
626
612
  response = _a.sent();
627
613
  return [4 /*yield*/, response.value()];
@@ -923,7 +909,7 @@ var DefaultApi = /** @class */ (function (_super) {
923
909
  });
924
910
  };
925
911
  /**
926
- * 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.
912
+ * ## **Validate Activation / Verification Code** This API **validates a one-time verification code** submitted by a user and **executes the corresponding account operation** based on the specified **mode**. Depending on the mode, the API may: * Activate a newly registered account * Confirm a login attempt * Verify a password change or reset * Validate email or mobile updates * Confirm account deletion or clearing requests The API verifies the provided `activation_code` against the given `user_id`, `mode`, and application context. If validation succeeds, the requested operation is completed and the API returns the relevant **POD information** and **user profile details** (where applicable). If validation fails, the operation is **not performed** and an appropriate error response is returned. --- ## **Authentication** This endpoint requires **Bearer Token authentication**. **Header** ``` Authorization: Bearer <access_token> ``` --- ## **Request Body** ```json { \"user_id\": \"string\", \"activation_code\": \"string\", \"app_id\": \"string\", \"mode\": \"string\" } ``` ### **Field Descriptions** * **user_id** – Unique identifier of the user initiating the operation * **activation_code** – One-time verification code sent to the user * **app_id** – Application identifier (optional or context-specific) * **mode**Operation context for which the verification is being performed --- ## **Usage Scenarios (Mode Definitions)** | Mode | Purpose | | ---- | ---------------------------------------- | | 0 | Email or mobile number change | | 1 | Password change | | 2 | Delete account | | 3 | Clear account | | 4 | Signup verification (account activation) | | 5 | Login verification | | 6 | Forgot password verification | --- ## **Successful Response** On successful validation: * The requested operation (based on `mode`) is completed * The API returns: * **POD information** associated with the user (if applicable) * **User profile details** (if applicable) Examples: * For **signup verification**, the user account is activated * For **login**, access is confirmed * For **password reset**, the user may proceed to set a new password * For **account deletion**, the request is confirmed --- ## **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 operation mode * The requested operation is already completed (e.g., user already activated) * Authorization fails or the bearer token is missing or invalid ⚠️ In all error cases, **no account state change occurs**. --- ## **One-Line Summary** > Validates a one-time verification code and securely completes the requested user account operation (signup, login, password change, or account actions), returning POD and profile details on success.
927
913
  * Validation
928
914
  */
929
915
  DefaultApi.prototype.validateCodeRaw = function (requestParameters, initOverrides) {
@@ -964,7 +950,7 @@ var DefaultApi = /** @class */ (function (_super) {
964
950
  });
965
951
  };
966
952
  /**
967
- * 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.
953
+ * ## **Validate Activation / Verification Code** This API **validates a one-time verification code** submitted by a user and **executes the corresponding account operation** based on the specified **mode**. Depending on the mode, the API may: * Activate a newly registered account * Confirm a login attempt * Verify a password change or reset * Validate email or mobile updates * Confirm account deletion or clearing requests The API verifies the provided `activation_code` against the given `user_id`, `mode`, and application context. If validation succeeds, the requested operation is completed and the API returns the relevant **POD information** and **user profile details** (where applicable). If validation fails, the operation is **not performed** and an appropriate error response is returned. --- ## **Authentication** This endpoint requires **Bearer Token authentication**. **Header** ``` Authorization: Bearer <access_token> ``` --- ## **Request Body** ```json { \"user_id\": \"string\", \"activation_code\": \"string\", \"app_id\": \"string\", \"mode\": \"string\" } ``` ### **Field Descriptions** * **user_id** – Unique identifier of the user initiating the operation * **activation_code** – One-time verification code sent to the user * **app_id** – Application identifier (optional or context-specific) * **mode**Operation context for which the verification is being performed --- ## **Usage Scenarios (Mode Definitions)** | Mode | Purpose | | ---- | ---------------------------------------- | | 0 | Email or mobile number change | | 1 | Password change | | 2 | Delete account | | 3 | Clear account | | 4 | Signup verification (account activation) | | 5 | Login verification | | 6 | Forgot password verification | --- ## **Successful Response** On successful validation: * The requested operation (based on `mode`) is completed * The API returns: * **POD information** associated with the user (if applicable) * **User profile details** (if applicable) Examples: * For **signup verification**, the user account is activated * For **login**, access is confirmed * For **password reset**, the user may proceed to set a new password * For **account deletion**, the request is confirmed --- ## **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 operation mode * The requested operation is already completed (e.g., user already activated) * Authorization fails or the bearer token is missing or invalid ⚠️ In all error cases, **no account state change occurs**. --- ## **One-Line Summary** > Validates a one-time verification code and securely completes the requested user account operation (signup, login, password change, or account actions), returning POD and profile details on success.
968
954
  * Validation
969
955
  */
970
956
  DefaultApi.prototype.validateCode = function (requestParameters, initOverrides) {
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Floor Memory
3
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts. - 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.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: contact@ipomo.in
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ResetPassword200Response
16
+ */
17
+ export interface ResetPassword200Response {
18
+ /**
19
+ * Password Reset
20
+ * @type {string}
21
+ * @memberof ResetPassword200Response
22
+ */
23
+ success: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the ResetPassword200Response interface.
27
+ */
28
+ export declare function instanceOfResetPassword200Response(value: object): value is ResetPassword200Response;
29
+ export declare function ResetPassword200ResponseFromJSON(json: any): ResetPassword200Response;
30
+ export declare function ResetPassword200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResetPassword200Response;
31
+ export declare function ResetPassword200ResponseToJSON(json: any): ResetPassword200Response;
32
+ export declare function ResetPassword200ResponseToJSONTyped(value?: ResetPassword200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Floor Memory
6
+ * The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts. - 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.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: contact@ipomo.in
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfResetPassword200Response = instanceOfResetPassword200Response;
17
+ exports.ResetPassword200ResponseFromJSON = ResetPassword200ResponseFromJSON;
18
+ exports.ResetPassword200ResponseFromJSONTyped = ResetPassword200ResponseFromJSONTyped;
19
+ exports.ResetPassword200ResponseToJSON = ResetPassword200ResponseToJSON;
20
+ exports.ResetPassword200ResponseToJSONTyped = ResetPassword200ResponseToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ResetPassword200Response interface.
23
+ */
24
+ function instanceOfResetPassword200Response(value) {
25
+ if (!('success' in value) || value['success'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function ResetPassword200ResponseFromJSON(json) {
30
+ return ResetPassword200ResponseFromJSONTyped(json, false);
31
+ }
32
+ function ResetPassword200ResponseFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'success': json['success'],
38
+ };
39
+ }
40
+ function ResetPassword200ResponseToJSON(json) {
41
+ return ResetPassword200ResponseToJSONTyped(json, false);
42
+ }
43
+ function ResetPassword200ResponseToJSONTyped(value, ignoreDiscriminator) {
44
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'success': value['success'],
50
+ };
51
+ }
@@ -12,39 +12,39 @@
12
12
  /**
13
13
  *
14
14
  * @export
15
- * @interface SendSignInValidationCode400Response
15
+ * @interface ResetPassword400Response
16
16
  */
17
- export interface SendSignInValidationCode400Response {
17
+ export interface ResetPassword400Response {
18
18
  /**
19
19
  * Validation Error
20
20
  * @type {string}
21
- * @memberof SendSignInValidationCode400Response
21
+ * @memberof ResetPassword400Response
22
22
  */
23
23
  code: string;
24
24
  /**
25
25
  * Error Message
26
26
  * @type {string}
27
- * @memberof SendSignInValidationCode400Response
27
+ * @memberof ResetPassword400Response
28
28
  */
29
29
  message: string;
30
30
  /**
31
31
  * REST api path
32
32
  * @type {string}
33
- * @memberof SendSignInValidationCode400Response
33
+ * @memberof ResetPassword400Response
34
34
  */
35
35
  path: string;
36
36
  /**
37
37
  * Time stamp
38
38
  * @type {string}
39
- * @memberof SendSignInValidationCode400Response
39
+ * @memberof ResetPassword400Response
40
40
  */
41
41
  timestamp: string;
42
42
  }
43
43
  /**
44
- * Check if a given object implements the SendSignInValidationCode400Response interface.
44
+ * Check if a given object implements the ResetPassword400Response interface.
45
45
  */
46
- export declare function instanceOfSendSignInValidationCode400Response(value: object): value is SendSignInValidationCode400Response;
47
- export declare function SendSignInValidationCode400ResponseFromJSON(json: any): SendSignInValidationCode400Response;
48
- export declare function SendSignInValidationCode400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendSignInValidationCode400Response;
49
- export declare function SendSignInValidationCode400ResponseToJSON(json: any): SendSignInValidationCode400Response;
50
- export declare function SendSignInValidationCode400ResponseToJSONTyped(value?: SendSignInValidationCode400Response | null, ignoreDiscriminator?: boolean): any;
46
+ export declare function instanceOfResetPassword400Response(value: object): value is ResetPassword400Response;
47
+ export declare function ResetPassword400ResponseFromJSON(json: any): ResetPassword400Response;
48
+ export declare function ResetPassword400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResetPassword400Response;
49
+ export declare function ResetPassword400ResponseToJSON(json: any): ResetPassword400Response;
50
+ export declare function ResetPassword400ResponseToJSONTyped(value?: ResetPassword400Response | null, ignoreDiscriminator?: boolean): any;
@@ -13,15 +13,15 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfSendSignInValidationCode400Response = instanceOfSendSignInValidationCode400Response;
17
- exports.SendSignInValidationCode400ResponseFromJSON = SendSignInValidationCode400ResponseFromJSON;
18
- exports.SendSignInValidationCode400ResponseFromJSONTyped = SendSignInValidationCode400ResponseFromJSONTyped;
19
- exports.SendSignInValidationCode400ResponseToJSON = SendSignInValidationCode400ResponseToJSON;
20
- exports.SendSignInValidationCode400ResponseToJSONTyped = SendSignInValidationCode400ResponseToJSONTyped;
16
+ exports.instanceOfResetPassword400Response = instanceOfResetPassword400Response;
17
+ exports.ResetPassword400ResponseFromJSON = ResetPassword400ResponseFromJSON;
18
+ exports.ResetPassword400ResponseFromJSONTyped = ResetPassword400ResponseFromJSONTyped;
19
+ exports.ResetPassword400ResponseToJSON = ResetPassword400ResponseToJSON;
20
+ exports.ResetPassword400ResponseToJSONTyped = ResetPassword400ResponseToJSONTyped;
21
21
  /**
22
- * Check if a given object implements the SendSignInValidationCode400Response interface.
22
+ * Check if a given object implements the ResetPassword400Response interface.
23
23
  */
24
- function instanceOfSendSignInValidationCode400Response(value) {
24
+ function instanceOfResetPassword400Response(value) {
25
25
  if (!('code' in value) || value['code'] === undefined)
26
26
  return false;
27
27
  if (!('message' in value) || value['message'] === undefined)
@@ -32,10 +32,10 @@ function instanceOfSendSignInValidationCode400Response(value) {
32
32
  return false;
33
33
  return true;
34
34
  }
35
- function SendSignInValidationCode400ResponseFromJSON(json) {
36
- return SendSignInValidationCode400ResponseFromJSONTyped(json, false);
35
+ function ResetPassword400ResponseFromJSON(json) {
36
+ return ResetPassword400ResponseFromJSONTyped(json, false);
37
37
  }
38
- function SendSignInValidationCode400ResponseFromJSONTyped(json, ignoreDiscriminator) {
38
+ function ResetPassword400ResponseFromJSONTyped(json, ignoreDiscriminator) {
39
39
  if (json == null) {
40
40
  return json;
41
41
  }
@@ -46,10 +46,10 @@ function SendSignInValidationCode400ResponseFromJSONTyped(json, ignoreDiscrimina
46
46
  'timestamp': json['timestamp'],
47
47
  };
48
48
  }
49
- function SendSignInValidationCode400ResponseToJSON(json) {
50
- return SendSignInValidationCode400ResponseToJSONTyped(json, false);
49
+ function ResetPassword400ResponseToJSON(json) {
50
+ return ResetPassword400ResponseToJSONTyped(json, false);
51
51
  }
52
- function SendSignInValidationCode400ResponseToJSONTyped(value, ignoreDiscriminator) {
52
+ function ResetPassword400ResponseToJSONTyped(value, ignoreDiscriminator) {
53
53
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
54
54
  if (value == null) {
55
55
  return value;
@@ -20,13 +20,25 @@ export interface SendValidationCodeRequest {
20
20
  * @type {string}
21
21
  * @memberof SendValidationCodeRequest
22
22
  */
23
- userId: string;
23
+ userId?: string;
24
24
  /**
25
- * Mode - 0 for getting activation code, 1 for password change
25
+ * Mode - 0 for getting activation code to change email or mobile number, 1 for password change
26
26
  * @type {string}
27
27
  * @memberof SendValidationCodeRequest
28
28
  */
29
29
  mode: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof SendValidationCodeRequest
34
+ */
35
+ mobilesNumber?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof SendValidationCodeRequest
40
+ */
41
+ emailId?: string;
30
42
  }
31
43
  /**
32
44
  * Check if a given object implements the SendValidationCodeRequest interface.
@@ -22,8 +22,6 @@ exports.SendValidationCodeRequestToJSONTyped = SendValidationCodeRequestToJSONTy
22
22
  * Check if a given object implements the SendValidationCodeRequest interface.
23
23
  */
24
24
  function instanceOfSendValidationCodeRequest(value) {
25
- if (!('userId' in value) || value['userId'] === undefined)
26
- return false;
27
25
  if (!('mode' in value) || value['mode'] === undefined)
28
26
  return false;
29
27
  return true;
@@ -36,8 +34,10 @@ function SendValidationCodeRequestFromJSONTyped(json, ignoreDiscriminator) {
36
34
  return json;
37
35
  }
38
36
  return {
39
- 'userId': json['user_id'],
37
+ 'userId': json['user_id'] == null ? undefined : json['user_id'],
40
38
  'mode': json['mode'],
39
+ 'mobilesNumber': json['mobiles_number'] == null ? undefined : json['mobiles_number'],
40
+ 'emailId': json['email_id'] == null ? undefined : json['email_id'],
41
41
  };
42
42
  }
43
43
  function SendValidationCodeRequestToJSON(json) {
@@ -51,5 +51,7 @@ function SendValidationCodeRequestToJSONTyped(value, ignoreDiscriminator) {
51
51
  return {
52
52
  'user_id': value['userId'],
53
53
  'mode': value['mode'],
54
+ 'mobiles_number': value['mobilesNumber'],
55
+ 'email_id': value['emailId'],
54
56
  };
55
57
  }
@@ -20,8 +20,8 @@ export * from './QueryRequest';
20
20
  export * from './QueryRequestFilters';
21
21
  export * from './QueryResponse';
22
22
  export * from './QueryResponseItemsInner';
23
- export * from './SendSignInValidationCode200Response';
24
- export * from './SendSignInValidationCode400Response';
23
+ export * from './ResetPassword200Response';
24
+ export * from './ResetPassword400Response';
25
25
  export * from './SendValidationCode200Response';
26
26
  export * from './SendValidationCodeRequest';
27
27
  export * from './SignInWithEmail200Response';
@@ -38,8 +38,8 @@ __exportStar(require("./QueryRequest"), exports);
38
38
  __exportStar(require("./QueryRequestFilters"), exports);
39
39
  __exportStar(require("./QueryResponse"), exports);
40
40
  __exportStar(require("./QueryResponseItemsInner"), exports);
41
- __exportStar(require("./SendSignInValidationCode200Response"), exports);
42
- __exportStar(require("./SendSignInValidationCode400Response"), exports);
41
+ __exportStar(require("./ResetPassword200Response"), exports);
42
+ __exportStar(require("./ResetPassword400Response"), exports);
43
43
  __exportStar(require("./SendValidationCode200Response"), exports);
44
44
  __exportStar(require("./SendValidationCodeRequest"), exports);
45
45
  __exportStar(require("./SignInWithEmail200Response"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xfloor/floor-memory-sdk-ts",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "TypeScript SDK for xFloor Memory APIs (Memory + Registration).",
5
5
  "author": "xFloor",
6
6
  "repository": {
@@ -1,44 +0,0 @@
1
- /**
2
- * Floor Memory
3
- * The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts. - 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.
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- * Contact: contact@ipomo.in
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface SendSignInValidationCode200Response
16
- */
17
- export interface SendSignInValidationCode200Response {
18
- /**
19
- * Operation successful
20
- * @type {string}
21
- * @memberof SendSignInValidationCode200Response
22
- */
23
- success: string;
24
- /**
25
- * Mobile number if signed in through mobile number
26
- * @type {string}
27
- * @memberof SendSignInValidationCode200Response
28
- */
29
- mobileNumber?: string;
30
- /**
31
- * Email ID if signed through email
32
- * @type {string}
33
- * @memberof SendSignInValidationCode200Response
34
- */
35
- emailId: string;
36
- }
37
- /**
38
- * Check if a given object implements the SendSignInValidationCode200Response interface.
39
- */
40
- export declare function instanceOfSendSignInValidationCode200Response(value: object): value is SendSignInValidationCode200Response;
41
- export declare function SendSignInValidationCode200ResponseFromJSON(json: any): SendSignInValidationCode200Response;
42
- export declare function SendSignInValidationCode200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendSignInValidationCode200Response;
43
- export declare function SendSignInValidationCode200ResponseToJSON(json: any): SendSignInValidationCode200Response;
44
- export declare function SendSignInValidationCode200ResponseToJSONTyped(value?: SendSignInValidationCode200Response | null, ignoreDiscriminator?: boolean): any;
@@ -1,57 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Floor Memory
6
- * The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts. - 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.
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: contact@ipomo.in
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfSendSignInValidationCode200Response = instanceOfSendSignInValidationCode200Response;
17
- exports.SendSignInValidationCode200ResponseFromJSON = SendSignInValidationCode200ResponseFromJSON;
18
- exports.SendSignInValidationCode200ResponseFromJSONTyped = SendSignInValidationCode200ResponseFromJSONTyped;
19
- exports.SendSignInValidationCode200ResponseToJSON = SendSignInValidationCode200ResponseToJSON;
20
- exports.SendSignInValidationCode200ResponseToJSONTyped = SendSignInValidationCode200ResponseToJSONTyped;
21
- /**
22
- * Check if a given object implements the SendSignInValidationCode200Response interface.
23
- */
24
- function instanceOfSendSignInValidationCode200Response(value) {
25
- if (!('success' in value) || value['success'] === undefined)
26
- return false;
27
- if (!('emailId' in value) || value['emailId'] === undefined)
28
- return false;
29
- return true;
30
- }
31
- function SendSignInValidationCode200ResponseFromJSON(json) {
32
- return SendSignInValidationCode200ResponseFromJSONTyped(json, false);
33
- }
34
- function SendSignInValidationCode200ResponseFromJSONTyped(json, ignoreDiscriminator) {
35
- if (json == null) {
36
- return json;
37
- }
38
- return {
39
- 'success': json['success'],
40
- 'mobileNumber': json['mobile_number'] == null ? undefined : json['mobile_number'],
41
- 'emailId': json['email_id'],
42
- };
43
- }
44
- function SendSignInValidationCode200ResponseToJSON(json) {
45
- return SendSignInValidationCode200ResponseToJSONTyped(json, false);
46
- }
47
- function SendSignInValidationCode200ResponseToJSONTyped(value, ignoreDiscriminator) {
48
- if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
49
- if (value == null) {
50
- return value;
51
- }
52
- return {
53
- 'success': value['success'],
54
- 'mobile_number': value['mobileNumber'],
55
- 'email_id': value['emailId'],
56
- };
57
- }