@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = UserPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef SuccessMessageResponse
|
|
4
4
|
* @property {string} [success]
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
@@ -23,7 +23,7 @@ export = UserPlatformModel;
|
|
|
23
23
|
* @property {number} [__v] - The version number of the attribute.
|
|
24
24
|
*/
|
|
25
25
|
/**
|
|
26
|
-
* @typedef
|
|
26
|
+
* @typedef UserAttributeDefinitionResponse
|
|
27
27
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
28
28
|
* @property {string} [name] - The attribute name.
|
|
29
29
|
* @property {string} [slug] - The attribute key.
|
|
@@ -49,108 +49,57 @@ export = UserPlatformModel;
|
|
|
49
49
|
* @property {Object} [value] - The validation value.
|
|
50
50
|
*/
|
|
51
51
|
/**
|
|
52
|
-
* @typedef
|
|
52
|
+
* @typedef UserAttributeResponse
|
|
53
53
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
54
54
|
* @property {string} [name] - The name of user attribute definition.
|
|
55
55
|
* @property {string} [user_id] - The unique identifier for the user.
|
|
56
56
|
* @property {string} [application_id] - The application ID.
|
|
57
57
|
* @property {string} [type] - The attribute type.
|
|
58
|
-
* @property {boolean} [
|
|
58
|
+
* @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
|
|
59
59
|
* @property {Object} [attribute]
|
|
60
60
|
* @property {string} [updated_by]
|
|
61
61
|
*/
|
|
62
62
|
/**
|
|
63
|
-
* @typedef
|
|
64
|
-
* @property {boolean} [
|
|
63
|
+
* @typedef CreateUserAttributeRequest
|
|
64
|
+
* @property {boolean} [customer_overriden]
|
|
65
65
|
* @property {Object} [attribute]
|
|
66
66
|
*/
|
|
67
67
|
/**
|
|
68
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
|
-
*
|
|
75
|
-
* @property {boolean} [
|
|
76
|
-
*
|
|
77
|
-
* @property {
|
|
78
|
-
*
|
|
79
|
-
* @property {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
* @
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
* @property {
|
|
86
|
-
*
|
|
87
|
-
* @property {string} relative_url - A valid relative path to the file within
|
|
88
|
-
* the storage system. This path should not include the base URL or domain and
|
|
89
|
-
* must conform to the storage structure
|
|
90
|
-
*/
|
|
91
|
-
/**
|
|
92
|
-
* @typedef BulkUserExportSchema
|
|
93
|
-
* @property {string} file_format - The format of the file in which you want to
|
|
94
|
-
* export data. Supported formats are CSV and XLSX.
|
|
95
|
-
*/
|
|
96
|
-
/**
|
|
97
|
-
* @typedef BulkActionModel
|
|
98
|
-
* @property {string} _id - The Job ID associated with an Import or Export Job
|
|
99
|
-
* @property {string} file_name - The name of the file
|
|
100
|
-
* @property {string} file_format - The format of the uploaded file (e.g., CSV, XLSX).
|
|
101
|
-
* @property {string} action_type - The type of bulk action being performed
|
|
102
|
-
* (e.g., import, export).
|
|
103
|
-
* @property {CreatedBySchema} created_by
|
|
104
|
-
* @property {BulkActionCountSchema} [count]
|
|
105
|
-
* @property {string} [status] - The current status of the bulk action.
|
|
106
|
-
* @property {BulkActionLinkSchema} [links]
|
|
107
|
-
* @property {string} application_id - The unique identifier of the associated
|
|
108
|
-
* application.
|
|
109
|
-
* @property {string} company_id - The unique identifier of the company
|
|
110
|
-
* associated with the bulk action.
|
|
111
|
-
* @property {string} [created_at] - The timestamp when the bulk action was created.
|
|
112
|
-
* @property {string} [updated_at] - The timestamp when the bulk action was last updated.
|
|
113
|
-
*/
|
|
114
|
-
/**
|
|
115
|
-
* @typedef CreatedBySchema
|
|
116
|
-
* @property {string} name - The name of the user who initiated the operation.
|
|
117
|
-
* @property {string} user_id - A unique identifier for the user who initiated
|
|
118
|
-
* the operation.
|
|
119
|
-
*/
|
|
120
|
-
/**
|
|
121
|
-
* @typedef BulkActionLinkSchema
|
|
122
|
-
* @property {FileLinks} [file]
|
|
123
|
-
* @property {FileLinks} [error]
|
|
124
|
-
*/
|
|
125
|
-
/**
|
|
126
|
-
* @typedef FileLinks
|
|
127
|
-
* @property {string} [absolute_url] - The full URL of the file, including the
|
|
128
|
-
* domain and protocol, allowing direct access to the file from any location.
|
|
129
|
-
* @property {string} [relative_url] - The relative path to the file within the
|
|
130
|
-
* storage system, excluding the base URL or domain. This path is specific to
|
|
131
|
-
* the storage structure.
|
|
132
|
-
*/
|
|
133
|
-
/**
|
|
134
|
-
* @typedef BulkActionCountSchema
|
|
135
|
-
* @property {number} [total] - The total number of items to be processed.
|
|
136
|
-
* @property {number} [success] - The number of successfully processed items.
|
|
137
|
-
* @property {number} [error] - The number of items that failed to process.
|
|
69
|
+
* @property {string} [name] - The name of user attribute definition.
|
|
70
|
+
* @property {string} [slug] - The unique identifier of user attribute definition.
|
|
71
|
+
* @property {string} [description] - The description for the user attribute definition.
|
|
72
|
+
* @property {string} [type] - The attribute type for the user attribute definition.
|
|
73
|
+
* @property {boolean} [multi_value] - Identifier to specify if attribute will
|
|
74
|
+
* have multiple values or not.
|
|
75
|
+
* @property {boolean} [customer_editable] - Identifier to specify if attribute
|
|
76
|
+
* can be edited by the customer.
|
|
77
|
+
* @property {boolean} [encrypted] - Identifier to specify if attribute will be
|
|
78
|
+
* stored in encrypted format.
|
|
79
|
+
* @property {boolean} [pinned] - Identifier to specify if the definition is
|
|
80
|
+
* pinned or not.
|
|
81
|
+
* @property {number} [pin_order] - Pin order of the Attribute Definition.
|
|
82
|
+
* @property {Object} [default_value] - The default value for the User Attribute
|
|
83
|
+
* Definition. Data type of the default value depends on the type of the
|
|
84
|
+
* attribute definition type defined.
|
|
85
|
+
* @property {Object[]} [validations] - The custom validations that have been
|
|
86
|
+
* set for this customer definition.
|
|
138
87
|
*/
|
|
139
88
|
/**
|
|
140
89
|
* @typedef BlockUserRequestSchema
|
|
141
|
-
* @property {boolean}
|
|
142
|
-
* @property {string[]}
|
|
143
|
-
* @property {string}
|
|
90
|
+
* @property {boolean} status
|
|
91
|
+
* @property {string[]} user_id
|
|
92
|
+
* @property {string} reason
|
|
144
93
|
*/
|
|
145
94
|
/**
|
|
146
95
|
* @typedef ArchiveUserRequestSchema
|
|
147
|
-
* @property {string}
|
|
96
|
+
* @property {string} user_id
|
|
148
97
|
*/
|
|
149
98
|
/**
|
|
150
99
|
* @typedef UnDeleteUserRequestSchema
|
|
151
|
-
* @property {string}
|
|
152
|
-
* @property {string}
|
|
153
|
-
* @property {string}
|
|
100
|
+
* @property {string} user_id
|
|
101
|
+
* @property {string} reason
|
|
102
|
+
* @property {string} reason_id
|
|
154
103
|
*/
|
|
155
104
|
/**
|
|
156
105
|
* @typedef BlockUserSuccess
|
|
@@ -173,18 +122,13 @@ export = UserPlatformModel;
|
|
|
173
122
|
* @property {UserSearchSchema[]} [items]
|
|
174
123
|
* @property {PaginationSchema} [page]
|
|
175
124
|
*/
|
|
176
|
-
/**
|
|
177
|
-
* @typedef BulkActionPaginationSchema
|
|
178
|
-
* @property {BulkActionModel[]} [items] - Array of Bulk Action Documents
|
|
179
|
-
* @property {PaginationSchema} [page]
|
|
180
|
-
*/
|
|
181
125
|
/**
|
|
182
126
|
* @typedef PaginationSchema
|
|
183
|
-
* @property {number} [size]
|
|
184
|
-
* @property {number} [item_total]
|
|
185
|
-
* @property {boolean} [has_next]
|
|
186
|
-
* @property {string} [type]
|
|
187
|
-
* @property {number} [current]
|
|
127
|
+
* @property {number} [size]
|
|
128
|
+
* @property {number} [item_total]
|
|
129
|
+
* @property {boolean} [has_next]
|
|
130
|
+
* @property {string} [type]
|
|
131
|
+
* @property {number} [current]
|
|
188
132
|
*/
|
|
189
133
|
/**
|
|
190
134
|
* @typedef SessionListResponseSchema
|
|
@@ -223,7 +167,7 @@ export = UserPlatformModel;
|
|
|
223
167
|
* @typedef Conditions
|
|
224
168
|
* @property {string} [user_attribute_definition_id]
|
|
225
169
|
* @property {string} [type]
|
|
226
|
-
* @property {
|
|
170
|
+
* @property {Object} [value]
|
|
227
171
|
* @property {string} [key]
|
|
228
172
|
*/
|
|
229
173
|
/**
|
|
@@ -234,6 +178,7 @@ export = UserPlatformModel;
|
|
|
234
178
|
/**
|
|
235
179
|
* @typedef UserGroupResponseSchema
|
|
236
180
|
* @property {Conditions[]} [conditions]
|
|
181
|
+
* @property {string[]} [blacklisted_users]
|
|
237
182
|
* @property {UserResponseErrorSchema} [error]
|
|
238
183
|
* @property {string} [name]
|
|
239
184
|
* @property {string} [description]
|
|
@@ -257,7 +202,7 @@ export = UserPlatformModel;
|
|
|
257
202
|
* @typedef ConditionsSchema
|
|
258
203
|
* @property {string} [user_attribute_definition_id]
|
|
259
204
|
* @property {string} [type]
|
|
260
|
-
* @property {
|
|
205
|
+
* @property {Object} [value]
|
|
261
206
|
*/
|
|
262
207
|
/**
|
|
263
208
|
* @typedef CreateUserGroup
|
|
@@ -266,6 +211,7 @@ export = UserPlatformModel;
|
|
|
266
211
|
* @property {string} name
|
|
267
212
|
* @property {string} description
|
|
268
213
|
* @property {string} [file_url]
|
|
214
|
+
* @property {string[]} [blacklisted_users]
|
|
269
215
|
*/
|
|
270
216
|
/**
|
|
271
217
|
* @typedef CreateUserRequestSchema
|
|
@@ -274,7 +220,7 @@ export = UserPlatformModel;
|
|
|
274
220
|
* @property {string} [first_name]
|
|
275
221
|
* @property {string} [last_name]
|
|
276
222
|
* @property {string} [gender]
|
|
277
|
-
* @property {string}
|
|
223
|
+
* @property {string} username
|
|
278
224
|
* @property {Object} [meta]
|
|
279
225
|
* @property {string} [external_id]
|
|
280
226
|
* @property {string} [rr_id]
|
|
@@ -285,8 +231,9 @@ export = UserPlatformModel;
|
|
|
285
231
|
*/
|
|
286
232
|
/**
|
|
287
233
|
* @typedef CreateUserSessionRequestSchema
|
|
288
|
-
* @property {string}
|
|
289
|
-
* @property {string}
|
|
234
|
+
* @property {string} domain
|
|
235
|
+
* @property {string} user_id
|
|
236
|
+
* @property {number} [max_age]
|
|
290
237
|
*/
|
|
291
238
|
/**
|
|
292
239
|
* @typedef CreateUserSessionResponseSchema
|
|
@@ -304,6 +251,8 @@ export = UserPlatformModel;
|
|
|
304
251
|
* @property {boolean} [active]
|
|
305
252
|
* @property {boolean} [forgot_password]
|
|
306
253
|
* @property {Login} [login]
|
|
254
|
+
* @property {AccountLockout} [account_lockout]
|
|
255
|
+
* @property {PasswordSettings} [password_settings]
|
|
307
256
|
* @property {boolean} [skip_captcha]
|
|
308
257
|
* @property {string} [name]
|
|
309
258
|
* @property {MetaSchema} [meta]
|
|
@@ -330,10 +279,40 @@ export = UserPlatformModel;
|
|
|
330
279
|
* @property {string} [card_position]
|
|
331
280
|
* @property {string} [background_color]
|
|
332
281
|
*/
|
|
282
|
+
/**
|
|
283
|
+
* @typedef PasswordConfigs
|
|
284
|
+
* @property {number} [length]
|
|
285
|
+
* @property {boolean} [require_special_character]
|
|
286
|
+
* @property {boolean} [require_number]
|
|
287
|
+
* @property {boolean} [require_capital_character]
|
|
288
|
+
*/
|
|
289
|
+
/**
|
|
290
|
+
* @typedef PasswordHistory
|
|
291
|
+
* @property {boolean} [required]
|
|
292
|
+
* @property {number} [count]
|
|
293
|
+
*/
|
|
294
|
+
/**
|
|
295
|
+
* @typedef PasswordExpiry
|
|
296
|
+
* @property {boolean} [required]
|
|
297
|
+
* @property {number} [duration]
|
|
298
|
+
*/
|
|
299
|
+
/**
|
|
300
|
+
* @typedef PasswordSettings
|
|
301
|
+
* @property {PasswordConfigs} [configs]
|
|
302
|
+
* @property {PasswordHistory} [history]
|
|
303
|
+
* @property {PasswordExpiry} [expiry]
|
|
304
|
+
*/
|
|
305
|
+
/**
|
|
306
|
+
* @typedef AccountLockout
|
|
307
|
+
* @property {boolean} [enable]
|
|
308
|
+
* @property {number} [attempts]
|
|
309
|
+
* @property {number} [duration]
|
|
310
|
+
*/
|
|
333
311
|
/**
|
|
334
312
|
* @typedef Login
|
|
335
313
|
* @property {boolean} [password]
|
|
336
314
|
* @property {boolean} [otp]
|
|
315
|
+
* @property {string} [via]
|
|
337
316
|
*/
|
|
338
317
|
/**
|
|
339
318
|
* @typedef MetaSchema
|
|
@@ -346,10 +325,15 @@ export = UserPlatformModel;
|
|
|
346
325
|
* @property {boolean} [google]
|
|
347
326
|
* @property {boolean} [apple]
|
|
348
327
|
*/
|
|
328
|
+
/**
|
|
329
|
+
* @typedef PlatformPassword
|
|
330
|
+
* @property {boolean} [is_required]
|
|
331
|
+
*/
|
|
349
332
|
/**
|
|
350
333
|
* @typedef RequiredFields
|
|
351
334
|
* @property {PlatformEmail} [email]
|
|
352
335
|
* @property {PlatformMobile} [mobile]
|
|
336
|
+
* @property {PlatformPassword} [password]
|
|
353
337
|
*/
|
|
354
338
|
/**
|
|
355
339
|
* @typedef PlatformEmail
|
|
@@ -365,6 +349,7 @@ export = UserPlatformModel;
|
|
|
365
349
|
* @typedef RegisterRequiredFields
|
|
366
350
|
* @property {RegisterRequiredFieldsEmail} [email]
|
|
367
351
|
* @property {RegisterRequiredFieldsMobile} [mobile]
|
|
352
|
+
* @property {PlatformPassword} [password]
|
|
368
353
|
*/
|
|
369
354
|
/**
|
|
370
355
|
* @typedef RegisterRequiredFieldsEmail
|
|
@@ -385,7 +370,7 @@ export = UserPlatformModel;
|
|
|
385
370
|
/**
|
|
386
371
|
* @typedef SocialTokens
|
|
387
372
|
* @property {Facebook} [facebook]
|
|
388
|
-
* @property {Accountkit} [
|
|
373
|
+
* @property {Accountkit} [accountkit]
|
|
389
374
|
* @property {Google} [google]
|
|
390
375
|
*/
|
|
391
376
|
/**
|
|
@@ -440,6 +425,10 @@ export = UserPlatformModel;
|
|
|
440
425
|
* @property {UserGroupUpdateData[]} [user_data] - Required property when passed
|
|
441
426
|
* type json. Array of user data. Must have `action` field and one of
|
|
442
427
|
* `phone_number`, `email` or `user_id` field in object
|
|
428
|
+
* @property {string[]} [whitelisted_users] - List of user ids to be whitelisted
|
|
429
|
+
* from user group
|
|
430
|
+
* @property {string[]} [blacklisted_users] - List of user ids to be blacklisted
|
|
431
|
+
* from user group
|
|
443
432
|
*/
|
|
444
433
|
/**
|
|
445
434
|
* @typedef UserGroupUpdateData
|
|
@@ -474,10 +463,17 @@ export = UserPlatformModel;
|
|
|
474
463
|
* @property {string} [phone]
|
|
475
464
|
* @property {string} [country_code]
|
|
476
465
|
*/
|
|
466
|
+
/**
|
|
467
|
+
* @typedef UserPasswordHistory
|
|
468
|
+
* @property {string} [salt]
|
|
469
|
+
* @property {string} [hash]
|
|
470
|
+
*/
|
|
477
471
|
/**
|
|
478
472
|
* @typedef UserSchema
|
|
479
473
|
* @property {string} [application_id]
|
|
480
474
|
* @property {string} [user_id]
|
|
475
|
+
* @property {string} [password_last_modified]
|
|
476
|
+
* @property {UserPasswordHistory[]} [password_history]
|
|
481
477
|
* @property {string} [first_name]
|
|
482
478
|
* @property {Object} [meta]
|
|
483
479
|
* @property {string} [last_name]
|
|
@@ -536,11 +532,11 @@ export = UserPlatformModel;
|
|
|
536
532
|
declare class UserPlatformModel {
|
|
537
533
|
}
|
|
538
534
|
declare namespace UserPlatformModel {
|
|
539
|
-
export {
|
|
535
|
+
export { SuccessMessageResponse, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, CreateUserAttributeRequest, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, PasswordConfigs, PasswordHistory, PasswordExpiry, PasswordSettings, AccountLockout, Login, MetaSchema, Social, PlatformPassword, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserPasswordHistory, UserSchema, UserSearchSchema, PhoneNumber, Email };
|
|
540
536
|
}
|
|
541
|
-
/** @returns {
|
|
542
|
-
declare function
|
|
543
|
-
type
|
|
537
|
+
/** @returns {SuccessMessageResponse} */
|
|
538
|
+
declare function SuccessMessageResponse(): SuccessMessageResponse;
|
|
539
|
+
type SuccessMessageResponse = {
|
|
544
540
|
success?: string;
|
|
545
541
|
};
|
|
546
542
|
/** @returns {UserAttributeDefinition} */
|
|
@@ -608,9 +604,9 @@ type UserAttributeDefinition = {
|
|
|
608
604
|
*/
|
|
609
605
|
__v?: number;
|
|
610
606
|
};
|
|
611
|
-
/** @returns {
|
|
612
|
-
declare function
|
|
613
|
-
type
|
|
607
|
+
/** @returns {UserAttributeDefinitionResponse} */
|
|
608
|
+
declare function UserAttributeDefinitionResponse(): UserAttributeDefinitionResponse;
|
|
609
|
+
type UserAttributeDefinitionResponse = {
|
|
614
610
|
/**
|
|
615
611
|
* - The unique identifier for the attribute definition.
|
|
616
612
|
*/
|
|
@@ -690,9 +686,9 @@ type UserAttributeDefinitionValidation = {
|
|
|
690
686
|
*/
|
|
691
687
|
value?: any;
|
|
692
688
|
};
|
|
693
|
-
/** @returns {
|
|
694
|
-
declare function
|
|
695
|
-
type
|
|
689
|
+
/** @returns {UserAttributeResponse} */
|
|
690
|
+
declare function UserAttributeResponse(): UserAttributeResponse;
|
|
691
|
+
type UserAttributeResponse = {
|
|
696
692
|
/**
|
|
697
693
|
* - The unique identifier for the attribute definition.
|
|
698
694
|
*/
|
|
@@ -716,174 +712,89 @@ type UserAttribute = {
|
|
|
716
712
|
/**
|
|
717
713
|
* - Whether the attribute is customer-editable.
|
|
718
714
|
*/
|
|
719
|
-
|
|
715
|
+
customer_overriden?: boolean;
|
|
720
716
|
attribute?: any;
|
|
721
717
|
updated_by?: string;
|
|
722
718
|
};
|
|
723
|
-
/** @returns {
|
|
724
|
-
declare function
|
|
725
|
-
type
|
|
726
|
-
|
|
719
|
+
/** @returns {CreateUserAttributeRequest} */
|
|
720
|
+
declare function CreateUserAttributeRequest(): CreateUserAttributeRequest;
|
|
721
|
+
type CreateUserAttributeRequest = {
|
|
722
|
+
customer_overriden?: boolean;
|
|
727
723
|
attribute?: any;
|
|
728
724
|
};
|
|
729
725
|
/** @returns {CreateUserAttributeDefinition} */
|
|
730
726
|
declare function CreateUserAttributeDefinition(): CreateUserAttributeDefinition;
|
|
731
727
|
type CreateUserAttributeDefinition = {
|
|
732
|
-
name?: string;
|
|
733
|
-
slug?: string;
|
|
734
|
-
description?: string;
|
|
735
|
-
type?: string;
|
|
736
|
-
multi_value?: boolean;
|
|
737
|
-
customer_editable?: boolean;
|
|
738
|
-
encrypted?: boolean;
|
|
739
|
-
pinned?: boolean;
|
|
740
|
-
pin_order?: number;
|
|
741
|
-
default_value?: string;
|
|
742
|
-
validations?: any[];
|
|
743
|
-
};
|
|
744
|
-
/** @returns {CreateStoreFrontUsersPayload} */
|
|
745
|
-
declare function CreateStoreFrontUsersPayload(): CreateStoreFrontUsersPayload;
|
|
746
|
-
type CreateStoreFrontUsersPayload = {
|
|
747
|
-
/**
|
|
748
|
-
* - A valid URL linking to the file containing
|
|
749
|
-
* user data to be imported.
|
|
750
|
-
*/
|
|
751
|
-
absolute_url: string;
|
|
752
|
-
/**
|
|
753
|
-
* - The format of the file containing the user's
|
|
754
|
-
* data. Supported formats are CSV and XLSX.
|
|
755
|
-
*/
|
|
756
|
-
file_format: string;
|
|
757
|
-
/**
|
|
758
|
-
* - A valid relative path to the file within
|
|
759
|
-
* the storage system. This path should not include the base URL or domain and
|
|
760
|
-
* must conform to the storage structure
|
|
761
|
-
*/
|
|
762
|
-
relative_url: string;
|
|
763
|
-
};
|
|
764
|
-
/** @returns {BulkUserExportSchema} */
|
|
765
|
-
declare function BulkUserExportSchema(): BulkUserExportSchema;
|
|
766
|
-
type BulkUserExportSchema = {
|
|
767
|
-
/**
|
|
768
|
-
* - The format of the file in which you want to
|
|
769
|
-
* export data. Supported formats are CSV and XLSX.
|
|
770
|
-
*/
|
|
771
|
-
file_format: string;
|
|
772
|
-
};
|
|
773
|
-
/** @returns {BulkActionModel} */
|
|
774
|
-
declare function BulkActionModel(): BulkActionModel;
|
|
775
|
-
type BulkActionModel = {
|
|
776
728
|
/**
|
|
777
|
-
* - The
|
|
778
|
-
*/
|
|
779
|
-
_id: string;
|
|
780
|
-
/**
|
|
781
|
-
* - The name of the file
|
|
782
|
-
*/
|
|
783
|
-
file_name: string;
|
|
784
|
-
/**
|
|
785
|
-
* - The format of the uploaded file (e.g., CSV, XLSX).
|
|
786
|
-
*/
|
|
787
|
-
file_format: string;
|
|
788
|
-
/**
|
|
789
|
-
* - The type of bulk action being performed
|
|
790
|
-
* (e.g., import, export).
|
|
791
|
-
*/
|
|
792
|
-
action_type: string;
|
|
793
|
-
created_by: CreatedBySchema;
|
|
794
|
-
count?: BulkActionCountSchema;
|
|
795
|
-
/**
|
|
796
|
-
* - The current status of the bulk action.
|
|
797
|
-
*/
|
|
798
|
-
status?: string;
|
|
799
|
-
links?: BulkActionLinkSchema;
|
|
800
|
-
/**
|
|
801
|
-
* - The unique identifier of the associated
|
|
802
|
-
* application.
|
|
729
|
+
* - The name of user attribute definition.
|
|
803
730
|
*/
|
|
804
|
-
|
|
731
|
+
name?: string;
|
|
805
732
|
/**
|
|
806
|
-
* - The unique identifier of
|
|
807
|
-
* associated with the bulk action.
|
|
733
|
+
* - The unique identifier of user attribute definition.
|
|
808
734
|
*/
|
|
809
|
-
|
|
735
|
+
slug?: string;
|
|
810
736
|
/**
|
|
811
|
-
* - The
|
|
737
|
+
* - The description for the user attribute definition.
|
|
812
738
|
*/
|
|
813
|
-
|
|
739
|
+
description?: string;
|
|
814
740
|
/**
|
|
815
|
-
* - The
|
|
741
|
+
* - The attribute type for the user attribute definition.
|
|
816
742
|
*/
|
|
817
|
-
|
|
818
|
-
};
|
|
819
|
-
/** @returns {CreatedBySchema} */
|
|
820
|
-
declare function CreatedBySchema(): CreatedBySchema;
|
|
821
|
-
type CreatedBySchema = {
|
|
743
|
+
type?: string;
|
|
822
744
|
/**
|
|
823
|
-
* -
|
|
745
|
+
* - Identifier to specify if attribute will
|
|
746
|
+
* have multiple values or not.
|
|
824
747
|
*/
|
|
825
|
-
|
|
748
|
+
multi_value?: boolean;
|
|
826
749
|
/**
|
|
827
|
-
* -
|
|
828
|
-
* the
|
|
750
|
+
* - Identifier to specify if attribute
|
|
751
|
+
* can be edited by the customer.
|
|
829
752
|
*/
|
|
830
|
-
|
|
831
|
-
};
|
|
832
|
-
/** @returns {BulkActionLinkSchema} */
|
|
833
|
-
declare function BulkActionLinkSchema(): BulkActionLinkSchema;
|
|
834
|
-
type BulkActionLinkSchema = {
|
|
835
|
-
file?: FileLinks;
|
|
836
|
-
error?: FileLinks;
|
|
837
|
-
};
|
|
838
|
-
/** @returns {FileLinks} */
|
|
839
|
-
declare function FileLinks(): FileLinks;
|
|
840
|
-
type FileLinks = {
|
|
753
|
+
customer_editable?: boolean;
|
|
841
754
|
/**
|
|
842
|
-
* -
|
|
843
|
-
*
|
|
755
|
+
* - Identifier to specify if attribute will be
|
|
756
|
+
* stored in encrypted format.
|
|
844
757
|
*/
|
|
845
|
-
|
|
758
|
+
encrypted?: boolean;
|
|
846
759
|
/**
|
|
847
|
-
* -
|
|
848
|
-
*
|
|
849
|
-
* the storage structure.
|
|
760
|
+
* - Identifier to specify if the definition is
|
|
761
|
+
* pinned or not.
|
|
850
762
|
*/
|
|
851
|
-
|
|
852
|
-
};
|
|
853
|
-
/** @returns {BulkActionCountSchema} */
|
|
854
|
-
declare function BulkActionCountSchema(): BulkActionCountSchema;
|
|
855
|
-
type BulkActionCountSchema = {
|
|
763
|
+
pinned?: boolean;
|
|
856
764
|
/**
|
|
857
|
-
* -
|
|
765
|
+
* - Pin order of the Attribute Definition.
|
|
858
766
|
*/
|
|
859
|
-
|
|
767
|
+
pin_order?: number;
|
|
860
768
|
/**
|
|
861
|
-
* - The
|
|
769
|
+
* - The default value for the User Attribute
|
|
770
|
+
* Definition. Data type of the default value depends on the type of the
|
|
771
|
+
* attribute definition type defined.
|
|
862
772
|
*/
|
|
863
|
-
|
|
773
|
+
default_value?: any;
|
|
864
774
|
/**
|
|
865
|
-
* - The
|
|
775
|
+
* - The custom validations that have been
|
|
776
|
+
* set for this customer definition.
|
|
866
777
|
*/
|
|
867
|
-
|
|
778
|
+
validations?: any[];
|
|
868
779
|
};
|
|
869
780
|
/** @returns {BlockUserRequestSchema} */
|
|
870
781
|
declare function BlockUserRequestSchema(): BlockUserRequestSchema;
|
|
871
782
|
type BlockUserRequestSchema = {
|
|
872
|
-
status
|
|
873
|
-
user_id
|
|
874
|
-
reason
|
|
783
|
+
status: boolean;
|
|
784
|
+
user_id: string[];
|
|
785
|
+
reason: string;
|
|
875
786
|
};
|
|
876
787
|
/** @returns {ArchiveUserRequestSchema} */
|
|
877
788
|
declare function ArchiveUserRequestSchema(): ArchiveUserRequestSchema;
|
|
878
789
|
type ArchiveUserRequestSchema = {
|
|
879
|
-
user_id
|
|
790
|
+
user_id: string;
|
|
880
791
|
};
|
|
881
792
|
/** @returns {UnDeleteUserRequestSchema} */
|
|
882
793
|
declare function UnDeleteUserRequestSchema(): UnDeleteUserRequestSchema;
|
|
883
794
|
type UnDeleteUserRequestSchema = {
|
|
884
|
-
user_id
|
|
885
|
-
reason
|
|
886
|
-
reason_id
|
|
795
|
+
user_id: string;
|
|
796
|
+
reason: string;
|
|
797
|
+
reason_id: string;
|
|
887
798
|
};
|
|
888
799
|
/** @returns {BlockUserSuccess} */
|
|
889
800
|
declare function BlockUserSuccess(): BlockUserSuccess;
|
|
@@ -911,37 +822,13 @@ type CustomerListResponseSchema = {
|
|
|
911
822
|
items?: UserSearchSchema[];
|
|
912
823
|
page?: PaginationSchema;
|
|
913
824
|
};
|
|
914
|
-
/** @returns {BulkActionPaginationSchema} */
|
|
915
|
-
declare function BulkActionPaginationSchema(): BulkActionPaginationSchema;
|
|
916
|
-
type BulkActionPaginationSchema = {
|
|
917
|
-
/**
|
|
918
|
-
* - Array of Bulk Action Documents
|
|
919
|
-
*/
|
|
920
|
-
items?: BulkActionModel[];
|
|
921
|
-
page?: PaginationSchema;
|
|
922
|
-
};
|
|
923
825
|
/** @returns {PaginationSchema} */
|
|
924
826
|
declare function PaginationSchema(): PaginationSchema;
|
|
925
827
|
type PaginationSchema = {
|
|
926
|
-
/**
|
|
927
|
-
* - The number of items per page.
|
|
928
|
-
*/
|
|
929
828
|
size?: number;
|
|
930
|
-
/**
|
|
931
|
-
* - The total number of items across all pages.
|
|
932
|
-
*/
|
|
933
829
|
item_total?: number;
|
|
934
|
-
/**
|
|
935
|
-
* - Indicates whether there are more pages to retrieve.
|
|
936
|
-
*/
|
|
937
830
|
has_next?: boolean;
|
|
938
|
-
/**
|
|
939
|
-
* - The type of pagination used (eg Number).
|
|
940
|
-
*/
|
|
941
831
|
type?: string;
|
|
942
|
-
/**
|
|
943
|
-
* - The current page number.
|
|
944
|
-
*/
|
|
945
832
|
current?: number;
|
|
946
833
|
};
|
|
947
834
|
/** @returns {SessionListResponseSchema} */
|
|
@@ -990,7 +877,7 @@ declare function Conditions(): Conditions;
|
|
|
990
877
|
type Conditions = {
|
|
991
878
|
user_attribute_definition_id?: string;
|
|
992
879
|
type?: string;
|
|
993
|
-
value?:
|
|
880
|
+
value?: any;
|
|
994
881
|
key?: string;
|
|
995
882
|
};
|
|
996
883
|
/** @returns {UserResponseErrorSchema} */
|
|
@@ -1003,6 +890,7 @@ type UserResponseErrorSchema = {
|
|
|
1003
890
|
declare function UserGroupResponseSchema(): UserGroupResponseSchema;
|
|
1004
891
|
type UserGroupResponseSchema = {
|
|
1005
892
|
conditions?: Conditions[];
|
|
893
|
+
blacklisted_users?: string[];
|
|
1006
894
|
error?: UserResponseErrorSchema;
|
|
1007
895
|
name?: string;
|
|
1008
896
|
description?: string;
|
|
@@ -1028,7 +916,7 @@ declare function ConditionsSchema(): ConditionsSchema;
|
|
|
1028
916
|
type ConditionsSchema = {
|
|
1029
917
|
user_attribute_definition_id?: string;
|
|
1030
918
|
type?: string;
|
|
1031
|
-
value?:
|
|
919
|
+
value?: any;
|
|
1032
920
|
};
|
|
1033
921
|
/** @returns {CreateUserGroup} */
|
|
1034
922
|
declare function CreateUserGroup(): CreateUserGroup;
|
|
@@ -1038,6 +926,7 @@ type CreateUserGroup = {
|
|
|
1038
926
|
name: string;
|
|
1039
927
|
description: string;
|
|
1040
928
|
file_url?: string;
|
|
929
|
+
blacklisted_users?: string[];
|
|
1041
930
|
};
|
|
1042
931
|
/** @returns {CreateUserRequestSchema} */
|
|
1043
932
|
declare function CreateUserRequestSchema(): CreateUserRequestSchema;
|
|
@@ -1047,7 +936,7 @@ type CreateUserRequestSchema = {
|
|
|
1047
936
|
first_name?: string;
|
|
1048
937
|
last_name?: string;
|
|
1049
938
|
gender?: string;
|
|
1050
|
-
username
|
|
939
|
+
username: string;
|
|
1051
940
|
meta?: any;
|
|
1052
941
|
external_id?: string;
|
|
1053
942
|
rr_id?: string;
|
|
@@ -1060,8 +949,9 @@ type CreateUserResponseSchema = {
|
|
|
1060
949
|
/** @returns {CreateUserSessionRequestSchema} */
|
|
1061
950
|
declare function CreateUserSessionRequestSchema(): CreateUserSessionRequestSchema;
|
|
1062
951
|
type CreateUserSessionRequestSchema = {
|
|
1063
|
-
domain
|
|
1064
|
-
user_id
|
|
952
|
+
domain: string;
|
|
953
|
+
user_id: string;
|
|
954
|
+
max_age?: number;
|
|
1065
955
|
};
|
|
1066
956
|
/** @returns {CreateUserSessionResponseSchema} */
|
|
1067
957
|
declare function CreateUserSessionResponseSchema(): CreateUserSessionResponseSchema;
|
|
@@ -1081,6 +971,8 @@ type PlatformSchema = {
|
|
|
1081
971
|
active?: boolean;
|
|
1082
972
|
forgot_password?: boolean;
|
|
1083
973
|
login?: Login;
|
|
974
|
+
account_lockout?: AccountLockout;
|
|
975
|
+
password_settings?: PasswordSettings;
|
|
1084
976
|
skip_captcha?: boolean;
|
|
1085
977
|
name?: string;
|
|
1086
978
|
meta?: MetaSchema;
|
|
@@ -1108,11 +1000,46 @@ type LookAndFeel = {
|
|
|
1108
1000
|
card_position?: string;
|
|
1109
1001
|
background_color?: string;
|
|
1110
1002
|
};
|
|
1003
|
+
/** @returns {PasswordConfigs} */
|
|
1004
|
+
declare function PasswordConfigs(): PasswordConfigs;
|
|
1005
|
+
type PasswordConfigs = {
|
|
1006
|
+
length?: number;
|
|
1007
|
+
require_special_character?: boolean;
|
|
1008
|
+
require_number?: boolean;
|
|
1009
|
+
require_capital_character?: boolean;
|
|
1010
|
+
};
|
|
1011
|
+
/** @returns {PasswordHistory} */
|
|
1012
|
+
declare function PasswordHistory(): PasswordHistory;
|
|
1013
|
+
type PasswordHistory = {
|
|
1014
|
+
required?: boolean;
|
|
1015
|
+
count?: number;
|
|
1016
|
+
};
|
|
1017
|
+
/** @returns {PasswordExpiry} */
|
|
1018
|
+
declare function PasswordExpiry(): PasswordExpiry;
|
|
1019
|
+
type PasswordExpiry = {
|
|
1020
|
+
required?: boolean;
|
|
1021
|
+
duration?: number;
|
|
1022
|
+
};
|
|
1023
|
+
/** @returns {PasswordSettings} */
|
|
1024
|
+
declare function PasswordSettings(): PasswordSettings;
|
|
1025
|
+
type PasswordSettings = {
|
|
1026
|
+
configs?: PasswordConfigs;
|
|
1027
|
+
history?: PasswordHistory;
|
|
1028
|
+
expiry?: PasswordExpiry;
|
|
1029
|
+
};
|
|
1030
|
+
/** @returns {AccountLockout} */
|
|
1031
|
+
declare function AccountLockout(): AccountLockout;
|
|
1032
|
+
type AccountLockout = {
|
|
1033
|
+
enable?: boolean;
|
|
1034
|
+
attempts?: number;
|
|
1035
|
+
duration?: number;
|
|
1036
|
+
};
|
|
1111
1037
|
/** @returns {Login} */
|
|
1112
1038
|
declare function Login(): Login;
|
|
1113
1039
|
type Login = {
|
|
1114
1040
|
password?: boolean;
|
|
1115
1041
|
otp?: boolean;
|
|
1042
|
+
via?: string;
|
|
1116
1043
|
};
|
|
1117
1044
|
/** @returns {MetaSchema} */
|
|
1118
1045
|
declare function MetaSchema(): MetaSchema;
|
|
@@ -1127,11 +1054,17 @@ type Social = {
|
|
|
1127
1054
|
google?: boolean;
|
|
1128
1055
|
apple?: boolean;
|
|
1129
1056
|
};
|
|
1057
|
+
/** @returns {PlatformPassword} */
|
|
1058
|
+
declare function PlatformPassword(): PlatformPassword;
|
|
1059
|
+
type PlatformPassword = {
|
|
1060
|
+
is_required?: boolean;
|
|
1061
|
+
};
|
|
1130
1062
|
/** @returns {RequiredFields} */
|
|
1131
1063
|
declare function RequiredFields(): RequiredFields;
|
|
1132
1064
|
type RequiredFields = {
|
|
1133
1065
|
email?: PlatformEmail;
|
|
1134
1066
|
mobile?: PlatformMobile;
|
|
1067
|
+
password?: PlatformPassword;
|
|
1135
1068
|
};
|
|
1136
1069
|
/** @returns {PlatformEmail} */
|
|
1137
1070
|
declare function PlatformEmail(): PlatformEmail;
|
|
@@ -1150,6 +1083,7 @@ declare function RegisterRequiredFields(): RegisterRequiredFields;
|
|
|
1150
1083
|
type RegisterRequiredFields = {
|
|
1151
1084
|
email?: RegisterRequiredFieldsEmail;
|
|
1152
1085
|
mobile?: RegisterRequiredFieldsMobile;
|
|
1086
|
+
password?: PlatformPassword;
|
|
1153
1087
|
};
|
|
1154
1088
|
/** @returns {RegisterRequiredFieldsEmail} */
|
|
1155
1089
|
declare function RegisterRequiredFieldsEmail(): RegisterRequiredFieldsEmail;
|
|
@@ -1174,7 +1108,7 @@ type FlashCard = {
|
|
|
1174
1108
|
declare function SocialTokens(): SocialTokens;
|
|
1175
1109
|
type SocialTokens = {
|
|
1176
1110
|
facebook?: Facebook;
|
|
1177
|
-
|
|
1111
|
+
accountkit?: Accountkit;
|
|
1178
1112
|
google?: Google;
|
|
1179
1113
|
};
|
|
1180
1114
|
/** @returns {DeleteAccountReasons} */
|
|
@@ -1246,6 +1180,16 @@ type PartialUserGroupUpdateSchema = {
|
|
|
1246
1180
|
* `phone_number`, `email` or `user_id` field in object
|
|
1247
1181
|
*/
|
|
1248
1182
|
user_data?: UserGroupUpdateData[];
|
|
1183
|
+
/**
|
|
1184
|
+
* - List of user ids to be whitelisted
|
|
1185
|
+
* from user group
|
|
1186
|
+
*/
|
|
1187
|
+
whitelisted_users?: string[];
|
|
1188
|
+
/**
|
|
1189
|
+
* - List of user ids to be blacklisted
|
|
1190
|
+
* from user group
|
|
1191
|
+
*/
|
|
1192
|
+
blacklisted_users?: string[];
|
|
1249
1193
|
};
|
|
1250
1194
|
/** @returns {UserGroupUpdateData} */
|
|
1251
1195
|
declare function UserGroupUpdateData(): UserGroupUpdateData;
|
|
@@ -1293,11 +1237,19 @@ type UserPhoneNumbers = {
|
|
|
1293
1237
|
phone?: string;
|
|
1294
1238
|
country_code?: string;
|
|
1295
1239
|
};
|
|
1240
|
+
/** @returns {UserPasswordHistory} */
|
|
1241
|
+
declare function UserPasswordHistory(): UserPasswordHistory;
|
|
1242
|
+
type UserPasswordHistory = {
|
|
1243
|
+
salt?: string;
|
|
1244
|
+
hash?: string;
|
|
1245
|
+
};
|
|
1296
1246
|
/** @returns {UserSchema} */
|
|
1297
1247
|
declare function UserSchema(): UserSchema;
|
|
1298
1248
|
type UserSchema = {
|
|
1299
1249
|
application_id?: string;
|
|
1300
1250
|
user_id?: string;
|
|
1251
|
+
password_last_modified?: string;
|
|
1252
|
+
password_history?: UserPasswordHistory[];
|
|
1301
1253
|
first_name?: string;
|
|
1302
1254
|
meta?: any;
|
|
1303
1255
|
last_name?: string;
|