@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- 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 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- 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
|
@@ -55,7 +55,7 @@ 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
|
|
58
|
+
* @summary: Add Email to Profile
|
|
59
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>;
|
|
@@ -65,7 +65,7 @@ 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
|
|
68
|
+
* @summary: Add Mobile Number to Profile
|
|
69
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>;
|
|
@@ -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
|
|
79
|
-
* @description:
|
|
78
|
+
* @summary: Delete Email From Profile
|
|
79
|
+
* @description: Delete Email From 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
|
/**
|
|
@@ -85,8 +85,8 @@ declare class User {
|
|
|
85
85
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
86
86
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
87
87
|
* @name deleteMobileNumber
|
|
88
|
-
* @summary: Delete
|
|
89
|
-
* @description:
|
|
88
|
+
* @summary: Delete Mobile Number From Profile
|
|
89
|
+
* @description: Delete Mobile Number From Profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteMobileNumber/).
|
|
90
90
|
*/
|
|
91
91
|
deleteMobileNumber({ active, primary, verified, countryCode, phone, platform, requestHeaders, }?: UserApplicationValidator.DeleteMobileNumberParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
92
92
|
/**
|
|
@@ -95,8 +95,8 @@ declare class User {
|
|
|
95
95
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
96
96
|
* @returns {Promise<UserApplicationModel.DeleteUserSuccess>} - Success response
|
|
97
97
|
* @name deleteUser
|
|
98
|
-
* @summary:
|
|
99
|
-
* @description:
|
|
98
|
+
* @summary: Verify OTP and Delete User
|
|
99
|
+
* @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/).
|
|
100
100
|
*/
|
|
101
101
|
deleteUser({ body, requestHeaders }?: UserApplicationValidator.DeleteUserParam, { responseHeaders }?: object): Promise<UserApplicationModel.DeleteUserSuccess>;
|
|
102
102
|
/**
|
|
@@ -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:
|
|
109
|
-
* @description:
|
|
108
|
+
* @summary: Reset Password via Code and login
|
|
109
|
+
* @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/).
|
|
110
110
|
*/
|
|
111
111
|
forgotPassword({ body, requestHeaders }?: UserApplicationValidator.ForgotPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
112
112
|
/**
|
|
@@ -115,8 +115,8 @@ declare class User {
|
|
|
115
115
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
116
116
|
* @returns {Promise<UserApplicationModel.SessionListSuccess>} - Success response
|
|
117
117
|
* @name getListOfActiveSessions
|
|
118
|
-
* @summary: Get
|
|
119
|
-
* @description:
|
|
118
|
+
* @summary: Get List OF Active Sessions
|
|
119
|
+
* @description: Retrieve all active sessions of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getListOfActiveSessions/).
|
|
120
120
|
*/
|
|
121
121
|
getListOfActiveSessions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserApplicationModel.SessionListSuccess>;
|
|
122
122
|
/**
|
|
@@ -125,7 +125,7 @@ declare class User {
|
|
|
125
125
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
126
126
|
* @returns {Promise<UserApplicationModel.UserObjectSchema>} - Success response
|
|
127
127
|
* @name getLoggedInUser
|
|
128
|
-
* @summary:
|
|
128
|
+
* @summary: Get Logged in User
|
|
129
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>;
|
|
@@ -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: Platform
|
|
139
|
-
* @description: Retrieve
|
|
138
|
+
* @summary: Get Platform Configuration
|
|
139
|
+
* @description: Retrieve platform sales channel authentication configuration. - 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
|
/**
|
|
@@ -145,8 +145,8 @@ declare class User {
|
|
|
145
145
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
146
146
|
* @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
|
|
147
147
|
* @name getUserAttributes
|
|
148
|
-
* @summary: Get
|
|
149
|
-
* @description:
|
|
148
|
+
* @summary: Get User Attributes
|
|
149
|
+
* @description: Get the list of user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getUserAttributes/).
|
|
150
150
|
*/
|
|
151
151
|
getUserAttributes({ slug, requestHeaders }?: UserApplicationValidator.GetUserAttributesParam, { responseHeaders }?: object): Promise<UserApplicationModel.UserAttributes>;
|
|
152
152
|
/**
|
|
@@ -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
|
|
159
|
-
* @description:
|
|
158
|
+
* @summary: Check Password Existence
|
|
159
|
+
* @description: Check if user has set an account password - 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: Enables
|
|
168
|
+
* @summary: iOS Login with Apple
|
|
169
|
+
* @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/).
|
|
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: Email
|
|
179
|
-
* @description:
|
|
178
|
+
* @summary: Email and Password Login
|
|
179
|
+
* @description: Allows 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: Facebook
|
|
189
|
-
* @description: Enables
|
|
188
|
+
* @summary: Login with Facebook
|
|
189
|
+
* @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/).
|
|
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: Google
|
|
199
|
-
* @description: Enables
|
|
198
|
+
* @summary: Login with Google
|
|
199
|
+
* @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/).
|
|
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: Android Google
|
|
209
|
-
* @description:
|
|
208
|
+
* @summary: Android Login with Google
|
|
209
|
+
* @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/).
|
|
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: iOS Google
|
|
219
|
-
* @description:
|
|
218
|
+
* @summary: iOS Login with Google
|
|
219
|
+
* @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/).
|
|
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: OTP
|
|
229
|
-
* @description: Allows users to log in using a one-time password
|
|
228
|
+
* @summary: Login with Mobile OTP
|
|
229
|
+
* @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/).
|
|
230
230
|
*/
|
|
231
231
|
loginWithOTP({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendOtpResponse>;
|
|
232
232
|
/**
|
|
@@ -235,8 +235,8 @@ declare class User {
|
|
|
235
235
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
236
236
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
237
237
|
* @name loginWithToken
|
|
238
|
-
* @summary: Login
|
|
239
|
-
* @description:
|
|
238
|
+
* @summary: Login with Token
|
|
239
|
+
* @description: Login User using a token for authentication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithToken/).
|
|
240
240
|
*/
|
|
241
241
|
loginWithToken({ body, requestHeaders }?: UserApplicationValidator.LoginWithTokenParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
242
242
|
/**
|
|
@@ -245,8 +245,8 @@ declare class User {
|
|
|
245
245
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
246
246
|
* @returns {Promise<UserApplicationModel.LogoutSuccess>} - Success response
|
|
247
247
|
* @name logout
|
|
248
|
-
* @summary:
|
|
249
|
-
* @description:
|
|
248
|
+
* @summary: Logout Current User
|
|
249
|
+
* @description: Logout currently logged-in user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/logout/).
|
|
250
250
|
*/
|
|
251
251
|
logout({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserApplicationModel.LogoutSuccess>;
|
|
252
252
|
/**
|
|
@@ -255,7 +255,7 @@ declare class User {
|
|
|
255
255
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
256
256
|
* @returns {Promise<UserApplicationModel.RegisterFormSuccess>} - Success response
|
|
257
257
|
* @name registerWithForm
|
|
258
|
-
* @summary: User
|
|
258
|
+
* @summary: Register User with Form
|
|
259
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>;
|
|
@@ -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: Reset Password via Code
|
|
270
|
+
* @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/).
|
|
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
|
|
280
|
-
* @description: Sends a one-time password to the user's
|
|
279
|
+
* @summary: Send Email OTP for Forgot Password
|
|
280
|
+
* @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/).
|
|
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: Sends a one-time password to the user's
|
|
289
|
+
* @summary: Send mobile OTP for forgot-password
|
|
290
|
+
* @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/).
|
|
291
291
|
*/
|
|
292
292
|
sendForgotOTPOnMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendForgotOTPOnMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.OtpSuccess>;
|
|
293
293
|
/**
|
|
@@ -296,7 +296,7 @@ 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
|
|
299
|
+
* @summary: Send OTP on Email
|
|
300
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>;
|
|
@@ -306,7 +306,7 @@ 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
|
|
309
|
+
* @summary: Send OTP on Mobile
|
|
310
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>;
|
|
@@ -316,7 +316,7 @@ 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
|
|
319
|
+
* @summary: Reset Password via Email
|
|
320
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>;
|
|
@@ -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: Sends a password reset
|
|
329
|
+
* @summary: Reset Password via Mobile
|
|
330
|
+
* @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/).
|
|
331
331
|
*/
|
|
332
332
|
sendResetPasswordMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendResetPasswordMobileParam, { responseHeaders }?: object): Promise<any>;
|
|
333
333
|
/**
|
|
@@ -336,8 +336,8 @@ declare class User {
|
|
|
336
336
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
337
337
|
* @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
|
|
338
338
|
* @name sendResetToken
|
|
339
|
-
* @summary:
|
|
340
|
-
* @description:
|
|
339
|
+
* @summary: Validate Password Reset Code
|
|
340
|
+
* @description: Validate Password Reset link Code - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetToken/).
|
|
341
341
|
*/
|
|
342
342
|
sendResetToken({ body, requestHeaders }?: UserApplicationValidator.SendResetTokenParam, { responseHeaders }?: object): Promise<UserApplicationModel.ResetPasswordSuccess>;
|
|
343
343
|
/**
|
|
@@ -348,7 +348,7 @@ declare class User {
|
|
|
348
348
|
* @returns {Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>} -
|
|
349
349
|
* Success response
|
|
350
350
|
* @name sendVerificationLinkToEmail
|
|
351
|
-
* @summary:
|
|
351
|
+
* @summary: Send Verification Link to Email
|
|
352
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>;
|
|
@@ -361,7 +361,7 @@ declare class User {
|
|
|
361
361
|
* @returns {Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>} -
|
|
362
362
|
* Success response
|
|
363
363
|
* @name sendVerificationLinkToMobile
|
|
364
|
-
* @summary:
|
|
364
|
+
* @summary: Send Verification Link to Mobile
|
|
365
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>;
|
|
@@ -371,7 +371,7 @@ 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
|
|
374
|
+
* @summary: Set Email as Primary
|
|
375
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>;
|
|
@@ -381,7 +381,7 @@ 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
|
|
384
|
+
* @summary: Set Mobile as Primary
|
|
385
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>;
|
|
@@ -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: Allow user to change their 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
|
/**
|
|
@@ -401,8 +401,8 @@ declare class User {
|
|
|
401
401
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
402
402
|
* @returns {Promise<UserApplicationModel.ProfileEditSuccess>} - Success response
|
|
403
403
|
* @name updateProfile
|
|
404
|
-
* @summary: Edit Profile Details
|
|
405
|
-
* @description:
|
|
404
|
+
* @summary: Edit User Profile Details
|
|
405
|
+
* @description: Allows users to modify and update their profile details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateProfile/).
|
|
406
406
|
*/
|
|
407
407
|
updateProfile({ body, platform, requestHeaders }?: UserApplicationValidator.UpdateProfileParam, { responseHeaders }?: object): Promise<UserApplicationModel.ProfileEditSuccess>;
|
|
408
408
|
/**
|
|
@@ -411,8 +411,8 @@ declare class User {
|
|
|
411
411
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
412
412
|
* @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
|
|
413
413
|
* @name updateUserAttributes
|
|
414
|
-
* @summary: Update
|
|
415
|
-
* @description:
|
|
414
|
+
* @summary: Update User Attributes
|
|
415
|
+
* @description: Update user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateUserAttributes/).
|
|
416
416
|
*/
|
|
417
417
|
updateUserAttributes({ body, requestHeaders }?: UserApplicationValidator.UpdateUserAttributesParam, { responseHeaders }?: object): Promise<UserApplicationModel.UserAttributes>;
|
|
418
418
|
/**
|
|
@@ -421,8 +421,8 @@ declare class User {
|
|
|
421
421
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
422
422
|
* @returns {Promise<UserApplicationModel.UserExistsResponse>} - Success response
|
|
423
423
|
* @name userExists
|
|
424
|
-
* @summary:
|
|
425
|
-
* @description:
|
|
424
|
+
* @summary: Chcek User Existence
|
|
425
|
+
* @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/).
|
|
426
426
|
*/
|
|
427
427
|
userExists({ q, requestHeaders }?: UserApplicationValidator.UserExistsParam, { responseHeaders }?: object): Promise<UserApplicationModel.UserExistsResponse>;
|
|
428
428
|
/**
|
|
@@ -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
|
|
435
|
-
* @description: Verifies
|
|
434
|
+
* @summary: Verify Email with Code
|
|
435
|
+
* @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/).
|
|
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 Email Forgot
|
|
445
|
-
* @description:
|
|
444
|
+
* @summary: Verify Email OTP for Forgot Password
|
|
445
|
+
* @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/).
|
|
446
446
|
*/
|
|
447
447
|
verifyEmailForgotOTP({ body, platform, requestHeaders }?: UserApplicationValidator.VerifyEmailForgotOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyForgotOtpSuccess>;
|
|
448
448
|
/**
|
|
@@ -452,7 +452,7 @@ declare class User {
|
|
|
452
452
|
* @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
|
|
453
453
|
* @name verifyEmailOTP
|
|
454
454
|
* @summary: Verify Email OTP
|
|
455
|
-
* @description:
|
|
455
|
+
* @description: Verify one-time password sent to user's email. - 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
|
|
465
|
-
* @description: Verifies
|
|
464
|
+
* @summary: Verify Mobile with Code
|
|
465
|
+
* @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/).
|
|
466
466
|
*/
|
|
467
467
|
verifyMobile({ body, requestHeaders }?: UserApplicationValidator.VerifyMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
468
468
|
/**
|
|
@@ -471,8 +471,8 @@ declare class User {
|
|
|
471
471
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
472
472
|
* @returns {Promise<UserApplicationModel.VerifyForgotOtpSuccess>} - Success response
|
|
473
473
|
* @name verifyMobileForgotOTP
|
|
474
|
-
* @summary: Verify
|
|
475
|
-
* @description:
|
|
474
|
+
* @summary: Verify Mobile OTP for Forgot Password
|
|
475
|
+
* @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/).
|
|
476
476
|
*/
|
|
477
477
|
verifyMobileForgotOTP({ body, platform, requestHeaders }?: UserApplicationValidator.VerifyMobileForgotOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyForgotOtpSuccess>;
|
|
478
478
|
/**
|
|
@@ -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
|
|
485
|
-
* @description:
|
|
484
|
+
* @summary: Verify Mobile OTP
|
|
485
|
+
* @description: Verify one-time password sent to 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
|
}
|