@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.3

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 (106) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
  4. package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
  5. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  6. package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
  7. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  8. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  9. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  10. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  11. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
  12. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
  13. package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
  14. package/sdk/application/Content/ContentApplicationModel.js +757 -757
  15. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  16. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  17. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  18. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  19. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
  20. package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
  21. package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
  22. package/sdk/application/Order/OrderApplicationModel.js +822 -822
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  24. package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
  25. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
  26. package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
  27. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  28. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  29. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
  30. package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
  31. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  32. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  33. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  34. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  35. package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
  36. package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
  37. package/sdk/application/User/UserApplicationModel.d.ts +762 -762
  38. package/sdk/application/User/UserApplicationModel.js +738 -738
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
  40. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
  42. package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
  43. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
  45. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
  46. package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  50. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  51. package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
  52. package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
  54. package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
  57. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  58. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
  63. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
  64. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
  65. package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
  66. package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
  67. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
  68. package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
  69. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
  70. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
  71. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
  72. package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
  73. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  74. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  75. package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
  76. package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
  77. package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
  78. package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
  79. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  80. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  81. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
  82. package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
  83. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  84. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  85. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
  86. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
  87. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  88. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  89. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
  90. package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
  91. package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
  92. package/sdk/platform/User/UserPlatformModel.js +643 -643
  93. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
  94. package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
  95. package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
  96. package/sdk/public/Billing/BillingPublicModel.js +51 -51
  97. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  98. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  99. package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
  100. package/sdk/public/Content/ContentPublicModel.js +28 -28
  101. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  102. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  103. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  104. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  105. package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
  106. package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
@@ -1,80 +1,212 @@
1
1
  export = UserPlatformModel;
2
2
  /**
3
- * @typedef Accountkit
4
- * @property {string} [app_id]
3
+ * @typedef SuccessMessageResponse
4
+ * @property {string} [success]
5
5
  */
6
6
  /**
7
- * @typedef ArchiveUserRequestSchema
8
- * @property {string} [user_id]
7
+ * @typedef UserAttributeDefinition
8
+ * @property {string} [_id] - The unique identifier for the attribute definition.
9
+ * @property {string} [name] - The attribute name.
10
+ * @property {string} [slug] - The attribute key.
11
+ * @property {string} [description] - The description of the attribute.
12
+ * @property {string} [application_id] - The application ID.
13
+ * @property {string} [type] - The attribute type.
14
+ * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
15
+ * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
16
+ * @property {boolean} [encrypted] - Whether the attribute is encrypted.
17
+ * @property {boolean} [pinned] - Whether the attribute is pinned.
18
+ * @property {number} [pin_order] - The order in which the attribute is pinned.
19
+ * @property {Object[]} [validations]
20
+ * @property {boolean} [is_locked] - Whether the attribute is locked.
21
+ * @property {string} [created_at] - The creation date of the attribute.
22
+ * @property {string} [modified_at] - The modification date of the attribute.
23
+ * @property {number} [__v] - The version number of the attribute.
9
24
  */
10
25
  /**
11
- * @typedef ArchiveUserSuccess
12
- * @property {boolean} [success]
26
+ * @typedef UserAttributeDefinitionResponse
27
+ * @property {string} [_id] - The unique identifier for the attribute definition.
28
+ * @property {string} [name] - The attribute name.
29
+ * @property {string} [slug] - The attribute key.
30
+ * @property {string} [description] - The description of the attribute.
31
+ * @property {string} [application_id] - The application ID.
32
+ * @property {string} [type] - The attribute type.
33
+ * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
34
+ * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
35
+ * @property {boolean} [encrypted] - Whether the attribute is encrypted.
36
+ * @property {boolean} [pinned] - Whether the attribute is pinned.
37
+ * @property {number} [pin_order] - The order in which the attribute is pinned.
38
+ * @property {UserAttributeDefinitionValidation[]} [validations]
39
+ * @property {boolean} [is_locked] - Whether the attribute is locked.
40
+ * @property {string} [created_by] - The user who created the attribute.
41
+ * @property {string} [updated_by] - The user who last updated the attribute.
42
+ * @property {string} [created_at] - The creation date of the attribute definition.
43
+ * @property {string} [modified_at] - The last modification date of the
44
+ * attribute definition.
13
45
  */
14
46
  /**
15
- * @typedef AuthenticationApiErrorSchema
16
- * @property {string} [message]
47
+ * @typedef UserAttributeDefinitionValidation
48
+ * @property {string} [type] - The type of validation.
49
+ * @property {Object} [value] - The validation value.
50
+ */
51
+ /**
52
+ * @typedef UserAttributeResponse
53
+ * @property {string} [_id] - The unique identifier for the attribute definition.
54
+ * @property {string} [name] - The name of user attribute definition.
55
+ * @property {string} [user_id] - The unique identifier for the user.
56
+ * @property {string} [application_id] - The application ID.
57
+ * @property {string} [type] - The attribute type.
58
+ * @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
59
+ * @property {Object} [attribute]
60
+ * @property {string} [updated_by]
61
+ */
62
+ /**
63
+ * @typedef CreateUserAttributeRequest
64
+ * @property {boolean} [customer_overriden]
65
+ * @property {Object} [attribute]
66
+ */
67
+ /**
68
+ * @typedef CreateUserAttributeDefinition
69
+ * @property {string} [name]
70
+ * @property {string} [slug]
71
+ * @property {string} [description]
72
+ * @property {string} [type]
73
+ * @property {boolean} [multi_value]
74
+ * @property {boolean} [customer_editable]
75
+ * @property {boolean} [encrypted]
76
+ * @property {boolean} [pinned]
77
+ * @property {number} [pin_order]
78
+ * @property {string} [default_value]
79
+ * @property {Object[]} [validations]
17
80
  */
18
81
  /**
19
82
  * @typedef BlockUserRequestSchema
20
- * @property {string} [reason]
21
83
  * @property {boolean} [status]
22
84
  * @property {string[]} [user_id]
85
+ * @property {string} [reason]
86
+ */
87
+ /**
88
+ * @typedef ArchiveUserRequestSchema
89
+ * @property {string} [user_id]
90
+ */
91
+ /**
92
+ * @typedef UnDeleteUserRequestSchema
93
+ * @property {string} [user_id]
94
+ * @property {string} [reason]
95
+ * @property {string} [reason_id]
23
96
  */
24
97
  /**
25
98
  * @typedef BlockUserSuccess
26
99
  * @property {boolean} [success]
27
100
  */
28
101
  /**
29
- * @typedef Conditions
30
- * @property {string} [key]
31
- * @property {string} [type]
32
- * @property {string} [user_attribute_definition_id]
33
- * @property {string} [value]
102
+ * @typedef ArchiveUserSuccess
103
+ * @property {boolean} [success]
34
104
  */
35
105
  /**
36
- * @typedef ConditionsSchema
106
+ * @typedef UnDeleteUserSuccess
107
+ * @property {boolean} [success]
108
+ */
109
+ /**
110
+ * @typedef UserSearchResponseSchema
111
+ * @property {UserSchema[]} [users]
112
+ */
113
+ /**
114
+ * @typedef CustomerListResponseSchema
115
+ * @property {UserSchema[]} [items]
116
+ * @property {PaginationSchema} [page]
117
+ */
118
+ /**
119
+ * @typedef PaginationSchema
120
+ * @property {number} [size]
121
+ * @property {number} [item_total]
122
+ * @property {boolean} [has_next]
37
123
  * @property {string} [type]
124
+ * @property {number} [current]
125
+ */
126
+ /**
127
+ * @typedef SessionListResponseSchema
128
+ * @property {SessionListResponseInfo[]} [items]
129
+ */
130
+ /**
131
+ * @typedef SessionDeleteResponseSchema
132
+ * @property {string} [user_id]
133
+ * @property {string} [session_id]
134
+ */
135
+ /**
136
+ * @typedef SessionsDeleteResponseSchema
137
+ * @property {string} [user_id]
138
+ * @property {string[]} [session_ids]
139
+ */
140
+ /**
141
+ * @typedef AuthenticationApiErrorSchema
142
+ * @property {string} [message]
143
+ */
144
+ /**
145
+ * @typedef SessionListResponseInfo
146
+ * @property {string} [session_id]
147
+ * @property {string} [user_agent]
148
+ * @property {string} [ip]
149
+ * @property {string} [domain]
150
+ * @property {string} [expire_in]
151
+ */
152
+ /**
153
+ * @typedef Conditions
38
154
  * @property {string} [user_attribute_definition_id]
155
+ * @property {string} [type]
39
156
  * @property {string} [value]
157
+ * @property {string} [key]
40
158
  */
