@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

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.
Files changed (185) hide show
  1. package/README.md +51 -2
  2. package/index.d.ts +7 -4
  3. package/index.js +22 -7
  4. package/package.json +23 -14
  5. package/partner.d.ts +4 -0
  6. package/partner.js +7 -0
  7. package/sdk/application/ApplicationAPIClient.js +2 -4
  8. package/sdk/application/Cart/CartApplicationClient.js +29 -28
  9. package/sdk/application/Cart/CartApplicationModel.js +3 -1
  10. package/sdk/application/Catalog/CatalogApplicationClient.js +43 -42
  11. package/sdk/application/Catalog/CatalogApplicationModel.js +5 -3
  12. package/sdk/application/Common/CommonApplicationClient.js +5 -4
  13. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -5
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +21 -20
  15. package/sdk/application/Content/ContentApplicationClient.js +26 -25
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -5
  17. package/sdk/application/Lead/LeadApplicationClient.js +10 -9
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -3
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +11 -12
  20. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -1
  21. package/sdk/application/Order/OrderApplicationClient.js +15 -14
  22. package/sdk/application/Order/OrderApplicationModel.js +9 -0
  23. package/sdk/application/Payment/PaymentApplicationClient.js +42 -41
  24. package/sdk/application/PosCart/PosCartApplicationClient.js +30 -29
  25. package/sdk/application/PosCart/PosCartApplicationModel.js +3 -1
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +11 -10
  27. package/sdk/application/Share/ShareApplicationClient.js +10 -9
  28. package/sdk/application/Theme/ThemeApplicationClient.js +7 -6
  29. package/sdk/application/User/UserApplicationClient.js +38 -37
  30. package/sdk/common/AxiosHelper.js +17 -6
  31. package/sdk/common/BaseOAuthClient.d.ts +17 -0
  32. package/sdk/common/BaseOAuthClient.js +67 -0
  33. package/sdk/common/RequestSigner.js +0 -5
  34. package/sdk/partner/OAuthClient.d.ts +14 -0
  35. package/sdk/partner/OAuthClient.js +112 -0
  36. package/sdk/partner/PartnerAPIClient.d.ts +12 -0
  37. package/sdk/partner/PartnerAPIClient.js +42 -0
  38. package/sdk/partner/PartnerClient.d.ts +6 -0
  39. package/sdk/partner/PartnerClient.js +17 -0
  40. package/sdk/partner/PartnerConfig.d.ts +30 -0
  41. package/sdk/partner/PartnerConfig.js +39 -0
  42. package/sdk/partner/index.d.ts +3 -0
  43. package/sdk/partner/index.js +5 -0
  44. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -1
  45. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  46. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  47. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  48. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -2
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +1 -0
  50. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -0
  51. package/sdk/platform/Billing/BillingPlatformClient.js +137 -2
  52. package/sdk/platform/Billing/BillingPlatformModel.d.ts +4 -0
  53. package/sdk/platform/Billing/BillingPlatformModel.js +44 -0
  54. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +2 -0
  55. package/sdk/platform/Billing/BillingPlatformValidator.js +15 -0
  56. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +27 -0
  57. package/sdk/platform/Cart/CartPlatformApplicationClient.js +177 -1
  58. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +3 -0
  59. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +17 -1
  60. package/sdk/platform/Cart/CartPlatformModel.js +7 -3
  61. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +3 -1
  62. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -1
  63. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  64. package/sdk/platform/Catalog/CatalogPlatformClient.js +6 -9
  65. package/sdk/platform/Catalog/CatalogPlatformModel.js +9 -9
  66. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -1
  67. package/sdk/platform/Common/CommonPlatformClient.js +7 -18
  68. package/sdk/platform/Common/CommonPlatformValidator.js +1 -0
  69. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3 -1
  70. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -1
  71. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  72. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  73. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +5 -4
  74. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +1 -0
  75. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +1 -1
  77. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +9 -8
  78. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +1 -0
  79. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3 -1
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +1 -1
  81. package/sdk/platform/Discount/DiscountPlatformClient.js +3 -2
  82. package/sdk/platform/Discount/DiscountPlatformValidator.js +1 -0
  83. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -3
  84. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +27 -5
  85. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  86. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -3
  87. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -6
  88. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +1 -0
  89. package/sdk/platform/Inventory/InventoryPlatformClient.js +3 -2
  90. package/sdk/platform/Inventory/InventoryPlatformValidator.js +1 -0
  91. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +3 -1
  92. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +1 -1
  93. package/sdk/platform/Lead/LeadPlatformClient.js +4 -3
  94. package/sdk/platform/Lead/LeadPlatformValidator.js +1 -0
  95. package/sdk/platform/OAuthClient.js +3 -9
  96. package/sdk/platform/Order/OrderPlatformApplicationClient.js +3 -1
  97. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +1 -1
  98. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  99. package/sdk/platform/Order/OrderPlatformClient.js +16 -3
  100. package/sdk/platform/Order/OrderPlatformModel.js +1 -0
  101. package/sdk/platform/Order/OrderPlatformValidator.js +1 -0
  102. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  103. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  104. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +14 -14
  106. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +1 -1
  107. package/sdk/platform/Payment/PaymentPlatformClient.js +3 -2
  108. package/sdk/platform/Payment/PaymentPlatformValidator.js +1 -0
  109. package/sdk/platform/PlatformApplicationClient.d.ts +5 -1
  110. package/sdk/platform/PlatformApplicationClient.js +4 -0
  111. package/sdk/platform/PlatformClient.d.ts +51 -12
  112. package/sdk/platform/PlatformClient.js +54 -11
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +17 -19
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +88 -83
  115. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  116. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +8 -9
  117. package/sdk/platform/Share/SharePlatformApplicationClient.js +3 -1
  118. package/sdk/platform/Share/SharePlatformApplicationValidator.js +1 -1
  119. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +3 -1
  120. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +1 -1
  121. package/sdk/platform/User/UserPlatformApplicationClient.js +3 -1
  122. package/sdk/platform/User/UserPlatformApplicationValidator.js +1 -1
  123. package/sdk/platform/Webhook/WebhookPlatformClient.js +3 -2
  124. package/sdk/platform/Webhook/WebhookPlatformValidator.js +1 -0
  125. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -0
  126. package/sdk/public/Inventory/InventoryPublicClient.js +2 -0
  127. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  128. package/.github/workflows/on_create_release.yml +0 -23
  129. package/.github/workflows/on_merge_main.yml +0 -38
  130. package/.github/workflows/on_pull_request.yml +0 -35
  131. package/.prettierrc +0 -5
  132. package/documentation/application/CART.md +0 -8771
  133. package/documentation/application/CATALOG.md +0 -8690
  134. package/documentation/application/COMMON.md +0 -325
  135. package/documentation/application/COMMUNICATION.md +0 -387
  136. package/documentation/application/CONFIGURATION.md +0 -2212
  137. package/documentation/application/CONTENT.md +0 -2629
  138. package/documentation/application/FILESTORAGE.md +0 -442
  139. package/documentation/application/LEAD.md +0 -1549
  140. package/documentation/application/LOGISTIC.md +0 -689
  141. package/documentation/application/ORDER.md +0 -2937
  142. package/documentation/application/PAYMENT.md +0 -4475
  143. package/documentation/application/POSCART.md +0 -9375
  144. package/documentation/application/README.md +0 -21
  145. package/documentation/application/REWARDS.md +0 -554
  146. package/documentation/application/SHARE.md +0 -635
  147. package/documentation/application/THEME.md +0 -5517
  148. package/documentation/application/USER.md +0 -3798
  149. package/documentation/platform/ANALYTICS.md +0 -1012
  150. package/documentation/platform/AUDITTRAIL.md +0 -493
  151. package/documentation/platform/BILLING.md +0 -1889
  152. package/documentation/platform/CART.md +0 -4711
  153. package/documentation/platform/CATALOG.md +0 -20522
  154. package/documentation/platform/COMMON.md +0 -325
  155. package/documentation/platform/COMMUNICATION.md +0 -4970
  156. package/documentation/platform/COMPANYPROFILE.md +0 -1646
  157. package/documentation/platform/CONFIGURATION.md +0 -6316
  158. package/documentation/platform/CONTENT.md +0 -8364
  159. package/documentation/platform/DISCOUNT.md +0 -767
  160. package/documentation/platform/FILESTORAGE.md +0 -945
  161. package/documentation/platform/INVENTORY.md +0 -1136
  162. package/documentation/platform/LEAD.md +0 -4394
  163. package/documentation/platform/ORDER.md +0 -6525
  164. package/documentation/platform/PARTNER.md +0 -193
  165. package/documentation/platform/PAYMENT.md +0 -3138
  166. package/documentation/platform/README.md +0 -27
  167. package/documentation/platform/REWARDS.md +0 -919
  168. package/documentation/platform/SHARE.md +0 -513
  169. package/documentation/platform/THEME.md +0 -35446
  170. package/documentation/platform/USER.md +0 -2174
  171. package/documentation/platform/WEBHOOK.md +0 -485
  172. package/documentation/public/CONFIGURATION.md +0 -325
  173. package/documentation/public/INVENTORY.md +0 -508
  174. package/documentation/public/WEBHOOK.md +0 -246
  175. package/jest.config.d.ts +0 -4
  176. package/jest.config.js +0 -6
  177. package/tests/application/catalog.spec.js +0 -54
  178. package/tests/common/action-url.spec.js +0 -35
  179. package/tests/common/schema/action-url.json +0 -178
  180. package/tests/common/schema/url-action.json +0 -683
  181. package/tests/common/url-action.spec.js +0 -48
  182. package/tests/helpers/cookie.helper.js +0 -31
  183. package/tests/helpers/oauth.helper.js +0 -43
  184. package/tests/platform/catalog.spec.js +0 -49
  185. package/tests/public/location.spec.js +0 -39
