@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +3 -5
- package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
- package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
- package/sdk/application/Cart/CartApplicationValidator.js +0 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
- package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
- package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
- package/sdk/application/Content/ContentApplicationClient.js +0 -246
- package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
- package/sdk/application/Content/ContentApplicationModel.js +565 -817
- package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
- package/sdk/application/Content/ContentApplicationValidator.js +0 -41
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
- package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
- package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +8 -32
- package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
- package/sdk/application/Order/OrderApplicationModel.js +816 -824
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
- package/sdk/application/Order/OrderApplicationValidator.js +0 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
- package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
- package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
- package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
- package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
- package/sdk/application/User/UserApplicationClient.d.ts +0 -33
- package/sdk/application/User/UserApplicationClient.js +0 -239
- package/sdk/application/User/UserApplicationModel.d.ts +753 -768
- package/sdk/application/User/UserApplicationModel.js +731 -755
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
- package/sdk/application/User/UserApplicationValidator.js +0 -36
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +254 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
- package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
- package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
- package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
- package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
- package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
- package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
- package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
- package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
- package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
- package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
- package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
- package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
- package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
- package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +2 -4
- package/sdk/platform/PlatformClient.js +4 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +989 -1588
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +977 -1695
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
- package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
- package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
- package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
- package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
- package/sdk/platform/User/UserPlatformModel.js +428 -679
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
- package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
- package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
- package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
- package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
- package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
- package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
- package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
- package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
- package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
- package/sdk/public/Billing/BillingPublicClient.js +0 -116
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
- package/sdk/public/Billing/BillingPublicModel.js +0 -96
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
- package/sdk/public/Billing/BillingPublicValidator.js +0 -19
- package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
- package/sdk/public/Content/ContentPublicClient.js +0 -114
- package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
- package/sdk/public/Content/ContentPublicModel.js +0 -60
- package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
- package/sdk/public/Content/ContentPublicValidator.js +0 -19
|
@@ -1,80 +1,109 @@
|
|
|
1
1
|
export = UserPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
3
|
+
* @typedef BlockUserRequestSchema
|
|
4
|
+
* @property {boolean} [status]
|
|
5
|
+
* @property {string[]} [user_id]
|
|
6
|
+
* @property {string} [reason]
|
|
5
7
|
*/
|
|
6
8
|
/**
|
|
7
9
|
* @typedef ArchiveUserRequestSchema
|
|
8
10
|
* @property {string} [user_id]
|
|
9
11
|
*/
|
|
12
|
+
/**
|
|
13
|
+
* @typedef UnDeleteUserRequestSchema
|
|
14
|
+
* @property {string} [user_id]
|
|
15
|
+
* @property {string} [reason]
|
|
16
|
+
* @property {string} [reason_id]
|
|
17
|
+
*/
|
|
18
|
+
/**
|
|
19
|
+
* @typedef BlockUserSuccess
|
|
20
|
+
* @property {boolean} [success]
|
|
21
|
+
*/
|
|
10
22
|
/**
|
|
11
23
|
* @typedef ArchiveUserSuccess
|
|
12
24
|
* @property {boolean} [success]
|
|
13
25
|
*/
|
|
14
26
|
/**
|
|
15
|
-
* @typedef
|
|
16
|
-
* @property {
|
|
27
|
+
* @typedef UnDeleteUserSuccess
|
|
28
|
+
* @property {boolean} [success]
|
|
17
29
|
*/
|
|
18
30
|
/**
|
|
19
|
-
* @typedef
|
|
20
|
-
* @property {
|
|
21
|
-
* @property {boolean} [status]
|
|
22
|
-
* @property {string[]} [user_id]
|
|
31
|
+
* @typedef UserSearchResponseSchema
|
|
32
|
+
* @property {UserSchema[]} [users]
|
|
23
33
|
*/
|
|
24
34
|
/**
|
|
25
|
-
* @typedef
|
|
26
|
-
* @property {
|
|
35
|
+
* @typedef CustomerListResponseSchema
|
|
36
|
+
* @property {UserSchema[]} [items]
|
|
37
|
+
* @property {PaginationSchema} [page]
|
|
27
38
|
*/
|
|
28
39
|
/**
|
|
29
|
-
* @typedef
|
|
30
|
-
* @property {
|
|
40
|
+
* @typedef PaginationSchema
|
|
41
|
+
* @property {number} [size]
|
|
42
|
+
* @property {number} [item_total]
|
|
43
|
+
* @property {boolean} [has_next]
|
|
31
44
|
* @property {string} [type]
|
|
32
|
-
* @property {
|
|
33
|
-
* @property {string} [value]
|
|
45
|
+
* @property {number} [current]
|
|
34
46
|
*/
|
|
35
47
|
/**
|
|
36
|
-
* @typedef
|
|
37
|
-
* @property {
|
|
38
|
-
* @property {string} [user_attribute_definition_id]
|
|
39
|
-
* @property {string} [value]
|
|
48
|
+
* @typedef SessionListResponseSchema
|
|
49
|
+
* @property {SessionListResponseInfo[]} [items]
|
|
40
50
|
*/
|
|
41
51
|
/**
|
|
42
|
-
* @typedef
|
|
43
|
-
* @property {
|
|
44
|
-
* @property {string} [
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
* @
|
|
48
|
-
* @property {string} [
|
|
49
|
-
* @property {
|
|
50
|
-
* @property {boolean} [pinned]
|
|
51
|
-
* @property {string} [slug]
|
|
52
|
-
* @property {string} [type]
|
|
53
|
-
* @property {Object[]} [validations]
|
|
52
|
+
* @typedef SessionDeleteResponseSchema
|
|
53
|
+
* @property {string} [user_id]
|
|
54
|
+
* @property {string} [session_id]
|
|
55
|
+
*/
|
|
56
|
+
/**
|
|
57
|
+
* @typedef SessionsDeleteResponseSchema
|
|
58
|
+
* @property {string} [user_id]
|
|
59
|
+
* @property {string[]} [session_ids]
|
|
54
60
|
*/
|
|
55
61
|
/**
|
|
56
|
-
* @typedef
|
|
57
|
-
* @property {
|
|
58
|
-
* @property {boolean} [customer_overriden]
|
|
62
|
+
* @typedef AuthenticationApiErrorSchema
|
|
63
|
+
* @property {string} [message]
|
|
59
64
|
*/
|
|
60
65
|
/**
|
|
61
|
-
* @typedef
|
|
62
|
-
* @property {
|
|
63
|
-
* @property {string}
|
|
66
|
+
* @typedef SessionListResponseInfo
|
|
67
|
+
* @property {string} [session_id]
|
|
68
|
+
* @property {string} [user_agent]
|
|
69
|
+
* @property {string} [ip]
|
|
70
|
+
* @property {string} [domain]
|
|
71
|
+
* @property {string} [expire_in]
|
|
72
|
+
*/
|
|
73
|
+
/**
|
|
74
|
+
* @typedef UserGroupResponseSchema
|
|
75
|
+
* @property {string} [name]
|
|
76
|
+
* @property {string} [description]
|
|
64
77
|
* @property {string} [file_url]
|
|
78
|
+
* @property {string} [_id]
|
|
79
|
+
* @property {string} [status]
|
|
80
|
+
* @property {number} [uid]
|
|
81
|
+
* @property {string} [application_id]
|
|
82
|
+
* @property {string} [created_at]
|
|
83
|
+
* @property {string} [modified_at]
|
|
84
|
+
* @property {number} [__v]
|
|
85
|
+
*/
|
|
86
|
+
/**
|
|
87
|
+
* @typedef UserGroupListResponseSchema
|
|
88
|
+
* @property {UserGroupResponseSchema[]} [items]
|
|
89
|
+
* @property {PaginationSchema} [page]
|
|
90
|
+
*/
|
|
91
|
+
/**
|
|
92
|
+
* @typedef CreateUserGroupSchema
|
|
65
93
|
* @property {string} name
|
|
66
|
-
* @property {string}
|
|
94
|
+
* @property {string} description
|
|
95
|
+
* @property {string} file_url
|
|
67
96
|
*/
|
|
68
97
|
/**
|
|
69
98
|
* @typedef CreateUserRequestSchema
|
|
99
|
+
* @property {string} phone_number
|
|
70
100
|
* @property {string} [email]
|
|
71
|
-
* @property {string} [external_id]
|
|
72
101
|
* @property {string} [first_name]
|
|
73
|
-
* @property {string} [gender]
|
|
74
102
|
* @property {string} [last_name]
|
|
75
|
-
* @property {
|
|
76
|
-
* @property {string} phone_number
|
|
103
|
+
* @property {string} [gender]
|
|
77
104
|
* @property {string} username
|
|
105
|
+
* @property {Object} [meta]
|
|
106
|
+
* @property {string} [external_id]
|
|
78
107
|
*/
|
|
79
108
|
/**
|
|
80
109
|
* @typedef CreateUserResponseSchema
|
|
@@ -88,91 +117,65 @@ export = UserPlatformModel;
|
|
|
88
117
|
*/
|
|
89
118
|
/**
|
|
90
119
|
* @typedef CreateUserSessionResponseSchema
|
|
91
|
-
* @property {Object} [cookie]
|
|
92
120
|
* @property {string} [domain]
|
|
93
|
-
* @property {boolean} [http_only]
|
|
94
121
|
* @property {number} [max_age]
|
|
95
122
|
* @property {boolean} [secure]
|
|
123
|
+
* @property {boolean} [http_only]
|
|
124
|
+
* @property {Object} [cookie]
|
|
96
125
|
*/
|
|
97
126
|
/**
|
|
98
|
-
* @typedef
|
|
99
|
-
* @property {
|
|
100
|
-
* @property {
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* @typedef DeleteAccountConsent
|
|
104
|
-
* @property {string} [consent_text]
|
|
105
|
-
*/
|
|
106
|
-
/**
|
|
107
|
-
* @typedef DeleteAccountReasons
|
|
108
|
-
* @property {string} [reason_id]
|
|
109
|
-
* @property {string} [reason_text]
|
|
110
|
-
* @property {boolean} [show_text_area]
|
|
111
|
-
*/
|
|
112
|
-
/**
|
|
113
|
-
* @typedef Email
|
|
127
|
+
* @typedef PlatformSchema
|
|
128
|
+
* @property {string} [display]
|
|
129
|
+
* @property {LookAndFeel} [look_and_feel]
|
|
130
|
+
* @property {string} [updated_at]
|
|
114
131
|
* @property {boolean} [active]
|
|
115
|
-
* @property {
|
|
116
|
-
* @property {
|
|
117
|
-
* @property {boolean} [
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
* @
|
|
121
|
-
* @property {
|
|
132
|
+
* @property {boolean} [forgot_password]
|
|
133
|
+
* @property {Login} [login]
|
|
134
|
+
* @property {boolean} [skip_captcha]
|
|
135
|
+
* @property {string} [name]
|
|
136
|
+
* @property {MetaSchema} [meta]
|
|
137
|
+
* @property {string} [_id]
|
|
138
|
+
* @property {Social} [social]
|
|
139
|
+
* @property {RequiredFields} [required_fields]
|
|
140
|
+
* @property {RegisterRequiredFields} [register_required_fields]
|
|
141
|
+
* @property {boolean} [skip_login]
|
|
142
|
+
* @property {FlashCard} [flash_card]
|
|
143
|
+
* @property {string} [subtext]
|
|
144
|
+
* @property {SocialTokens} [social_tokens]
|
|
145
|
+
* @property {string} [created_at]
|
|
146
|
+
* @property {boolean} [register]
|
|
147
|
+
* @property {string} [mobile_image]
|
|
148
|
+
* @property {string} [desktop_image]
|
|
149
|
+
* @property {number} [delete_account_day]
|
|
150
|
+
* @property {DeleteAccountReasons[]} [delete_account_reasons]
|
|
151
|
+
* @property {Object} [delete_account_consent]
|
|
152
|
+
* @property {Object} [session_config]
|
|
122
153
|
*/
|
|
123
154
|
/**
|
|
124
|
-
* @typedef
|
|
155
|
+
* @typedef LookAndFeel
|
|
156
|
+
* @property {string} [card_position]
|
|
125
157
|
* @property {string} [background_color]
|
|
126
|
-
* @property {string} [text]
|
|
127
|
-
* @property {string} [text_color]
|
|
128
|
-
*/
|
|
129
|
-
/**
|
|
130
|
-
* @typedef Google
|
|
131
|
-
* @property {string} [app_id]
|
|
132
158
|
*/
|
|
133
159
|
/**
|
|
134
160
|
* @typedef Login
|
|
135
|
-
* @property {boolean} [otp]
|
|
136
161
|
* @property {boolean} [password]
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
* @typedef LookAndFeel
|
|
140
|
-
* @property {string} [background_color]
|
|
141
|
-
* @property {string} [card_position]
|
|
162
|
+
* @property {boolean} [otp]
|
|
142
163
|
*/
|
|
143
164
|
/**
|
|
144
165
|
* @typedef MetaSchema
|
|
145
166
|
* @property {boolean} [fynd_default]
|
|
146
167
|
*/
|
|
147
168
|
/**
|
|
148
|
-
* @typedef
|
|
149
|
-
* @property {
|
|
150
|
-
* @property {boolean} [
|
|
151
|
-
* @property {
|
|
152
|
-
* @property {
|
|
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
|
|
169
|
+
* @typedef Social
|
|
170
|
+
* @property {boolean} [account_kit]
|
|
171
|
+
* @property {boolean} [facebook]
|
|
172
|
+
* @property {boolean} [google]
|
|
173
|
+
* @property {boolean} [apple]
|
|
168
174
|
*/
|
|
169
175
|
/**
|
|
170
|
-
* @typedef
|
|
171
|
-
* @property {
|
|
172
|
-
* @property {
|
|
173
|
-
* @property {string} [phone]
|
|
174
|
-
* @property {boolean} [primary]
|
|
175
|
-
* @property {boolean} [verified]
|
|
176
|
+
* @typedef RequiredFields
|
|
177
|
+
* @property {PlatformEmail} [email]
|
|
178
|
+
* @property {PlatformMobile} [mobile]
|
|
176
179
|
*/
|
|
177
180
|
/**
|
|
178
181
|
* @typedef PlatformEmail
|
|
@@ -184,34 +187,6 @@ export = UserPlatformModel;
|
|
|
184
187
|
* @property {boolean} [is_required]
|
|
185
188
|
* @property {string} [level]
|
|
186
189
|
*/
|
|
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
190
|
/**
|
|
216
191
|
* @typedef RegisterRequiredFields
|
|
217
192
|
* @property {RegisterRequiredFieldsEmail} [email]
|
|
@@ -228,305 +203,260 @@ export = UserPlatformModel;
|
|
|
228
203
|
* @property {string} [level]
|
|
229
204
|
*/
|
|
230
205
|
/**
|
|
231
|
-
* @typedef
|
|
232
|
-
* @property {
|
|
233
|
-
* @property {
|
|
206
|
+
* @typedef FlashCard
|
|
207
|
+
* @property {string} [text]
|
|
208
|
+
* @property {string} [text_color]
|
|
209
|
+
* @property {string} [background_color]
|
|
234
210
|
*/
|
|
235
211
|
/**
|
|
236
|
-
* @typedef
|
|
237
|
-
* @property {
|
|
238
|
-
* @property {
|
|
212
|
+
* @typedef SocialTokens
|
|
213
|
+
* @property {Facebook} [facebook]
|
|
214
|
+
* @property {Accountkit} [account_kit]
|
|
215
|
+
* @property {Google} [google]
|
|
239
216
|
*/
|
|
240
217
|
/**
|
|
241
|
-
* @typedef
|
|
242
|
-
* @property {
|
|
243
|
-
* @property {
|
|
244
|
-
* @property {
|
|
218
|
+
* @typedef DeleteAccountReasons
|
|
219
|
+
* @property {string} [reason_text]
|
|
220
|
+
* @property {string} [reason_id]
|
|
221
|
+
* @property {boolean} [show_text_area]
|
|
245
222
|
*/
|
|
246
223
|
/**
|
|
247
|
-
* @typedef
|
|
248
|
-
* @property {string} [
|
|
249
|
-
* @property {string} [expire_in]
|
|
250
|
-
* @property {string} [ip]
|
|
251
|
-
* @property {string} [session_id]
|
|
252
|
-
* @property {string} [user_agent]
|
|
224
|
+
* @typedef DeleteAccountConsent
|
|
225
|
+
* @property {string} [consent_text]
|
|
253
226
|
*/
|
|
254
227
|
/**
|
|
255
|
-
* @typedef
|
|
256
|
-
* @property {
|
|
228
|
+
* @typedef Facebook
|
|
229
|
+
* @property {string} [app_id]
|
|
257
230
|
*/
|
|
258
231
|
/**
|
|
259
|
-
* @typedef
|
|
260
|
-
* @property {string
|
|
261
|
-
* @property {string} [user_id]
|
|
262
|
-
*/
|
|
263
|
-
/**
|
|
264
|
-
* @typedef Social
|
|
265
|
-
* @property {boolean} [account_kit]
|
|
266
|
-
* @property {boolean} [apple]
|
|
267
|
-
* @property {boolean} [facebook]
|
|
268
|
-
* @property {boolean} [google]
|
|
269
|
-
*/
|
|
270
|
-
/**
|
|
271
|
-
* @typedef SocialTokens
|
|
272
|
-
* @property {Accountkit} [account_kit]
|
|
273
|
-
* @property {Facebook} [facebook]
|
|
274
|
-
* @property {Google} [google]
|
|
275
|
-
*/
|
|
276
|
-
/**
|
|
277
|
-
* @typedef SuccessMessageResponse
|
|
278
|
-
* @property {string} [success]
|
|
232
|
+
* @typedef Accountkit
|
|
233
|
+
* @property {string} [app_id]
|
|
279
234
|
*/
|
|
280
235
|
/**
|
|
281
|
-
* @typedef
|
|
282
|
-
* @property {string} [
|
|
283
|
-
* @property {string} [reason_id]
|
|
284
|
-
* @property {string} [user_id]
|
|
236
|
+
* @typedef Google
|
|
237
|
+
* @property {string} [app_id]
|
|
285
238
|
*/
|
|
286
239
|
/**
|
|
287
|
-
* @typedef
|
|
288
|
-
* @property {
|
|
240
|
+
* @typedef SessionExpiry
|
|
241
|
+
* @property {number} [duration]
|
|
242
|
+
* @property {string} [type]
|
|
243
|
+
* @property {boolean} [is_rolling]
|
|
289
244
|
*/
|
|
290
245
|
/**
|
|
291
246
|
* @typedef UpdateUserGroupSchema
|
|
292
|
-
* @property {
|
|
247
|
+
* @property {string} [name]
|
|
293
248
|
* @property {string} [description]
|
|
294
249
|
* @property {string} [file_url]
|
|
250
|
+
*/
|
|
251
|
+
/**
|
|
252
|
+
* @typedef PartialUserGroupUpdateSchema
|
|
253
|
+
* @property {string} [type] - Source of update to be used to update individual
|
|
254
|
+
* users. Default value is considered file_url if not passed.
|
|
295
255
|
* @property {string} [name]
|
|
296
|
-
* @property {string} [
|
|
256
|
+
* @property {string} [description]
|
|
257
|
+
* @property {string} [file_url] - Required property when passed type file_url.
|
|
258
|
+
* Internet reachable csv file url which will be used to fetch download data.
|
|
259
|
+
* It must have one of columns from `phone_number``, `email`, `user_id` and
|
|
260
|
+
* must have `action` column. `action` column can have `add` or `remove` value.
|
|
261
|
+
* @property {UserGroupUpdateData[]} [user_data] - Required property when passed
|
|
262
|
+
* type json. Array of user data. Must have `action` field and one of
|
|
263
|
+
* `phone_number`, `email` or `user_id` field in object
|
|
264
|
+
*/
|
|
265
|
+
/**
|
|
266
|
+
* @typedef UserGroupUpdateData
|
|
267
|
+
* @property {string} [user_id] - Must be valid mongodb objectid of existing user
|
|
268
|
+
* @property {string} [phone_number] - Phone number of registered user
|
|
269
|
+
* @property {string} [email] - Email of registered user
|
|
270
|
+
* @property {string} action
|
|
297
271
|
*/
|
|
298
272
|
/**
|
|
299
273
|
* @typedef UpdateUserRequestSchema
|
|
300
|
-
* @property {UserEmails[]} [emails]
|
|
301
|
-
* @property {string} [external_id]
|
|
302
274
|
* @property {string} [first_name]
|
|
303
|
-
* @property {string} [gender]
|
|
304
275
|
* @property {string} [last_name]
|
|
276
|
+
* @property {string} [gender]
|
|
277
|
+
* @property {string} [external_id]
|
|
305
278
|
* @property {Object} [meta]
|
|
306
279
|
* @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.
|
|
280
|
+
* @property {UserEmails[]} [emails]
|
|
363
281
|
*/
|
|
364
282
|
/**
|
|
365
283
|
* @typedef UserEmails
|
|
366
284
|
* @property {boolean} [active]
|
|
367
|
-
* @property {string} [email]
|
|
368
285
|
* @property {boolean} [primary]
|
|
369
286
|
* @property {boolean} [verified]
|
|
370
|
-
|
|
371
|
-
/**
|
|
372
|
-
* @typedef UserGroupListResponseSchema
|
|
373
|
-
* @property {UserGroupResponseSchema[]} [items]
|
|
374
|
-
* @property {PaginationSchema} [page]
|
|
375
|
-
*/
|
|
376
|
-
/**
|
|
377
|
-
* @typedef UserGroupResponseSchema
|
|
378
|
-
* @property {number} [__v]
|
|
379
|
-
* @property {string} [_id]
|
|
380
|
-
* @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
|
|
287
|
+
* @property {string} [email]
|
|
399
288
|
*/
|
|
400
289
|
/**
|
|
401
290
|
* @typedef UserPhoneNumbers
|
|
402
291
|
* @property {boolean} [active]
|
|
403
|
-
* @property {string} [country_code]
|
|
404
|
-
* @property {string} [phone]
|
|
405
292
|
* @property {boolean} [primary]
|
|
406
293
|
* @property {boolean} [verified]
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
* @typedef UserResponseErrorSchema
|
|
410
|
-
* @property {number} [count]
|
|
411
|
-
* @property {string} [file_url]
|
|
294
|
+
* @property {string} [phone]
|
|
295
|
+
* @property {string} [country_code]
|
|
412
296
|
*/
|
|
413
297
|
/**
|
|
414
298
|
* @typedef UserSchema
|
|
415
|
-
* @property {string} [_id]
|
|
416
|
-
* @property {string} [account_type]
|
|
417
|
-
* @property {boolean} [active]
|
|
418
299
|
* @property {string} [application_id]
|
|
419
|
-
* @property {string} [
|
|
420
|
-
* @property {string} [dob]
|
|
421
|
-
* @property {Email[]} [emails]
|
|
422
|
-
* @property {string} [external_id]
|
|
300
|
+
* @property {string} [user_id]
|
|
423
301
|
* @property {string} [first_name]
|
|
424
|
-
* @property {string} [gender]
|
|
425
|
-
* @property {string} [last_name]
|
|
426
302
|
* @property {Object} [meta]
|
|
303
|
+
* @property {string} [last_name]
|
|
427
304
|
* @property {PhoneNumber[]} [phone_numbers]
|
|
305
|
+
* @property {Email[]} [emails]
|
|
306
|
+
* @property {string} [gender]
|
|
307
|
+
* @property {string} [dob]
|
|
308
|
+
* @property {boolean} [active]
|
|
428
309
|
* @property {string} [profile_pic_url]
|
|
429
|
-
* @property {string} [updated_at]
|
|
430
|
-
* @property {string} [user_id]
|
|
431
310
|
* @property {string} [username]
|
|
311
|
+
* @property {string} [account_type]
|
|
312
|
+
* @property {string} [_id]
|
|
313
|
+
* @property {string} [created_at]
|
|
314
|
+
* @property {string} [updated_at]
|
|
315
|
+
* @property {string} [external_id]
|
|
432
316
|
*/
|
|
433
317
|
/**
|
|
434
|
-
* @typedef
|
|
435
|
-
* @property {
|
|
318
|
+
* @typedef PhoneNumber
|
|
319
|
+
* @property {boolean} [active]
|
|
320
|
+
* @property {boolean} [primary]
|
|
321
|
+
* @property {boolean} [verified]
|
|
322
|
+
* @property {string} [phone]
|
|
323
|
+
* @property {number} [country_code]
|
|
324
|
+
*/
|
|
325
|
+
/**
|
|
326
|
+
* @typedef Email
|
|
327
|
+
* @property {boolean} [primary]
|
|
328
|
+
* @property {boolean} [verified]
|
|
329
|
+
* @property {string} [email]
|
|
330
|
+
* @property {boolean} [active]
|
|
436
331
|
*/
|
|
437
332
|
declare class UserPlatformModel {
|
|
438
333
|
}
|
|
439
334
|
declare namespace UserPlatformModel {
|
|
440
|
-
export {
|
|
335
|
+
export { BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, AuthenticationApiErrorSchema, SessionListResponseInfo, UserGroupResponseSchema, UserGroupListResponseSchema, CreateUserGroupSchema, 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
336
|
}
|
|
442
|
-
/** @returns {
|
|
443
|
-
declare function
|
|
444
|
-
type
|
|
445
|
-
|
|
337
|
+
/** @returns {BlockUserRequestSchema} */
|
|
338
|
+
declare function BlockUserRequestSchema(): BlockUserRequestSchema;
|
|
339
|
+
type BlockUserRequestSchema = {
|
|
340
|
+
status?: boolean;
|
|
341
|
+
user_id?: string[];
|
|
342
|
+
reason?: string;
|
|
446
343
|
};
|
|
447
344
|
/** @returns {ArchiveUserRequestSchema} */
|
|
448
345
|
declare function ArchiveUserRequestSchema(): ArchiveUserRequestSchema;
|
|
449
346
|
type ArchiveUserRequestSchema = {
|
|
450
347
|
user_id?: string;
|
|
451
348
|
};
|
|
349
|
+
/** @returns {UnDeleteUserRequestSchema} */
|
|
350
|
+
declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
|
|
351
|
+
type UnDeleteUserRequestSchema = {
|
|
352
|
+
user_id?: string;
|
|
353
|
+
reason?: string;
|
|
354
|
+
reason_id?: string;
|
|
355
|
+
};
|
|
356
|
+
/** @returns {BlockUserSuccess} */
|
|
357
|
+
declare function BlockUserSuccess(): BlockUserSuccess;
|
|
358
|
+
type BlockUserSuccess = {
|
|
359
|
+
success?: boolean;
|
|
360
|
+
};
|
|
452
361
|
/** @returns {ArchiveUserSuccess} */
|
|
453
362
|
declare function ArchiveUserSuccess(): ArchiveUserSuccess;
|
|
454
363
|
type ArchiveUserSuccess = {
|
|
455
364
|
success?: boolean;
|
|
456
365
|
};
|
|
457
|
-
/** @returns {
|
|
458
|
-
declare function
|
|
459
|
-
type
|
|
460
|
-
|
|
366
|
+
/** @returns {UnDeleteUserSuccess} */
|
|
367
|
+
declare function UnDeleteUserSuccess(): UnDeleteUserSuccess;
|
|
368
|
+
type UnDeleteUserSuccess = {
|
|
369
|
+
success?: boolean;
|
|
461
370
|
};
|
|
462
|
-
/** @returns {
|
|
463
|
-
declare function
|
|
464
|
-
type
|
|
465
|
-
|
|
466
|
-
status?: boolean;
|
|
467
|
-
user_id?: string[];
|
|
371
|
+
/** @returns {UserSearchResponseSchema} */
|
|
372
|
+
declare function UserSearchResponseSchema(): UserSearchResponseSchema;
|
|
373
|
+
type UserSearchResponseSchema = {
|
|
374
|
+
users?: UserSchema[];
|
|
468
375
|
};
|
|
469
|
-
/** @returns {
|
|
470
|
-
declare function
|
|
471
|
-
type
|
|
472
|
-
|
|
376
|
+
/** @returns {CustomerListResponseSchema} */
|
|
377
|
+
declare function CustomerListResponseSchema(): CustomerListResponseSchema;
|
|
378
|
+
type CustomerListResponseSchema = {
|
|
379
|
+
items?: UserSchema[];
|
|
380
|
+
page?: PaginationSchema;
|
|
473
381
|
};
|
|
474
|
-
/** @returns {
|
|
475
|
-
declare function
|
|
476
|
-
type
|
|
477
|
-
|
|
382
|
+
/** @returns {PaginationSchema} */
|
|
383
|
+
declare function PaginationSchema(): PaginationSchema;
|
|
384
|
+
type PaginationSchema = {
|
|
385
|
+
size?: number;
|
|
386
|
+
item_total?: number;
|
|
387
|
+
has_next?: boolean;
|
|
478
388
|
type?: string;
|
|
479
|
-
|
|
480
|
-
value?: string;
|
|
389
|
+
current?: number;
|
|
481
390
|
};
|
|
482
|
-
/** @returns {
|
|
483
|
-
declare function
|
|
484
|
-
type
|
|
485
|
-
|
|
486
|
-
user_attribute_definition_id?: string;
|
|
487
|
-
value?: string;
|
|
391
|
+
/** @returns {SessionListResponseSchema} */
|
|
392
|
+
declare function SessionListResponseSchema(): SessionListResponseSchema;
|
|
393
|
+
type SessionListResponseSchema = {
|
|
394
|
+
items?: SessionListResponseInfo[];
|
|
488
395
|
};
|
|
489
|
-
/** @returns {
|
|
490
|
-
declare function
|
|
491
|
-
type
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
slug?: string;
|
|
501
|
-
type?: string;
|
|
502
|
-
validations?: any[];
|
|
396
|
+
/** @returns {SessionDeleteResponseSchema} */
|
|
397
|
+
declare function SessionDeleteResponseSchema(): SessionDeleteResponseSchema;
|
|
398
|
+
type SessionDeleteResponseSchema = {
|
|
399
|
+
user_id?: string;
|
|
400
|
+
session_id?: string;
|
|
401
|
+
};
|
|
402
|
+
/** @returns {SessionsDeleteResponseSchema} */
|
|
403
|
+
declare function SessionsDeleteResponseSchema(): SessionsDeleteResponseSchema;
|
|
404
|
+
type SessionsDeleteResponseSchema = {
|
|
405
|
+
user_id?: string;
|
|
406
|
+
session_ids?: string[];
|
|
503
407
|
};
|
|
504
|
-
/** @returns {
|
|
505
|
-
declare function
|
|
506
|
-
type
|
|
507
|
-
|
|
508
|
-
customer_overriden?: boolean;
|
|
408
|
+
/** @returns {AuthenticationApiErrorSchema} */
|
|
409
|
+
declare function AuthenticationApiErrorSchema(): AuthenticationApiErrorSchema;
|
|
410
|
+
type AuthenticationApiErrorSchema = {
|
|
411
|
+
message?: string;
|
|
509
412
|
};
|
|
510
|
-
/** @returns {
|
|
511
|
-
declare function
|
|
512
|
-
type
|
|
513
|
-
|
|
514
|
-
|
|
413
|
+
/** @returns {SessionListResponseInfo} */
|
|
414
|
+
declare function SessionListResponseInfo(): SessionListResponseInfo;
|
|
415
|
+
type SessionListResponseInfo = {
|
|
416
|
+
session_id?: string;
|
|
417
|
+
user_agent?: string;
|
|
418
|
+
ip?: string;
|
|
419
|
+
domain?: string;
|
|
420
|
+
expire_in?: string;
|
|
421
|
+
};
|
|
422
|
+
/** @returns {UserGroupResponseSchema} */
|
|
423
|
+
declare function UserGroupResponseSchema(): UserGroupResponseSchema;
|
|
424
|
+
type UserGroupResponseSchema = {
|
|
425
|
+
name?: string;
|
|
426
|
+
description?: string;
|
|
515
427
|
file_url?: string;
|
|
428
|
+
_id?: string;
|
|
429
|
+
status?: string;
|
|
430
|
+
uid?: number;
|
|
431
|
+
application_id?: string;
|
|
432
|
+
created_at?: string;
|
|
433
|
+
modified_at?: string;
|
|
434
|
+
__v?: number;
|
|
435
|
+
};
|
|
436
|
+
/** @returns {UserGroupListResponseSchema} */
|
|
437
|
+
declare function UserGroupListResponseSchema(): UserGroupListResponseSchema;
|
|
438
|
+
type UserGroupListResponseSchema = {
|
|
439
|
+
items?: UserGroupResponseSchema[];
|
|
440
|
+
page?: PaginationSchema;
|
|
441
|
+
};
|
|
442
|
+
/** @returns {CreateUserGroupSchema} */
|
|
443
|
+
declare function CreateUserGroupSchema(): CreateUserGroupSchema;
|
|
444
|
+
type CreateUserGroupSchema = {
|
|
516
445
|
name: string;
|
|
517
|
-
|
|
446
|
+
description: string;
|
|
447
|
+
file_url: string;
|
|
518
448
|
};
|
|
519
449
|
/** @returns {CreateUserRequestSchema} */
|
|
520
450
|
declare function CreateUserRequestSchema(): CreateUserRequestSchema;
|
|
521
451
|
type CreateUserRequestSchema = {
|
|
452
|
+
phone_number: string;
|
|
522
453
|
email?: string;
|
|
523
|
-
external_id?: string;
|
|
524
454
|
first_name?: string;
|
|
525
|
-
gender?: string;
|
|
526
455
|
last_name?: string;
|
|
527
|
-
|
|
528
|
-
phone_number: string;
|
|
456
|
+
gender?: string;
|
|
529
457
|
username: string;
|
|
458
|
+
meta?: any;
|
|
459
|
+
external_id?: string;
|
|
530
460
|
};
|
|
531
461
|
/** @returns {CreateUserResponseSchema} */
|
|
532
462
|
declare function CreateUserResponseSchema(): CreateUserResponseSchema;
|
|
@@ -543,113 +473,71 @@ type CreateUserSessionRequestSchema = {
|
|
|
543
473
|
/** @returns {CreateUserSessionResponseSchema} */
|
|
544
474
|
declare function CreateUserSessionResponseSchema(): CreateUserSessionResponseSchema;
|
|
545
475
|
type CreateUserSessionResponseSchema = {
|
|
546
|
-
cookie?: any;
|
|
547
476
|
domain?: string;
|
|
548
|
-
http_only?: boolean;
|
|
549
477
|
max_age?: number;
|
|
550
478
|
secure?: boolean;
|
|
479
|
+
http_only?: boolean;
|
|
480
|
+
cookie?: any;
|
|
551
481
|
};
|
|
552
|
-
/** @returns {
|
|
553
|
-
declare function
|
|
554
|
-
type
|
|
555
|
-
|
|
556
|
-
|
|
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 = {
|
|
482
|
+
/** @returns {PlatformSchema} */
|
|
483
|
+
declare function PlatformSchema(): PlatformSchema;
|
|
484
|
+
type PlatformSchema = {
|
|
485
|
+
display?: string;
|
|
486
|
+
look_and_feel?: LookAndFeel;
|
|
487
|
+
updated_at?: string;
|
|
573
488
|
active?: boolean;
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
489
|
+
forgot_password?: boolean;
|
|
490
|
+
login?: Login;
|
|
491
|
+
skip_captcha?: boolean;
|
|
492
|
+
name?: string;
|
|
493
|
+
meta?: MetaSchema;
|
|
494
|
+
_id?: string;
|
|
495
|
+
social?: Social;
|
|
496
|
+
required_fields?: RequiredFields;
|
|
497
|
+
register_required_fields?: RegisterRequiredFields;
|
|
498
|
+
skip_login?: boolean;
|
|
499
|
+
flash_card?: FlashCard;
|
|
500
|
+
subtext?: string;
|
|
501
|
+
social_tokens?: SocialTokens;
|
|
502
|
+
created_at?: string;
|
|
503
|
+
register?: boolean;
|
|
504
|
+
mobile_image?: string;
|
|
505
|
+
desktop_image?: string;
|
|
506
|
+
delete_account_day?: number;
|
|
507
|
+
delete_account_reasons?: DeleteAccountReasons[];
|
|
508
|
+
delete_account_consent?: any;
|
|
509
|
+
session_config?: any;
|
|
582
510
|
};
|
|
583
|
-
/** @returns {
|
|
584
|
-
declare function
|
|
585
|
-
type
|
|
511
|
+
/** @returns {LookAndFeel} */
|
|
512
|
+
declare function LookAndFeel(): LookAndFeel;
|
|
513
|
+
type LookAndFeel = {
|
|
514
|
+
card_position?: string;
|
|
586
515
|
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
516
|
};
|
|
595
517
|
/** @returns {Login} */
|
|
596
518
|
declare function Login(): Login;
|
|
597
519
|
type Login = {
|
|
598
|
-
otp?: boolean;
|
|
599
520
|
password?: boolean;
|
|
600
|
-
|
|
601
|
-
/** @returns {LookAndFeel} */
|
|
602
|
-
declare function LookAndFeel(): LookAndFeel;
|
|
603
|
-
type LookAndFeel = {
|
|
604
|
-
background_color?: string;
|
|
605
|
-
card_position?: string;
|
|
521
|
+
otp?: boolean;
|
|
606
522
|
};
|
|
607
523
|
/** @returns {MetaSchema} */
|
|
608
524
|
declare function MetaSchema(): MetaSchema;
|
|
609
525
|
type MetaSchema = {
|
|
610
526
|
fynd_default?: boolean;
|
|
611
527
|
};
|
|
612
|
-
/** @returns {
|
|
613
|
-
declare function
|
|
614
|
-
type
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
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[];
|
|
528
|
+
/** @returns {Social} */
|
|
529
|
+
declare function Social(): Social;
|
|
530
|
+
type Social = {
|
|
531
|
+
account_kit?: boolean;
|
|
532
|
+
facebook?: boolean;
|
|
533
|
+
google?: boolean;
|
|
534
|
+
apple?: boolean;
|
|
644
535
|
};
|
|
645
|
-
/** @returns {
|
|
646
|
-
declare function
|
|
647
|
-
type
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
phone?: string;
|
|
651
|
-
primary?: boolean;
|
|
652
|
-
verified?: boolean;
|
|
536
|
+
/** @returns {RequiredFields} */
|
|
537
|
+
declare function RequiredFields(): RequiredFields;
|
|
538
|
+
type RequiredFields = {
|
|
539
|
+
email?: PlatformEmail;
|
|
540
|
+
mobile?: PlatformMobile;
|
|
653
541
|
};
|
|
654
542
|
/** @returns {PlatformEmail} */
|
|
655
543
|
declare function PlatformEmail(): PlatformEmail;
|
|
@@ -663,35 +551,6 @@ type PlatformMobile = {
|
|
|
663
551
|
is_required?: boolean;
|
|
664
552
|
level?: string;
|
|
665
553
|
};
|
|
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
554
|
/** @returns {RegisterRequiredFields} */
|
|
696
555
|
declare function RegisterRequiredFields(): RegisterRequiredFields;
|
|
697
556
|
type RegisterRequiredFields = {
|
|
@@ -710,361 +569,165 @@ type RegisterRequiredFieldsMobile = {
|
|
|
710
569
|
is_required?: boolean;
|
|
711
570
|
level?: string;
|
|
712
571
|
};
|
|
713
|
-
/** @returns {
|
|
714
|
-
declare function
|
|
715
|
-
type
|
|
716
|
-
|
|
717
|
-
|
|
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;
|
|
572
|
+
/** @returns {FlashCard} */
|
|
573
|
+
declare function FlashCard(): FlashCard;
|
|
574
|
+
type FlashCard = {
|
|
575
|
+
text?: string;
|
|
576
|
+
text_color?: string;
|
|
577
|
+
background_color?: string;
|
|
759
578
|
};
|
|
760
579
|
/** @returns {SocialTokens} */
|
|
761
580
|
declare function SocialTokens(): SocialTokens;
|
|
762
581
|
type SocialTokens = {
|
|
763
|
-
account_kit?: Accountkit;
|
|
764
582
|
facebook?: Facebook;
|
|
583
|
+
account_kit?: Accountkit;
|
|
765
584
|
google?: Google;
|
|
766
585
|
};
|
|
767
|
-
/** @returns {
|
|
768
|
-
declare function
|
|
769
|
-
type
|
|
770
|
-
|
|
771
|
-
};
|
|
772
|
-
/** @returns {UnDeleteUserRequestSchema} */
|
|
773
|
-
declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
|
|
774
|
-
type UnDeleteUserRequestSchema = {
|
|
775
|
-
reason?: string;
|
|
586
|
+
/** @returns {DeleteAccountReasons} */
|
|
587
|
+
declare function DeleteAccountReasons(): DeleteAccountReasons;
|
|
588
|
+
type DeleteAccountReasons = {
|
|
589
|
+
reason_text?: string;
|
|
776
590
|
reason_id?: string;
|
|
777
|
-
|
|
591
|
+
show_text_area?: boolean;
|
|
778
592
|
};
|
|
779
|
-
/** @returns {
|
|
780
|
-
declare function
|
|
781
|
-
type
|
|
782
|
-
|
|
593
|
+
/** @returns {DeleteAccountConsent} */
|
|
594
|
+
declare function DeleteAccountConsent(): DeleteAccountConsent;
|
|
595
|
+
type DeleteAccountConsent = {
|
|
596
|
+
consent_text?: string;
|
|
597
|
+
};
|
|
598
|
+
/** @returns {Facebook} */
|
|
599
|
+
declare function Facebook(): Facebook;
|
|
600
|
+
type Facebook = {
|
|
601
|
+
app_id?: string;
|
|
602
|
+
};
|
|
603
|
+
/** @returns {Accountkit} */
|
|
604
|
+
declare function Accountkit(): Accountkit;
|
|
605
|
+
type Accountkit = {
|
|
606
|
+
app_id?: string;
|
|
607
|
+
};
|
|
608
|
+
/** @returns {Google} */
|
|
609
|
+
declare function Google(): Google;
|
|
610
|
+
type Google = {
|
|
611
|
+
app_id?: string;
|
|
612
|
+
};
|
|
613
|
+
/** @returns {SessionExpiry} */
|
|
614
|
+
declare function SessionExpiry(): SessionExpiry;
|
|
615
|
+
type SessionExpiry = {
|
|
616
|
+
duration?: number;
|
|
617
|
+
type?: string;
|
|
618
|
+
is_rolling?: boolean;
|
|
783
619
|
};
|
|
784
620
|
/** @returns {UpdateUserGroupSchema} */
|
|
785
621
|
declare function UpdateUserGroupSchema(): UpdateUserGroupSchema;
|
|
786
622
|
type UpdateUserGroupSchema = {
|
|
787
|
-
|
|
623
|
+
name?: string;
|
|
788
624
|
description?: string;
|
|
789
625
|
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[];
|
|
803
626
|
};
|
|
804
|
-
/** @returns {
|
|
805
|
-
declare function
|
|
806
|
-
type
|
|
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;
|
|
627
|
+
/** @returns {PartialUserGroupUpdateSchema} */
|
|
628
|
+
declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
|
|
629
|
+
type PartialUserGroupUpdateSchema = {
|
|
863
630
|
/**
|
|
864
|
-
* -
|
|
631
|
+
* - Source of update to be used to update individual
|
|
632
|
+
* users. Default value is considered file_url if not passed.
|
|
865
633
|
*/
|
|
866
634
|
type?: string;
|
|
867
|
-
validations?: any[];
|
|
868
|
-
};
|
|
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
635
|
name?: string;
|
|
636
|
+
description?: string;
|
|
917
637
|
/**
|
|
918
|
-
* -
|
|
919
|
-
|
|
920
|
-
|
|
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
|
-
*/
|
|
932
|
-
type?: string;
|
|
933
|
-
/**
|
|
934
|
-
* - The user who last updated the attribute.
|
|
935
|
-
*/
|
|
936
|
-
updated_by?: string;
|
|
937
|
-
validations?: UserAttributeDefinitionValidation[];
|
|
938
|
-
};
|
|
939
|
-
/** @returns {UserAttributeDefinitionValidation} */
|
|
940
|
-
declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
|
|
941
|
-
type UserAttributeDefinitionValidation = {
|
|
942
|
-
/**
|
|
943
|
-
* - The type of validation.
|
|
638
|
+
* - Required property when passed type file_url.
|
|
639
|
+
* Internet reachable csv file url which will be used to fetch download data.
|
|
640
|
+
* It must have one of columns from `phone_number``, `email`, `user_id` and
|
|
641
|
+
* must have `action` column. `action` column can have `add` or `remove` value.
|
|
944
642
|
*/
|
|
945
|
-
|
|
643
|
+
file_url?: string;
|
|
946
644
|
/**
|
|
947
|
-
* -
|
|
645
|
+
* - Required property when passed
|
|
646
|
+
* type json. Array of user data. Must have `action` field and one of
|
|
647
|
+
* `phone_number`, `email` or `user_id` field in object
|
|
948
648
|
*/
|
|
949
|
-
|
|
649
|
+
user_data?: UserGroupUpdateData[];
|
|
950
650
|
};
|
|
951
|
-
/** @returns {
|
|
952
|
-
declare function
|
|
953
|
-
type
|
|
954
|
-
/**
|
|
955
|
-
* - The unique identifier for the attribute definition.
|
|
956
|
-
*/
|
|
957
|
-
_id?: string;
|
|
958
|
-
/**
|
|
959
|
-
* - The application ID.
|
|
960
|
-
*/
|
|
961
|
-
application_id?: string;
|
|
962
|
-
attribute?: any;
|
|
963
|
-
/**
|
|
964
|
-
* - Whether the attribute is customer-editable.
|
|
965
|
-
*/
|
|
966
|
-
customer_overriden?: boolean;
|
|
651
|
+
/** @returns {UserGroupUpdateData} */
|
|
652
|
+
declare function UserGroupUpdateData(): UserGroupUpdateData;
|
|
653
|
+
type UserGroupUpdateData = {
|
|
967
654
|
/**
|
|
968
|
-
* -
|
|
655
|
+
* - Must be valid mongodb objectid of existing user
|
|
969
656
|
*/
|
|
970
|
-
|
|
657
|
+
user_id?: string;
|
|
971
658
|
/**
|
|
972
|
-
* -
|
|
659
|
+
* - Phone number of registered user
|
|
973
660
|
*/
|
|
974
|
-
|
|
975
|
-
updated_by?: string;
|
|
661
|
+
phone_number?: string;
|
|
976
662
|
/**
|
|
977
|
-
* -
|
|
663
|
+
* - Email of registered user
|
|
978
664
|
*/
|
|
979
|
-
|
|
665
|
+
email?: string;
|
|
666
|
+
action: string;
|
|
667
|
+
};
|
|
668
|
+
/** @returns {UpdateUserRequestSchema} */
|
|
669
|
+
declare function UpdateUserRequestSchema(): UpdateUserRequestSchema;
|
|
670
|
+
type UpdateUserRequestSchema = {
|
|
671
|
+
first_name?: string;
|
|
672
|
+
last_name?: string;
|
|
673
|
+
gender?: string;
|
|
674
|
+
external_id?: string;
|
|
675
|
+
meta?: any;
|
|
676
|
+
phone_numbers?: UserPhoneNumbers[];
|
|
677
|
+
emails?: UserEmails[];
|
|
980
678
|
};
|
|
981
679
|
/** @returns {UserEmails} */
|
|
982
680
|
declare function UserEmails(): UserEmails;
|
|
983
681
|
type UserEmails = {
|
|
984
682
|
active?: boolean;
|
|
985
|
-
email?: string;
|
|
986
683
|
primary?: boolean;
|
|
987
684
|
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
685
|
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
686
|
};
|
|
1030
687
|
/** @returns {UserPhoneNumbers} */
|
|
1031
688
|
declare function UserPhoneNumbers(): UserPhoneNumbers;
|
|
1032
689
|
type UserPhoneNumbers = {
|
|
1033
690
|
active?: boolean;
|
|
1034
|
-
country_code?: string;
|
|
1035
|
-
phone?: string;
|
|
1036
691
|
primary?: boolean;
|
|
1037
692
|
verified?: boolean;
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
declare function UserResponseErrorSchema(): UserResponseErrorSchema;
|
|
1041
|
-
type UserResponseErrorSchema = {
|
|
1042
|
-
count?: number;
|
|
1043
|
-
file_url?: string;
|
|
693
|
+
phone?: string;
|
|
694
|
+
country_code?: string;
|
|
1044
695
|
};
|
|
1045
696
|
/** @returns {UserSchema} */
|
|
1046
697
|
declare function UserSchema(): UserSchema;
|
|
1047
698
|
type UserSchema = {
|
|
1048
|
-
_id?: string;
|
|
1049
|
-
account_type?: string;
|
|
1050
|
-
active?: boolean;
|
|
1051
699
|
application_id?: string;
|
|
1052
|
-
|
|
1053
|
-
dob?: string;
|
|
1054
|
-
emails?: Email[];
|
|
1055
|
-
external_id?: string;
|
|
700
|
+
user_id?: string;
|
|
1056
701
|
first_name?: string;
|
|
1057
|
-
gender?: string;
|
|
1058
|
-
last_name?: string;
|
|
1059
702
|
meta?: any;
|
|
703
|
+
last_name?: string;
|
|
1060
704
|
phone_numbers?: PhoneNumber[];
|
|
705
|
+
emails?: Email[];
|
|
706
|
+
gender?: string;
|
|
707
|
+
dob?: string;
|
|
708
|
+
active?: boolean;
|
|
1061
709
|
profile_pic_url?: string;
|
|
1062
|
-
updated_at?: string;
|
|
1063
|
-
user_id?: string;
|
|
1064
710
|
username?: string;
|
|
711
|
+
account_type?: string;
|
|
712
|
+
_id?: string;
|
|
713
|
+
created_at?: string;
|
|
714
|
+
updated_at?: string;
|
|
715
|
+
external_id?: string;
|
|
1065
716
|
};
|
|
1066
|
-
/** @returns {
|
|
1067
|
-
declare function
|
|
1068
|
-
type
|
|
1069
|
-
|
|
717
|
+
/** @returns {PhoneNumber} */
|
|
718
|
+
declare function PhoneNumber(): PhoneNumber;
|
|
719
|
+
type PhoneNumber = {
|
|
720
|
+
active?: boolean;
|
|
721
|
+
primary?: boolean;
|
|
722
|
+
verified?: boolean;
|
|
723
|
+
phone?: string;
|
|
724
|
+
country_code?: number;
|
|
725
|
+
};
|
|
726
|
+
/** @returns {Email} */
|
|
727
|
+
declare function Email(): Email;
|
|
728
|
+
type Email = {
|
|
729
|
+
primary?: boolean;
|
|
730
|
+
verified?: boolean;
|
|
731
|
+
email?: string;
|
|
732
|
+
active?: boolean;
|
|
1070
733
|
};
|