41
159
  /**
42
- * @typedef CreateUserAttributeDefinition
43
- * @property {boolean} [customer_editable]
44
- * @property {string} [default_value]
45
- * @property {string} [description]
46
- * @property {boolean} [encrypted]
47
- * @property {boolean} [multi_value]
160
+ * @typedef UserResponseErrorSchema
161
+ * @property {number} [count]
162
+ * @property {string} [file_url]
163
+ */
164
+ /**
165
+ * @typedef UserGroupResponseSchema
166
+ * @property {Conditions[]} [conditions]
167
+ * @property {UserResponseErrorSchema} [error]
48
168
  * @property {string} [name]
49
- * @property {number} [pin_order]
50
- * @property {boolean} [pinned]
51
- * @property {string} [slug]
169
+ * @property {string} [description]
170
+ * @property {string} [file_url]
171
+ * @property {string} [_id]
172
+ * @property {string} [status]
173
+ * @property {boolean} [is_active]
52
174
  * @property {string} [type]
53
- * @property {Object[]} [validations]
175
+ * @property {number} [uid]
176
+ * @property {string} [application_id]
177
+ * @property {string} [created_at]
178
+ * @property {string} [modified_at]
179
+ * @property {number} [__v]
54
180
  */
55
181
  /**
56
- * @typedef CreateUserAttributeRequest
57
- * @property {Object} [attribute]
58
- * @property {boolean} [customer_overriden]
182
+ * @typedef UserGroupListResponseSchema
183
+ * @property {UserGroupResponseSchema[]} [items]
184
+ * @property {PaginationSchema} [page]
185
+ */
186
+ /**
187
+ * @typedef ConditionsSchema
188
+ * @property {string} [user_attribute_definition_id]
189
+ * @property {string} [type]
190
+ * @property {string} [value]
59
191
  */
60
192
  /**
61
193
  * @typedef CreateUserGroup
62
194
  * @property {ConditionsSchema[]} [conditions]
195
+ * @property {string} [type]
196
+ * @property {string} name
63
197
  * @property {string} description
64
198
  * @property {string} [file_url]
65
- * @property {string} name
66
- * @property {string} [type]
67
199
  */
68
200
  /**
69
201
  * @typedef CreateUserRequestSchema
202
+ * @property {string} phone_number
70
203
  * @property {string} [email]
71
- * @property {string} [external_id]
72
204
  * @property {string} [first_name]
73
- * @property {string} [gender]
74
205
  * @property {string} [last_name]
75
- * @property {Object} [meta]
76
- * @property {string} phone_number
206
+ * @property {string} [gender]
77
207
  * @property {string} username
208
+ * @property {Object} [meta]
209
+ * @property {string} [external_id]
78
210
  */
79
211
  /**
80
212
  * @typedef CreateUserResponseSchema
@@ -88,91 +220,65 @@ export = UserPlatformModel;
88
220
  */
89
221
  /**
90
222
  * @typedef CreateUserSessionResponseSchema
91
- * @property {Object} [cookie]
92
223
  * @property {string} [domain]
93
- * @property {boolean} [http_only]
94
224
  * @property {number} [max_age]
95
225
  * @property {boolean} [secure]
226
+ * @property {boolean} [http_only]
227
+ * @property {Object} [cookie]
96
228
  */
97
229
  /**
98
- * @typedef CustomerListResponseSchema
99
- * @property {UserSchema[]} [items]
100
- * @property {PaginationSchema} [page]
101
- */
102
- /**
103
- * @typedef DeleteAccountConsent
104
- * @property {string} [consent_text]
230
+ * @typedef PlatformSchema
231
+ * @property {string} [display]
232
+ * @property {LookAndFeel} [look_and_feel]
233
+ * @property {string} [updated_at]
234
+ * @property {boolean} [active]
235
+ * @property {boolean} [forgot_password]
236
+ * @property {Login} [login]
237
+ * @property {boolean} [skip_captcha]
238
+ * @property {string} [name]
239
+ * @property {MetaSchema} [meta]
240
+ * @property {string} [_id]
241
+ * @property {Social} [social]
242
+ * @property {RequiredFields} [required_fields]
243
+ * @property {RegisterRequiredFields} [register_required_fields]
244
+ * @property {boolean} [skip_login]
245
+ * @property {FlashCard} [flash_card]
246
+ * @property {string} [subtext]
247
+ * @property {SocialTokens} [social_tokens]
248
+ * @property {string} [created_at]
249
+ * @property {boolean} [register]
250
+ * @property {string} [mobile_image]
251
+ * @property {string} [desktop_image]
252
+ * @property {number} [delete_account_day]
253
+ * @property {DeleteAccountReasons[]} [delete_account_reasons]
254
+ * @property {Object} [delete_account_consent]
255
+ * @property {Object} [session_config]
105
256
  */
106
257
  /**
107
- * @typedef DeleteAccountReasons
108
- * @property {string} [reason_id]
109
- * @property {string} [reason_text]
110
- * @property {boolean} [show_text_area]
258
+ * @typedef LookAndFeel
259
+ * @property {string} [card_position]
260
+ * @property {string} [background_color]
111
261
  */
112
262
  /**
113
- * @typedef Email
114
- * @property {boolean} [active]
115
- * @property {string} [email]
116
- * @property {boolean} [primary]
117
- * @property {boolean} [verified]
263
+ * @typedef Login
264
+ * @property {boolean} [password]
265
+ * @property {boolean} [otp]
118
266
  */
119
267
  /**
120
- * @typedef Facebook
121
- * @property {string} [app_id]
268
+ * @typedef MetaSchema
269
+ * @property {boolean} [fynd_default]
122
270
  */
123
271
  /**
124
- * @typedef FlashCard
125
- * @property {string} [background_color]
126
- * @property {string} [text]
127
- * @property {string} [text_color]
128
- */
129
- /**
130
- * @typedef Google
131
- * @property {string} [app_id]
132
- */
133
- /**
134
- * @typedef Login
135
- * @property {boolean} [otp]
136
- * @property {boolean} [password]
137
- */
138
- /**
139
- * @typedef LookAndFeel
140
- * @property {string} [background_color]
141
- * @property {string} [card_position]
142
- */
143
- /**
144
- * @typedef MetaSchema
145
- * @property {boolean} [fynd_default]
146
- */
147
- /**
148
- * @typedef PaginationSchema
149
- * @property {number} [current]
150
- * @property {boolean} [has_next]
151
- * @property {number} [item_total]
152
- * @property {number} [size]
153
- * @property {string} [type]
154
- */
155
- /**
156
- * @typedef PartialUserGroupUpdateSchema
157
- * @property {string} [description]
158
- * @property {string} [file_url] - Required property when passed type file_url.
159
- * Internet reachable csv file url which will be used to fetch download data.
160
- * It must have one of columns from `phone_number``, `email`, `user_id` and
161
- * must have `action` column. `action` column can have `add` or `remove` value.
162
- * @property {string} [name]
163
- * @property {string} [type] - Source of update to be used to update individual
164
- * users. Default value is considered file_url if not passed.
165
- * @property {UserGroupUpdateData[]} [user_data] - Required property when passed
166
- * type json. Array of user data. Must have `action` field and one of
167
- * `phone_number`, `email` or `user_id` field in object
272
+ * @typedef Social
273
+ * @property {boolean} [account_kit]
274
+ * @property {boolean} [facebook]
275
+ * @property {boolean} [google]
276
+ * @property {boolean} [apple]
168
277
  */
169
278
  /**
170
- * @typedef PhoneNumber
171
- * @property {boolean} [active]
172
- * @property {number} [country_code]
173
- * @property {string} [phone]
174
- * @property {boolean} [primary]
175
- * @property {boolean} [verified]
279
+ * @typedef RequiredFields
280
+ * @property {PlatformEmail} [email]
281
+ * @property {PlatformMobile} [mobile]
176
282
  */
177
283
  /**
178
284
  * @typedef PlatformEmail
@@ -184,34 +290,6 @@ export = UserPlatformModel;
184
290
  * @property {boolean} [is_required]
185
291
  * @property {string} [level]
186
292
  */
