@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
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 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -108,7 +108,7 @@ class User {
|
|
|
108
108
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<UserApplicationModel.VerifyEmailOTPSuccess>} - Success response
|
|
110
110
|
* @name addEmail
|
|
111
|
-
* @summary: Add
|
|
111
|
+
* @summary: Add Email to Profile
|
|
112
112
|
* @description: Adds a new email address to the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/addEmail/).
|
|
113
113
|
*/
|
|
114
114
|
async addEmail(
|
|
@@ -185,7 +185,7 @@ class User {
|
|
|
185
185
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
186
186
|
* @returns {Promise<UserApplicationModel.VerifyMobileOTPSuccess>} - Success response
|
|
187
187
|
* @name addMobileNumber
|
|
188
|
-
* @summary: Add
|
|
188
|
+
* @summary: Add Mobile Number to Profile
|
|
189
189
|
* @description: Adds a new mobile number to the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/addMobileNumber/).
|
|
190
190
|
*/
|
|
191
191
|
async addMobileNumber(
|
|
@@ -264,8 +264,8 @@ class User {
|
|
|
264
264
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
265
265
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
266
266
|
* @name deleteEmail
|
|
267
|
-
* @summary: Delete
|
|
268
|
-
* @description:
|
|
267
|
+
* @summary: Delete Email From Profile
|
|
268
|
+
* @description: Delete Email From Profile - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteEmail/).
|
|
269
269
|
*/
|
|
270
270
|
async deleteEmail(
|
|
271
271
|
{ active, primary, verified, email, platform, requestHeaders } = {
|
|
@@ -347,8 +347,8 @@ class User {
|
|
|
347
347
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
348
348
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
349
349
|
* @name deleteMobileNumber
|
|
350
|
-
* @summary: Delete
|
|
351
|
-
* @description:
|
|
350
|
+
* @summary: Delete Mobile Number From Profile
|
|
351
|
+
* @description: Delete Mobile Number From Profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteMobileNumber/).
|
|
352
352
|
*/
|
|
353
353
|
async deleteMobileNumber(
|
|
354
354
|
{
|
|
@@ -439,8 +439,8 @@ class User {
|
|
|
439
439
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
440
440
|
* @returns {Promise<UserApplicationModel.DeleteUserSuccess>} - Success response
|
|
441
441
|
* @name deleteUser
|
|
442
|
-
* @summary:
|
|
443
|
-
* @description:
|
|
442
|
+
* @summary: Verify OTP and Delete User
|
|
443
|
+
* @description: Verify OTP sent to mobile/email and Delete the user's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteUser/).
|
|
444
444
|
*/
|
|
445
445
|
async deleteUser(
|
|
446
446
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -515,8 +515,8 @@ class User {
|
|
|
515
515
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
516
516
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
517
517
|
* @name forgotPassword
|
|
518
|
-
* @summary:
|
|
519
|
-
* @description:
|
|
518
|
+
* @summary: Reset Password via Code and login
|
|
519
|
+
* @description: Reset a password using the code sent on email or SMS the Login. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/forgotPassword/).
|
|
520
520
|
*/
|
|
521
521
|
async forgotPassword(
|
|
522
522
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -593,8 +593,8 @@ class User {
|
|
|
593
593
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
594
594
|
* @returns {Promise<UserApplicationModel.SessionListSuccess>} - Success response
|
|
595
595
|
* @name getListOfActiveSessions
|
|
596
|
-
* @summary: Get
|
|
597
|
-
* @description:
|
|
596
|
+
* @summary: Get List OF Active Sessions
|
|
597
|
+
* @description: Retrieve all active sessions of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getListOfActiveSessions/).
|
|
598
598
|
*/
|
|
599
599
|
async getListOfActiveSessions(
|
|
600
600
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -673,7 +673,7 @@ class User {
|
|
|
673
673
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
674
674
|
* @returns {Promise<UserApplicationModel.UserObjectSchema>} - Success response
|
|
675
675
|
* @name getLoggedInUser
|
|
676
|
-
* @summary:
|
|
676
|
+
* @summary: Get Logged in User
|
|
677
677
|
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getLoggedInUser/).
|
|
678
678
|
*/
|
|
679
679
|
async getLoggedInUser(
|
|
@@ -751,8 +751,8 @@ class User {
|
|
|
751
751
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
752
752
|
* @returns {Promise<UserApplicationModel.PlatformSchema>} - Success response
|
|
753
753
|
* @name getPlatformConfig
|
|
754
|
-
* @summary: Platform
|
|
755
|
-
* @description: Retrieve
|
|
754
|
+
* @summary: Get Platform Configuration
|
|
755
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getPlatformConfig/).
|
|
756
756
|
*/
|
|
757
757
|
async getPlatformConfig(
|
|
758
758
|
{ name, requestHeaders } = { requestHeaders: {} },
|
|
@@ -830,8 +830,8 @@ class User {
|
|
|
830
830
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
831
831
|
* @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
|
|
832
832
|
* @name getUserAttributes
|
|
833
|
-
* @summary: Get
|
|
834
|
-
* @description:
|
|
833
|
+
* @summary: Get User Attributes
|
|
834
|
+
* @description: Get the list of user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getUserAttributes/).
|
|
835
835
|
*/
|
|
836
836
|
async getUserAttributes(
|
|
837
837
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -909,8 +909,8 @@ class User {
|
|
|
909
909
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
910
910
|
* @returns {Promise<UserApplicationModel.HasPasswordSuccess>} - Success response
|
|
911
911
|
* @name hasPassword
|
|
912
|
-
* @summary: Check
|
|
913
|
-
* @description:
|
|
912
|
+
* @summary: Check Password Existence
|
|
913
|
+
* @description: Check if user has set an account password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/hasPassword/).
|
|
914
914
|
*/
|
|
915
915
|
async hasPassword(
|
|
916
916
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -985,8 +985,8 @@ class User {
|
|
|
985
985
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
986
986
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
987
987
|
* @name loginWithAppleIOS
|
|
988
|
-
* @summary:
|
|
989
|
-
* @description: Enables
|
|
988
|
+
* @summary: iOS Login with Apple
|
|
989
|
+
* @description: Enables iOS users to log in to the system using their Apple ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithAppleIOS/).
|
|
990
990
|
*/
|
|
991
991
|
async loginWithAppleIOS(
|
|
992
992
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1064,8 +1064,8 @@ class User {
|
|
|
1064
1064
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1065
1065
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
1066
1066
|
* @name loginWithEmailAndPassword
|
|
1067
|
-
* @summary: Email
|
|
1068
|
-
* @description:
|
|
1067
|
+
* @summary: Email and Password Login
|
|
1068
|
+
* @description: Allows login using an email and password combination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithEmailAndPassword/).
|
|
1069
1069
|
*/
|
|
1070
1070
|
async loginWithEmailAndPassword(
|
|
1071
1071
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1144,8 +1144,8 @@ class User {
|
|
|
1144
1144
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1145
1145
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
1146
1146
|
* @name loginWithFacebook
|
|
1147
|
-
* @summary: Facebook
|
|
1148
|
-
* @description: Enables
|
|
1147
|
+
* @summary: Login with Facebook
|
|
1148
|
+
* @description: Enables users to log in to the system using their Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithFacebook/).
|
|
1149
1149
|
*/
|
|
1150
1150
|
async loginWithFacebook(
|
|
1151
1151
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1223,8 +1223,8 @@ class User {
|
|
|
1223
1223
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1224
1224
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
1225
1225
|
* @name loginWithGoogle
|
|
1226
|
-
* @summary: Google
|
|
1227
|
-
* @description: Enables
|
|
1226
|
+
* @summary: Login with Google
|
|
1227
|
+
* @description: Enables website users to log in to the system using their Google accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogle/).
|
|
1228
1228
|
*/
|
|
1229
1229
|
async loginWithGoogle(
|
|
1230
1230
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1302,8 +1302,8 @@ class User {
|
|
|
1302
1302
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1303
1303
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
1304
1304
|
* @name loginWithGoogleAndroid
|
|
1305
|
-
* @summary: Android Google
|
|
1306
|
-
* @description:
|
|
1305
|
+
* @summary: Android Login with Google
|
|
1306
|
+
* @description: Enables Android users to log in to the system using their Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleAndroid/).
|
|
1307
1307
|
*/
|
|
1308
1308
|
async loginWithGoogleAndroid(
|
|
1309
1309
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1383,8 +1383,8 @@ class User {
|
|
|
1383
1383
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1384
1384
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
1385
1385
|
* @name loginWithGoogleIOS
|
|
1386
|
-
* @summary: iOS Google
|
|
1387
|
-
* @description:
|
|
1386
|
+
* @summary: iOS Login with Google
|
|
1387
|
+
* @description: Enables iOS users to log in to the system using their Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleIOS/).
|
|
1388
1388
|
*/
|
|
1389
1389
|
async loginWithGoogleIOS(
|
|
1390
1390
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1462,8 +1462,8 @@ class User {
|
|
|
1462
1462
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1463
1463
|
* @returns {Promise<UserApplicationModel.SendOtpResponse>} - Success response
|
|
1464
1464
|
* @name loginWithOTP
|
|
1465
|
-
* @summary: OTP
|
|
1466
|
-
* @description: Allows users to log in using a one-time password
|
|
1465
|
+
* @summary: Login with Mobile OTP
|
|
1466
|
+
* @description: Allows users to log in using a one-time password sent to their mobile - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithOTP/).
|
|
1467
1467
|
*/
|
|
1468
1468
|
async loginWithOTP(
|
|
1469
1469
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1541,8 +1541,8 @@ class User {
|
|
|
1541
1541
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1542
1542
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
1543
1543
|
* @name loginWithToken
|
|
1544
|
-
* @summary: Login
|
|
1545
|
-
* @description:
|
|
1544
|
+
* @summary: Login with Token
|
|
1545
|
+
* @description: Login User using a token for authentication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithToken/).
|
|
1546
1546
|
*/
|
|
1547
1547
|
async loginWithToken(
|
|
1548
1548
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1619,8 +1619,8 @@ class User {
|
|
|
1619
1619
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1620
1620
|
* @returns {Promise<UserApplicationModel.LogoutSuccess>} - Success response
|
|
1621
1621
|
* @name logout
|
|
1622
|
-
* @summary:
|
|
1623
|
-
* @description:
|
|
1622
|
+
* @summary: Logout Current User
|
|
1623
|
+
* @description: Logout currently logged-in user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/logout/).
|
|
1624
1624
|
*/
|
|
1625
1625
|
async logout(
|
|
1626
1626
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1695,7 +1695,7 @@ class User {
|
|
|
1695
1695
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1696
1696
|
* @returns {Promise<UserApplicationModel.RegisterFormSuccess>} - Success response
|
|
1697
1697
|
* @name registerWithForm
|
|
1698
|
-
* @summary: User
|
|
1698
|
+
* @summary: Register User with Form
|
|
1699
1699
|
* @description: Enables new users to register using a form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/registerWithForm/).
|
|
1700
1700
|
*/
|
|
1701
1701
|
async registerWithForm(
|
|
@@ -1775,8 +1775,8 @@ class User {
|
|
|
1775
1775
|
* @returns {Promise<UserApplicationModel.ResetForgotPasswordSuccess>} -
|
|
1776
1776
|
* Success response
|
|
1777
1777
|
* @name resetForgotPassword
|
|
1778
|
-
* @summary:
|
|
1779
|
-
* @description:
|
|
1778
|
+
* @summary: Reset Password via Code
|
|
1779
|
+
* @description: Reset a password using the code sent on email or SMS. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/resetForgotPassword/).
|
|
1780
1780
|
*/
|
|
1781
1781
|
async resetForgotPassword(
|
|
1782
1782
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1853,8 +1853,8 @@ class User {
|
|
|
1853
1853
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1854
1854
|
* @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
|
|
1855
1855
|
* @name sendForgotOTPOnEmail
|
|
1856
|
-
* @summary: Send
|
|
1857
|
-
* @description: Sends a one-time password to the user's
|
|
1856
|
+
* @summary: Send Email OTP for Forgot Password
|
|
1857
|
+
* @description: Sends a one-time password to the user's email for verification when resetting a forgotten password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnEmail/).
|
|
1858
1858
|
*/
|
|
1859
1859
|
async sendForgotOTPOnEmail(
|
|
1860
1860
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1932,8 +1932,8 @@ class User {
|
|
|
1932
1932
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1933
1933
|
* @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
|
|
1934
1934
|
* @name sendForgotOTPOnMobile
|
|
1935
|
-
* @summary: Send
|
|
1936
|
-
* @description: Sends a one-time password to the user's
|
|
1935
|
+
* @summary: Send mobile OTP for forgot-password
|
|
1936
|
+
* @description: Sends a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnMobile/).
|
|
1937
1937
|
*/
|
|
1938
1938
|
async sendForgotOTPOnMobile(
|
|
1939
1939
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2011,7 +2011,7 @@ class User {
|
|
|
2011
2011
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2012
2012
|
* @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
|
|
2013
2013
|
* @name sendOTPOnEmail
|
|
2014
|
-
* @summary: Send
|
|
2014
|
+
* @summary: Send OTP on Email
|
|
2015
2015
|
* @description: Sends a one-time password to the user's email for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnEmail/).
|
|
2016
2016
|
*/
|
|
2017
2017
|
async sendOTPOnEmail(
|
|
@@ -2090,7 +2090,7 @@ class User {
|
|
|
2090
2090
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2091
2091
|
* @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
|
|
2092
2092
|
* @name sendOTPOnMobile
|
|
2093
|
-
* @summary: Send
|
|
2093
|
+
* @summary: Send OTP on Mobile
|
|
2094
2094
|
* @description: Sends a one-time password to the user's mobile for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnMobile/).
|
|
2095
2095
|
*/
|
|
2096
2096
|
async sendOTPOnMobile(
|
|
@@ -2169,7 +2169,7 @@ class User {
|
|
|
2169
2169
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2170
2170
|
* @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
|
|
2171
2171
|
* @name sendResetPasswordEmail
|
|
2172
|
-
* @summary: Reset
|
|
2172
|
+
* @summary: Reset Password via Email
|
|
2173
2173
|
* @description: Sends a password reset link to the user's email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordEmail/).
|
|
2174
2174
|
*/
|
|
2175
2175
|
async sendResetPasswordEmail(
|
|
@@ -2250,8 +2250,8 @@ class User {
|
|
|
2250
2250
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2251
2251
|
* @returns {Promise<any>} - Success response
|
|
2252
2252
|
* @name sendResetPasswordMobile
|
|
2253
|
-
* @summary: Reset
|
|
2254
|
-
* @description: Sends a password reset
|
|
2253
|
+
* @summary: Reset Password via Mobile
|
|
2254
|
+
* @description: Sends a password reset link to the user's Mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordMobile/).
|
|
2255
2255
|
*/
|
|
2256
2256
|
async sendResetPasswordMobile(
|
|
2257
2257
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2328,8 +2328,8 @@ class User {
|
|
|
2328
2328
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2329
2329
|
* @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
|
|
2330
2330
|
* @name sendResetToken
|
|
2331
|
-
* @summary:
|
|
2332
|
-
* @description:
|
|
2331
|
+
* @summary: Validate Password Reset Code
|
|
2332
|
+
* @description: Validate Password Reset link Code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetToken/).
|
|
2333
2333
|
*/
|
|
2334
2334
|
async sendResetToken(
|
|
2335
2335
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2408,7 +2408,7 @@ class User {
|
|
|
2408
2408
|
* @returns {Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>} -
|
|
2409
2409
|
* Success response
|
|
2410
2410
|
* @name sendVerificationLinkToEmail
|
|
2411
|
-
* @summary:
|
|
2411
|
+
* @summary: Send Verification Link to Email
|
|
2412
2412
|
* @description: Sends a verification link to a newly added email address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendVerificationLinkToEmail/).
|
|
2413
2413
|
*/
|
|
2414
2414
|
async sendVerificationLinkToEmail(
|
|
@@ -2492,7 +2492,7 @@ class User {
|
|
|
2492
2492
|
* @returns {Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>} -
|
|
2493
2493
|
* Success response
|
|
2494
2494
|
* @name sendVerificationLinkToMobile
|
|
2495
|
-
* @summary:
|
|
2495
|
+
* @summary: Send Verification Link to Mobile
|
|
2496
2496
|
* @description: Sends a verification link to a newly added mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendVerificationLinkToMobile/).
|
|
2497
2497
|
*/
|
|
2498
2498
|
async sendVerificationLinkToMobile(
|
|
@@ -2573,7 +2573,7 @@ class User {
|
|
|
2573
2573
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2574
2574
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
2575
2575
|
* @name setEmailAsPrimary
|
|
2576
|
-
* @summary: Set
|
|
2576
|
+
* @summary: Set Email as Primary
|
|
2577
2577
|
* @description: Sets an email address as the primary contact for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/setEmailAsPrimary/).
|
|
2578
2578
|
*/
|
|
2579
2579
|
async setEmailAsPrimary(
|
|
@@ -2651,7 +2651,7 @@ class User {
|
|
|
2651
2651
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2652
2652
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
2653
2653
|
* @name setMobileNumberAsPrimary
|
|
2654
|
-
* @summary: Set
|
|
2654
|
+
* @summary: Set Mobile as Primary
|
|
2655
2655
|
* @description: Sets a mobile number as the primary contact for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/setMobileNumberAsPrimary/).
|
|
2656
2656
|
*/
|
|
2657
2657
|
async setMobileNumberAsPrimary(
|
|
@@ -2731,8 +2731,8 @@ class User {
|
|
|
2731
2731
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2732
2732
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
2733
2733
|
* @name updatePassword
|
|
2734
|
-
* @summary: Update
|
|
2735
|
-
* @description:
|
|
2734
|
+
* @summary: Update Password
|
|
2735
|
+
* @description: Allow user to change their password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updatePassword/).
|
|
2736
2736
|
*/
|
|
2737
2737
|
async updatePassword(
|
|
2738
2738
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2809,8 +2809,8 @@ class User {
|
|
|
2809
2809
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2810
2810
|
* @returns {Promise<UserApplicationModel.ProfileEditSuccess>} - Success response
|
|
2811
2811
|
* @name updateProfile
|
|
2812
|
-
* @summary: Edit Profile Details
|
|
2813
|
-
* @description:
|
|
2812
|
+
* @summary: Edit User Profile Details
|
|
2813
|
+
* @description: Allows users to modify and update their profile details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateProfile/).
|
|
2814
2814
|
*/
|
|
2815
2815
|
async updateProfile(
|
|
2816
2816
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2888,8 +2888,8 @@ class User {
|
|
|
2888
2888
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2889
2889
|
* @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
|
|
2890
2890
|
* @name updateUserAttributes
|
|
2891
|
-
* @summary: Update
|
|
2892
|
-
* @description:
|
|
2891
|
+
* @summary: Update User Attributes
|
|
2892
|
+
* @description: Update user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateUserAttributes/).
|
|
2893
2893
|
*/
|
|
2894
2894
|
async updateUserAttributes(
|
|
2895
2895
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2966,8 +2966,8 @@ class User {
|
|
|
2966
2966
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
2967
2967
|
* @returns {Promise<UserApplicationModel.UserExistsResponse>} - Success response
|
|
2968
2968
|
* @name userExists
|
|
2969
|
-
* @summary:
|
|
2970
|
-
* @description:
|
|
2969
|
+
* @summary: Chcek User Existence
|
|
2970
|
+
* @description: Check whether user is already registered or not to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/userExists/).
|
|
2971
2971
|
*/
|
|
2972
2972
|
async userExists(
|
|
2973
2973
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3043,8 +3043,8 @@ class User {
|
|
|
3043
3043
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3044
3044
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
3045
3045
|
* @name verifyEmail
|
|
3046
|
-
* @summary: Verify
|
|
3047
|
-
* @description: Verifies
|
|
3046
|
+
* @summary: Verify Email with Code
|
|
3047
|
+
* @description: Verifies user email with a code sent within a link sent to their email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmail/).
|
|
3048
3048
|
*/
|
|
3049
3049
|
async verifyEmail(
|
|
3050
3050
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3119,8 +3119,8 @@ class User {
|
|
|
3119
3119
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3120
3120
|
* @returns {Promise<UserApplicationModel.VerifyForgotOtpSuccess>} - Success response
|
|
3121
3121
|
* @name verifyEmailForgotOTP
|
|
3122
|
-
* @summary: Verify Email Forgot
|
|
3123
|
-
* @description:
|
|
3122
|
+
* @summary: Verify Email OTP for Forgot Password
|
|
3123
|
+
* @description: Verify one-time password sent to user's email for resetting a forgotten password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailForgotOTP/).
|
|
3124
3124
|
*/
|
|
3125
3125
|
async verifyEmailForgotOTP(
|
|
3126
3126
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3199,7 +3199,7 @@ class User {
|
|
|
3199
3199
|
* @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
|
|
3200
3200
|
* @name verifyEmailOTP
|
|
3201
3201
|
* @summary: Verify Email OTP
|
|
3202
|
-
* @description:
|
|
3202
|
+
* @description: Verify one-time password sent to user's email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailOTP/).
|
|
3203
3203
|
*/
|
|
3204
3204
|
async verifyEmailOTP(
|
|
3205
3205
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3277,8 +3277,8 @@ class User {
|
|
|
3277
3277
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3278
3278
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
3279
3279
|
* @name verifyMobile
|
|
3280
|
-
* @summary: Verify
|
|
3281
|
-
* @description: Verifies
|
|
3280
|
+
* @summary: Verify Mobile with Code
|
|
3281
|
+
* @description: Verifies user mobile with a code sent within a link sent to their mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobile/).
|
|
3282
3282
|
*/
|
|
3283
3283
|
async verifyMobile(
|
|
3284
3284
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3355,8 +3355,8 @@ class User {
|
|
|
3355
3355
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3356
3356
|
* @returns {Promise<UserApplicationModel.VerifyForgotOtpSuccess>} - Success response
|
|
3357
3357
|
* @name verifyMobileForgotOTP
|
|
3358
|
-
* @summary: Verify
|
|
3359
|
-
* @description:
|
|
3358
|
+
* @summary: Verify Mobile OTP for Forgot Password
|
|
3359
|
+
* @description: Verify one-time password sent to user's mobile for resetting a forgotten password - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileForgotOTP/).
|
|
3360
3360
|
*/
|
|
3361
3361
|
async verifyMobileForgotOTP(
|
|
3362
3362
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3434,8 +3434,8 @@ class User {
|
|
|
3434
3434
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
3435
3435
|
* @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
|
|
3436
3436
|
* @name verifyMobileOTP
|
|
3437
|
-
* @summary: Verify
|
|
3438
|
-
* @description:
|
|
3437
|
+
* @summary: Verify Mobile OTP
|
|
3438
|
+
* @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
|
|
3439
3439
|
*/
|
|
3440
3440
|
async verifyMobileOTP(
|
|
3441
3441
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -488,21 +488,23 @@ export = UserApplicationModel;
|
|
|
488
488
|
* @property {string} [_id]
|
|
489
489
|
* @property {string} [created_at]
|
|
490
490
|
* @property {string} [updated_at]
|
|
491
|
+
* @property {string} [external_id]
|
|
492
|
+
* @property {string} [rr_id]
|
|
491
493
|
*/
|
|
492
494
|
/**
|
|
493
495
|
* @typedef PhoneNumber
|
|
494
|
-
* @property {
|
|
495
|
-
* @property {
|
|
496
|
-
* @property {boolean} [
|
|
497
|
-
* @property {
|
|
498
|
-
* @property {
|
|
496
|
+
* @property {string} [phone] - Phone number
|
|
497
|
+
* @property {number} [country_code] - Country code
|
|
498
|
+
* @property {boolean} [active] - Is the phone number active
|
|
499
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
500
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
499
501
|
*/
|
|
500
502
|
/**
|
|
501
503
|
* @typedef Email
|
|
502
|
-
* @property {
|
|
503
|
-
* @property {boolean} [
|
|
504
|
-
* @property {
|
|
505
|
-
* @property {boolean} [
|
|
504
|
+
* @property {string} [email] - Email address
|
|
505
|
+
* @property {boolean} [active] - Is the email active
|
|
506
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
507
|
+
* @property {boolean} [verified] - Is the email verified
|
|
506
508
|
*/
|
|
507
509
|
declare class UserApplicationModel {
|
|
508
510
|
}
|
|
@@ -1085,21 +1087,50 @@ type UserSchema = {
|
|
|
1085
1087
|
_id?: string;
|
|
1086
1088
|
created_at?: string;
|
|
1087
1089
|
updated_at?: string;
|
|
1090
|
+
external_id?: string;
|
|
1091
|
+
rr_id?: string;
|
|
1088
1092
|
};
|
|
1089
1093
|
/** @returns {PhoneNumber} */
|
|
1090
1094
|
declare function PhoneNumber(): PhoneNumber;
|
|
1091
1095
|
type PhoneNumber = {
|
|
1096
|
+
/**
|
|
1097
|
+
* - Phone number
|
|
1098
|
+
*/
|
|
1099
|
+
phone?: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* - Country code
|
|
1102
|
+
*/
|
|
1103
|
+
country_code?: number;
|
|
1104
|
+
/**
|
|
1105
|
+
* - Is the phone number active
|
|
1106
|
+
*/
|
|
1092
1107
|
active?: boolean;
|
|
1108
|
+
/**
|
|
1109
|
+
* - Is it a primary phone number
|
|
1110
|
+
*/
|
|
1093
1111
|
primary?: boolean;
|
|
1112
|
+
/**
|
|
1113
|
+
* - Is the phone number verified
|
|
1114
|
+
*/
|
|
1094
1115
|
verified?: boolean;
|
|
1095
|
-
phone?: string;
|
|
1096
|
-
country_code?: number;
|
|
1097
1116
|
};
|
|
1098
1117
|
/** @returns {Email} */
|
|
1099
1118
|
declare function Email(): Email;
|
|
1100
1119
|
type Email = {
|
|
1101
|
-
|
|
1102
|
-
|
|
1120
|
+
/**
|
|
1121
|
+
* - Email address
|
|
1122
|
+
*/
|
|
1103
1123
|
email?: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* - Is the email active
|
|
1126
|
+
*/
|
|
1104
1127
|
active?: boolean;
|
|
1128
|
+
/**
|
|
1129
|
+
* - Is it a primary email
|
|
1130
|
+
*/
|
|
1131
|
+
primary?: boolean;
|
|
1132
|
+
/**
|
|
1133
|
+
* - Is the email verified
|
|
1134
|
+
*/
|
|
1135
|
+
verified?: boolean;
|
|
1105
1136
|
};
|
|
@@ -563,23 +563,25 @@ const Joi = require("joi");
|
|
|
563
563
|
* @property {string} [_id]
|
|
564
564
|
* @property {string} [created_at]
|
|
565
565
|
* @property {string} [updated_at]
|
|
566
|
+
* @property {string} [external_id]
|
|
567
|
+
* @property {string} [rr_id]
|
|
566
568
|
*/
|
|
567
569
|
|
|
568
570
|
/**
|
|
569
571
|
* @typedef PhoneNumber
|
|
570
|
-
* @property {
|
|
571
|
-
* @property {
|
|
572
|
-
* @property {boolean} [
|
|
573
|
-
* @property {
|
|
574
|
-
* @property {
|
|
572
|
+
* @property {string} [phone] - Phone number
|
|
573
|
+
* @property {number} [country_code] - Country code
|
|
574
|
+
* @property {boolean} [active] - Is the phone number active
|
|
575
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
576
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
575
577
|
*/
|
|
576
578
|
|
|
577
579
|
/**
|
|
578
580
|
* @typedef Email
|
|
579
|
-
* @property {
|
|
580
|
-
* @property {boolean} [
|
|
581
|
-
* @property {
|
|
582
|
-
* @property {boolean} [
|
|
581
|
+
* @property {string} [email] - Email address
|
|
582
|
+
* @property {boolean} [active] - Is the email active
|
|
583
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
584
|
+
* @property {boolean} [verified] - Is the email verified
|
|
583
585
|
*/
|
|
584
586
|
|
|
585
587
|
class UserApplicationModel {
|
|
@@ -1297,27 +1299,29 @@ class UserApplicationModel {
|
|
|
1297
1299
|
_id: Joi.string().allow(""),
|
|
1298
1300
|
created_at: Joi.string().allow(""),
|
|
1299
1301
|
updated_at: Joi.string().allow(""),
|
|
1302
|
+
external_id: Joi.string().allow(""),
|
|
1303
|
+
rr_id: Joi.string().allow(""),
|
|
1300
1304
|
});
|
|
1301
1305
|
}
|
|
1302
1306
|
|
|
1303
1307
|
/** @returns {PhoneNumber} */
|
|
1304
1308
|
static PhoneNumber() {
|
|
1305
1309
|
return Joi.object({
|
|
1310
|
+
phone: Joi.string().allow(""),
|
|
1311
|
+
country_code: Joi.number(),
|
|
1306
1312
|
active: Joi.boolean(),
|
|
1307
1313
|
primary: Joi.boolean(),
|
|
1308
1314
|
verified: Joi.boolean(),
|
|
1309
|
-
phone: Joi.string().allow(""),
|
|
1310
|
-
country_code: Joi.number(),
|
|
1311
1315
|
});
|
|
1312
1316
|
}
|
|
1313
1317
|
|
|
1314
1318
|
/** @returns {Email} */
|
|
1315
1319
|
static Email() {
|
|
1316
1320
|
return Joi.object({
|
|
1317
|
-
primary: Joi.boolean(),
|
|
1318
|
-
verified: Joi.boolean(),
|
|
1319
1321
|
email: Joi.string().allow(""),
|
|
1320
1322
|
active: Joi.boolean(),
|
|
1323
|
+
primary: Joi.boolean(),
|
|
1324
|
+
verified: Joi.boolean(),
|
|
1321
1325
|
});
|
|
1322
1326
|
}
|
|
1323
1327
|
}
|
|
@@ -557,4 +557,4 @@ type GetListOfActiveSessionsParam = any;
|
|
|
557
557
|
type GetLoggedInUserParam = any;
|
|
558
558
|
type HasPasswordParam = any;
|
|
559
559
|
type LogoutParam = any;
|
|
560
|
-
import UserApplicationModel = require("
|
|
560
|
+
import UserApplicationModel = require("sdk/output/javascript/code/sdk/application/User/UserApplicationModel");
|