@xfloor/floor-memory-sdk-ts 1.0.17 → 1.0.18

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,5 +1,5 @@
1
- # @xfloor/floor-memory-sdk-ts@1.0.17
2
- A TypeScript SDK client for the localhost API.
1
+ # @xfloor/floor-memory-sdk-ts@1.0.18
2
+ A TypeScript SDK client for the floortv.in API.
3
3
 
4
4
  ### Usage
5
5
 
@@ -51,7 +51,7 @@ example().catch(console.error);
51
51
 
52
52
  ### API Endpoints
53
53
 
54
- All URIs are relative to *http://localhost*
54
+ All URIs are relative to *https://floortv.in*
55
55
 
56
56
  | Class | Method | HTTP request |
57
57
 
@@ -116,7 +116,7 @@ Sign In with Mobile number
116
116
  Sign Up
117
117
  *DefaultApi*
118
118
 
119
- | [**validateCode**](docs/DefaultApi.md#validatecodeoperation) | **POST** /auth-service/validate/activation/code |
119
+ | [**validateCode**](docs/DefaultApi.md#validatecode) | **POST** /auth-service/validate/activation/code |
120
120
 
121
121
  Validation
122
122
  *EditFloorApi*
@@ -183,7 +183,6 @@ Query (Primary API)
183
183
  - [ValidateCode400Response](docs/ValidateCode400Response.md)
184
184
  - [ValidateCode400ResponseError](docs/ValidateCode400ResponseError.md)
185
185
  - [ValidateCode412Response](docs/ValidateCode412Response.md)
186
- - [ValidateCodeRequest](docs/ValidateCodeRequest.md)
187
186
 
188
187
  ### Authorization
189
188
 
@@ -202,7 +201,7 @@ and is automatically generated by the
202
201
  [OpenAPI Generator](https://openapi-generator.tech) project:
203
202
 
204
203
  - API version: `1.0.0`
205
- - Package version: `1.0.17`
204
+ - Package version: `1.0.18`
206
205
  - Generator version: `7.18.0`
207
206
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
208
207
 
@@ -12,13 +12,14 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import * as runtime from '../runtime';
15
- import type { ChangePassword200Response, GetFloorInformation200Response, ResetPassword200Response, SendValidationCode200Response, SignInWithEmail200Response, SignUp200Response, UserDetails, ValidateCodeRequest } from '../models/index';
15
+ import type { ChangePassword200Response, GetFloorInformation200Response, ResetPassword200Response, SendValidationCode200Response, SignInWithEmail200Response, SignUp200Response, UserDetails } from '../models/index';
16
16
  export interface ChangeEmailRequest {
17
17
  newEmailId: string;
18
18
  activationCode: string;
19
19
  }
20
20
  export interface ChangeMobileNumberRequest {
21
- body: object;
21
+ newMobileNumber: string;
22
+ activationCode: string;
22
23
  }
23
24
  export interface ChangePasswordRequest {
24
25
  newPassword: string;
@@ -42,9 +43,10 @@ export interface RenameFloorRequest {
42
43
  to: string;
43
44
  }
44
45
  export interface ResetPasswordRequest {
46
+ newPassword: string;
45
47
  activationCode: string;
46
- emailId?: string;
47
48
  mobileNumber?: string;
49
+ emailId?: string;
48
50
  appId?: string;
49
51
  }
50
52
  export interface SendValidationCodeRequest {
@@ -73,8 +75,11 @@ export interface SignUpRequest {
73
75
  mobileNumber?: string;
74
76
  appId?: string;
75
77
  }
76
- export interface ValidateCodeOperationRequest {
77
- validateCodeRequest: ValidateCodeRequest;
78
+ export interface ValidateCodeRequest {
79
+ userId: string;
80
+ activationCode: string;
81
+ mode: string;
82
+ appId?: string;
78
83
  }
79
84
  /**
80
85
  *
@@ -194,10 +199,10 @@ export declare class DefaultApi extends runtime.BaseAPI {
194
199
  * ## **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.
195
200
  * Validation
196
201
  */
197
- validateCodeRaw(requestParameters: ValidateCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserDetails>>;
202
+ validateCodeRaw(requestParameters: ValidateCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserDetails>>;
198
203
  /**
199
204
  * ## **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.
200
205
  * Validation
201
206
  */
202
- validateCode(requestParameters: ValidateCodeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserDetails>;
207
+ validateCode(requestParameters: ValidateCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserDetails>;
203
208
  }
@@ -161,16 +161,18 @@ var DefaultApi = /** @class */ (function (_super) {
161
161
  */
162
162
  DefaultApi.prototype.changeMobileNumberRaw = function (requestParameters, initOverrides) {
163
163
  return __awaiter(this, void 0, void 0, function () {
164
- var queryParameters, headerParameters, token, tokenString, urlPath, response;
164
+ var queryParameters, headerParameters, token, tokenString, consumes, canConsumeForm, formParams, useForm, urlPath, response;
165
165
  return __generator(this, function (_a) {
166
166
  switch (_a.label) {
167
167
  case 0:
168
- if (requestParameters['body'] == null) {
169
- throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling changeMobileNumber().');
168
+ if (requestParameters['newMobileNumber'] == null) {
169
+ throw new runtime.RequiredError('newMobileNumber', 'Required parameter "newMobileNumber" was null or undefined when calling changeMobileNumber().');
170
+ }
171
+ if (requestParameters['activationCode'] == null) {
172
+ throw new runtime.RequiredError('activationCode', 'Required parameter "activationCode" was null or undefined when calling changeMobileNumber().');
170
173
  }
171
174
  queryParameters = {};
172
175
  headerParameters = {};
173
- headerParameters['Content-Type'] = 'application/json';
174
176
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
175
177
  token = this.configuration.accessToken;
176
178
  return [4 /*yield*/, token("bearer", [])];
@@ -181,13 +183,30 @@ var DefaultApi = /** @class */ (function (_super) {
181
183
  }
182
184
  _a.label = 2;
183
185
  case 2:
186
+ consumes = [
187
+ { contentType: 'multipart/form-data' },
188
+ ];
189
+ canConsumeForm = runtime.canConsumeForm(consumes);
190
+ useForm = false;
191
+ if (useForm) {
192
+ formParams = new FormData();
193
+ }
194
+ else {
195
+ formParams = new URLSearchParams();
196
+ }
197
+ if (requestParameters['newMobileNumber'] != null) {
198
+ formParams.append('new_mobile_number', requestParameters['newMobileNumber']);
199
+ }
200
+ if (requestParameters['activationCode'] != null) {
201
+ formParams.append('activation_code', requestParameters['activationCode']);
202
+ }
184
203
  urlPath = "/auth-service/change/mobile";
185
204
  return [4 /*yield*/, this.request({
186
205
  path: urlPath,
187
206
  method: 'POST',
188
207
  headers: headerParameters,
189
208
  query: queryParameters,
190
- body: requestParameters['body'],
209
+ body: formParams,
191
210
  }, initOverrides)];
192
211
  case 3:
193
212
  response = _a.sent();
@@ -519,33 +538,51 @@ var DefaultApi = /** @class */ (function (_super) {
519
538
  */
520
539
  DefaultApi.prototype.resetPasswordRaw = function (requestParameters, initOverrides) {
521
540
  return __awaiter(this, void 0, void 0, function () {
522
- var queryParameters, headerParameters, urlPath, response;
541
+ var queryParameters, headerParameters, consumes, canConsumeForm, formParams, useForm, urlPath, response;
523
542
  return __generator(this, function (_a) {
524
543
  switch (_a.label) {
525
544
  case 0:
545
+ if (requestParameters['newPassword'] == null) {
546
+ throw new runtime.RequiredError('newPassword', 'Required parameter "newPassword" was null or undefined when calling resetPassword().');
547
+ }
526
548
  if (requestParameters['activationCode'] == null) {
527
549
  throw new runtime.RequiredError('activationCode', 'Required parameter "activationCode" was null or undefined when calling resetPassword().');
528
550
  }
529
551
  queryParameters = {};
530
- if (requestParameters['emailId'] != null) {
531
- queryParameters['email_id'] = requestParameters['emailId'];
552
+ headerParameters = {};
553
+ consumes = [
554
+ { contentType: 'multipart/form-data' },
555
+ ];
556
+ canConsumeForm = runtime.canConsumeForm(consumes);
557
+ useForm = false;
558
+ if (useForm) {
559
+ formParams = new FormData();
560
+ }
561
+ else {
562
+ formParams = new URLSearchParams();
532
563
  }
533
564
  if (requestParameters['mobileNumber'] != null) {
534
- queryParameters['mobile_number'] = requestParameters['mobileNumber'];
565
+ formParams.append('mobile_number', requestParameters['mobileNumber']);
566
+ }
567
+ if (requestParameters['emailId'] != null) {
568
+ formParams.append('email_id', requestParameters['emailId']);
569
+ }
570
+ if (requestParameters['newPassword'] != null) {
571
+ formParams.append('new_password', requestParameters['newPassword']);
535
572
  }
536
573
  if (requestParameters['activationCode'] != null) {
537
- queryParameters['activation_code'] = requestParameters['activationCode'];
574
+ formParams.append('activation_code', requestParameters['activationCode']);
538
575
  }
539
576
  if (requestParameters['appId'] != null) {
540
- queryParameters['app_id'] = requestParameters['appId'];
577
+ formParams.append('app_id', requestParameters['appId']);
541
578
  }
542
- headerParameters = {};
543
579
  urlPath = "/auth-service/password/reset";
544
580
  return [4 /*yield*/, this.request({
545
581
  path: urlPath,
546
582
  method: 'POST',
547
583
  headers: headerParameters,
548
584
  query: queryParameters,
585
+ body: formParams,
549
586
  }, initOverrides)];
550
587
  case 1:
551
588
  response = _a.sent();
@@ -923,16 +960,21 @@ var DefaultApi = /** @class */ (function (_super) {
923
960
  */
924
961
  DefaultApi.prototype.validateCodeRaw = function (requestParameters, initOverrides) {
925
962
  return __awaiter(this, void 0, void 0, function () {
926
- var queryParameters, headerParameters, token, tokenString, urlPath, response;
963
+ var queryParameters, headerParameters, token, tokenString, consumes, canConsumeForm, formParams, useForm, urlPath, response;
927
964
  return __generator(this, function (_a) {
928
965
  switch (_a.label) {
929
966
  case 0:
930
- if (requestParameters['validateCodeRequest'] == null) {
931
- throw new runtime.RequiredError('validateCodeRequest', 'Required parameter "validateCodeRequest" was null or undefined when calling validateCode().');
967
+ if (requestParameters['userId'] == null) {
968
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling validateCode().');
969
+ }
970
+ if (requestParameters['activationCode'] == null) {
971
+ throw new runtime.RequiredError('activationCode', 'Required parameter "activationCode" was null or undefined when calling validateCode().');
972
+ }
973
+ if (requestParameters['mode'] == null) {
974
+ throw new runtime.RequiredError('mode', 'Required parameter "mode" was null or undefined when calling validateCode().');
932
975
  }
933
976
  queryParameters = {};
934
977
  headerParameters = {};
935
- headerParameters['Content-Type'] = 'application/json';
936
978
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
937
979
  token = this.configuration.accessToken;
938
980
  return [4 /*yield*/, token("bearer", [])];
@@ -943,13 +985,36 @@ var DefaultApi = /** @class */ (function (_super) {
943
985
  }
944
986
  _a.label = 2;
945
987
  case 2:
988
+ consumes = [
989
+ { contentType: 'multipart/form-data' },
990
+ ];
991
+ canConsumeForm = runtime.canConsumeForm(consumes);
992
+ useForm = false;
993
+ if (useForm) {
994
+ formParams = new FormData();
995
+ }
996
+ else {
997
+ formParams = new URLSearchParams();
998
+ }
999
+ if (requestParameters['userId'] != null) {
1000
+ formParams.append('user_id', requestParameters['userId']);
1001
+ }
1002
+ if (requestParameters['activationCode'] != null) {
1003
+ formParams.append('activation_code', requestParameters['activationCode']);
1004
+ }
1005
+ if (requestParameters['mode'] != null) {
1006
+ formParams.append('mode', requestParameters['mode']);
1007
+ }
1008
+ if (requestParameters['appId'] != null) {
1009
+ formParams.append('app_id', requestParameters['appId']);
1010
+ }
946
1011
  urlPath = "/auth-service/validate/activation/code";
947
1012
  return [4 /*yield*/, this.request({
948
1013
  path: urlPath,
949
1014
  method: 'POST',
950
1015
  headers: headerParameters,
951
1016
  query: queryParameters,
952
- body: (0, index_1.ValidateCodeRequestToJSON)(requestParameters['validateCodeRequest']),
1017
+ body: formParams,
953
1018
  }, initOverrides)];
954
1019
  case 3:
955
1020
  response = _a.sent();
@@ -33,4 +33,3 @@ export * from './UserDetails';
33
33
  export * from './ValidateCode400Response';
34
34
  export * from './ValidateCode400ResponseError';
35
35
  export * from './ValidateCode412Response';
36
- export * from './ValidateCodeRequest';
@@ -51,4 +51,3 @@ __exportStar(require("./UserDetails"), exports);
51
51
  __exportStar(require("./ValidateCode400Response"), exports);
52
52
  __exportStar(require("./ValidateCode400ResponseError"), exports);
53
53
  __exportStar(require("./ValidateCode412Response"), exports);
54
- __exportStar(require("./ValidateCodeRequest"), exports);
package/dist/runtime.js CHANGED
@@ -82,7 +82,7 @@ exports.querystring = querystring;
82
82
  exports.exists = exists;
83
83
  exports.mapValues = mapValues;
84
84
  exports.canConsumeForm = canConsumeForm;
85
- exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
85
+ exports.BASE_PATH = "https://floortv.in".replace(/\/+$/, "");
86
86
  var Configuration = /** @class */ (function () {
87
87
  function Configuration(configuration) {
88
88
  if (configuration === void 0) { configuration = {}; }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xfloor/floor-memory-sdk-ts",
3
- "version": "1.0.17",
3
+ "version": "1.0.18",
4
4
  "description": "TypeScript SDK for xFloor Memory APIs (Memory + Registration).",
5
5
  "author": "xFloor",
6
6
  "repository": {
@@ -1,52 +0,0 @@
1
- /**
2
- * Floor Memory
3
- * The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts.
4
- * - Memory and
5
- * - Registration. The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
6
- *
7
- * The version of the OpenAPI document: 1.0.0
8
- * Contact: contact@ipomo.in
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- /**
15
- *
16
- * @export
17
- * @interface ValidateCodeRequest
18
- */
19
- export interface ValidateCodeRequest {
20
- /**
21
- * User ID
22
- * @type {string}
23
- * @memberof ValidateCodeRequest
24
- */
25
- userId: string;
26
- /**
27
- * Validation code
28
- * @type {string}
29
- * @memberof ValidateCodeRequest
30
- */
31
- activationCode: string;
32
- /**
33
- * App ID which is given while registering as developer
34
- * @type {string}
35
- * @memberof ValidateCodeRequest
36
- */
37
- appId: string;
38
- /**
39
- * 4 for sign up, 5 for login
40
- * @type {string}
41
- * @memberof ValidateCodeRequest
42
- */
43
- mode: string;
44
- }
45
- /**
46
- * Check if a given object implements the ValidateCodeRequest interface.
47
- */
48
- export declare function instanceOfValidateCodeRequest(value: object): value is ValidateCodeRequest;
49
- export declare function ValidateCodeRequestFromJSON(json: any): ValidateCodeRequest;
50
- export declare function ValidateCodeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateCodeRequest;
51
- export declare function ValidateCodeRequestToJSON(json: any): ValidateCodeRequest;
52
- export declare function ValidateCodeRequestToJSONTyped(value?: ValidateCodeRequest | null, ignoreDiscriminator?: boolean): any;
@@ -1,65 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Floor Memory
6
- * The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts.
7
- * - Memory and
8
- * - Registration. The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
9
- *
10
- * The version of the OpenAPI document: 1.0.0
11
- * Contact: contact@ipomo.in
12
- *
13
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
14
- * https://openapi-generator.tech
15
- * Do not edit the class manually.
16
- */
17
- Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.instanceOfValidateCodeRequest = instanceOfValidateCodeRequest;
19
- exports.ValidateCodeRequestFromJSON = ValidateCodeRequestFromJSON;
20
- exports.ValidateCodeRequestFromJSONTyped = ValidateCodeRequestFromJSONTyped;
21
- exports.ValidateCodeRequestToJSON = ValidateCodeRequestToJSON;
22
- exports.ValidateCodeRequestToJSONTyped = ValidateCodeRequestToJSONTyped;
23
- /**
24
- * Check if a given object implements the ValidateCodeRequest interface.
25
- */
26
- function instanceOfValidateCodeRequest(value) {
27
- if (!('userId' in value) || value['userId'] === undefined)
28
- return false;
29
- if (!('activationCode' in value) || value['activationCode'] === undefined)
30
- return false;
31
- if (!('appId' in value) || value['appId'] === undefined)
32
- return false;
33
- if (!('mode' in value) || value['mode'] === undefined)
34
- return false;
35
- return true;
36
- }
37
- function ValidateCodeRequestFromJSON(json) {
38
- return ValidateCodeRequestFromJSONTyped(json, false);
39
- }
40
- function ValidateCodeRequestFromJSONTyped(json, ignoreDiscriminator) {
41
- if (json == null) {
42
- return json;
43
- }
44
- return {
45
- 'userId': json['user_id'],
46
- 'activationCode': json['activation_code'],
47
- 'appId': json['app_id'],
48
- 'mode': json['mode'],
49
- };
50
- }
51
- function ValidateCodeRequestToJSON(json) {
52
- return ValidateCodeRequestToJSONTyped(json, false);
53
- }
54
- function ValidateCodeRequestToJSONTyped(value, ignoreDiscriminator) {
55
- if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
56
- if (value == null) {
57
- return value;
58
- }
59
- return {
60
- 'user_id': value['userId'],
61
- 'activation_code': value['activationCode'],
62
- 'app_id': value['appId'],
63
- 'mode': value['mode'],
64
- };
65
- }