187
- /**
188
- * @typedef PlatformSchema
189
- * @property {string} [_id]
190
- * @property {boolean} [active]
191
- * @property {string} [created_at]
192
- * @property {Object} [delete_account_consent]
193
- * @property {number} [delete_account_day]
194
- * @property {DeleteAccountReasons[]} [delete_account_reasons]
195
- * @property {string} [desktop_image]
196
- * @property {string} [display]
197
- * @property {FlashCard} [flash_card]
198
- * @property {boolean} [forgot_password]
199
- * @property {Login} [login]
200
- * @property {LookAndFeel} [look_and_feel]
201
- * @property {MetaSchema} [meta]
202
- * @property {string} [mobile_image]
203
- * @property {string} [name]
204
- * @property {boolean} [register]
205
- * @property {RegisterRequiredFields} [register_required_fields]
206
- * @property {RequiredFields} [required_fields]
207
- * @property {Object} [session_config]
208
- * @property {boolean} [skip_captcha]
209
- * @property {boolean} [skip_login]
210
- * @property {Social} [social]
211
- * @property {SocialTokens} [social_tokens]
212
- * @property {string} [subtext]
213
- * @property {string} [updated_at]
214
- */
215
293
  /**
216
294
  * @typedef RegisterRequiredFields
217
295
  * @property {RegisterRequiredFieldsEmail} [email]
@@ -228,305 +306,492 @@ export = UserPlatformModel;
228
306
  * @property {string} [level]
229
307
  */
230
308
  /**
231
- * @typedef RequiredFields
232
- * @property {PlatformEmail} [email]
233
- * @property {PlatformMobile} [mobile]
234
- */
235
- /**
236
- * @typedef SessionDeleteResponseSchema
237
- * @property {string} [session_id]
238
- * @property {string} [user_id]
239
- */
240
- /**
241
- * @typedef SessionExpiry
242
- * @property {number} [duration]
243
- * @property {boolean} [is_rolling]
244
- * @property {string} [type]
245
- */
246
- /**
247
- * @typedef SessionListResponseInfo
248
- * @property {string} [domain]
249
- * @property {string} [expire_in]
250
- * @property {string} [ip]
251
- * @property {string} [session_id]
252
- * @property {string} [user_agent]
309
+ * @typedef FlashCard
310
+ * @property {string} [text]
311
+ * @property {string} [text_color]
312
+ * @property {string} [background_color]
253
313
  */
254
314
  /**
255
- * @typedef SessionListResponseSchema
256
- * @property {SessionListResponseInfo[]} [items]
315
+ * @typedef SocialTokens
316
+ * @property {Facebook} [facebook]
317
+ * @property {Accountkit} [account_kit]
318
+ * @property {Google} [google]
257
319
  */
258
320
  /**
259
- * @typedef SessionsDeleteResponseSchema
260
- * @property {string[]} [session_ids]
261
- * @property {string} [user_id]
321
+ * @typedef DeleteAccountReasons
322
+ * @property {string} [reason_text]
323
+ * @property {string} [reason_id]
324
+ * @property {boolean} [show_text_area]
262
325
  */
263
326
  /**
264
- * @typedef Social
265
- * @property {boolean} [account_kit]
266
- * @property {boolean} [apple]
267
- * @property {boolean} [facebook]
268
- * @property {boolean} [google]
327
+ * @typedef DeleteAccountConsent
328
+ * @property {string} [consent_text]
269
329
  */
270
330
  /**
271
- * @typedef SocialTokens
272
- * @property {Accountkit} [account_kit]
273
- * @property {Facebook} [facebook]
274
- * @property {Google} [google]
331
+ * @typedef Facebook
332
+ * @property {string} [app_id]
275
333
  */
276
334
  /**
277
- * @typedef SuccessMessageResponse
278
- * @property {string} [success]
335
+ * @typedef Accountkit
336
+ * @property {string} [app_id]
279
337
  */
280
338
  /**
281
- * @typedef UnDeleteUserRequestSchema
282
- * @property {string} [reason]
283
- * @property {string} [reason_id]
284
- * @property {string} [user_id]
339
+ * @typedef Google
340
+ * @property {string} [app_id]
285
341
  */
286
342
  /**
287
- * @typedef UnDeleteUserSuccess
288
- * @property {boolean} [success]
343
+ * @typedef SessionExpiry
344
+ * @property {number} [duration]
345
+ * @property {string} [type]
346
+ * @property {boolean} [is_rolling]
289
347
  */
290
348
  /**
291
349
  * @typedef UpdateUserGroupSchema
292
350
  * @property {ConditionsSchema[]} [conditions]
351
+ * @property {string} [type]
352
+ * @property {string} [name]
293
353
  * @property {string} [description]
294
354
  * @property {string} [file_url]
355
+ */
356
+ /**
357
+ * @typedef PartialUserGroupUpdateSchema
358
+ * @property {string} [type] - Source of update to be used to update individual
359
+ * users. Default value is considered file_url if not passed.
295
360
  * @property {string} [name]
296
- * @property {string} [type]
361
+ * @property {string} [description]
362
+ * @property {string} [file_url] - Required property when passed type file_url.
363
+ * Internet reachable csv file url which will be used to fetch download data.
364
+ * It must have one of columns from `phone_number``, `email`, `user_id` and
365
+ * must have `action` column. `action` column can have `add` or `remove` value.
366
+ * @property {UserGroupUpdateData[]} [user_data] - Required property when passed
367
+ * type json. Array of user data. Must have `action` field and one of
368
+ * `phone_number`, `email` or `user_id` field in object
369
+ */
370
+ /**
371
+ * @typedef UserGroupUpdateData
372
+ * @property {string} [user_id] - Must be valid mongodb objectid of existing user
373
+ * @property {string} [phone_number] - Phone number of registered user
374
+ * @property {string} [email] - Email of registered user
375
+ * @property {string} action
297
376
  */
298
377
  /**
299
378
  * @typedef UpdateUserRequestSchema
300
- * @property {UserEmails[]} [emails]
301
- * @property {string} [external_id]
302
379
  * @property {string} [first_name]
303
- * @property {string} [gender]
304
380
  * @property {string} [last_name]
381
+ * @property {string} [gender]
382
+ * @property {string} [external_id]
305
383
  * @property {Object} [meta]
306
384
  * @property {UserPhoneNumbers[]} [phone_numbers]
307
- */
308
- /**
309
- * @typedef UserAttributeDefinition
310
- * @property {number} [__v] - The version number of the attribute.
311
- * @property {string} [_id] - The unique identifier for the attribute definition.
312
- * @property {string} [application_id] - The application ID.
313
- * @property {string} [created_at] - The creation date of the attribute.
314
- * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
315
- * @property {string} [description] - The description of the attribute.
316
- * @property {boolean} [encrypted] - Whether the attribute is encrypted.
317
- * @property {boolean} [is_locked] - Whether the attribute is locked.
318
- * @property {string} [modified_at] - The modification date of the attribute.
319
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
320
- * @property {string} [name] - The attribute name.
321
- * @property {number} [pin_order] - The order in which the attribute is pinned.
322
- * @property {boolean} [pinned] - Whether the attribute is pinned.
323
- * @property {string} [slug] - The attribute key.
324
- * @property {string} [type] - The attribute type.
325
- * @property {Object[]} [validations]
326
- */
327
- /**
328
- * @typedef UserAttributeDefinitionResponse
329
- * @property {string} [_id] - The unique identifier for the attribute definition.
330
- * @property {string} [application_id] - The application ID.
331
- * @property {string} [created_at] - The creation date of the attribute definition.
332
- * @property {string} [created_by] - The user who created the attribute.
333
- * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
334
- * @property {string} [description] - The description of the attribute.
335
- * @property {boolean} [encrypted] - Whether the attribute is encrypted.
336
- * @property {boolean} [is_locked] - Whether the attribute is locked.
337
- * @property {string} [modified_at] - The last modification date of the
338
- * attribute definition.
339
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
340
- * @property {string} [name] - The attribute name.
341
- * @property {number} [pin_order] - The order in which the attribute is pinned.
342
- * @property {boolean} [pinned] - Whether the attribute is pinned.
343
- * @property {string} [slug] - The attribute key.
344
- * @property {string} [type] - The attribute type.
345
- * @property {string} [updated_by] - The user who last updated the attribute.
346
- * @property {UserAttributeDefinitionValidation[]} [validations]
347
- */
348
- /**
349
- * @typedef UserAttributeDefinitionValidation
350
- * @property {string} [type] - The type of validation.
351
- * @property {Object} [value] - The validation value.
352
- */
353
- /**
354
- * @typedef UserAttributeResponse
355
- * @property {string} [_id] - The unique identifier for the attribute definition.
356
- * @property {string} [application_id] - The application ID.
357
- * @property {Object} [attribute]
358
- * @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
359
- * @property {string} [name] - The name of user attribute definition.
360
- * @property {string} [type] - The attribute type.
361
- * @property {string} [updated_by]
362
- * @property {string} [user_id] - The unique identifier for the user.
385
+ * @property {UserEmails[]} [emails]
363
386
  */