@@ -1,2174 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Platform docs](./README.md)
7
-
8
- ## User Methods
9
- Authentication Service
10
-
11
- * [archiveUser](#archiveuser)
12
- * [blockOrUnblockUsers](#blockorunblockusers)
13
- * [createUser](#createuser)
14
- * [createUserGroup](#createusergroup)
15
- * [createUserSession](#createusersession)
16
- * [deleteActiveSessions](#deleteactivesessions)
17
- * [deleteSession](#deletesession)
18
- * [getActiveSessions](#getactivesessions)
19
- * [getCustomers](#getcustomers)
20
- * [getPlatformConfig](#getplatformconfig)
21
- * [getUserGroupById](#getusergroupbyid)
22
- * [getUserGroups](#getusergroups)
23
- * [searchUsers](#searchusers)
24
- * [unDeleteUser](#undeleteuser)
25
- * [updatePlatformConfig](#updateplatformconfig)
26
- * [updateUser](#updateuser)
27
- * [updateUserGroup](#updateusergroup)
28
-
29
-
30
-
31
- ## Methods with example and description
32
-
33
-
34
-
35
-
36
- ### archiveUser
37
- archive user
38
-
39
-
40
-
41
- ```javascript
42
- // Promise
43
- const promise = client.application("<APPLICATION_ID>").user.archiveUser({ body : value });
44
-
45
- // Async/Await
46
- const data = await client.application("<APPLICATION_ID>").user.archiveUser({ body : value });
47
- ```
48
-
49
-
50
-
51
-
52
-
53
- | Argument | Type | Required | Description |
54
- | --------- | ----- | -------- | ----------- |
55
- | body | [ArchiveUserRequestSchema](#ArchiveUserRequestSchema) | yes | Request body |
56
-
57
-
58
- archive user
59
-
60
- *Returned Response:*
61
-
62
-
63
-
64
-
65
- [ArchiveUserSuccess](#ArchiveUserSuccess)
66
-
67
- Success
68
-
69
-
70
-
71
-
72
- <details>
73
- <summary><i>&nbsp; Example:</i></summary>
74
-
75
- ```json
76
- {
77
- "success": true
78
- }
79
- ```
80
- </details>
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
- ---
91
-
92
-
93
- ### blockOrUnblockUsers
94
- Block/Unblock user
95
-
96
-
97
-
98
- ```javascript
99
- // Promise
100
- const promise = client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({ body : value });
101
-
102
- // Async/Await
103
- const data = await client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({ body : value });
104
- ```
105
-
106
-
107
-
108
-
109
-
110
- | Argument | Type | Required | Description |
111
- | --------- | ----- | -------- | ----------- |
112
- | body | [BlockUserRequestSchema](#BlockUserRequestSchema) | yes | Request body |
113
-
114
-
115
- Block/Unblock user
116
-
117
- *Returned Response:*
118
-
119
-
120
-
121
-
122
- [BlockUserSuccess](#BlockUserSuccess)
123
-
124
- Success
125
-
126
-
127
-
128
-
129
- <details>
130
- <summary><i>&nbsp; Example:</i></summary>
131
-
132
- ```json
133
- {
134
- "success": true
135
- }
136
- ```
137
- </details>
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
- ---
148
-
149
-
150
- ### createUser
151
- Create user
152
-
153
-
154
-
155
- ```javascript
156
- // Promise
157
- const promise = client.application("<APPLICATION_ID>").user.createUser({ body : value });
158
-
159
- // Async/Await
160
- const data = await client.application("<APPLICATION_ID>").user.createUser({ body : value });
161
- ```
162
-
163
-
164
-
165
-
166
-
167
- | Argument | Type | Required | Description |
168
- | --------- | ----- | -------- | ----------- |
169
- | body | [CreateUserRequestSchema](#CreateUserRequestSchema) | yes | Request body |
170
-
171
-
172
- Create user
173
-
174
- *Returned Response:*
175
-
176
-
177
-
178
-
179
- [CreateUserResponseSchema](#CreateUserResponseSchema)
180
-
181
- User create
182
-
183
-
184
-
185
-
186
- <details>
187
- <summary><i>&nbsp; Example:</i></summary>
188
-
189
- ```json
190
- {
191
- "user": {
192
- "_id": "5e68af49cfa09bf7233022f1",
193
- "gender": "male",
194
- "active": true,
195
- "emails": [
196
- {
197
- "active": true,
198
- "primary": true,
199
- "verified": true,
200
- "email": "akashmane@gofynd.com"
201
- },
202
- {
203
- "active": true,
204
- "primary": false,
205
- "verified": true,
206
- "email": "akashmane@fynd.com"
207
- },
208
- {
209
- "active": true,
210
- "primary": false,
211
- "verified": true,
212
- "email": "akashmane@uniket.store"
213
- }
214
- ],
215
- "external_id": "100002000036789",
216
- "account_type": "user",
217
- "first_name": "Akash",
218
- "last_name": "Mane",
219
- "phone_numbers": [
220
- {
221
- "active": true,
222
- "primary": true,
223
- "verified": true,
224
- "phone": "8652523958",
225
- "country_code": 91
226
- }
227
- ],
228
- "meta": {},
229
- "created_at": "2020-03-11T09:28:41.982Z",
230
- "updated_at": "2020-03-11T09:28:41.982Z"
231
- }
232
- }
233
- ```
234
- </details>
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
- ---
245
-
246
-
247
- ### createUserGroup
248
- Create an User Group
249
-
250
-
251
-
252
- ```javascript
253
- // Promise
254
- const promise = client.application("<APPLICATION_ID>").user.createUserGroup({ body : value });
255
-
256
- // Async/Await
257
- const data = await client.application("<APPLICATION_ID>").user.createUserGroup({ body : value });
258
- ```
259
-
260
-
261
-
262
-
263
-
264
- | Argument | Type | Required | Description |
265
- | --------- | ----- | -------- | ----------- |
266
- | body | [CreateUserGroupSchema](#CreateUserGroupSchema) | yes | Request body |
267
-
268
-
269
- Use this API to create new user Group
270
-
271
- *Returned Response:*
272
-
273
-
274
-
275
-
276
- [UserGroupResponseSchema](#UserGroupResponseSchema)
277
-
278
- Success. returns created User Group. `UserGroupResponseSchema` for more details.
279
-
280
-
281
-
282
-
283
- <details>
284
- <summary><i>&nbsp; Example:</i></summary>
285
-
286
- ```json
287
- {
288
- "is_active": true,
289
- "_id": "6345677535474fbb6944b7ce",
290
- "name": "Group 1",
291
- "description": "description",
292
- "file_url": "url",
293
- "status": "pending",
294
- "uid": 1,
295
- "application_id": "000000000000000000000001",
296
- "created_at": "2022-10-11T12:54:13.539Z",
297
- "modified_at": "2022-10-11T12:54:13.539Z",
298
- "__v": 0
299
- }
300
- ```
301
- </details>
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
- ---
312
-
313
-
314
- ### createUserSession
315
- Create user session
316
-
317
-
318
-
319
- ```javascript
320
- // Promise
321
- const promise = client.application("<APPLICATION_ID>").user.createUserSession({ body : value });
322
-
323
- // Async/Await
324
- const data = await client.application("<APPLICATION_ID>").user.createUserSession({ body : value });
325
- ```
326
-
327
-
328
-
329
-
330
-
331
- | Argument | Type | Required | Description |
332
- | --------- | ----- | -------- | ----------- |
333
- | body | [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema) | yes | Request body |
334
-
335
-
336
- Create user session
337
-
338
- *Returned Response:*
339
-
340
-
341
-
342
-
343
- [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
344
-
345
- Create user session
346
-
347
-
348
-
349
-
350
- <details>
351
- <summary><i>&nbsp; Example:</i></summary>
352
-
353
- ```json
354
- {
355
- "domain": "vinit.com",
356
- "max_age": 4555555,
357
- "secure": true,
358
- "http_only": true,
359
- "cookie": {
360
- "f.session": "s%3A-LrEF5FVR8jrT5DCtCHSbAy7JFyX-f9T.uXOQwzje8nOfx4ODANrLi4yNX5fW2W5kLQ2rkBdO2xE"
361
- }
362
- }
363
- ```
364
- </details>
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
- ---
375
-
376
-
377
- ### deleteActiveSessions
378
- Delete a list of all session for a user
379
-
380
-
381
-
382
- ```javascript
383
- // Promise
384
- const promise = client.application("<APPLICATION_ID>").user.deleteActiveSessions({ id : value,
385
- reason : value });
386
-
387
- // Async/Await
388
- const data = await client.application("<APPLICATION_ID>").user.deleteActiveSessions({ id : value,
389
- reason : value });
390
- ```
391
-
392
-
393
-
394
-
395
-
396
- | Argument | Type | Required | Description |
397
- | --------- | ----- | -------- | ----------- |
398
- | id | string | yes | ID of a customer. |
399
- | reason | string | yes | Reason to delete sessions. |
400
-
401
-
402
-
403
- Use this API to Delete a list of session of customers who have registered in the application.
404
-
405
- *Returned Response:*
406
-
407
-
408
-
409
-
410
- [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
411
-
412
- Success. Refer `SessionDeleteResponseSchema` for more details.
413
-
414
-
415
-
416
-
417
- <details>
418
- <summary><i>&nbsp; Examples:</i></summary>
419
-
420
-
421
- <details>
422
- <summary><i>&nbsp; Success</i></summary>
423
-
424
- ```json
425
- {
426
- "value": {
427
- "items": [
428
- "sess:123",
429
- "sess:456"
430
- ]
431
- }
432
- }
433
- ```
434
- </details>
435
-
436
- </details>
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
- ---
447
-
448
-
449
- ### deleteSession
450
- Delete a session for a user
451
-
452
-
453
-
454
- ```javascript
455
- // Promise
456
- const promise = client.application("<APPLICATION_ID>").user.deleteSession({ id : value,
457
- sessionId : value,
458
- reason : value });
459
-
460
- // Async/Await
461
- const data = await client.application("<APPLICATION_ID>").user.deleteSession({ id : value,
462
- sessionId : value,
463
- reason : value });
464
- ```
465
-
466
-
467
-
468
-
469
-
470
- | Argument | Type | Required | Description |
471
- | --------- | ----- | -------- | ----------- |
472
- | id | string | yes | ID of a customer. |
473
- | sessionId | string | yes | Session ID of a customer. |
474
- | reason | string | yes | Reason for deleting session. |
475
-
476
-
477
-
478
- Use this API to Delete a session of customers who have registered in the application.
479
-
480
- *Returned Response:*
481
-
482
-
483
-
484
-
485
- [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
486
-
487
- Success. Refer `SessionDeleteResponseSchema` for more details.
488
-
489
-
490
-
491
-
492
- <details>
493
- <summary><i>&nbsp; Examples:</i></summary>
494
-
495
-
496
- <details>
497
- <summary><i>&nbsp; Success</i></summary>
498
-
499
- ```json
500
- {
501
- "value": {
502
- "items": [
503
- "sess:123",
504
- "sess:456"
505
- ]
506
- }
507
- }
508
- ```
509
- </details>
510
-
511
- </details>
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
- ---
522
-
523
-
524
- ### getActiveSessions
525
- Get a list of all session with info for a user
526
-
527
-
528
-
529
- ```javascript
530
- // Promise
531
- const promise = client.application("<APPLICATION_ID>").user.getActiveSessions({ id : value });
532
-
533
- // Async/Await
534
- const data = await client.application("<APPLICATION_ID>").user.getActiveSessions({ id : value });
535
- ```
536
-
537
-
538
-
539
-
540
-
541
- | Argument | Type | Required | Description |
542
- | --------- | ----- | -------- | ----------- |
543
- | id | string | yes | ID of a customer. |
544
-
545
-
546
-
547
- Use this API to retrieve a list of session with info of customers who have registered in the application.
548
-
549
- *Returned Response:*
550
-
551
-
552
-
553
-
554
- [SessionListResponseSchema](#SessionListResponseSchema)
555
-
556
- Success. Refer `SessionListResponseSchema` for more details.
557
-
558
-
559
-
560
-
561
- <details>
562
- <summary><i>&nbsp; Examples:</i></summary>
563
-
564
-
565
- <details>
566
- <summary><i>&nbsp; Success</i></summary>
567
-
568
- ```json
569
- {
570
- "value": {
571
- "items": [
572
- "sess:123",
573
- "sess:456"
574
- ]
575
- }
576
- }
577
- ```
578
- </details>
579
-
580
- </details>
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
- ---
591
-
592
-
593
- ### getCustomers
594
- Get a list of customers
595
-
596
-
597
-
598
- ```javascript
599
- // Promise
600
- const promise = client.application("<APPLICATION_ID>").user.getCustomers({ q : value,
601
- pageSize : value,
602
- pageNo : value });
603
-
604
- // Async/Await
605
- const data = await client.application("<APPLICATION_ID>").user.getCustomers({ q : value,
606
- pageSize : value,
607
- pageNo : value });
608
- ```
609
-
610
-
611
-
612
-
613
-
614
- | Argument | Type | Required | Description |
615
- | --------- | ----- | -------- | ----------- |
616
- | q | Object | no | The search query. Mobile number or email ID of a customer. |
617
- | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
618
- | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
619
-
620
-
621
-
622
- Use this API to retrieve a list of customers who have registered in the application.
623
-
624
- *Returned Response:*
625
-
626
-
627
-
628
-
629
- [CustomerListResponseSchema](#CustomerListResponseSchema)
630
-
631
- Success. Refer `CustomerListResponseSchema` for more details.
632
-
633
-
634
-
635
-
636
- <details>
637
- <summary><i>&nbsp; Examples:</i></summary>
638
-
639
-
640
- <details>
641
- <summary><i>&nbsp; Success</i></summary>
642
-
643
- ```json
644
- {
645
- "value": {
646
- "items": [
647
- {
648
- "_id": "000000000000000023106198",
649
- "gender": "male",
650
- "active": true,
651
- "emails": [
652
- {
653
- "active": true,
654
- "primary": true,
655
- "verified": true,
656
- "email": "raaz.crzy@gmail.com"
657
- }
658
- ],
659
- "username": "raaz_crzy_gmail_com_63747_23106198",
660
- "__v": 7,
661
- "debug": {
662
- "source": "deadlock",
663
- "platform": "000000000000000000000003"
664
- },
665
- "dob": "1995-07-23T00:00:00.000Z",
666
- "id": "000000000000000023106198",
667
- "account_type": "user",
668
- "profile_pic_url": "https://hdn-1.fynd.com/user/profile/original/000000000000000023106198/1586498418772.jpg",
669
- "first_name": "Prince",
670
- "last_name": "Raj",
671
- "phone_numbers": [
672
- {
673
- "active": true,
674
- "primary": true,
675
- "verified": true,
676
- "phone": "7008963113",
677
- "country_code": 91
678
- }
679
- ],
680
- "created_at": "2019-05-15T14:07:52.872Z",
681
- "updated_at": "2020-09-21T06:38:41.388Z",
682
- "has_old_password_hash": false
683
- }
684
- ],
685
- "page": {
686
- "type": "number",
687
- "current": 1,
688
- "size": 10,
689
- "item_total": 0,
690
- "has_next": false
691
- }
692
- }
693
- }
694
- ```
695
- </details>
696
-
697
- </details>
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
- ---
708
-
709
-
710
- ### getPlatformConfig
711
- Get platform configurations
712
-
713
-
714
-
715
- ```javascript
716
- // Promise
717
- const promise = client.application("<APPLICATION_ID>").user.getPlatformConfig();
718
-
719
- // Async/Await
720
- const data = await client.application("<APPLICATION_ID>").user.getPlatformConfig();
721
- ```
722
-
723
-
724
-
725
-
726
-
727
-
728
- Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
729
-
730
- *Returned Response:*
731
-
732
-
733
-
734
-
735
- [PlatformSchema](#PlatformSchema)
736
-
737
- Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
738
-
739
-
740
-
741
-
742
- <details>
743
- <summary><i>&nbsp; Example:</i></summary>
744
-
745
- ```json
746
- {
747
- "active": true,
748
- "mobile_image": "",
749
- "desktop_image": "",
750
- "social": {
751
- "facebook": true,
752
- "google": true,
753
- "account_kit": true
754
- },
755
- "flash_card": {
756
- "text": "",
757
- "text_color": "#FFFFFF",
758
- "background_color": "#EF5350"
759
- },
760
- "register": true,
761
- "forgot_password": true,
762
- "login": {
763
- "password": true,
764
- "otp": true
765
- },
766
- "skip_captcha": false,
767
- "display": "Fynd",
768
- "subtext": "Login to Fynd",
769
- "name": "Fynd",
770
- "meta": {},
771
- "required_fields": {
772
- "email": {
773
- "is_required": false,
774
- "level": "hard"
775
- },
776
- "mobile": {
777
- "is_required": true,
778
- "level": "hard"
779
- }
780
- },
781
- "register_required_fields": {
782
- "email": {
783
- "is_required": false,
784
- "level": "hard"
785
- },
786
- "mobile": {
787
- "is_required": true,
788
- "level": "hard"
789
- }
790
- },
791
- "skip_login": false,
792
- "look_and_feel": {
793
- "background_color": "#F5F5F5",
794
- "card_position": "center"
795
- },
796
- "social_tokens": {
797
- "google": {
798
- "appId": "token_123"
799
- },
800
- "facebook": {
801
- "appId": "token_123"
802
- },
803
- "account_kit": {
804
- "appId": "token_123"
805
- }
806
- },
807
- "session_config": {
808
- "duration": 30,
809
- "type": "Days",
810
- "is_rolling": false
811
- },
812
- "delete_account_reasons": [
813
- {
814
- "reason_text": "test",
815
- "reason_id": "123",
816
- "show_text_area": true
817
- }
818
- ],
819
- "delete_account_day": 7,
820
- "delete_account_consent": {
821
- "consent_text": ""
822
- },
823
- "_id": "5e04a5e5220bc15839ad9bc0",
824
- "created_at": "2019-12-26T12:21:57.878Z",
825
- "updated_at": "2020-08-13T14:31:09.878Z",
826
- "__v": 0
827
- }
828
- ```
829
- </details>
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
- ---
840
-
841
-
842
- ### getUserGroupById
843
- Get an User Group by Id
844
-
845
-
846
-
847
- ```javascript
848
- // Promise
849
- const promise = client.application("<APPLICATION_ID>").user.getUserGroupById({ groupId : value });
850
-
851
- // Async/Await
852
- const data = await client.application("<APPLICATION_ID>").user.getUserGroupById({ groupId : value });
853
- ```
854
-
855
-
856
-
857
-
858
-
859
- | Argument | Type | Required | Description |
860
- | --------- | ----- | -------- | ----------- |
861
- | groupId | string | yes | Numeric ID allotted to a User Group |
862
-
863
-
864
-
865
- Use this API to get details of an existing user Group
866
-
867
- *Returned Response:*
868
-
869
-
870
-
871
-
872
- [UserGroupResponseSchema](#UserGroupResponseSchema)
873
-
874
- Success. User Group details. `UserGroupResponseSchema` for more details.
875
-
876
-
877
-
878
-
879
- <details>
880
- <summary><i>&nbsp; Example:</i></summary>
881
-
882
- ```json
883
- {
884
- "is_active": true,
885
- "_id": "6345677535474fbb6944b7ce",
886
- "name": "Group 1",
887
- "description": "description",
888
- "file_url": "url",
889
- "status": "pending",
890
- "uid": 1,
891
- "application_id": "000000000000000000000001",
892
- "created_at": "2022-10-11T12:54:13.539Z",
893
- "modified_at": "2022-10-11T12:54:13.539Z",
894
- "__v": 0
895
- }
896
- ```
897
- </details>
898
-
899
-
900
-
901
-
902
-
903
-
904
-
905
-
906
-
907
- ---
908
-
909
-
910
- ### getUserGroups
911
- Get User Groups mathcing criteria
912
-
913
-
914
-
915
- ```javascript
916
- // Promise
917
- const promise = client.application("<APPLICATION_ID>").user.getUserGroups({ pageNo : value,
918
- pageSize : value,
919
- name : value,
920
- status : value,
921
- groupUid : value });
922
-
923
- // Async/Await
924
- const data = await client.application("<APPLICATION_ID>").user.getUserGroups({ pageNo : value,
925
- pageSize : value,
926
- name : value,
927
- status : value,
928
- groupUid : value });
929
- ```
930
-
931
-
932
-
933
-
934
-
935
- | Argument | Type | Required | Description |
936
- | --------- | ----- | -------- | ----------- |
937
- | pageNo | string | no | page number for pagination result |
938
- | pageSize | string | no | page size for pagination result |
939
- | name | string | no | to seartch for User Groups which contains given string in their name |
940
- | status | string | no | to get User Groups with given status |
941
- | groupUid | number | no | to get User Groups with given uid |
942
-
943
-
944
-
945
- Use this API to get User Groups mathing criteria passed in query
946
-
947
- *Returned Response:*
948
-
949
-
950
-
951
-
952
- [UserGroupListResponseSchema](#UserGroupListResponseSchema)
953
-
954
- Success. User Group details. `UserGroupListResponseSchema` for more details.
955
-
956
-
957
-
958
-
959
- <details>
960
- <summary><i>&nbsp; Example:</i></summary>
961
-
962
- ```json
963
- {
964
- "items": [
965
- {
966
- "is_active": true,
967
- "_id": "6345677535474fbb6944b7ce",
968
- "name": "Group 1",
969
- "description": "description",
970
- "file_url": "url",
971
- "status": "pending",
972
- "uid": 1,
973
- "application_id": "000000000000000000000001",
974
- "created_at": "2022-10-11T12:54:13.539Z",
975
- "modified_at": "2022-10-11T12:54:13.539Z",
976
- "__v": 0
977
- },
978
- {
979
- "is_active": true,
980
- "_id": "6345677535474fbb6944b7ced",
981
- "name": "Group 2",
982
- "description": "description",
983
- "file_url": "url2",
984
- "status": "pending",
985
- "uid": 1,
986
- "application_id": "000000000000000000000001",
987
- "created_at": "2022-10-11T12:54:13.539Z",
988
- "modified_at": "2022-10-11T12:54:13.539Z",
989
- "__v": 0
990
- }
991
- ],
992
- "page": {
993
- "type": "number",
994
- "current": 1,
995
- "size": 10,
996
- "item_total": 0,
997
- "has_next": false
998
- }
999
- }
1000
- ```
1001
- </details>
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
- ---
1012
-
1013
-
1014
- ### searchUsers
1015
- Search an existing user.
1016
-
1017
-
1018
-
1019
- ```javascript
1020
- // Promise
1021
- const promise = client.application("<APPLICATION_ID>").user.searchUsers({ q : value });
1022
-
1023
- // Async/Await
1024
- const data = await client.application("<APPLICATION_ID>").user.searchUsers({ q : value });
1025
- ```
1026
-
1027
-
1028
-
1029
-
1030
-
1031
- | Argument | Type | Required | Description |
1032
- | --------- | ----- | -------- | ----------- |
1033
- | q | string | no | The search query. Mobile number or email ID of a customer. |
1034
-
1035
-
1036
-
1037
- Use this API to retrieve an existing user from a list.
1038
-
1039
- *Returned Response:*
1040
-
1041
-
1042
-
1043
-
1044
- [UserSearchResponseSchema](#UserSearchResponseSchema)
1045
-
1046
- Success. Returns first name, last name, emails, phone number and gender of the user. Refer `UserSearchResponseSchema` for more details.
1047
-
1048
-
1049
-
1050
-
1051
- <details>
1052
- <summary><i>&nbsp; Example:</i></summary>
1053
-
1054
- ```json
1055
- {
1056
- "users": [
1057
- {
1058
- "_id": "5e68af49cfa09bf7233022f1",
1059
- "gender": "male",
1060
- "active": true,
1061
- "emails": [
1062
- {
1063
- "active": true,
1064
- "primary": true,
1065
- "verified": true,
1066
- "email": "akashmane@gofynd.com"
1067
- },
1068
- {
1069
- "active": true,
1070
- "primary": false,
1071
- "verified": true,
1072
- "email": "akashmane@fynd.com"
1073
- },
1074
- {
1075
- "active": true,
1076
- "primary": false,
1077
- "verified": true,
1078
- "email": "akashmane@uniket.store"
1079
- }
1080
- ],
1081
- "account_type": "user",
1082
- "first_name": "Akash",
1083
- "last_name": "Mane",
1084
- "phone_numbers": [
1085
- {
1086
- "active": true,
1087
- "primary": true,
1088
- "verified": true,
1089
- "phone": "8652523958",
1090
- "country_code": 91
1091
- }
1092
- ],
1093
- "created_at": "2020-03-11T09:28:41.982Z",
1094
- "updated_at": "2020-03-11T09:28:41.982Z"
1095
- }
1096
- ]
1097
- }
1098
- ```
1099
- </details>
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
- ---
1110
-
1111
-
1112
- ### unDeleteUser
1113
- undelete user who deleted from application and have not elapsed the platform configured delete days
1114
-
1115
-
1116
-
1117
- ```javascript
1118
- // Promise
1119
- const promise = client.application("<APPLICATION_ID>").user.unDeleteUser({ body : value });
1120
-
1121
- // Async/Await
1122
- const data = await client.application("<APPLICATION_ID>").user.unDeleteUser({ body : value });
1123
- ```
1124
-
1125
-
1126
-
1127
-
1128
-
1129
- | Argument | Type | Required | Description |
1130
- | --------- | ----- | -------- | ----------- |
1131
- | body | [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema) | yes | Request body |
1132
-
1133
-
1134
- undelete user who deleted from application and have not elapsed the platform configured delete days
1135
-
1136
- *Returned Response:*
1137
-
1138
-
1139
-
1140
-
1141
- [UnDeleteUserSuccess](#UnDeleteUserSuccess)
1142
-
1143
- Success
1144
-
1145
-
1146
-
1147
-
1148
- <details>
1149
- <summary><i>&nbsp; Example:</i></summary>
1150
-
1151
- ```json
1152
- {
1153
- "success": true
1154
- }
1155
- ```
1156
- </details>
1157
-
1158
-
1159
-
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
- ---
1167
-
1168
-
1169
- ### updatePlatformConfig
1170
- Update platform configurations
1171
-
1172
-
1173
-
1174
- ```javascript
1175
- // Promise
1176
- const promise = client.application("<APPLICATION_ID>").user.updatePlatformConfig({ body : value });
1177
-
1178
- // Async/Await
1179
- const data = await client.application("<APPLICATION_ID>").user.updatePlatformConfig({ body : value });
1180
- ```
1181
-
1182
-
1183
-
1184
-
1185
-
1186
- | Argument | Type | Required | Description |
1187
- | --------- | ----- | -------- | ----------- |
1188
- | body | [PlatformSchema](#PlatformSchema) | yes | Request body |
1189
-
1190
-
1191
- Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text.
1192
-
1193
- *Returned Response:*
1194
-
1195
-
1196
-
1197
-
1198
- [PlatformSchema](#PlatformSchema)
1199
-
1200
- Success. Returns a JSON object with the updated platform configurations. Refer `PlatformSchema` for more details.
1201
-
1202
-
1203
-
1204
-
1205
- <details>
1206
- <summary><i>&nbsp; Example:</i></summary>
1207
-
1208
- ```json
1209
- {
1210
- "active": true,
1211
- "mobile_image": "",
1212
- "desktop_image": "",
1213
- "social": {
1214
- "facebook": true,
1215
- "google": true,
1216
- "account_kit": true
1217
- },
1218
- "flash_card": {
1219
- "text": "",
1220
- "text_color": "#FFFFFF",
1221
- "background_color": "#EF5350"
1222
- },
1223
- "register": true,
1224
- "forgot_password": true,
1225
- "login": {
1226
- "password": true,
1227
- "otp": true
1228
- },
1229
- "skip_captcha": false,
1230
- "display": "Fynd",
1231
- "subtext": "Login to Fynd",
1232
- "name": "Fynd",
1233
- "meta": {},
1234
- "required_fields": {
1235
- "email": {
1236
- "is_required": false,
1237
- "level": "hard"
1238
- },
1239
- "mobile": {
1240
- "is_required": true,
1241
- "level": "hard"
1242
- }
1243
- },
1244
- "register_required_fields": {
1245
- "email": {
1246
- "is_required": false,
1247
- "level": "hard"
1248
- },
1249
- "mobile": {
1250
- "is_required": true,
1251
- "level": "hard"
1252
- }
1253
- },
1254
- "skip_login": false,
1255
- "look_and_feel": {
1256
- "background_color": "#F5F5F5",
1257
- "card_position": "center"
1258
- },
1259
- "social_tokens": {
1260
- "google": {
1261
- "appId": "token_123"
1262
- },
1263
- "facebook": {
1264
- "appId": "token_123"
1265
- },
1266
- "account_kit": {
1267
- "appId": "token_123"
1268
- }
1269
- },
1270
- "session_config": {
1271
- "duration": 30,
1272
- "type": "Days",
1273
- "is_rolling": false
1274
- },
1275
- "delete_account_reasons": [
1276
- {
1277
- "reason_text": "test",
1278
- "reason_id": "123",
1279
- "show_text_area": true
1280
- }
1281
- ],
1282
- "delete_account_day": 7,
1283
- "delete_account_consent": {
1284
- "consent_text": ""
1285
- },
1286
- "_id": "5e04a5e5220bc15839ad9bc0",
1287
- "created_at": "2019-12-26T12:21:57.878Z",
1288
- "updated_at": "2020-08-13T14:31:09.878Z",
1289
- "__v": 0
1290
- }
1291
- ```
1292
- </details>
1293
-
1294
-
1295
-
1296
-
1297
-
1298
-
1299
-
1300
-
1301
-
1302
- ---
1303
-
1304
-
1305
- ### updateUser
1306
- Update user
1307
-
1308
-
1309
-
1310
- ```javascript
1311
- // Promise
1312
- const promise = client.application("<APPLICATION_ID>").user.updateUser({ userId : value,
1313
- body : value });
1314
-
1315
- // Async/Await
1316
- const data = await client.application("<APPLICATION_ID>").user.updateUser({ userId : value,
1317
- body : value });
1318
- ```
1319
-
1320
-
1321
-
1322
-
1323
-
1324
- | Argument | Type | Required | Description |
1325
- | --------- | ----- | -------- | ----------- |
1326
- | userId | string | yes | User ID |
1327
- | body | [UpdateUserRequestSchema](#UpdateUserRequestSchema) | yes | Request body |
1328
-
1329
-
1330
- Use this API to update user details, Note: Existing emails and phone numbers of user will be replaced directly if phone_numbers or emails field sent in request data.
1331
-
1332
- *Returned Response:*
1333
-
1334
-
1335
-
1336
-
1337
- [CreateUserResponseSchema](#CreateUserResponseSchema)
1338
-
1339
- User update
1340
-
1341
-
1342
-
1343
-
1344
- <details>
1345
- <summary><i>&nbsp; Example:</i></summary>
1346
-
1347
- ```json
1348
- {
1349
- "user": {
1350
- "_id": "5e68af49cfa09bf7233022f1",
1351
- "gender": "male",
1352
- "active": true,
1353
- "emails": [
1354
- {
1355
- "active": true,
1356
- "primary": true,
1357
- "verified": true,
1358
- "email": "akashmane@gofynd.com"
1359
- },
1360
- {
1361
- "active": true,
1362
- "primary": false,
1363
- "verified": true,
1364
- "email": "akashmane@fynd.com"
1365
- },
1366
- {
1367
- "active": true,
1368
- "primary": false,
1369
- "verified": true,
1370
- "email": "akashmane@uniket.store"
1371
- }
1372
- ],
1373
- "external_id": "100002000036789",
1374
- "account_type": "user",
1375
- "first_name": "Akash",
1376
- "last_name": "Mane",
1377
- "phone_numbers": [
1378
- {
1379
- "active": true,
1380
- "primary": true,
1381
- "verified": true,
1382
- "phone": "8652523958",
1383
- "country_code": 91
1384
- }
1385
- ],
1386
- "meta": {},
1387
- "created_at": "2020-03-11T09:28:41.982Z",
1388
- "updated_at": "2020-03-11T09:28:41.982Z"
1389
- }
1390
- }
1391
- ```
1392
- </details>
1393
-
1394
-
1395
-
1396
-
1397
-
1398
-
1399
-
1400
-
1401
-
1402
- ---
1403
-
1404
-
1405
- ### updateUserGroup
1406
- Update an User Group
1407
-
1408
-
1409
-
1410
- ```javascript
1411
- // Promise
1412
- const promise = client.application("<APPLICATION_ID>").user.updateUserGroup({ groupId : value,
1413
- body : value });
1414
-
1415
- // Async/Await
1416
- const data = await client.application("<APPLICATION_ID>").user.updateUserGroup({ groupId : value,
1417
- body : value });
1418
- ```
1419
-
1420
-
1421
-
1422
-
1423
-
1424
- | Argument | Type | Required | Description |
1425
- | --------- | ----- | -------- | ----------- |
1426
- | groupId | string | yes | Numeric ID allotted to a User Group |
1427
- | body | [UpdateUserGroupSchema](#UpdateUserGroupSchema) | yes | Request body |
1428
-
1429
-
1430
- Use this API to update an existing user Group
1431
-
1432
- *Returned Response:*
1433
-
1434
-
1435
-
1436
-
1437
- [UserGroupResponseSchema](#UserGroupResponseSchema)
1438
-
1439
- Success. returns updated User Group. `UserGroupResponseSchema` for more details.
1440
-
1441
-
1442
-
1443
-
1444
- <details>
1445
- <summary><i>&nbsp; Example:</i></summary>
1446
-
1447
- ```json
1448
- {
1449
- "is_active": true,
1450
- "_id": "6345677535474fbb6944b7ce",
1451
- "name": "Group 1",
1452
- "description": "description",
1453
- "file_url": "url",
1454
- "status": "pending",
1455
- "uid": 1,
1456
- "application_id": "000000000000000000000001",
1457
- "created_at": "2022-10-11T12:54:13.539Z",
1458
- "modified_at": "2022-10-11T12:54:13.539Z",
1459
- "__v": 0
1460
- }
1461
- ```
1462
- </details>
1463
-
1464
-
1465
-
1466
-
1467
-
1468
-
1469
-
1470
-
1471
-
1472
- ---
1473
-
1474
-
1475
-
1476
- ### Schemas
1477
-
1478
-
1479
- #### [Accountkit](#Accountkit)
1480
-
1481
- | Properties | Type | Nullable | Description |
1482
- | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1483
-
1484
- ---
1485
-
1486
- #### [ArchiveUserRequestSchema](#ArchiveUserRequestSchema)
1487
-
1488
- | Properties | Type | Nullable | Description |
1489
- | ---------- | ---- | -------- | ----------- || user_id | string | no | |
1490
-
1491
- ---
1492
-
1493
- #### [ArchiveUserSuccess](#ArchiveUserSuccess)
1494
-
1495
- | Properties | Type | Nullable | Description |
1496
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1497
-
1498
- ---
1499
-
1500
- #### [AuthenticationApiErrorSchema](#AuthenticationApiErrorSchema)
1501
-
1502
- | Properties | Type | Nullable | Description |
1503
- | ---------- | ---- | -------- | ----------- || message | string | no | |
1504
-
1505
- ---
1506
-
1507
- #### [AuthenticationInternalServerErrorSchema](#AuthenticationInternalServerErrorSchema)
1508
-
1509
- | Properties | Type | Nullable | Description |
1510
- | ---------- | ---- | -------- | ----------- || message | string | no | |
1511
-
1512
- ---
1513
-
1514
- #### [AuthSuccess](#AuthSuccess)
1515
-
1516
- | Properties | Type | Nullable | Description |
1517
- | ---------- | ---- | -------- | ----------- || register_token | string | no | || user | [UserSchema](#UserSchema) | no | || user_exists | boolean | no | |
1518
-
1519
- ---
1520
-
1521
- #### [AuthSuccessUser](#AuthSuccessUser)
1522
-
1523
- | Properties | Type | Nullable | Description |
1524
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || debug | [AuthSuccessUserDebug](#AuthSuccessUserDebug) | no | || emails | [AuthSuccessUserEmails](#AuthSuccessUserEmails) | no | || first_name | string | no | || last_name | string | no | |
1525
-
1526
- ---
1527
-
1528
- #### [AuthSuccessUserDebug](#AuthSuccessUserDebug)
1529
-
1530
- | Properties | Type | Nullable | Description |
1531
- | ---------- | ---- | -------- | ----------- || platform | string | no | |
1532
-
1533
- ---
1534
-
1535
- #### [AuthSuccessUserEmails](#AuthSuccessUserEmails)
1536
-
1537
- | Properties | Type | Nullable | Description |
1538
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
1539
-
1540
- ---
1541
-
1542
- #### [BlockUserRequestSchema](#BlockUserRequestSchema)
1543
-
1544
- | Properties | Type | Nullable | Description |
1545
- | ---------- | ---- | -------- | ----------- || reason | string | no | || status | boolean | no | || user_id | [string] | no | |
1546
-
1547
- ---
1548
-
1549
- #### [BlockUserSuccess](#BlockUserSuccess)
1550
-
1551
- | Properties | Type | Nullable | Description |
1552
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1553
-
1554
- ---
1555
-
1556
- #### [CodeRequestBodySchema](#CodeRequestBodySchema)
1557
-
1558
- | Properties | Type | Nullable | Description |
1559
- | ---------- | ---- | -------- | ----------- || code | string | no | |
1560
-
1561
- ---
1562
-
1563
- #### [CreateUserGroupSchema](#CreateUserGroupSchema)
1564
-
1565
- | Properties | Type | Nullable | Description |
1566
- | ---------- | ---- | -------- | ----------- || description | string | yes | || file_url | string | yes | || name | string | yes | |
1567
-
1568
- ---
1569
-
1570
- #### [CreateUserRequestSchema](#CreateUserRequestSchema)
1571
-
1572
- | Properties | Type | Nullable | Description |
1573
- | ---------- | ---- | -------- | ----------- || email | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || meta | string | no | || phone_number | string | yes | || username | string | yes | |
1574
-
1575
- ---
1576
-
1577
- #### [CreateUserResponseSchema](#CreateUserResponseSchema)
1578
-
1579
- | Properties | Type | Nullable | Description |
1580
- | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | |
1581
-
1582
- ---
1583
-
1584
- #### [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema)
1585
-
1586
- | Properties | Type | Nullable | Description |
1587
- | ---------- | ---- | -------- | ----------- || domain | string | no | || max_age | number | no | || user_id | string | no | |
1588
-
1589
- ---
1590
-
1591
- #### [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
1592
-
1593
- | Properties | Type | Nullable | Description |
1594
- | ---------- | ---- | -------- | ----------- || cookie | string | no | || domain | string | no | || http_only | boolean | no | || max_age | number | no | || secure | boolean | no | |
1595
-
1596
- ---
1597
-
1598
- #### [CustomerListResponseSchema](#CustomerListResponseSchema)
1599
-
1600
- | Properties | Type | Nullable | Description |
1601
- | ---------- | ---- | -------- | ----------- || items | [[UserSchema](#UserSchema)] | no | || page | [PaginationSchema](#PaginationSchema) | no | |
1602
-
1603
- ---
1604
-
1605
- #### [DeleteAccountConsent](#DeleteAccountConsent)
1606
-
1607
- | Properties | Type | Nullable | Description |
1608
- | ---------- | ---- | -------- | ----------- || consent_text | string | no | |
1609
-
1610
- ---
1611
-
1612
- #### [DeleteAccountReasons](#DeleteAccountReasons)
1613
-
1614
- | Properties | Type | Nullable | Description |
1615
- | ---------- | ---- | -------- | ----------- || reason_id | string | no | || reason_text | string | no | || show_text_area | boolean | no | |
1616
-
1617
- ---
1618
-
1619
- #### [DeleteApplicationUserRequestSchema](#DeleteApplicationUserRequestSchema)
1620
-
1621
- | Properties | Type | Nullable | Description |
1622
- | ---------- | ---- | -------- | ----------- || otp | string | no | || reason | string | no | || reason_id | string | no | || request_id | string | no | || user_id | string | no | |
1623
-
1624
- ---
1625
-
1626
- #### [DeleteUserSuccess](#DeleteUserSuccess)
1627
-
1628
- | Properties | Type | Nullable | Description |
1629
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1630
-
1631
- ---
1632
-
1633
- #### [EditEmailRequestSchema](#EditEmailRequestSchema)
1634
-
1635
- | Properties | Type | Nullable | Description |
1636
- | ---------- | ---- | -------- | ----------- || email | string | no | |
1637
-
1638
- ---
1639
-
1640
- #### [EditMobileRequestSchema](#EditMobileRequestSchema)
1641
-
1642
- | Properties | Type | Nullable | Description |
1643
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || phone | string | no | |
1644
-
1645
- ---
1646
-
1647
- #### [EditProfileMobileSchema](#EditProfileMobileSchema)
1648
-
1649
- | Properties | Type | Nullable | Description |
1650
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || phone | string | no | |
1651
-
1652
- ---
1653
-
1654
- #### [EditProfileRequestSchema](#EditProfileRequestSchema)
1655
-
1656
- | Properties | Type | Nullable | Description |
1657
- | ---------- | ---- | -------- | ----------- || android_hash | string | no | || country_code | string | no | || dob | string | no | || email | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || mobile | [EditProfileMobileSchema](#EditProfileMobileSchema) | no | || profile_pic_url | string | no | || register_token | string | no | || sender | string | no | |
1658
-
1659
- ---
1660
-
1661
- #### [Email](#Email)
1662
-
1663
- | Properties | Type | Nullable | Description |
1664
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
1665
-
1666
- ---
1667
-
1668
- #### [EmailOtpSuccess](#EmailOtpSuccess)
1669
-
1670
- | Properties | Type | Nullable | Description |
1671
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1672
-
1673
- ---
1674
-
1675
- #### [Facebook](#Facebook)
1676
-
1677
- | Properties | Type | Nullable | Description |
1678
- | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1679
-
1680
- ---
1681
-
1682
- #### [FlashCard](#FlashCard)
1683
-
1684
- | Properties | Type | Nullable | Description |
1685
- | ---------- | ---- | -------- | ----------- || background_color | string | no | || text | string | no | || text_color | string | no | |
1686
-
1687
- ---
1688
-
1689
- #### [ForgotPasswordRequestSchema](#ForgotPasswordRequestSchema)
1690
-
1691
- | Properties | Type | Nullable | Description |
1692
- | ---------- | ---- | -------- | ----------- || code | string | no | || password | string | no | |
1693
-
1694
- ---
1695
-
1696
- #### [FormRegisterRequestSchema](#FormRegisterRequestSchema)
1697
-
1698
- | Properties | Type | Nullable | Description |
1699
- | ---------- | ---- | -------- | ----------- || email | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || password | string | no | || phone | [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone) | no | || register_token | string | no | |
1700
-
1701
- ---
1702
-
1703
- #### [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone)
1704
-
1705
- | Properties | Type | Nullable | Description |
1706
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || mobile | string | no | |
1707
-
1708
- ---
1709
-
1710
- #### [Google](#Google)
1711
-
1712
- | Properties | Type | Nullable | Description |
1713
- | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1714
-
1715
- ---
1716
-
1717
- #### [HasPasswordSuccess](#HasPasswordSuccess)
1718
-
1719
- | Properties | Type | Nullable | Description |
1720
- | ---------- | ---- | -------- | ----------- || result | boolean | no | |
1721
-
1722
- ---
1723
-
1724
- #### [Login](#Login)
1725
-
1726
- | Properties | Type | Nullable | Description |
1727
- | ---------- | ---- | -------- | ----------- || otp | boolean | no | || password | boolean | no | |
1728
-
1729
- ---
1730
-
1731
- #### [LoginSuccess](#LoginSuccess)
1732
-
1733
- | Properties | Type | Nullable | Description |
1734
- | ---------- | ---- | -------- | ----------- || register_token | string | no | || request_id | string | no | || user | [UserSchema](#UserSchema) | no | |
1735
-
1736
- ---
1737
-
1738
- #### [LogoutSuccess](#LogoutSuccess)
1739
-
1740
- | Properties | Type | Nullable | Description |
1741
- | ---------- | ---- | -------- | ----------- || logout | boolean | no | |
1742
-
1743
- ---
1744
-
1745
- #### [LookAndFeel](#LookAndFeel)
1746
-
1747
- | Properties | Type | Nullable | Description |
1748
- | ---------- | ---- | -------- | ----------- || background_color | string | no | || card_position | string | no | |
1749
-
1750
- ---
1751
-
1752
- #### [MetaSchema](#MetaSchema)
1753
-
1754
- | Properties | Type | Nullable | Description |
1755
- | ---------- | ---- | -------- | ----------- || fynd_default | boolean | no | |
1756
-
1757
- ---
1758
-
1759
- #### [NotFoundSchema](#NotFoundSchema)
1760
-
1761
- | Properties | Type | Nullable | Description |
1762
- | ---------- | ---- | -------- | ----------- || message | string | no | |
1763
-
1764
- ---
1765
-
1766
- #### [OAuthRequestAppleSchema](#OAuthRequestAppleSchema)
1767
-
1768
- | Properties | Type | Nullable | Description |
1769
- | ---------- | ---- | -------- | ----------- || oauth | [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth) | no | || profile | [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile) | no | || user_identifier | string | no | |
1770
-
1771
- ---
1772
-
1773
- #### [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth)
1774
-
1775
- | Properties | Type | Nullable | Description |
1776
- | ---------- | ---- | -------- | ----------- || identity_token | string | no | |
1777
-
1778
- ---
1779
-
1780
- #### [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile)
1781
-
1782
- | Properties | Type | Nullable | Description |
1783
- | ---------- | ---- | -------- | ----------- || first_name | string | no | || full_name | string | no | || last_name | string | no | |
1784
-
1785
- ---
1786
-
1787
- #### [OAuthRequestSchema](#OAuthRequestSchema)
1788
-
1789
- | Properties | Type | Nullable | Description |
1790
- | ---------- | ---- | -------- | ----------- || is_signed_in | boolean | no | || oauth2 | [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2) | no | || profile | [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile) | no | |
1791
-
1792
- ---
1793
-
1794
- #### [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2)
1795
-
1796
- | Properties | Type | Nullable | Description |
1797
- | ---------- | ---- | -------- | ----------- || access_token | string | no | || expiry | number | no | || refresh_token | string | no | |
1798
-
1799
- ---
1800
-
1801
- #### [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile)
1802
-
1803
- | Properties | Type | Nullable | Description |
1804
- | ---------- | ---- | -------- | ----------- || email | string | no | || first_name | string | no | || full_name | string | no | || id | string | no | || image | string | no | || last_name | string | no | |
1805
-
1806
- ---
1807
-
1808
- #### [OtpSuccess](#OtpSuccess)
1809
-
1810
- | Properties | Type | Nullable | Description |
1811
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | |
1812
-
1813
- ---
1814
-
1815
- #### [PaginationSchema](#PaginationSchema)
1816
-
1817
- | Properties | Type | Nullable | Description |
1818
- | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || item_total | number | no | || size | number | no | || type | string | no | |
1819
-
1820
- ---
1821
-
1822
- #### [PasswordLoginRequestSchema](#PasswordLoginRequestSchema)
1823
-
1824
- | Properties | Type | Nullable | Description |
1825
- | ---------- | ---- | -------- | ----------- || captcha_code | string | no | || password | string | no | || username | string | no | |
1826
-
1827
- ---
1828
-
1829
- #### [PhoneNumber](#PhoneNumber)
1830
-
1831
- | Properties | Type | Nullable | Description |
1832
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | number | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
1833
-
1834
- ---
1835
-
1836
- #### [PlatformEmail](#PlatformEmail)
1837
-
1838
- | Properties | Type | Nullable | Description |
1839
- | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1840
-
1841
- ---
1842
-
1843
- #### [PlatformMobile](#PlatformMobile)
1844
-
1845
- | Properties | Type | Nullable | Description |
1846
- | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1847
-
1848
- ---
1849
-
1850
- #### [PlatformSchema](#PlatformSchema)
1851
-
1852
- | Properties | Type | Nullable | Description |
1853
- | ---------- | ---- | -------- | ----------- || _id | string | no | || active | boolean | no | || created_at | string | no | || delete_account_consent | string | no | || delete_account_day | number | no | || delete_account_reasons | [[DeleteAccountReasons](#DeleteAccountReasons)] | no | || desktop_image | string | no | || display | string | no | || flash_card | [FlashCard](#FlashCard) | no | || forgot_password | boolean | no | || login | [Login](#Login) | no | || look_and_feel | [LookAndFeel](#LookAndFeel) | no | || meta | [MetaSchema](#MetaSchema) | no | || mobile_image | string | no | || name | string | no | || register | boolean | no | || register_required_fields | [RegisterRequiredFields](#RegisterRequiredFields) | no | || required_fields | [RequiredFields](#RequiredFields) | no | || session_config | string | no | || skip_captcha | boolean | no | || skip_login | boolean | no | || social | [Social](#Social) | no | || social_tokens | [SocialTokens](#SocialTokens) | no | || subtext | string | no | || updated_at | string | no | |
1854
-
1855
- ---
1856
-
1857
- #### [ProfileEditSuccess](#ProfileEditSuccess)
1858
-
1859
- | Properties | Type | Nullable | Description |
1860
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || email | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_email_token | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | || user | [UserSchema](#UserSchema) | no | || user_exists | boolean | no | || verify_email_link | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1861
-
1862
- ---
1863
-
1864
- #### [ProfileEditSuccessSchema](#ProfileEditSuccessSchema)
1865
-
1866
- | Properties | Type | Nullable | Description |
1867
- | ---------- | ---- | -------- | ----------- || email | string | no | || register_token | string | no | || user | string | no | || user_exists | boolean | no | || verify_email_link | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1868
-
1869
- ---
1870
-
1871
- #### [RegisterFormSuccess](#RegisterFormSuccess)
1872
-
1873
- | Properties | Type | Nullable | Description |
1874
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || email | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_email_token | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | || user_exists | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1875
-
1876
- ---
1877
-
1878
- #### [RegisterRequiredFields](#RegisterRequiredFields)
1879
-
1880
- | Properties | Type | Nullable | Description |
1881
- | ---------- | ---- | -------- | ----------- || email | [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail) | no | || mobile | [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile) | no | |
1882
-
1883
- ---
1884
-
1885
- #### [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail)
1886
-
1887
- | Properties | Type | Nullable | Description |
1888
- | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1889
-
1890
- ---
1891
-
1892
- #### [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile)
1893
-
1894
- | Properties | Type | Nullable | Description |
1895
- | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1896
-
1897
- ---
1898
-
1899
- #### [RequiredFields](#RequiredFields)
1900
-
1901
- | Properties | Type | Nullable | Description |
1902
- | ---------- | ---- | -------- | ----------- || email | [PlatformEmail](#PlatformEmail) | no | || mobile | [PlatformMobile](#PlatformMobile) | no | |
1903
-
1904
- ---
1905
-
1906
- #### [ResetPasswordSuccess](#ResetPasswordSuccess)
1907
-
1908
- | Properties | Type | Nullable | Description |
1909
- | ---------- | ---- | -------- | ----------- || status | string | no | |
1910
-
1911
- ---
1912
-
1913
- #### [SendEmailOtpRequestSchema](#SendEmailOtpRequestSchema)
1914
-
1915
- | Properties | Type | Nullable | Description |
1916
- | ---------- | ---- | -------- | ----------- || action | string | no | || email | string | no | || register_token | string | no | || token | string | no | |
1917
-
1918
- ---
1919
-
1920
- #### [SendEmailVerifyLinkSuccess](#SendEmailVerifyLinkSuccess)
1921
-
1922
- | Properties | Type | Nullable | Description |
1923
- | ---------- | ---- | -------- | ----------- || verify_email_link | boolean | no | |
1924
-
1925
- ---
1926
-
1927
- #### [SendMobileOtpRequestSchema](#SendMobileOtpRequestSchema)
1928
-
1929
- | Properties | Type | Nullable | Description |
1930
- | ---------- | ---- | -------- | ----------- || action | string | no | || android_hash | string | no | || captcha_code | string | no | || country_code | string | no | || force | string | no | || mobile | string | no | || token | string | no | |
1931
-
1932
- ---
1933
-
1934
- #### [SendMobileVerifyLinkSuccess](#SendMobileVerifyLinkSuccess)
1935
-
1936
- | Properties | Type | Nullable | Description |
1937
- | ---------- | ---- | -------- | ----------- || verify_mobile_link | boolean | no | |
1938
-
1939
- ---
1940
-
1941
- #### [SendOtpRequestSchema](#SendOtpRequestSchema)
1942
-
1943
- | Properties | Type | Nullable | Description |
1944
- | ---------- | ---- | -------- | ----------- || android_hash | string | no | || captcha_code | string | no | || country_code | string | no | || mobile | string | no | |
1945
-
1946
- ---
1947
-
1948
- #### [SendOtpResponse](#SendOtpResponse)
1949
-
1950
- | Properties | Type | Nullable | Description |
1951
- | ---------- | ---- | -------- | ----------- || country_code | string | no | || email | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_email_token | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | || user_exists | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1952
-
1953
- ---
1954
-
1955
- #### [SendResetPasswordEmailRequestSchema](#SendResetPasswordEmailRequestSchema)
1956
-
1957
- | Properties | Type | Nullable | Description |
1958
- | ---------- | ---- | -------- | ----------- || captcha_code | string | no | || email | string | no | |
1959
-
1960
- ---
1961
-
1962
- #### [SendResetPasswordMobileRequestSchema](#SendResetPasswordMobileRequestSchema)
1963
-
1964
- | Properties | Type | Nullable | Description |
1965
- | ---------- | ---- | -------- | ----------- || captcha_code | string | no | || country_code | string | no | || mobile | string | no | |
1966
-
1967
- ---
1968
-
1969
- #### [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema)
1970
-
1971
- | Properties | Type | Nullable | Description |
1972
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | string | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
1973
-
1974
- ---
1975
-
1976
- #### [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
1977
-
1978
- | Properties | Type | Nullable | Description |
1979
- | ---------- | ---- | -------- | ----------- || items | [string] | no | |
1980
-
1981
- ---
1982
-
1983
- #### [SessionExpiry](#SessionExpiry)
1984
-
1985
- | Properties | Type | Nullable | Description |
1986
- | ---------- | ---- | -------- | ----------- || duration | number | no | || is_rolling | boolean | no | || type | string | no | |
1987
-
1988
- ---
1989
-
1990
- #### [SessionListResponseInfo](#SessionListResponseInfo)
1991
-
1992
- | Properties | Type | Nullable | Description |
1993
- | ---------- | ---- | -------- | ----------- || domain | string | no | || expire_in | string | no | || ip | string | no | || session_id | string | no | || user_agent | string | no | |
1994
-
1995
- ---
1996
-
1997
- #### [SessionListResponseSchema](#SessionListResponseSchema)
1998
-
1999
- | Properties | Type | Nullable | Description |
2000
- | ---------- | ---- | -------- | ----------- || items | [[SessionListResponseInfo](#SessionListResponseInfo)] | no | |
2001
-
2002
- ---
2003
-
2004
- #### [SessionListSuccess](#SessionListSuccess)
2005
-
2006
- | Properties | Type | Nullable | Description |
2007
- | ---------- | ---- | -------- | ----------- || sessions | [string] | no | |
2008
-
2009
- ---
2010
-
2011
- #### [Social](#Social)
2012
-
2013
- | Properties | Type | Nullable | Description |
2014
- | ---------- | ---- | -------- | ----------- || account_kit | boolean | no | || apple | boolean | no | || facebook | boolean | no | || google | boolean | no | |
2015
-
2016
- ---
2017
-
2018
- #### [SocialTokens](#SocialTokens)
2019
-
2020
- | Properties | Type | Nullable | Description |
2021
- | ---------- | ---- | -------- | ----------- || account_kit | [Accountkit](#Accountkit) | no | || facebook | [Facebook](#Facebook) | no | || google | [Google](#Google) | no | |
2022
-
2023
- ---
2024
-
2025
- #### [TokenRequestBodySchema](#TokenRequestBodySchema)
2026
-
2027
- | Properties | Type | Nullable | Description |
2028
- | ---------- | ---- | -------- | ----------- || token | string | no | |
2029
-
2030
- ---
2031
-
2032
- #### [UnauthenticatedSchema](#UnauthenticatedSchema)
2033
-
2034
- | Properties | Type | Nullable | Description |
2035
- | ---------- | ---- | -------- | ----------- || authenticated | boolean | no | |
2036
-
2037
- ---
2038
-
2039
- #### [UnauthorizedSchema](#UnauthorizedSchema)
2040
-
2041
- | Properties | Type | Nullable | Description |
2042
- | ---------- | ---- | -------- | ----------- || message | string | no | |
2043
-
2044
- ---
2045
-
2046
- #### [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema)
2047
-
2048
- | Properties | Type | Nullable | Description |
2049
- | ---------- | ---- | -------- | ----------- || reason | string | no | || reason_id | string | no | || user_id | string | no | |
2050
-
2051
- ---
2052
-
2053
- #### [UnDeleteUserSuccess](#UnDeleteUserSuccess)
2054
-
2055
- | Properties | Type | Nullable | Description |
2056
- | ---------- | ---- | -------- | ----------- || success | boolean | no | |
2057
-
2058
- ---
2059
-
2060
- #### [UpdatePasswordRequestSchema](#UpdatePasswordRequestSchema)
2061
-
2062
- | Properties | Type | Nullable | Description |
2063
- | ---------- | ---- | -------- | ----------- || new_password | string | no | || old_password | string | no | |
2064
-
2065
- ---
2066
-
2067
- #### [UpdateUserGroupSchema](#UpdateUserGroupSchema)
2068
-
2069
- | Properties | Type | Nullable | Description |
2070
- | ---------- | ---- | -------- | ----------- || description | string | no | || file_url | string | no | || name | string | no | |
2071
-
2072
- ---
2073
-
2074
- #### [UpdateUserRequestSchema](#UpdateUserRequestSchema)
2075
-
2076
- | Properties | Type | Nullable | Description |
2077
- | ---------- | ---- | -------- | ----------- || emails | [[UserEmails](#UserEmails)] | no | || external_id | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || meta | string | no | || phone_numbers | [[UserPhoneNumbers](#UserPhoneNumbers)] | no | |
2078
-
2079
- ---
2080
-
2081
- #### [UserEmails](#UserEmails)
2082
-
2083
- | Properties | Type | Nullable | Description |
2084
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
2085
-
2086
- ---
2087
-
2088
- #### [UserGroupListResponseSchema](#UserGroupListResponseSchema)
2089
-
2090
- | Properties | Type | Nullable | Description |
2091
- | ---------- | ---- | -------- | ----------- || items | [[UserGroupResponseSchema](#UserGroupResponseSchema)] | no | || page | [PaginationSchema](#PaginationSchema) | no | |
2092
-
2093
- ---
2094
-
2095
- #### [UserGroupResponseSchema](#UserGroupResponseSchema)
2096
-
2097
- | Properties | Type | Nullable | Description |
2098
- | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || application_id | string | no | || created_at | string | no | || description | string | no | || file_url | string | no | || modified_at | string | no | || name | string | no | || status | string | no | || uid | number | no | |
2099
-
2100
- ---
2101
-
2102
- #### [UserObjectSchema](#UserObjectSchema)
2103
-
2104
- | Properties | Type | Nullable | Description |
2105
- | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | |
2106
-
2107
- ---
2108
-
2109
- #### [UserPhoneNumbers](#UserPhoneNumbers)
2110
-
2111
- | Properties | Type | Nullable | Description |
2112
- | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | string | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
2113
-
2114
- ---
2115
-
2116
- #### [UserSchema](#UserSchema)
2117
-
2118
- | Properties | Type | Nullable | Description |
2119
- | ---------- | ---- | -------- | ----------- || _id | string | no | || account_type | string | no | || active | boolean | no | || application_id | string | no | || created_at | string | no | || dob | string | no | || emails | [[Email](#Email)] | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || meta | string | no | || phone_numbers | [[PhoneNumber](#PhoneNumber)] | no | || profile_pic_url | string | no | || updated_at | string | no | || user_id | string | no | || username | string | no | |
2120
-
2121
- ---
2122
-
2123
- #### [UserSearchResponseSchema](#UserSearchResponseSchema)
2124
-
2125
- | Properties | Type | Nullable | Description |
2126
- | ---------- | ---- | -------- | ----------- || users | [[UserSchema](#UserSchema)] | no | |
2127
-
2128
- ---
2129
-
2130
- #### [VerifyEmailOtpRequestSchema](#VerifyEmailOtpRequestSchema)
2131
-
2132
- | Properties | Type | Nullable | Description |
2133
- | ---------- | ---- | -------- | ----------- || action | string | no | || email | string | no | || otp | string | no | || register_token | string | no | |
2134
-
2135
- ---
2136
-
2137
- #### [VerifyEmailOTPSuccess](#VerifyEmailOTPSuccess)
2138
-
2139
- | Properties | Type | Nullable | Description |
2140
- | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | || verify_email_link | boolean | no | |
2141
-
2142
- ---
2143
-
2144
- #### [VerifyEmailSuccess](#VerifyEmailSuccess)
2145
-
2146
- | Properties | Type | Nullable | Description |
2147
- | ---------- | ---- | -------- | ----------- || message | string | no | |
2148
-
2149
- ---
2150
-
2151
- #### [VerifyMobileOTPSuccess](#VerifyMobileOTPSuccess)
2152
-
2153
- | Properties | Type | Nullable | Description |
2154
- | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | || verify_mobile_link | boolean | no | |
2155
-
2156
- ---
2157
-
2158
- #### [VerifyOtpRequestSchema](#VerifyOtpRequestSchema)
2159
-
2160
- | Properties | Type | Nullable | Description |
2161
- | ---------- | ---- | -------- | ----------- || otp | string | no | || register_token | string | no | || request_id | string | no | |
2162
-
2163
- ---
2164
-
2165
- #### [VerifyOtpSuccess](#VerifyOtpSuccess)
2166
-
2167
- | Properties | Type | Nullable | Description |
2168
- | ---------- | ---- | -------- | ----------- || register_token | string | no | || user | [UserSchema](#UserSchema) | no | || user_exists | boolean | no | |
2169
-
2170
- ---
2171
-
2172
-
2173
-
2174
-