@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -55,8 +55,8 @@ declare class User {
|
|
|
55
55
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
56
56
|
* @returns {Promise<UserApplicationModel.VerifyEmailOTPSuccess>} - Success response
|
|
57
57
|
* @name addEmail
|
|
58
|
-
* @summary: Add email
|
|
59
|
-
* @description:
|
|
58
|
+
* @summary: Add email.
|
|
59
|
+
* @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/).
|
|
60
60
|
*/
|
|
61
61
|
addEmail({ body, platform, requestHeaders }?: UserApplicationValidator.AddEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailOTPSuccess>;
|
|
62
62
|
/**
|
|
@@ -65,8 +65,8 @@ declare class User {
|
|
|
65
65
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
66
66
|
* @returns {Promise<UserApplicationModel.VerifyMobileOTPSuccess>} - Success response
|
|
67
67
|
* @name addMobileNumber
|
|
68
|
-
* @summary: Add mobile
|
|
69
|
-
* @description:
|
|
68
|
+
* @summary: Add mobile.
|
|
69
|
+
* @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/).
|
|
70
70
|
*/
|
|
71
71
|
addMobileNumber({ body, platform, requestHeaders }?: UserApplicationValidator.AddMobileNumberParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyMobileOTPSuccess>;
|
|
72
72
|
/**
|
|
@@ -75,8 +75,8 @@ declare class User {
|
|
|
75
75
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
76
76
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
77
77
|
* @name deleteEmail
|
|
78
|
-
* @summary: Delete email
|
|
79
|
-
* @description:
|
|
78
|
+
* @summary: Delete email.
|
|
79
|
+
* @description: Removes an email address from the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteEmail/).
|
|
80
80
|
*/
|
|
81
81
|
deleteEmail({ active, primary, verified, email, platform, requestHeaders }?: UserApplicationValidator.DeleteEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
82
82
|
/**
|
|
@@ -105,8 +105,8 @@ declare class User {
|
|
|
105
105
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
107
107
|
* @name forgotPassword
|
|
108
|
-
* @summary: Forgot
|
|
109
|
-
* @description:
|
|
108
|
+
* @summary: Forgot password.
|
|
109
|
+
* @description: Initiates the password recovery process for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/forgotPassword/).
|
|
110
110
|
*/
|
|
111
111
|
forgotPassword({ body, requestHeaders }?: UserApplicationValidator.ForgotPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
112
112
|
/**
|
|
@@ -125,8 +125,8 @@ declare class User {
|
|
|
125
125
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
126
126
|
* @returns {Promise<UserApplicationModel.UserObjectSchema>} - Success response
|
|
127
127
|
* @name getLoggedInUser
|
|
128
|
-
* @summary:
|
|
129
|
-
* @description:
|
|
128
|
+
* @summary: Current user.
|
|
129
|
+
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getLoggedInUser/).
|
|
130
130
|
*/
|
|
131
131
|
getLoggedInUser({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserApplicationModel.UserObjectSchema>;
|
|
132
132
|
/**
|
|
@@ -135,8 +135,8 @@ declare class User {
|
|
|
135
135
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
136
136
|
* @returns {Promise<UserApplicationModel.PlatformSchema>} - Success response
|
|
137
137
|
* @name getPlatformConfig
|
|
138
|
-
* @summary:
|
|
139
|
-
* @description:
|
|
138
|
+
* @summary: Platform config.
|
|
139
|
+
* @description: Retrieve configuration settings related to the user platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getPlatformConfig/).
|
|
140
140
|
*/
|
|
141
141
|
getPlatformConfig({ name, requestHeaders }?: UserApplicationValidator.GetPlatformConfigParam, { responseHeaders }?: object): Promise<UserApplicationModel.PlatformSchema>;
|
|
142
142
|
/**
|
|
@@ -155,8 +155,8 @@ declare class User {
|
|
|
155
155
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
156
156
|
* @returns {Promise<UserApplicationModel.HasPasswordSuccess>} - Success response
|
|
157
157
|
* @name hasPassword
|
|
158
|
-
* @summary: Check password
|
|
159
|
-
* @description:
|
|
158
|
+
* @summary: Check password.
|
|
159
|
+
* @description: Checks if the user has set a password for the account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/hasPassword/).
|
|
160
160
|
*/
|
|
161
161
|
hasPassword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserApplicationModel.HasPasswordSuccess>;
|
|
162
162
|
/**
|
|
@@ -165,8 +165,8 @@ declare class User {
|
|
|
165
165
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
166
166
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
167
167
|
* @name loginWithAppleIOS
|
|
168
|
-
* @summary:
|
|
169
|
-
* @description:
|
|
168
|
+
* @summary: Apple iOS login.
|
|
169
|
+
* @description: Enables login through Apple ID specifically for iOS users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithAppleIOS/).
|
|
170
170
|
*/
|
|
171
171
|
loginWithAppleIOS({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithAppleIOSParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
172
172
|
/**
|
|
@@ -175,8 +175,8 @@ declare class User {
|
|
|
175
175
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
176
176
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
177
177
|
* @name loginWithEmailAndPassword
|
|
178
|
-
* @summary:
|
|
179
|
-
* @description:
|
|
178
|
+
* @summary: Email/password login.
|
|
179
|
+
* @description: Enables login using an email and password combination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithEmailAndPassword/).
|
|
180
180
|
*/
|
|
181
181
|
loginWithEmailAndPassword({ body, requestHeaders }?: UserApplicationValidator.LoginWithEmailAndPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
182
182
|
/**
|
|
@@ -185,8 +185,8 @@ declare class User {
|
|
|
185
185
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
186
186
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
187
187
|
* @name loginWithFacebook
|
|
188
|
-
* @summary:
|
|
189
|
-
* @description:
|
|
188
|
+
* @summary: Facebook login.
|
|
189
|
+
* @description: Enables login through Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithFacebook/).
|
|
190
190
|
*/
|
|
191
191
|
loginWithFacebook({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithFacebookParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
192
192
|
/**
|
|
@@ -195,8 +195,8 @@ declare class User {
|
|
|
195
195
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
196
196
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
197
197
|
* @name loginWithGoogle
|
|
198
|
-
* @summary:
|
|
199
|
-
* @description:
|
|
198
|
+
* @summary: Google login.
|
|
199
|
+
* @description: Enables login through Google accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogle/).
|
|
200
200
|
*/
|
|
201
201
|
loginWithGoogle({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithGoogleParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
202
202
|
/**
|
|
@@ -205,8 +205,8 @@ declare class User {
|
|
|
205
205
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
206
206
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
207
207
|
* @name loginWithGoogleAndroid
|
|
208
|
-
* @summary:
|
|
209
|
-
* @description:
|
|
208
|
+
* @summary: Android Google login.
|
|
209
|
+
* @description: Facilitates Google login specifically for Android users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleAndroid/).
|
|
210
210
|
*/
|
|
211
211
|
loginWithGoogleAndroid({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithGoogleAndroidParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
212
212
|
/**
|
|
@@ -215,8 +215,8 @@ declare class User {
|
|
|
215
215
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
216
216
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
217
217
|
* @name loginWithGoogleIOS
|
|
218
|
-
* @summary:
|
|
219
|
-
* @description:
|
|
218
|
+
* @summary: iOS Google login.
|
|
219
|
+
* @description: Facilitates Google login specifically for iOS users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleIOS/).
|
|
220
220
|
*/
|
|
221
221
|
loginWithGoogleIOS({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithGoogleIOSParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
222
222
|
/**
|
|
@@ -225,8 +225,8 @@ declare class User {
|
|
|
225
225
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
226
226
|
* @returns {Promise<UserApplicationModel.SendOtpResponse>} - Success response
|
|
227
227
|
* @name loginWithOTP
|
|
228
|
-
* @summary:
|
|
229
|
-
* @description:
|
|
228
|
+
* @summary: OTP login.
|
|
229
|
+
* @description: Allows users to log in using a one-time password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithOTP/).
|
|
230
230
|
*/
|
|
231
231
|
loginWithOTP({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendOtpResponse>;
|
|
232
232
|
/**
|
|
@@ -255,8 +255,8 @@ declare class User {
|
|
|
255
255
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
256
256
|
* @returns {Promise<UserApplicationModel.RegisterFormSuccess>} - Success response
|
|
257
257
|
* @name registerWithForm
|
|
258
|
-
* @summary:
|
|
259
|
-
* @description:
|
|
258
|
+
* @summary: User registration.
|
|
259
|
+
* @description: Enables new users to register using a form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/registerWithForm/).
|
|
260
260
|
*/
|
|
261
261
|
registerWithForm({ body, platform, requestHeaders }?: UserApplicationValidator.RegisterWithFormParam, { responseHeaders }?: object): Promise<UserApplicationModel.RegisterFormSuccess>;
|
|
262
262
|
/**
|
|
@@ -266,8 +266,8 @@ declare class User {
|
|
|
266
266
|
* @returns {Promise<UserApplicationModel.ResetForgotPasswordSuccess>} -
|
|
267
267
|
* Success response
|
|
268
268
|
* @name resetForgotPassword
|
|
269
|
-
* @summary:
|
|
270
|
-
* @description:
|
|
269
|
+
* @summary: Forgot password.
|
|
270
|
+
* @description: Initiates the password recovery process for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/resetForgotPassword/).
|
|
271
271
|
*/
|
|
272
272
|
resetForgotPassword({ body, requestHeaders }?: UserApplicationValidator.ResetForgotPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.ResetForgotPasswordSuccess>;
|
|
273
273
|
/**
|
|
@@ -276,8 +276,8 @@ declare class User {
|
|
|
276
276
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
277
277
|
* @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
|
|
278
278
|
* @name sendForgotOTPOnEmail
|
|
279
|
-
* @summary: Send Forgot OTP
|
|
280
|
-
* @description:
|
|
279
|
+
* @summary: Send Forgot OTP Email
|
|
280
|
+
* @description: Sends a one-time password to the user's forgot email for verification request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnEmail/).
|
|
281
281
|
*/
|
|
282
282
|
sendForgotOTPOnEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendForgotOTPOnEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.EmailOtpSuccess>;
|
|
283
283
|
/**
|
|
@@ -286,8 +286,8 @@ declare class User {
|
|
|
286
286
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
287
287
|
* @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
|
|
288
288
|
* @name sendForgotOTPOnMobile
|
|
289
|
-
* @summary: Send
|
|
290
|
-
* @description:
|
|
289
|
+
* @summary: Send forgot OTP on mobile
|
|
290
|
+
* @description: Sends a one-time password to the user's forgot mobile for verification request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnMobile/).
|
|
291
291
|
*/
|
|
292
292
|
sendForgotOTPOnMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendForgotOTPOnMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.OtpSuccess>;
|
|
293
293
|
/**
|
|
@@ -296,8 +296,8 @@ declare class User {
|
|
|
296
296
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
297
297
|
* @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
|
|
298
298
|
* @name sendOTPOnEmail
|
|
299
|
-
* @summary: Send OTP
|
|
300
|
-
* @description:
|
|
299
|
+
* @summary: Send email OTP.
|
|
300
|
+
* @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/).
|
|
301
301
|
*/
|
|
302
302
|
sendOTPOnEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendOTPOnEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.EmailOtpSuccess>;
|
|
303
303
|
/**
|
|
@@ -306,8 +306,8 @@ declare class User {
|
|
|
306
306
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
307
307
|
* @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
|
|
308
308
|
* @name sendOTPOnMobile
|
|
309
|
-
* @summary: Send OTP
|
|
310
|
-
* @description:
|
|
309
|
+
* @summary: Send mobile OTP.
|
|
310
|
+
* @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/).
|
|
311
311
|
*/
|
|
312
312
|
sendOTPOnMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendOTPOnMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.OtpSuccess>;
|
|
313
313
|
/**
|
|
@@ -316,8 +316,8 @@ declare class User {
|
|
|
316
316
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
317
317
|
* @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
|
|
318
318
|
* @name sendResetPasswordEmail
|
|
319
|
-
* @summary: Reset
|
|
320
|
-
* @description:
|
|
319
|
+
* @summary: Reset password (Email).
|
|
320
|
+
* @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/).
|
|
321
321
|
*/
|
|
322
322
|
sendResetPasswordEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendResetPasswordEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.ResetPasswordSuccess>;
|
|
323
323
|
/**
|
|
@@ -326,8 +326,8 @@ declare class User {
|
|
|
326
326
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
327
327
|
* @returns {Promise<any>} - Success response
|
|
328
328
|
* @name sendResetPasswordMobile
|
|
329
|
-
* @summary: Reset
|
|
330
|
-
* @description:
|
|
329
|
+
* @summary: Reset password (Mobile).
|
|
330
|
+
* @description: Sends a password reset OTP to the user's mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordMobile/).
|
|
331
331
|
*/
|
|
332
332
|
sendResetPasswordMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendResetPasswordMobileParam, { responseHeaders }?: object): Promise<any>;
|
|
333
333
|
/**
|
|
@@ -348,8 +348,8 @@ declare class User {
|
|
|
348
348
|
* @returns {Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>} -
|
|
349
349
|
* Success response
|
|
350
350
|
* @name sendVerificationLinkToEmail
|
|
351
|
-
* @summary:
|
|
352
|
-
* @description:
|
|
351
|
+
* @summary: Verify new email.
|
|
352
|
+
* @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/).
|
|
353
353
|
*/
|
|
354
354
|
sendVerificationLinkToEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendVerificationLinkToEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>;
|
|
355
355
|
/**
|
|
@@ -361,8 +361,8 @@ declare class User {
|
|
|
361
361
|
* @returns {Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>} -
|
|
362
362
|
* Success response
|
|
363
363
|
* @name sendVerificationLinkToMobile
|
|
364
|
-
* @summary:
|
|
365
|
-
* @description:
|
|
364
|
+
* @summary: Verify new mobile.
|
|
365
|
+
* @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/).
|
|
366
366
|
*/
|
|
367
367
|
sendVerificationLinkToMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendVerificationLinkToMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>;
|
|
368
368
|
/**
|
|
@@ -371,8 +371,8 @@ declare class User {
|
|
|
371
371
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
372
372
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
373
373
|
* @name setEmailAsPrimary
|
|
374
|
-
* @summary: Set email
|
|
375
|
-
* @description:
|
|
374
|
+
* @summary: Set primary email.
|
|
375
|
+
* @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/).
|
|
376
376
|
*/
|
|
377
377
|
setEmailAsPrimary({ body, requestHeaders }?: UserApplicationValidator.SetEmailAsPrimaryParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
378
378
|
/**
|
|
@@ -381,8 +381,8 @@ declare class User {
|
|
|
381
381
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
382
382
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
383
383
|
* @name setMobileNumberAsPrimary
|
|
384
|
-
* @summary: Set mobile
|
|
385
|
-
* @description:
|
|
384
|
+
* @summary: Set primary mobile.
|
|
385
|
+
* @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/).
|
|
386
386
|
*/
|
|
387
387
|
setMobileNumberAsPrimary({ body, requestHeaders }?: UserApplicationValidator.SetMobileNumberAsPrimaryParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
388
388
|
/**
|
|
@@ -391,8 +391,8 @@ declare class User {
|
|
|
391
391
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
392
392
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
393
393
|
* @name updatePassword
|
|
394
|
-
* @summary: Update
|
|
395
|
-
* @description:
|
|
394
|
+
* @summary: Update password.
|
|
395
|
+
* @description: Allows users to update their existing password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updatePassword/).
|
|
396
396
|
*/
|
|
397
397
|
updatePassword({ body, requestHeaders }?: UserApplicationValidator.UpdatePasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
398
398
|
/**
|
|
@@ -431,8 +431,8 @@ declare class User {
|
|
|
431
431
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
432
432
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
433
433
|
* @name verifyEmail
|
|
434
|
-
* @summary: Verify email
|
|
435
|
-
* @description:
|
|
434
|
+
* @summary: Verify email.
|
|
435
|
+
* @description: Verifies the user's email address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmail/).
|
|
436
436
|
*/
|
|
437
437
|
verifyEmail({ body, requestHeaders }?: UserApplicationValidator.VerifyEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
438
438
|
/**
|
|
@@ -441,8 +441,8 @@ declare class User {
|
|
|
441
441
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
442
442
|
* @returns {Promise<UserApplicationModel.VerifyForgotOtpSuccess>} - Success response
|
|
443
443
|
* @name verifyEmailForgotOTP
|
|
444
|
-
* @summary: Verify Forgot OTP
|
|
445
|
-
* @description:
|
|
444
|
+
* @summary: Verify Email Forgot OTP
|
|
445
|
+
* @description: Validates the OTP sent to the user's forgot email address request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailForgotOTP/).
|
|
446
446
|
*/
|
|
447
447
|
verifyEmailForgotOTP({ body, platform, requestHeaders }?: UserApplicationValidator.VerifyEmailForgotOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyForgotOtpSuccess>;
|
|
448
448
|
/**
|
|
@@ -451,8 +451,8 @@ declare class User {
|
|
|
451
451
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
452
452
|
* @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
|
|
453
453
|
* @name verifyEmailOTP
|
|
454
|
-
* @summary: Verify OTP
|
|
455
|
-
* @description:
|
|
454
|
+
* @summary: Verify Email OTP
|
|
455
|
+
* @description: Validates the OTP sent to the user's email address request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmailOTP/).
|
|
456
456
|
*/
|
|
457
457
|
verifyEmailOTP({ body, platform, requestHeaders }?: UserApplicationValidator.VerifyEmailOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyOtpSuccess>;
|
|
458
458
|
/**
|
|
@@ -461,8 +461,8 @@ declare class User {
|
|
|
461
461
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
462
462
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
463
463
|
* @name verifyMobile
|
|
464
|
-
* @summary: Verify mobile
|
|
465
|
-
* @description:
|
|
464
|
+
* @summary: Verify mobile.
|
|
465
|
+
* @description: Verifies the user's mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobile/).
|
|
466
466
|
*/
|
|
467
467
|
verifyMobile({ body, requestHeaders }?: UserApplicationValidator.VerifyMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
468
468
|
/**
|
|
@@ -481,8 +481,8 @@ declare class User {
|
|
|
481
481
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
482
482
|
* @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
|
|
483
483
|
* @name verifyMobileOTP
|
|
484
|
-
* @summary: Verify OTP
|
|
485
|
-
* @description:
|
|
484
|
+
* @summary: Verify mobile OTP.
|
|
485
|
+
* @description: Validates the OTP sent to the user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
|
|
486
486
|
*/
|
|
487
487
|
verifyMobileOTP({ body, platform, requestHeaders }?: UserApplicationValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyOtpSuccess>;
|
|
488
488
|
}
|