364
387
  /**
365
388
  * @typedef UserEmails
366
389
  * @property {boolean} [active]
367
- * @property {string} [email]
368
390
  * @property {boolean} [primary]
369
391
  * @property {boolean} [verified]
392
+ * @property {string} [email]
370
393
  */
371
394
  /**
372
- * @typedef UserGroupListResponseSchema
373
- * @property {UserGroupResponseSchema[]} [items]
374
- * @property {PaginationSchema} [page]
395
+ * @typedef UserPhoneNumbers
396
+ * @property {boolean} [active]
397
+ * @property {boolean} [primary]
398
+ * @property {boolean} [verified]
399
+ * @property {string} [phone]
400
+ * @property {string} [country_code]
375
401
  */
376
402
  /**
377
- * @typedef UserGroupResponseSchema
378
- * @property {number} [__v]
379
- * @property {string} [_id]
403
+ * @typedef UserSchema
380
404
  * @property {string} [application_id]
381
- * @property {Conditions[]} [conditions]
382
- * @property {string} [created_at]
383
- * @property {string} [description]
384
- * @property {UserResponseErrorSchema} [error]
385
- * @property {string} [file_url]
386
- * @property {boolean} [is_active]
387
- * @property {string} [modified_at]
388
- * @property {string} [name]
389
- * @property {string} [status]
390
- * @property {string} [type]
391
- * @property {number} [uid]
392
- */
393
- /**
394
- * @typedef UserGroupUpdateData
395
- * @property {string} action
396
- * @property {string} [email] - Email of registered user
397
- * @property {string} [phone_number] - Phone number of registered user
398
- * @property {string} [user_id] - Must be valid mongodb objectid of existing user
405
+ * @property {string} [user_id]
406
+ * @property {string} [first_name]
407
+ * @property {Object} [meta]
408
+ * @property {string} [last_name]
409
+ * @property {PhoneNumber[]} [phone_numbers]
410
+ * @property {Email[]} [emails]
411
+ * @property {string} [gender]
412
+ * @property {string} [dob]
413
+ * @property {boolean} [active]
414
+ * @property {string} [profile_pic_url]
415
+ * @property {string} [username]
416
+ * @property {string} [account_type]
417
+ * @property {string} [_id]
418
+ * @property {string} [created_at]
419
+ * @property {string} [updated_at]
420
+ * @property {string} [external_id]
399
421
  */
400
422
  /**
401
- * @typedef UserPhoneNumbers
423
+ * @typedef PhoneNumber
402
424
  * @property {boolean} [active]
403
- * @property {string} [country_code]
404
- * @property {string} [phone]
405
425
  * @property {boolean} [primary]
406
426
  * @property {boolean} [verified]
427
+ * @property {string} [phone]
428
+ * @property {number} [country_code]
407
429
  */
408
430
  /**
409
- * @typedef UserResponseErrorSchema
410
- * @property {number} [count]
411
- * @property {string} [file_url]
412
- */
413
- /**
414
- * @typedef UserSchema
415
- * @property {string} [_id]
416
- * @property {string} [account_type]
431
+ * @typedef Email
432
+ * @property {boolean} [primary]
433
+ * @property {boolean} [verified]
434
+ * @property {string} [email]
417
435
  * @property {boolean} [active]
418
- * @property {string} [application_id]
419
- * @property {string} [created_at]
420
- * @property {string} [dob]
421
- * @property {Email[]} [emails]
422
- * @property {string} [external_id]
423
- * @property {string} [first_name]
424
- * @property {string} [gender]
425
- * @property {string} [last_name]
426
- * @property {Object} [meta]
427
- * @property {PhoneNumber[]} [phone_numbers]
428
- * @property {string} [profile_pic_url]
429
- * @property {string} [updated_at]
430
- * @property {string} [user_id]
431
- * @property {string} [username]
432
- */
433
- /**
434
- * @typedef UserSearchResponseSchema
435
- * @property {UserSchema[]} [users]
436
436
  */
437
437
  declare class UserPlatformModel {
438
438
  }
439
439
  declare namespace UserPlatformModel {
440
- export { Accountkit, ArchiveUserRequestSchema, ArchiveUserSuccess, AuthenticationApiErrorSchema, BlockUserRequestSchema, BlockUserSuccess, Conditions, ConditionsSchema, CreateUserAttributeDefinition, CreateUserAttributeRequest, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, CustomerListResponseSchema, DeleteAccountConsent, DeleteAccountReasons, Email, Facebook, FlashCard, Google, Login, LookAndFeel, MetaSchema, PaginationSchema, PartialUserGroupUpdateSchema, PhoneNumber, PlatformEmail, PlatformMobile, PlatformSchema, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, RequiredFields, SessionDeleteResponseSchema, SessionExpiry, SessionListResponseInfo, SessionListResponseSchema, SessionsDeleteResponseSchema, Social, SocialTokens, SuccessMessageResponse, UnDeleteUserRequestSchema, UnDeleteUserSuccess, UpdateUserGroupSchema, UpdateUserRequestSchema, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, UserEmails, UserGroupListResponseSchema, UserGroupResponseSchema, UserGroupUpdateData, UserPhoneNumbers, UserResponseErrorSchema, UserSchema, UserSearchResponseSchema };
440
+ export { SuccessMessageResponse, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, CreateUserAttributeRequest, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, AuthenticationApiErrorSchema, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, PhoneNumber, Email };
441
441
  }
442
- /** @returns {Accountkit} */
443
- declare function Accountkit(): Accountkit;
444
- type Accountkit = {
445
- app_id?: string;
442
+ /** @returns {SuccessMessageResponse} */
443
+ declare function SuccessMessageResponse(): SuccessMessageResponse;
444
+ type SuccessMessageResponse = {
445
+ success?: string;
446
+ };
447
+ /** @returns {UserAttributeDefinition} */
448
+ declare function UserAttributeDefinition(): UserAttributeDefinition;
449
+ type UserAttributeDefinition = {
450
+ /**
451
+ * - The unique identifier for the attribute definition.
452
+ */
453
+ _id?: string;
454
+ /**
455
+ * - The attribute name.
456
+ */
457
+ name?: string;
458
+ /**
459
+ * - The attribute key.
460
+ */
461
+ slug?: string;
462
+ /**
463
+ * - The description of the attribute.
464
+ */
465
+ description?: string;
466
+ /**
467
+ * - The application ID.
468
+ */
469
+ application_id?: string;
470
+ /**
471
+ * - The attribute type.
472
+ */
473
+ type?: string;
474
+ /**
475
+ * - Whether the attribute supports multiple values.
476
+ */
477
+ multi_value?: boolean;
478
+ /**
479
+ * - Whether the attribute is customer-editable.
480
+ */
481
+ customer_editable?: boolean;
482
+ /**
483
+ * - Whether the attribute is encrypted.
484
+ */
485
+ encrypted?: boolean;
486
+ /**
487
+ * - Whether the attribute is pinned.
488
+ */
489
+ pinned?: boolean;
490
+ /**
491
+ * - The order in which the attribute is pinned.
492
+ */
493
+ pin_order?: number;
494
+ validations?: any[];
495
+ /**
496
+ * - Whether the attribute is locked.
497
+ */
498
+ is_locked?: boolean;
499
+ /**
500
+ * - The creation date of the attribute.
501
+ */
502
+ created_at?: string;
503
+ /**
504
+ * - The modification date of the attribute.
505
+ */
506
+ modified_at?: string;
507
+ /**
508
+ * - The version number of the attribute.
509
+ */
510
+ __v?: number;
511
+ };
512
+ /** @returns {UserAttributeDefinitionResponse} */
513
+ declare function UserAttributeDefinitionResponse(): UserAttributeDefinitionResponse;
514
+ type UserAttributeDefinitionResponse = {
515
+ /**
516
+ * - The unique identifier for the attribute definition.
517
+ */
518
+ _id?: string;
519
+ /**
520
+ * - The attribute name.
521
+ */
522
+ name?: string;
523
+ /**
524
+ * - The attribute key.
525
+ */
526
+ slug?: string;
527
+ /**
528
+ * - The description of the attribute.
529
+ */
530
+ description?: string;
531
+ /**
532
+ * - The application ID.
533
+ */
534
+ application_id?: string;
535
+ /**
536
+ * - The attribute type.
537
+ */
538
+ type?: string;
539
+ /**
540
+ * - Whether the attribute supports multiple values.
541
+ */
542
+ multi_value?: boolean;
543
+ /**
544
+ * - Whether the attribute is customer-editable.
545
+ */
546
+ customer_editable?: boolean;
547
+ /**
548
+ * - Whether the attribute is encrypted.
549
+ */
550
+ encrypted?: boolean;
551
+ /**
552
+ * - Whether the attribute is pinned.
553
+ */
554
+ pinned?: boolean;
555
+ /**
556
+ * - The order in which the attribute is pinned.
557
+ */
558
+ pin_order?: number;
559
+ validations?: UserAttributeDefinitionValidation[];
560
+ /**
561
+ * - Whether the attribute is locked.
562
+ */
563
+ is_locked?: boolean;
564
+ /**
565
+ * - The user who created the attribute.
566
+ */
567
+ created_by?: string;
568
+ /**
569
+ * - The user who last updated the attribute.
570
+ */
571
+ updated_by?: string;
572
+ /**
573
+ * - The creation date of the attribute definition.
574
+ */
575
+ created_at?: string;
576
+ /**
577
+ * - The last modification date of the
578
+ * attribute definition.
579
+ */
580
+ modified_at?: string;
581
+ };
582
+ /** @returns {UserAttributeDefinitionValidation} */
583
+ declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
584
+ type UserAttributeDefinitionValidation = {
585
+ /**
586
+ * - The type of validation.
587
+ */
588
+ type?: string;
589
+ /**
590
+ * - The validation value.
591
+ */
592
+ value?: any;
593
+ };
594
+ /** @returns {UserAttributeResponse} */
595
+ declare function UserAttributeResponse(): UserAttributeResponse;
596
+ type UserAttributeResponse = {
597
+ /**
598
+ * - The unique identifier for the attribute definition.
599
+ */
600
+ _id?: string;
601
+ /**
602
+ * - The name of user attribute definition.
603
+ */
604
+ name?: string;
605
+ /**
606
+ * - The unique identifier for the user.
607
+ */
608
+ user_id?: string;
609
+ /**
610
+ * - The application ID.
611
+ */
612
+ application_id?: string;
613
+ /**
614
+ * - The attribute type.
615
+ */
616
+ type?: string;
617
+ /**
618
+ * - Whether the attribute is customer-editable.
619
+ */
620
+ customer_overriden?: boolean;
621
+ attribute?: any;
622
+ updated_by?: string;
623
+ };
624
+ /** @returns {CreateUserAttributeRequest} */
625
+ declare function CreateUserAttributeRequest(): CreateUserAttributeRequest;
626
+ type CreateUserAttributeRequest = {
627
+ customer_overriden?: boolean;
628
+ attribute?: any;
629
+ };
630
+ /** @returns {CreateUserAttributeDefinition} */
631
+ declare function CreateUserAttributeDefinition(): CreateUserAttributeDefinition;
632
+ type CreateUserAttributeDefinition = {
633
+ name?: string;
634
+ slug?: string;
635
+ description?: string;
636
+ type?: string;
637
+ multi_value?: boolean;
638
+ customer_editable?: boolean;
639
+ encrypted?: boolean;
640
+ pinned?: boolean;
641
+ pin_order?: number;
642
+ default_value?: string;
643
+ validations?: any[];
644
+ };
645
+ /** @returns {BlockUserRequestSchema} */
646
+ declare function BlockUserRequestSchema(): BlockUserRequestSchema;
647
+ type BlockUserRequestSchema = {
648
+ status?: boolean;
649
+ user_id?: string[];
650
+ reason?: string;
446
651
  };
447
652
  /** @returns {ArchiveUserRequestSchema} */
448
653
  declare function ArchiveUserRequestSchema(): ArchiveUserRequestSchema;
449
654
  type ArchiveUserRequestSchema = {
450
655
  user_id?: string;
451
656
  };
657
+ /** @returns {UnDeleteUserRequestSchema} */
658
+ declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
659
+ type UnDeleteUserRequestSchema = {
660
+ user_id?: string;
661
+ reason?: string;
662
+ reason_id?: string;
663
+ };
664
+ /** @returns {BlockUserSuccess} */
665
+ declare function BlockUserSuccess(): BlockUserSuccess;
666
+ type BlockUserSuccess = {
667
+ success?: boolean;
668
+ };
452
669
  /** @returns {ArchiveUserSuccess} */
453
670
  declare function ArchiveUserSuccess(): ArchiveUserSuccess;
454
671
  type ArchiveUserSuccess = {
455
672
  success?: boolean;
456
673
  };
674
+ /** @returns {UnDeleteUserSuccess} */
675
+ declare function UnDeleteUserSuccess(): UnDeleteUserSuccess;
676
+ type UnDeleteUserSuccess = {
677
+ success?: boolean;
678
+ };
679
+ /** @returns {UserSearchResponseSchema} */
680
+ declare function UserSearchResponseSchema(): UserSearchResponseSchema;
681
+ type UserSearchResponseSchema = {
682
+ users?: UserSchema[];
683
+ };
684
+ /** @returns {CustomerListResponseSchema} */
685
+ declare function CustomerListResponseSchema(): CustomerListResponseSchema;
686
+ type CustomerListResponseSchema = {
687
+ items?: UserSchema[];
688
+ page?: PaginationSchema;
689
+ };
690
+ /** @returns {PaginationSchema} */
691
+ declare function PaginationSchema(): PaginationSchema;
692
+ type PaginationSchema = {
693
+ size?: number;
694
+ item_total?: number;
695
+ has_next?: boolean;
696
+ type?: string;
697
+ current?: number;
698
+ };
699
+ /** @returns {SessionListResponseSchema} */
700
+ declare function SessionListResponseSchema(): SessionListResponseSchema;
701
+ type SessionListResponseSchema = {
702
+ items?: SessionListResponseInfo[];
703
+ };
704
+ /** @returns {SessionDeleteResponseSchema} */
705
+ declare function SessionDeleteResponseSchema(): SessionDeleteResponseSchema;
706
+ type SessionDeleteResponseSchema = {
707
+ user_id?: string;
708
+ session_id?: string;
709
+ };
710
+ /** @returns {SessionsDeleteResponseSchema} */
711
+ declare function SessionsDeleteResponseSchema(): SessionsDeleteResponseSchema;
712
+ type SessionsDeleteResponseSchema = {
713
+ user_id?: string;
714
+ session_ids?: string[];
715
+ };
457
716
  /** @returns {AuthenticationApiErrorSchema} */
458
717
  declare function AuthenticationApiErrorSchema(): AuthenticationApiErrorSchema;
459
718
  type AuthenticationApiErrorSchema = {
460
719
  message?: string;
461
720
  };
462
- /** @returns {BlockUserRequestSchema} */
463
- declare function BlockUserRequestSchema(): BlockUserRequestSchema;
464
- type BlockUserRequestSchema = {
465
- reason?: string;
466
- status?: boolean;
467
- user_id?: string[];
468
- };
469
- /** @returns {BlockUserSuccess} */
470
- declare function BlockUserSuccess(): BlockUserSuccess;
471
- type BlockUserSuccess = {
472
- success?: boolean;
721
+ /** @returns {SessionListResponseInfo} */
722
+ declare function SessionListResponseInfo(): SessionListResponseInfo;
723
+ type SessionListResponseInfo = {
724
+ session_id?: string;
725
+ user_agent?: string;
726
+ ip?: string;
727
+ domain?: string;
728
+ expire_in?: string;
473
729
  };
474
730
  /** @returns {Conditions} */
475
731
  declare function Conditions(): Conditions;
476
732
  type Conditions = {
477
- key?: string;
478
- type?: string;
479
733
  user_attribute_definition_id?: string;
734
+ type?: string;
480
735
  value?: string;
736
+ key?: string;
737
+ };
738
+ /** @returns {UserResponseErrorSchema} */
739
+ declare function UserResponseErrorSchema(): UserResponseErrorSchema;
740
+ type UserResponseErrorSchema = {
741
+ count?: number;
742
+ file_url?: string;
743
+ };
744
+ /** @returns {UserGroupResponseSchema} */
745
+ declare function UserGroupResponseSchema(): UserGroupResponseSchema;
746
+ type UserGroupResponseSchema = {
747
+ conditions?: Conditions[];
748
+ error?: UserResponseErrorSchema;
749
+ name?: string;
750
+ description?: string;
751
+ file_url?: string;
752
+ _id?: string;
753
+ status?: string;
754
+ is_active?: boolean;
755
+ type?: string;
756
+ uid?: number;
757
+ application_id?: string;
758
+ created_at?: string;
759
+ modified_at?: string;
760
+ __v?: number;
761
+ };
762
+ /** @returns {UserGroupListResponseSchema} */
763
+ declare function UserGroupListResponseSchema(): UserGroupListResponseSchema;
764
+ type UserGroupListResponseSchema = {
765
+ items?: UserGroupResponseSchema[];
766
+ page?: PaginationSchema;
481
767
  };
482
768
  /** @returns {ConditionsSchema} */
483
769
  declare function ConditionsSchema(): ConditionsSchema;
484
770
  type ConditionsSchema = {
485
- type?: string;
486
771
  user_attribute_definition_id?: string;
487
- value?: string;
488
- };
489
- /** @returns {CreateUserAttributeDefinition} */
490
- declare function CreateUserAttributeDefinition(): CreateUserAttributeDefinition;
491
- type CreateUserAttributeDefinition = {
492
- customer_editable?: boolean;
493
- default_value?: string;
494
- description?: string;
495
- encrypted?: boolean;
496
- multi_value?: boolean;
497
- name?: string;
498
- pin_order?: number;
499
- pinned?: boolean;
500
- slug?: string;
501
772
  type?: string;
502
- validations?: any[];
503
- };
504
- /** @returns {CreateUserAttributeRequest} */
505
- declare function CreateUserAttributeRequest(): CreateUserAttributeRequest;
506
- type CreateUserAttributeRequest = {
507
- attribute?: any;
508
- customer_overriden?: boolean;
773
+ value?: string;
509
774
  };
510
775
  /** @returns {CreateUserGroup} */
511
776
  declare function CreateUserGroup(): CreateUserGroup;
512
777
  type CreateUserGroup = {
513
778
  conditions?: ConditionsSchema[];
779
+ type?: string;
780
+ name: string;
514
781
  description: string;
515
782
  file_url?: string;
516
- name: string;
517
- type?: string;
518
783
  };
519
784
  /** @returns {CreateUserRequestSchema} */
520
785
  declare function CreateUserRequestSchema(): CreateUserRequestSchema;
521
786
  type CreateUserRequestSchema = {
787
+ phone_number: string;
522
788
  email?: string;
523
- external_id?: string;
524
789
  first_name?: string;
525
- gender?: string;
526
790
  last_name?: string;
527
- meta?: any;
528
- phone_number: string;
791
+ gender?: string;
529
792
  username: string;
793
+ meta?: any;
794
+ external_id?: string;
530
795
  };
531
796
  /** @returns {CreateUserResponseSchema} */
532
797
  declare function CreateUserResponseSchema(): CreateUserResponseSchema;
@@ -543,113 +808,71 @@ type CreateUserSessionRequestSchema = {
543
808
  /** @returns {CreateUserSessionResponseSchema} */
544
809
  declare function CreateUserSessionResponseSchema(): CreateUserSessionResponseSchema;
545
810
  type CreateUserSessionResponseSchema = {
546
- cookie?: any;
547
811
  domain?: string;
548
- http_only?: boolean;
549
812
  max_age?: number;
550
813
  secure?: boolean;
814
+ http_only?: boolean;
815
+ cookie?: any;
551
816
  };
552
- /** @returns {CustomerListResponseSchema} */
553
- declare function CustomerListResponseSchema(): CustomerListResponseSchema;
554
- type CustomerListResponseSchema = {
555
- items?: UserSchema[];
556
- page?: PaginationSchema;
557
- };
558
- /** @returns {DeleteAccountConsent} */
559
- declare function DeleteAccountConsent(): DeleteAccountConsent;
560
- type DeleteAccountConsent = {
561
- consent_text?: string;
562
- };
563
- /** @returns {DeleteAccountReasons} */
564
- declare function DeleteAccountReasons(): DeleteAccountReasons;
565
- type DeleteAccountReasons = {
566
- reason_id?: string;
567
- reason_text?: string;
568
- show_text_area?: boolean;
569
- };
570
- /** @returns {Email} */
571
- declare function Email(): Email;
572
- type Email = {
817
+ /** @returns {PlatformSchema} */
818
+ declare function PlatformSchema(): PlatformSchema;
819
+ type PlatformSchema = {
820
+ display?: string;
821
+ look_and_feel?: LookAndFeel;
822
+ updated_at?: string;
573
823
  active?: boolean;
574
- email?: string;
575
- primary?: boolean;
576
- verified?: boolean;
577
- };
578
- /** @returns {Facebook} */
579
- declare function Facebook(): Facebook;
580
- type Facebook = {
581
- app_id?: string;
824
+ forgot_password?: boolean;
825
+ login?: Login;
826
+ skip_captcha?: boolean;
827
+ name?: string;
828
+ meta?: MetaSchema;
829
+ _id?: string;
830
+ social?: Social;
831
+ required_fields?: RequiredFields;
832
+ register_required_fields?: RegisterRequiredFields;
833
+ skip_login?: boolean;
834
+ flash_card?: FlashCard;
835
+ subtext?: string;
836
+ social_tokens?: SocialTokens;
837
+ created_at?: string;
838
+ register?: boolean;
839
+ mobile_image?: string;
840
+ desktop_image?: string;
841
+ delete_account_day?: number;
842
+ delete_account_reasons?: DeleteAccountReasons[];
843
+ delete_account_consent?: any;
844
+ session_config?: any;
582
845
  };
583
- /** @returns {FlashCard} */
584
- declare function FlashCard(): FlashCard;
585
- type FlashCard = {
846
+ /** @returns {LookAndFeel} */
847
+ declare function LookAndFeel(): LookAndFeel;
848
+ type LookAndFeel = {
849
+ card_position?: string;
586
850
  background_color?: string;
587
- text?: string;
588
- text_color?: string;
589
- };
590
- /** @returns {Google} */
591
- declare function Google(): Google;
592
- type Google = {
593
- app_id?: string;
594
851
  };
595
852
  /** @returns {Login} */
596
853
  declare function Login(): Login;
597
854
  type Login = {
598
- otp?: boolean;
599
855
  password?: boolean;
600
- };
601
- /** @returns {LookAndFeel} */
602
- declare function LookAndFeel(): LookAndFeel;
603
- type LookAndFeel = {
604
- background_color?: string;
605
- card_position?: string;
856
+ otp?: boolean;
606
857
  };
607
858
  /** @returns {MetaSchema} */
608
859
  declare function MetaSchema(): MetaSchema;
609
860
  type MetaSchema = {
610
861
  fynd_default?: boolean;
611
862
  };
612
- /** @returns {PaginationSchema} */
613
- declare function PaginationSchema(): PaginationSchema;
614
- type PaginationSchema = {
615
- current?: number;
616
- has_next?: boolean;
617
- item_total?: number;
618
- size?: number;
619
- type?: string;
620
- };
621
- /** @returns {PartialUserGroupUpdateSchema} */
622
- declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
623
- type PartialUserGroupUpdateSchema = {
624
- description?: string;
625
- /**
626
- * - Required property when passed type file_url.
627
- * Internet reachable csv file url which will be used to fetch download data.
628
- * It must have one of columns from `phone_number``, `email`, `user_id` and
629
- * must have `action` column. `action` column can have `add` or `remove` value.
630
- */
631
- file_url?: string;
632
- name?: string;
633
- /**
634
- * - Source of update to be used to update individual
635
- * users. Default value is considered file_url if not passed.
636
- */
637
- type?: string;
638
- /**
639
- * - Required property when passed
640
- * type json. Array of user data. Must have `action` field and one of
641
- * `phone_number`, `email` or `user_id` field in object
642
- */
643
- user_data?: UserGroupUpdateData[];
863
+ /** @returns {Social} */
864
+ declare function Social(): Social;
865
+ type Social = {
866
+ account_kit?: boolean;
867
+ facebook?: boolean;
868
+ google?: boolean;
869
+ apple?: boolean;
644
870
  };
645
- /** @returns {PhoneNumber} */
646
- declare function PhoneNumber(): PhoneNumber;
647
- type PhoneNumber = {
648
- active?: boolean;
649
- country_code?: number;
650
- phone?: string;
651
- primary?: boolean;
652
- verified?: boolean;
871
+ /** @returns {RequiredFields} */
872
+ declare function RequiredFields(): RequiredFields;
873
+ type RequiredFields = {
874
+ email?: PlatformEmail;
875
+ mobile?: PlatformMobile;
653
876
  };
654
877
  /** @returns {PlatformEmail} */
655
878
  declare function PlatformEmail(): PlatformEmail;
@@ -663,35 +886,6 @@ type PlatformMobile = {
663
886
  is_required?: boolean;
664
887
  level?: string;
665
888
  };
666
- /** @returns {PlatformSchema} */
667
- declare function PlatformSchema(): PlatformSchema;
668
- type PlatformSchema = {
669
- _id?: string;
670
- active?: boolean;
671
- created_at?: string;
672
- delete_account_consent?: any;
673
- delete_account_day?: number;
674
- delete_account_reasons?: DeleteAccountReasons[];
675
- desktop_image?: string;
676
- display?: string;
677
- flash_card?: FlashCard;
678
- forgot_password?: boolean;
679
- login?: Login;
680
- look_and_feel?: LookAndFeel;
681
- meta?: MetaSchema;
682
- mobile_image?: string;
683
- name?: string;
684
- register?: boolean;
685
- register_required_fields?: RegisterRequiredFields;
686
- required_fields?: RequiredFields;
687
- session_config?: any;
688
- skip_captcha?: boolean;
689
- skip_login?: boolean;
690
- social?: Social;
691
- social_tokens?: SocialTokens;
692
- subtext?: string;
693
- updated_at?: string;
694
- };
695
889
  /** @returns {RegisterRequiredFields} */
696
890
  declare function RegisterRequiredFields(): RegisterRequiredFields;
697
891
  type RegisterRequiredFields = {
@@ -710,361 +904,167 @@ type RegisterRequiredFieldsMobile = {
710
904
  is_required?: boolean;
711
905
  level?: string;
712
906
  };
713
- /** @returns {RequiredFields} */
714
- declare function RequiredFields(): RequiredFields;
715
- type RequiredFields = {
716
- email?: PlatformEmail;
717
- mobile?: PlatformMobile;
718
- };
719
- /** @returns {SessionDeleteResponseSchema} */
720
- declare function SessionDeleteResponseSchema(): SessionDeleteResponseSchema;
721
- type SessionDeleteResponseSchema = {
722
- session_id?: string;
723
- user_id?: string;
724
- };
725
- /** @returns {SessionExpiry} */
726
- declare function SessionExpiry(): SessionExpiry;
727
- type SessionExpiry = {
728
- duration?: number;
729
- is_rolling?: boolean;
730
- type?: string;
731
- };
732
- /** @returns {SessionListResponseInfo} */
733
- declare function SessionListResponseInfo(): SessionListResponseInfo;
734
- type SessionListResponseInfo = {
735
- domain?: string;
736
- expire_in?: string;
737
- ip?: string;
738
- session_id?: string;
739
- user_agent?: string;
740
- };
741
- /** @returns {SessionListResponseSchema} */
742
- declare function SessionListResponseSchema(): SessionListResponseSchema;
743
- type SessionListResponseSchema = {
744
- items?: SessionListResponseInfo[];
745
- };
746
- /** @returns {SessionsDeleteResponseSchema} */
747
- declare function SessionsDeleteResponseSchema(): SessionsDeleteResponseSchema;
748
- type SessionsDeleteResponseSchema = {
749
- session_ids?: string[];
750
- user_id?: string;
751
- };
752
- /** @returns {Social} */
753
- declare function Social(): Social;
754
- type Social = {
755
- account_kit?: boolean;
756
- apple?: boolean;
757
- facebook?: boolean;
758
- google?: boolean;
907
+ /** @returns {FlashCard} */
908
+ declare function FlashCard(): FlashCard;
909
+ type FlashCard = {
910
+ text?: string;
911
+ text_color?: string;
912
+ background_color?: string;
759
913
  };
760
914
  /** @returns {SocialTokens} */
761
915
  declare function SocialTokens(): SocialTokens;
762
916
  type SocialTokens = {
763
- account_kit?: Accountkit;
764
917
  facebook?: Facebook;
918
+ account_kit?: Accountkit;
765
919
  google?: Google;
766
920
  };
767
- /** @returns {SuccessMessageResponse} */
768
- declare function SuccessMessageResponse(): SuccessMessageResponse;
769
- type SuccessMessageResponse = {
770
- success?: string;
771
- };
772
- /** @returns {UnDeleteUserRequestSchema} */
773
- declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
774
- type UnDeleteUserRequestSchema = {
775
- reason?: string;
921
+ /** @returns {DeleteAccountReasons} */
922
+ declare function DeleteAccountReasons(): DeleteAccountReasons;
923
+ type DeleteAccountReasons = {
924
+ reason_text?: string;
776
925
  reason_id?: string;
777
- user_id?: string;
778
- };
779
- /** @returns {UnDeleteUserSuccess} */
780
- declare function UnDeleteUserSuccess(): UnDeleteUserSuccess;
781
- type UnDeleteUserSuccess = {
782
- success?: boolean;
783
- };
784
- /** @returns {UpdateUserGroupSchema} */
785
- declare function UpdateUserGroupSchema(): UpdateUserGroupSchema;
786
- type UpdateUserGroupSchema = {
787
- conditions?: ConditionsSchema[];
788
- description?: string;
789
- file_url?: string;
790
- name?: string;
791
- type?: string;
792
- };
793
- /** @returns {UpdateUserRequestSchema} */
794
- declare function UpdateUserRequestSchema(): UpdateUserRequestSchema;
795
- type UpdateUserRequestSchema = {
796
- emails?: UserEmails[];
797
- external_id?: string;
798
- first_name?: string;
799
- gender?: string;
800
- last_name?: string;
801
- meta?: any;
802
- phone_numbers?: UserPhoneNumbers[];
926
+ show_text_area?: boolean;
803
927
  };
804
- /** @returns {UserAttributeDefinition} */
805
- declare function UserAttributeDefinition(): UserAttributeDefinition;
806
- type UserAttributeDefinition = {
807
- /**
808
- * - The version number of the attribute.
809
- */
810
- __v?: number;
811
- /**
812
- * - The unique identifier for the attribute definition.
813
- */
814
- _id?: string;
815
- /**
816
- * - The application ID.
817
- */
818
- application_id?: string;
819
- /**
820
- * - The creation date of the attribute.
821
- */
822
- created_at?: string;
823
- /**
824
- * - Whether the attribute is customer-editable.
825
- */
826
- customer_editable?: boolean;
827
- /**
828
- * - The description of the attribute.
829
- */
830
- description?: string;
831
- /**
832
- * - Whether the attribute is encrypted.
833
- */
834
- encrypted?: boolean;
835
- /**
836
- * - Whether the attribute is locked.
837
- */
838
- is_locked?: boolean;
839
- /**
840
- * - The modification date of the attribute.
841
- */
842
- modified_at?: string;
843
- /**
844
- * - Whether the attribute supports multiple values.
845
- */
846
- multi_value?: boolean;
847
- /**
848
- * - The attribute name.
849
- */
850
- name?: string;
851
- /**
852
- * - The order in which the attribute is pinned.
853
- */
854
- pin_order?: number;
855
- /**
856
- * - Whether the attribute is pinned.
857
- */
858
- pinned?: boolean;
859
- /**
860
- * - The attribute key.
861
- */
862
- slug?: string;
863
- /**
864
- * - The attribute type.
865
- */
866
- type?: string;
867
- validations?: any[];
928
+ /** @returns {DeleteAccountConsent} */
929
+ declare function DeleteAccountConsent(): DeleteAccountConsent;
930
+ type DeleteAccountConsent = {
931
+ consent_text?: string;
868
932
  };
869
- /** @returns {UserAttributeDefinitionResponse} */
870
- declare function UserAttributeDefinitionResponse(): UserAttributeDefinitionResponse;
871
- type UserAttributeDefinitionResponse = {
872
- /**
873
- * - The unique identifier for the attribute definition.
874
- */
875
- _id?: string;
876
- /**
877
- * - The application ID.
878
- */
879
- application_id?: string;
880
- /**
881
- * - The creation date of the attribute definition.
882
- */
883
- created_at?: string;
884
- /**
885
- * - The user who created the attribute.
886
- */
887
- created_by?: string;
888
- /**
889
- * - Whether the attribute is customer-editable.
890
- */
891
- customer_editable?: boolean;
892
- /**
893
- * - The description of the attribute.
894
- */
895
- description?: string;
896
- /**
897
- * - Whether the attribute is encrypted.
898
- */
899
- encrypted?: boolean;
900
- /**
901
- * - Whether the attribute is locked.
902
- */
903
- is_locked?: boolean;
904
- /**
905
- * - The last modification date of the
906
- * attribute definition.
907
- */
908
- modified_at?: string;
909
- /**
910
- * - Whether the attribute supports multiple values.
911
- */
912
- multi_value?: boolean;
913
- /**
914
- * - The attribute name.
915
- */
916
- name?: string;
917
- /**
918
- * - The order in which the attribute is pinned.
919
- */
920
- pin_order?: number;
921
- /**
922
- * - Whether the attribute is pinned.
923
- */
924
- pinned?: boolean;
925
- /**
926
- * - The attribute key.
927
- */
928
- slug?: string;
929
- /**
930
- * - The attribute type.
931
- */
933
+ /** @returns {Facebook} */
934
+ declare function Facebook(): Facebook;
935
+ type Facebook = {
936
+ app_id?: string;
937
+ };
938
+ /** @returns {Accountkit} */
939
+ declare function Accountkit(): Accountkit;
940
+ type Accountkit = {
941
+ app_id?: string;
942
+ };
943
+ /** @returns {Google} */
944
+ declare function Google(): Google;
945
+ type Google = {
946
+ app_id?: string;
947
+ };
948
+ /** @returns {SessionExpiry} */
949
+ declare function SessionExpiry(): SessionExpiry;
950
+ type SessionExpiry = {
951
+ duration?: number;
932
952
  type?: string;
933
- /**
934
- * - The user who last updated the attribute.
935
- */
936
- updated_by?: string;
937
- validations?: UserAttributeDefinitionValidation[];
953
+ is_rolling?: boolean;
938
954
  };
939
- /** @returns {UserAttributeDefinitionValidation} */
940
- declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
941
- type UserAttributeDefinitionValidation = {
942
- /**
943
- * - The type of validation.
944
- */
955
+ /** @returns {UpdateUserGroupSchema} */
956
+ declare function UpdateUserGroupSchema(): UpdateUserGroupSchema;
957
+ type UpdateUserGroupSchema = {
958
+ conditions?: ConditionsSchema[];
945
959
  type?: string;
946
- /**
947
- * - The validation value.
948
- */
949
- value?: any;
960
+ name?: string;
961
+ description?: string;
962
+ file_url?: string;
950
963
  };
951
- /** @returns {UserAttributeResponse} */
952
- declare function UserAttributeResponse(): UserAttributeResponse;
953
- type UserAttributeResponse = {
964
+ /** @returns {PartialUserGroupUpdateSchema} */
965
+ declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
966
+ type PartialUserGroupUpdateSchema = {
954
967
  /**
955
- * - The unique identifier for the attribute definition.
968
+ * - Source of update to be used to update individual
969
+ * users. Default value is considered file_url if not passed.
956
970
  */
957
- _id?: string;
971
+ type?: string;
972
+ name?: string;
973
+ description?: string;
958
974
  /**
959
- * - The application ID.
975
+ * - Required property when passed type file_url.
976
+ * Internet reachable csv file url which will be used to fetch download data.
977
+ * It must have one of columns from `phone_number``, `email`, `user_id` and
978
+ * must have `action` column. `action` column can have `add` or `remove` value.
960
979
  */
961
- application_id?: string;
962
- attribute?: any;
980
+ file_url?: string;
963
981
  /**
964
- * - Whether the attribute is customer-editable.
982
+ * - Required property when passed
983
+ * type json. Array of user data. Must have `action` field and one of
984
+ * `phone_number`, `email` or `user_id` field in object
965
985
  */
966
- customer_overriden?: boolean;
986
+ user_data?: UserGroupUpdateData[];
987
+ };
988
+ /** @returns {UserGroupUpdateData} */
989
+ declare function UserGroupUpdateData(): UserGroupUpdateData;
990
+ type UserGroupUpdateData = {
967
991
  /**
968
- * - The name of user attribute definition.
992
+ * - Must be valid mongodb objectid of existing user
969
993
  */
970
- name?: string;
994
+ user_id?: string;
971
995
  /**
972
- * - The attribute type.
996
+ * - Phone number of registered user
973
997
  */
974
- type?: string;
975
- updated_by?: string;
998
+ phone_number?: string;
976
999
  /**
977
- * - The unique identifier for the user.
1000
+ * - Email of registered user
978
1001
  */
979
- user_id?: string;
1002
+ email?: string;
1003
+ action: string;
1004
+ };
1005
+ /** @returns {UpdateUserRequestSchema} */
1006
+ declare function UpdateUserRequestSchema(): UpdateUserRequestSchema;
1007
+ type UpdateUserRequestSchema = {
1008
+ first_name?: string;
1009
+ last_name?: string;
1010
+ gender?: string;
1011
+ external_id?: string;
1012
+ meta?: any;
1013
+ phone_numbers?: UserPhoneNumbers[];
1014
+ emails?: UserEmails[];
980
1015
  };
981
1016
  /** @returns {UserEmails} */
982
1017
  declare function UserEmails(): UserEmails;
983
1018
  type UserEmails = {
984
1019
  active?: boolean;
985
- email?: string;
986
1020
  primary?: boolean;
987
1021
  verified?: boolean;
988
- };
989
- /** @returns {UserGroupListResponseSchema} */
990
- declare function UserGroupListResponseSchema(): UserGroupListResponseSchema;
991
- type UserGroupListResponseSchema = {
992
- items?: UserGroupResponseSchema[];
993
- page?: PaginationSchema;
994
- };
995
- /** @returns {UserGroupResponseSchema} */
996
- declare function UserGroupResponseSchema(): UserGroupResponseSchema;
997
- type UserGroupResponseSchema = {
998
- __v?: number;
999
- _id?: string;
1000
- application_id?: string;
1001
- conditions?: Conditions[];
1002
- created_at?: string;
1003
- description?: string;
1004
- error?: UserResponseErrorSchema;
1005
- file_url?: string;
1006
- is_active?: boolean;
1007
- modified_at?: string;
1008
- name?: string;
1009
- status?: string;
1010
- type?: string;
1011
- uid?: number;
1012
- };
1013
- /** @returns {UserGroupUpdateData} */
1014
- declare function UserGroupUpdateData(): UserGroupUpdateData;
1015
- type UserGroupUpdateData = {
1016
- action: string;
1017
- /**
1018
- * - Email of registered user
1019
- */
1020
1022
  email?: string;
1021
- /**
1022
- * - Phone number of registered user
1023
- */
1024
- phone_number?: string;
1025
- /**
1026
- * - Must be valid mongodb objectid of existing user
1027
- */
1028
- user_id?: string;
1029
1023
  };
1030
1024
  /** @returns {UserPhoneNumbers} */
1031
1025
  declare function UserPhoneNumbers(): UserPhoneNumbers;
1032
1026
  type UserPhoneNumbers = {
1033
1027
  active?: boolean;
1034
- country_code?: string;
1035
- phone?: string;
1036
1028
  primary?: boolean;
1037
1029
  verified?: boolean;
1038
- };
1039
- /** @returns {UserResponseErrorSchema} */
1040
- declare function UserResponseErrorSchema(): UserResponseErrorSchema;
1041
- type UserResponseErrorSchema = {
1042
- count?: number;
1043
- file_url?: string;
1030
+ phone?: string;
1031
+ country_code?: string;
1044
1032
  };
1045
1033
  /** @returns {UserSchema} */
1046
1034
  declare function UserSchema(): UserSchema;
1047
1035
  type UserSchema = {
1048
- _id?: string;
1049
- account_type?: string;
1050
- active?: boolean;
1051
1036
  application_id?: string;
1052
- created_at?: string;
1053
- dob?: string;
1054
- emails?: Email[];
1055
- external_id?: string;
1037
+ user_id?: string;
1056
1038
  first_name?: string;
1057
- gender?: string;
1058
- last_name?: string;
1059
1039
  meta?: any;
1040
+ last_name?: string;
1060
1041
  phone_numbers?: PhoneNumber[];
1042
+ emails?: Email[];
1043
+ gender?: string;
1044
+ dob?: string;
1045
+ active?: boolean;
1061
1046
  profile_pic_url?: string;
1062
- updated_at?: string;
1063
- user_id?: string;
1064
1047
  username?: string;
1048
+ account_type?: string;
1049
+ _id?: string;
1050
+ created_at?: string;
1051
+ updated_at?: string;
1052
+ external_id?: string;
1065
1053
  };
1066
- /** @returns {UserSearchResponseSchema} */
1067
- declare function UserSearchResponseSchema(): UserSearchResponseSchema;
1068
- type UserSearchResponseSchema = {
1069
- users?: UserSchema[];
1054
+ /** @returns {PhoneNumber} */
1055
+ declare function PhoneNumber(): PhoneNumber;
1056
+ type PhoneNumber = {
1057
+ active?: boolean;
1058
+ primary?: boolean;
1059
+ verified?: boolean;
1060
+ phone?: string;
1061
+ country_code?: number;
1062
+ };
1063
+ /** @returns {Email} */
1064
+ declare function Email(): Email;
1065
+ type Email = {
1066
+ primary?: boolean;
1067
+ verified?: boolean;
1068
+ email?: string;
1069
+ active?: boolean;
1070
1070
  };