@gofynd/fdk-client-javascript 3.3.3 → 3.3.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 +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -114,7 +114,7 @@ class User {
|
|
|
114
114
|
* @returns {Promise<VerifyEmailOTPSuccess>} - Success response
|
|
115
115
|
* @name addEmail
|
|
116
116
|
* @summary: Add Email to Profile
|
|
117
|
-
* @description: Add a new email address to the user's profile. - Check out [method documentation](https://
|
|
117
|
+
* @description: Add a new email address to the user's profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/addEmail/).
|
|
118
118
|
*/
|
|
119
119
|
async addEmail(
|
|
120
120
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -152,7 +152,7 @@ class User {
|
|
|
152
152
|
* @returns {Promise<VerifyMobileOTPSuccess>} - Success response
|
|
153
153
|
* @name addMobileNumber
|
|
154
154
|
* @summary: Add Mobile Number to Profile
|
|
155
|
-
* @description: Add a new mobile number to the user's profile. - Check out [method documentation](https://
|
|
155
|
+
* @description: Add a new mobile number to the user's profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/addMobileNumber/).
|
|
156
156
|
*/
|
|
157
157
|
async addMobileNumber(
|
|
158
158
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -190,7 +190,7 @@ class User {
|
|
|
190
190
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
191
191
|
* @name deleteEmail
|
|
192
192
|
* @summary: Delete Email From Profile
|
|
193
|
-
* @description: Delete email from profile. - Check out [method documentation](https://
|
|
193
|
+
* @description: Delete email from profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/deleteEmail/).
|
|
194
194
|
*/
|
|
195
195
|
async deleteEmail(
|
|
196
196
|
{ active, primary, verified, email, platform, requestHeaders } = {
|
|
@@ -234,7 +234,7 @@ class User {
|
|
|
234
234
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
235
235
|
* @name deleteMobileNumber
|
|
236
236
|
* @summary: Delete Mobile Number From Profile
|
|
237
|
-
* @description: Delete mobile number from profile. - Check out [method documentation](https://
|
|
237
|
+
* @description: Delete mobile number from profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/deleteMobileNumber/).
|
|
238
238
|
*/
|
|
239
239
|
async deleteMobileNumber(
|
|
240
240
|
{
|
|
@@ -285,7 +285,7 @@ class User {
|
|
|
285
285
|
* @returns {Promise<DeleteUserSuccess>} - Success response
|
|
286
286
|
* @name deleteUser
|
|
287
287
|
* @summary: Verify OTP and Delete User
|
|
288
|
-
* @description: Verify OTP sent to mobile/email and delete the user's account. - Check out [method documentation](https://
|
|
288
|
+
* @description: Verify OTP sent to mobile/email and delete the user's account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/deleteUser/).
|
|
289
289
|
*/
|
|
290
290
|
async deleteUser(
|
|
291
291
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -322,7 +322,7 @@ class User {
|
|
|
322
322
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
323
323
|
* @name forgotPassword
|
|
324
324
|
* @summary: Reset Password via Code and login
|
|
325
|
-
* @description: Reset a password using the code sent on email or sms the login. - Check out [method documentation](https://
|
|
325
|
+
* @description: Reset a password using the code sent on email or sms the login. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/forgotPassword/).
|
|
326
326
|
*/
|
|
327
327
|
async forgotPassword(
|
|
328
328
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -359,7 +359,7 @@ class User {
|
|
|
359
359
|
* @returns {Promise<SessionListSuccess>} - Success response
|
|
360
360
|
* @name getListOfActiveSessions
|
|
361
361
|
* @summary: Get List OF Active Sessions
|
|
362
|
-
* @description: Retrieve all active sessions of a user. - Check out [method documentation](https://
|
|
362
|
+
* @description: Retrieve all active sessions of a user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getListOfActiveSessions/).
|
|
363
363
|
*/
|
|
364
364
|
async getListOfActiveSessions(
|
|
365
365
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -396,7 +396,7 @@ class User {
|
|
|
396
396
|
* @returns {Promise<UserObjectSchema>} - Success response
|
|
397
397
|
* @name getLoggedInUser
|
|
398
398
|
* @summary: Get Logged in User
|
|
399
|
-
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://
|
|
399
|
+
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getLoggedInUser/).
|
|
400
400
|
*/
|
|
401
401
|
async getLoggedInUser(
|
|
402
402
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -433,7 +433,7 @@ class User {
|
|
|
433
433
|
* @returns {Promise<PlatformSchema>} - Success response
|
|
434
434
|
* @name getPlatformConfig
|
|
435
435
|
* @summary: Get Platform Configuration
|
|
436
|
-
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
436
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getPlatformConfig/).
|
|
437
437
|
*/
|
|
438
438
|
async getPlatformConfig(
|
|
439
439
|
{ name, requestHeaders } = { requestHeaders: {} },
|
|
@@ -471,7 +471,7 @@ class User {
|
|
|
471
471
|
* @returns {Promise<UserAttributes>} - Success response
|
|
472
472
|
* @name getUserAttributes
|
|
473
473
|
* @summary: Get User Attributes
|
|
474
|
-
* @description: Get the list of user attributes. - Check out [method documentation](https://
|
|
474
|
+
* @description: Get the list of user attributes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getUserAttributes/).
|
|
475
475
|
*/
|
|
476
476
|
async getUserAttributes(
|
|
477
477
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -509,7 +509,7 @@ class User {
|
|
|
509
509
|
* @returns {Promise<HasPasswordSuccess>} - Success response
|
|
510
510
|
* @name hasPassword
|
|
511
511
|
* @summary: Check Password Existence
|
|
512
|
-
* @description: Check if user has set an account password. - Check out [method documentation](https://
|
|
512
|
+
* @description: Check if user has set an account password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/hasPassword/).
|
|
513
513
|
*/
|
|
514
514
|
async hasPassword(
|
|
515
515
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -546,7 +546,7 @@ class User {
|
|
|
546
546
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
547
547
|
* @name loginWithAppleIOS
|
|
548
548
|
* @summary: iOS Login with Apple
|
|
549
|
-
* @description: Enable ios users to log in to the system using their apple id. - Check out [method documentation](https://
|
|
549
|
+
* @description: Enable ios users to log in to the system using their apple id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithAppleIOS/).
|
|
550
550
|
*/
|
|
551
551
|
async loginWithAppleIOS(
|
|
552
552
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -584,7 +584,7 @@ class User {
|
|
|
584
584
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
585
585
|
* @name loginWithEmailAndPassword
|
|
586
586
|
* @summary: Email and Password Login
|
|
587
|
-
* @description: Allow login using an email and password combination. - Check out [method documentation](https://
|
|
587
|
+
* @description: Allow login using an email and password combination. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithEmailAndPassword/).
|
|
588
588
|
*/
|
|
589
589
|
async loginWithEmailAndPassword(
|
|
590
590
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -621,7 +621,7 @@ class User {
|
|
|
621
621
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
622
622
|
* @name loginWithFacebook
|
|
623
623
|
* @summary: Login with Facebook
|
|
624
|
-
* @description: Enable users to log in to the system using their facebook accounts. - Check out [method documentation](https://
|
|
624
|
+
* @description: Enable users to log in to the system using their facebook accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithFacebook/).
|
|
625
625
|
*/
|
|
626
626
|
async loginWithFacebook(
|
|
627
627
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -659,7 +659,7 @@ class User {
|
|
|
659
659
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
660
660
|
* @name loginWithGoogle
|
|
661
661
|
* @summary: Login with Google
|
|
662
|
-
* @description: Enable website users to log in to the system using their google accounts. - Check out [method documentation](https://
|
|
662
|
+
* @description: Enable website users to log in to the system using their google accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithGoogle/).
|
|
663
663
|
*/
|
|
664
664
|
async loginWithGoogle(
|
|
665
665
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -697,7 +697,7 @@ class User {
|
|
|
697
697
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
698
698
|
* @name loginWithGoogleAndroid
|
|
699
699
|
* @summary: Android Login with Google
|
|
700
|
-
* @description: Enable android users to log in to the system using their facebook accounts. - Check out [method documentation](https://
|
|
700
|
+
* @description: Enable android users to log in to the system using their facebook accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithGoogleAndroid/).
|
|
701
701
|
*/
|
|
702
702
|
async loginWithGoogleAndroid(
|
|
703
703
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -735,7 +735,7 @@ class User {
|
|
|
735
735
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
736
736
|
* @name loginWithGoogleIOS
|
|
737
737
|
* @summary: iOS Login with Google
|
|
738
|
-
* @description: Enable ios users to log in to the system using their facebook accounts. - Check out [method documentation](https://
|
|
738
|
+
* @description: Enable ios users to log in to the system using their facebook accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithGoogleIOS/).
|
|
739
739
|
*/
|
|
740
740
|
async loginWithGoogleIOS(
|
|
741
741
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -773,7 +773,7 @@ class User {
|
|
|
773
773
|
* @returns {Promise<SendOtp>} - Success response
|
|
774
774
|
* @name loginWithOTP
|
|
775
775
|
* @summary: Login with Mobile OTP
|
|
776
|
-
* @description: Allow users to log in using a one-time password sent to their mobile. - Check out [method documentation](https://
|
|
776
|
+
* @description: Allow users to log in using a one-time password sent to their mobile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithOTP/).
|
|
777
777
|
*/
|
|
778
778
|
async loginWithOTP(
|
|
779
779
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -811,7 +811,7 @@ class User {
|
|
|
811
811
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
812
812
|
* @name loginWithToken
|
|
813
813
|
* @summary: Login with Token
|
|
814
|
-
* @description: Login user using a token for authentication. - Check out [method documentation](https://
|
|
814
|
+
* @description: Login user using a token for authentication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithToken/).
|
|
815
815
|
*/
|
|
816
816
|
async loginWithToken(
|
|
817
817
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -848,7 +848,7 @@ class User {
|
|
|
848
848
|
* @returns {Promise<LogoutSuccess>} - Success response
|
|
849
849
|
* @name logout
|
|
850
850
|
* @summary: Logout Current User
|
|
851
|
-
* @description: Logout currently logged-in user. - Check out [method documentation](https://
|
|
851
|
+
* @description: Logout currently logged-in user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/logout/).
|
|
852
852
|
*/
|
|
853
853
|
async logout(
|
|
854
854
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -885,7 +885,7 @@ class User {
|
|
|
885
885
|
* @returns {Promise<RegisterFormSuccess>} - Success response
|
|
886
886
|
* @name registerWithForm
|
|
887
887
|
* @summary: Register User with Form
|
|
888
|
-
* @description: Enable new users to register using a form. - Check out [method documentation](https://
|
|
888
|
+
* @description: Enable new users to register using a form. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/registerWithForm/).
|
|
889
889
|
*/
|
|
890
890
|
async registerWithForm(
|
|
891
891
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -923,7 +923,7 @@ class User {
|
|
|
923
923
|
* @returns {Promise<ResetForgotPasswordSuccess>} - Success response
|
|
924
924
|
* @name resetForgotPassword
|
|
925
925
|
* @summary: Reset Password via Code
|
|
926
|
-
* @description: Reset a password using the code sent on email or sms. - Check out [method documentation](https://
|
|
926
|
+
* @description: Reset a password using the code sent on email or sms. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/resetForgotPassword/).
|
|
927
927
|
*/
|
|
928
928
|
async resetForgotPassword(
|
|
929
929
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -960,7 +960,7 @@ class User {
|
|
|
960
960
|
* @returns {Promise<EmailOtpSuccess>} - Success response
|
|
961
961
|
* @name sendForgotOTPOnEmail
|
|
962
962
|
* @summary: Send Email OTP for Forgot Password
|
|
963
|
-
* @description: Send a one-time password to the user's email for verification when resetting a forgotten password. - Check out [method documentation](https://
|
|
963
|
+
* @description: Send a one-time password to the user's email for verification when resetting a forgotten password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendForgotOTPOnEmail/).
|
|
964
964
|
*/
|
|
965
965
|
async sendForgotOTPOnEmail(
|
|
966
966
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -998,7 +998,7 @@ class User {
|
|
|
998
998
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
999
999
|
* @name sendForgotOTPOnMobile
|
|
1000
1000
|
* @summary: Send mobile OTP for forgot-password
|
|
1001
|
-
* @description: Send a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://
|
|
1001
|
+
* @description: Send a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendForgotOTPOnMobile/).
|
|
1002
1002
|
*/
|
|
1003
1003
|
async sendForgotOTPOnMobile(
|
|
1004
1004
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1036,7 +1036,7 @@ class User {
|
|
|
1036
1036
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
1037
1037
|
* @name sendOTPForUpdate
|
|
1038
1038
|
* @summary: Send OTP to update Mobile or Email
|
|
1039
|
-
* @description: Send OTP to mobile number or email. User needs to use sendOTPOnPrimary and verifyOTPonPrimary before using this method to update details. - Check out [method documentation](https://
|
|
1039
|
+
* @description: Send OTP to mobile number or email. User needs to use sendOTPOnPrimary and verifyOTPonPrimary before using this method to update details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendOTPForUpdate/).
|
|
1040
1040
|
*/
|
|
1041
1041
|
async sendOTPForUpdate(
|
|
1042
1042
|
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1082,7 +1082,7 @@ class User {
|
|
|
1082
1082
|
* @returns {Promise<EmailOtpSuccess>} - Success response
|
|
1083
1083
|
* @name sendOTPOnEmail
|
|
1084
1084
|
* @summary: Send OTP on Email
|
|
1085
|
-
* @description: Send a one-time password to the user's email for verification. - Check out [method documentation](https://
|
|
1085
|
+
* @description: Send a one-time password to the user's email for verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendOTPOnEmail/).
|
|
1086
1086
|
*/
|
|
1087
1087
|
async sendOTPOnEmail(
|
|
1088
1088
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1120,7 +1120,7 @@ class User {
|
|
|
1120
1120
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
1121
1121
|
* @name sendOTPOnMobile
|
|
1122
1122
|
* @summary: Send OTP on Mobile
|
|
1123
|
-
* @description: Send a one-time password to the user's mobile for verification. - Check out [method documentation](https://
|
|
1123
|
+
* @description: Send a one-time password to the user's mobile for verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendOTPOnMobile/).
|
|
1124
1124
|
*/
|
|
1125
1125
|
async sendOTPOnMobile(
|
|
1126
1126
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1158,7 +1158,7 @@ class User {
|
|
|
1158
1158
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
1159
1159
|
* @name sendOTPOnPrimary
|
|
1160
1160
|
* @summary: Send OTP to Primary Mobile or Email
|
|
1161
|
-
* @description: Send OTP to primary mobile number or email to verify primary details. Use this to update Email or Mobile, other APIs will be deprecated. - Check out [method documentation](https://
|
|
1161
|
+
* @description: Send OTP to primary mobile number or email to verify primary details. Use this to update Email or Mobile, other APIs will be deprecated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendOTPOnPrimary/).
|
|
1162
1162
|
*/
|
|
1163
1163
|
async sendOTPOnPrimary(
|
|
1164
1164
|
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1204,7 +1204,7 @@ class User {
|
|
|
1204
1204
|
* @returns {Promise<ResetPasswordSuccess>} - Success response
|
|
1205
1205
|
* @name sendResetPasswordEmail
|
|
1206
1206
|
* @summary: Reset Password via Email
|
|
1207
|
-
* @description: Send a password reset link to the user's email. - Check out [method documentation](https://
|
|
1207
|
+
* @description: Send a password reset link to the user's email. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendResetPasswordEmail/).
|
|
1208
1208
|
*/
|
|
1209
1209
|
async sendResetPasswordEmail(
|
|
1210
1210
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1242,7 +1242,7 @@ class User {
|
|
|
1242
1242
|
* @returns {Promise<any>} - Success response
|
|
1243
1243
|
* @name sendResetPasswordMobile
|
|
1244
1244
|
* @summary: Reset Password via Mobile
|
|
1245
|
-
* @description: Send a password reset link to the user's mobile. - Check out [method documentation](https://
|
|
1245
|
+
* @description: Send a password reset link to the user's mobile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendResetPasswordMobile/).
|
|
1246
1246
|
*/
|
|
1247
1247
|
async sendResetPasswordMobile(
|
|
1248
1248
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1280,7 +1280,7 @@ class User {
|
|
|
1280
1280
|
* @returns {Promise<ResetPasswordSuccess>} - Success response
|
|
1281
1281
|
* @name sendResetToken
|
|
1282
1282
|
* @summary: Validate Password Reset Code
|
|
1283
|
-
* @description: Validate password reset link code. - Check out [method documentation](https://
|
|
1283
|
+
* @description: Validate password reset link code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendResetToken/).
|
|
1284
1284
|
*/
|
|
1285
1285
|
async sendResetToken(
|
|
1286
1286
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1317,7 +1317,7 @@ class User {
|
|
|
1317
1317
|
* @returns {Promise<SendEmailVerifyLinkSuccess>} - Success response
|
|
1318
1318
|
* @name sendVerificationLinkToEmail
|
|
1319
1319
|
* @summary: Send Verification Link to Email
|
|
1320
|
-
* @description: Send a verification link to a newly added email address. - Check out [method documentation](https://
|
|
1320
|
+
* @description: Send a verification link to a newly added email address. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendVerificationLinkToEmail/).
|
|
1321
1321
|
*/
|
|
1322
1322
|
async sendVerificationLinkToEmail(
|
|
1323
1323
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1355,7 +1355,7 @@ class User {
|
|
|
1355
1355
|
* @returns {Promise<SendMobileVerifyLinkSuccess>} - Success response
|
|
1356
1356
|
* @name sendVerificationLinkToMobile
|
|
1357
1357
|
* @summary: Send Verification Link to Mobile
|
|
1358
|
-
* @description: Send a verification link to a newly added mobile number. - Check out [method documentation](https://
|
|
1358
|
+
* @description: Send a verification link to a newly added mobile number. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendVerificationLinkToMobile/).
|
|
1359
1359
|
*/
|
|
1360
1360
|
async sendVerificationLinkToMobile(
|
|
1361
1361
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1393,7 +1393,7 @@ class User {
|
|
|
1393
1393
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
1394
1394
|
* @name setEmailAsPrimary
|
|
1395
1395
|
* @summary: Set Email as Primary
|
|
1396
|
-
* @description: Set an email address as the primary contact for the user. - Check out [method documentation](https://
|
|
1396
|
+
* @description: Set an email address as the primary contact for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/setEmailAsPrimary/).
|
|
1397
1397
|
*/
|
|
1398
1398
|
async setEmailAsPrimary(
|
|
1399
1399
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1430,7 +1430,7 @@ class User {
|
|
|
1430
1430
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
1431
1431
|
* @name setMobileNumberAsPrimary
|
|
1432
1432
|
* @summary: Set Mobile as Primary
|
|
1433
|
-
* @description: Set a mobile number as the primary contact for the user. - Check out [method documentation](https://
|
|
1433
|
+
* @description: Set a mobile number as the primary contact for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/setMobileNumberAsPrimary/).
|
|
1434
1434
|
*/
|
|
1435
1435
|
async setMobileNumberAsPrimary(
|
|
1436
1436
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1467,7 +1467,7 @@ class User {
|
|
|
1467
1467
|
* @returns {Promise<VerifyEmailSuccess>} - Success response
|
|
1468
1468
|
* @name updatePassword
|
|
1469
1469
|
* @summary: Update password
|
|
1470
|
-
* @description: Allow user to change their password. - Check out [method documentation](https://
|
|
1470
|
+
* @description: Allow user to change their password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/updatePassword/).
|
|
1471
1471
|
*/
|
|
1472
1472
|
async updatePassword(
|
|
1473
1473
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1504,7 +1504,7 @@ class User {
|
|
|
1504
1504
|
* @returns {Promise<ProfileEditSuccess>} - Success response
|
|
1505
1505
|
* @name updateProfile
|
|
1506
1506
|
* @summary: Edit User Profile Details
|
|
1507
|
-
* @description: Allow users to modify and update their profile details. - Check out [method documentation](https://
|
|
1507
|
+
* @description: Allow users to modify and update their profile details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/updateProfile/).
|
|
1508
1508
|
*/
|
|
1509
1509
|
async updateProfile(
|
|
1510
1510
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1542,7 +1542,7 @@ class User {
|
|
|
1542
1542
|
* @returns {Promise<UserAttributes>} - Success response
|
|
1543
1543
|
* @name updateUserAttributes
|
|
1544
1544
|
* @summary: Update User Attributes
|
|
1545
|
-
* @description: Update user attributes. - Check out [method documentation](https://
|
|
1545
|
+
* @description: Update user attributes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/updateUserAttributes/).
|
|
1546
1546
|
*/
|
|
1547
1547
|
async updateUserAttributes(
|
|
1548
1548
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1579,7 +1579,7 @@ class User {
|
|
|
1579
1579
|
* @returns {Promise<UserExistsDetails>} - Success response
|
|
1580
1580
|
* @name userExists
|
|
1581
1581
|
* @summary: Chcek User Existence
|
|
1582
|
-
* @description: Check whether user is already registered or not to the sales channel. - Check out [method documentation](https://
|
|
1582
|
+
* @description: Check whether user is already registered or not to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/userExists/).
|
|
1583
1583
|
*/
|
|
1584
1584
|
async userExists(
|
|
1585
1585
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1617,7 +1617,7 @@ class User {
|
|
|
1617
1617
|
* @returns {Promise<VerifyEmailSuccess>} - Success response
|
|
1618
1618
|
* @name verifyEmail
|
|
1619
1619
|
* @summary: Verify Email with Code
|
|
1620
|
-
* @description: Verify user email with a code sent within a link sent to their email. - Check out [method documentation](https://
|
|
1620
|
+
* @description: Verify user email with a code sent within a link sent to their email. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyEmail/).
|
|
1621
1621
|
*/
|
|
1622
1622
|
async verifyEmail(
|
|
1623
1623
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1654,7 +1654,7 @@ class User {
|
|
|
1654
1654
|
* @returns {Promise<VerifyForgotOtpSuccess>} - Success response
|
|
1655
1655
|
* @name verifyEmailForgotOTP
|
|
1656
1656
|
* @summary: Verify Email OTP for Forgot Password
|
|
1657
|
-
* @description: Verify one-time password sent to user's email for resetting a forgotten password. - Check out [method documentation](https://
|
|
1657
|
+
* @description: Verify one-time password sent to user's email for resetting a forgotten password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyEmailForgotOTP/).
|
|
1658
1658
|
*/
|
|
1659
1659
|
async verifyEmailForgotOTP(
|
|
1660
1660
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1692,7 +1692,7 @@ class User {
|
|
|
1692
1692
|
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
1693
1693
|
* @name verifyEmailOTP
|
|
1694
1694
|
* @summary: Verify Email OTP
|
|
1695
|
-
* @description: Verify one-time password sent to user's email. - Check out [method documentation](https://
|
|
1695
|
+
* @description: Verify one-time password sent to user's email. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyEmailOTP/).
|
|
1696
1696
|
*/
|
|
1697
1697
|
async verifyEmailOTP(
|
|
1698
1698
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1730,7 +1730,7 @@ class User {
|
|
|
1730
1730
|
* @returns {Promise<VerifyEmailSuccess>} - Success response
|
|
1731
1731
|
* @name verifyMobile
|
|
1732
1732
|
* @summary: Verify Mobile with Code
|
|
1733
|
-
* @description: Verify user mobile with a code sent within a link sent to their mobile. - Check out [method documentation](https://
|
|
1733
|
+
* @description: Verify user mobile with a code sent within a link sent to their mobile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyMobile/).
|
|
1734
1734
|
*/
|
|
1735
1735
|
async verifyMobile(
|
|
1736
1736
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1767,7 +1767,7 @@ class User {
|
|
|
1767
1767
|
* @returns {Promise<VerifyForgotOtpSuccess>} - Success response
|
|
1768
1768
|
* @name verifyMobileForgotOTP
|
|
1769
1769
|
* @summary: Verify Mobile OTP for Forgot Password
|
|
1770
|
-
* @description: Verify one-time password sent to user's mobile for resetting a forgotten password. - Check out [method documentation](https://
|
|
1770
|
+
* @description: Verify one-time password sent to user's mobile for resetting a forgotten password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyMobileForgotOTP/).
|
|
1771
1771
|
*/
|
|
1772
1772
|
async verifyMobileForgotOTP(
|
|
1773
1773
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1805,7 +1805,7 @@ class User {
|
|
|
1805
1805
|
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
1806
1806
|
* @name verifyMobileOTP
|
|
1807
1807
|
* @summary: Verify mobile OTP
|
|
1808
|
-
* @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://
|
|
1808
|
+
* @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyMobileOTP/).
|
|
1809
1809
|
*/
|
|
1810
1810
|
async verifyMobileOTP(
|
|
1811
1811
|
{ body, platform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1843,7 +1843,7 @@ class User {
|
|
|
1843
1843
|
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
1844
1844
|
* @name verifyOTPForUpdate
|
|
1845
1845
|
* @summary: Verify OTP sent to Mobile or Email to update primary details.
|
|
1846
|
-
* @description: Verify OTP sent to Mobile number or Email to update primary details. User needs to use sendOTPOnPrimary, verifyOTPonPrimary and sendOTPForUpdate before using this method to verify update details. - Check out [method documentation](https://
|
|
1846
|
+
* @description: Verify OTP sent to Mobile number or Email to update primary details. User needs to use sendOTPOnPrimary, verifyOTPonPrimary and sendOTPForUpdate before using this method to verify update details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyOTPForUpdate/).
|
|
1847
1847
|
*/
|
|
1848
1848
|
async verifyOTPForUpdate(
|
|
1849
1849
|
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1889,7 +1889,7 @@ class User {
|
|
|
1889
1889
|
* @returns {Promise<VerifyPrimaryOTPSuccess>} - Success response
|
|
1890
1890
|
* @name verifyOTPonPrimary
|
|
1891
1891
|
* @summary: Verify OTP sent to Primary Mobile or Email
|
|
1892
|
-
* @description: Verify OTP sent to primary mobile number or email to verify primary details. User needs to use sendOTPOnPrimary before verifying OTP. - Check out [method documentation](https://
|
|
1892
|
+
* @description: Verify OTP sent to primary mobile number or email to verify primary details. User needs to use sendOTPOnPrimary before verifying OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyOTPonPrimary/).
|
|
1893
1893
|
*/
|
|
1894
1894
|
async verifyOTPonPrimary(
|
|
1895
1895
|
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -13,7 +13,7 @@ declare class Webhook {
|
|
|
13
13
|
* @returns {Promise<ClickEventDetails>} - Success response
|
|
14
14
|
* @name saveClickEvent
|
|
15
15
|
* @summary: Capture and save click events from various sales channels
|
|
16
|
-
* @description: Send click events from various sales channels to enable insightful data collection and analysis. - Check out [method documentation](https://
|
|
16
|
+
* @description: Send click events from various sales channels to enable insightful data collection and analysis. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/webhook/saveClickEvent/).
|
|
17
17
|
*/
|
|
18
18
|
saveClickEvent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ClickEventDetails>;
|
|
19
19
|
}
|
|
@@ -37,7 +37,7 @@ class Webhook {
|
|
|
37
37
|
* @returns {Promise<ClickEventDetails>} - Success response
|
|
38
38
|
* @name saveClickEvent
|
|
39
39
|
* @summary: Capture and save click events from various sales channels
|
|
40
|
-
* @description: Send click events from various sales channels to enable insightful data collection and analysis. - Check out [method documentation](https://
|
|
40
|
+
* @description: Send click events from various sales channels to enable insightful data collection and analysis. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/webhook/saveClickEvent/).
|
|
41
41
|
*/
|
|
42
42
|
async saveClickEvent(
|
|
43
43
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -27,7 +27,7 @@ declare class FileStorage {
|
|
|
27
27
|
* ### Complete
|
|
28
28
|
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
29
29
|
* This operation will return the url for the uploaded file.
|
|
30
|
-
* - Check out [method documentation](https://
|
|
30
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/completeUpload/).
|
|
31
31
|
*/
|
|
32
32
|
completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUploadComplete>;
|
|
33
33
|
/**
|
|
@@ -55,7 +55,7 @@ declare class FileStorage {
|
|
|
55
55
|
* ### Complete
|
|
56
56
|
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
57
57
|
* This operation will return the url for the uploaded file.
|
|
58
|
-
* - Check out [method documentation](https://
|
|
58
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/startUpload/).
|
|
59
59
|
*/
|
|
60
60
|
startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUpload>;
|
|
61
61
|
/**
|
|
@@ -65,7 +65,7 @@ declare class FileStorage {
|
|
|
65
65
|
* @returns {Promise<Object>} - Success response
|
|
66
66
|
* @name browseFiles
|
|
67
67
|
* @summary: Browse Files
|
|
68
|
-
* @description: Browse Files - Check out [method documentation](https://
|
|
68
|
+
* @description: Browse Files - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/browseFiles/).
|
|
69
69
|
*/
|
|
70
70
|
browseFiles({ namespace, page, limit, requestHeaders }?: FileStoragePartnerValidator.BrowseFilesParam, { responseHeaders }?: object): Promise<any>;
|
|
71
71
|
/**
|
|
@@ -75,7 +75,7 @@ declare class FileStorage {
|
|
|
75
75
|
* @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
|
|
76
76
|
* @name fetchProxy
|
|
77
77
|
* @summary: Proxy
|
|
78
|
-
* @description: Proxy - Check out [method documentation](https://
|
|
78
|
+
* @description: Proxy - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/fetchProxy/).
|
|
79
79
|
*/
|
|
80
80
|
fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyDetails>;
|
|
81
81
|
/**
|
|
@@ -85,7 +85,7 @@ declare class FileStorage {
|
|
|
85
85
|
* @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
|
|
86
86
|
* @name saveProxyDetails
|
|
87
87
|
* @summary: Proxy
|
|
88
|
-
* @description: Proxy - Check out [method documentation](https://
|
|
88
|
+
* @description: Proxy - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/saveProxyDetails/).
|
|
89
89
|
*/
|
|
90
90
|
saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
|
|
91
91
|
/**
|
|
@@ -95,7 +95,7 @@ declare class FileStorage {
|
|
|
95
95
|
* @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
|
|
96
96
|
* @name signUrls
|
|
97
97
|
* @summary: Get signed URLs.
|
|
98
|
-
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://
|
|
98
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/signUrls/).
|
|
99
99
|
*/
|
|
100
100
|
signUrls({ body, requestHeaders }?: FileStoragePartnerValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SignUrlResult>;
|
|
101
101
|
}
|
|
@@ -39,7 +39,7 @@ class FileStorage {
|
|
|
39
39
|
* ### Complete
|
|
40
40
|
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
41
41
|
* This operation will return the url for the uploaded file.
|
|
42
|
-
* - Check out [method documentation](https://
|
|
42
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/completeUpload/).
|
|
43
43
|
*/
|
|
44
44
|
async completeUpload(
|
|
45
45
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -137,7 +137,7 @@ class FileStorage {
|
|
|
137
137
|
* ### Complete
|
|
138
138
|
* After successfully upload, call `completeUpload` api to complete the upload process.
|
|
139
139
|
* This operation will return the url for the uploaded file.
|
|
140
|
-
* - Check out [method documentation](https://
|
|
140
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/startUpload/).
|
|
141
141
|
*/
|
|
142
142
|
async startUpload(
|
|
143
143
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -217,7 +217,7 @@ class FileStorage {
|
|
|
217
217
|
* @returns {Promise<Object>} - Success response
|
|
218
218
|
* @name browseFiles
|
|
219
219
|
* @summary: Browse Files
|
|
220
|
-
* @description: Browse Files - Check out [method documentation](https://
|
|
220
|
+
* @description: Browse Files - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/browseFiles/).
|
|
221
221
|
*/
|
|
222
222
|
async browseFiles(
|
|
223
223
|
{ namespace, page, limit, requestHeaders } = { requestHeaders: {} },
|
|
@@ -299,7 +299,7 @@ class FileStorage {
|
|
|
299
299
|
* @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
|
|
300
300
|
* @name fetchProxy
|
|
301
301
|
* @summary: Proxy
|
|
302
|
-
* @description: Proxy - Check out [method documentation](https://
|
|
302
|
+
* @description: Proxy - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/fetchProxy/).
|
|
303
303
|
*/
|
|
304
304
|
async fetchProxy(
|
|
305
305
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -377,7 +377,7 @@ class FileStorage {
|
|
|
377
377
|
* @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
|
|
378
378
|
* @name saveProxyDetails
|
|
379
379
|
* @summary: Proxy
|
|
380
|
-
* @description: Proxy - Check out [method documentation](https://
|
|
380
|
+
* @description: Proxy - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/saveProxyDetails/).
|
|
381
381
|
*/
|
|
382
382
|
async saveProxyDetails(
|
|
383
383
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -454,7 +454,7 @@ class FileStorage {
|
|
|
454
454
|
* @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
|
|
455
455
|
* @name signUrls
|
|
456
456
|
* @summary: Get signed URLs.
|
|
457
|
-
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://
|
|
457
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/filestorage/signUrls/).
|
|
458
458
|
*/
|
|
459
459
|
async signUrls(
|
|
460
460
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -9,7 +9,7 @@ declare class Lead {
|
|
|
9
9
|
* @returns {Promise<LeadPartnerModel.TicketList>} - Success response
|
|
10
10
|
* @name getTickets
|
|
11
11
|
* @summary: Gets the list of partner level tickets and/or ticket filters depending on query params
|
|
12
|
-
* @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://
|
|
12
|
+
* @description: Gets the list of partner level tickets and/or ticket filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTickets/).
|
|
13
13
|
*/
|
|
14
14
|
getTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPartnerValidator.GetTicketsParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketList>;
|
|
15
15
|
/**
|
|
@@ -44,7 +44,7 @@ declare class Lead {
|
|
|
44
44
|
* @returns {Promise<LeadPartnerModel.Ticket>} - Success response
|
|
45
45
|
* @name createTicket
|
|
46
46
|
* @summary: Creates a partner level ticket
|
|
47
|
-
* @description: Creates a partner level ticket - Check out [method documentation](https://
|
|
47
|
+
* @description: Creates a partner level ticket - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/createTicket/).
|
|
48
48
|
*/
|
|
49
49
|
createTicket({ body, requestHeaders }?: LeadPartnerValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
|
|
50
50
|
/**
|
|
@@ -54,7 +54,7 @@ declare class Lead {
|
|
|
54
54
|
* @returns {Promise<LeadPartnerModel.Ticket>} - Success response
|
|
55
55
|
* @name getTicket
|
|
56
56
|
* @summary: Retreives ticket details of a partner level ticket with ticket ID
|
|
57
|
-
* @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://
|
|
57
|
+
* @description: Retreives ticket details of a partner level ticket - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTicket/).
|
|
58
58
|
*/
|
|
59
59
|
getTicket({ id, requestHeaders }?: LeadPartnerValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
|
|
60
60
|
/**
|
|
@@ -64,7 +64,7 @@ declare class Lead {
|
|
|
64
64
|
* @returns {Promise<LeadPartnerModel.Ticket>} - Success response
|
|
65
65
|
* @name editTicket
|
|
66
66
|
* @summary: Edits ticket details of a partner level ticket
|
|
67
|
-
* @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://
|
|
67
|
+
* @description: Edits ticket details of a partner level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/editTicket/).
|
|
68
68
|
*/
|
|
69
69
|
editTicket({ id, body, requestHeaders }?: LeadPartnerValidator.EditTicketParam, { responseHeaders }?: object): Promise<LeadPartnerModel.Ticket>;
|
|
70
70
|
/**
|
|
@@ -74,7 +74,7 @@ declare class Lead {
|
|
|
74
74
|
* @returns {Promise<LeadPartnerModel.TicketHistory>} - Success response
|
|
75
75
|
* @name createHistory
|
|
76
76
|
* @summary: Create history for specific partner level ticket
|
|
77
|
-
* @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://
|
|
77
|
+
* @description: Create history for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/createHistory/).
|
|
78
78
|
*/
|
|
79
79
|
createHistory({ id, body, requestHeaders }?: LeadPartnerValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistory>;
|
|
80
80
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Lead {
|
|
|
84
84
|
* @returns {Promise<LeadPartnerModel.TicketHistoryList>} - Success response
|
|
85
85
|
* @name getTicketHistory
|
|
86
86
|
* @summary: Gets history list for specific partner level ticket
|
|
87
|
-
* @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://
|
|
87
|
+
* @description: Gets history list for specific partner level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getTicketHistory/).
|
|
88
88
|
*/
|
|
89
89
|
getTicketHistory({ id, requestHeaders }?: LeadPartnerValidator.GetTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPartnerModel.TicketHistoryList>;
|
|
90
90
|
/**
|
|
@@ -94,7 +94,7 @@ declare class Lead {
|
|
|
94
94
|
* @returns {Promise<LeadPartnerModel.GeneralConfigDetails>} - Success response
|
|
95
95
|
* @name getGeneralConfig
|
|
96
96
|
* @summary: Get general support configuration
|
|
97
|
-
* @description: Get general support configuration. - Check out [method documentation](https://
|
|
97
|
+
* @description: Get general support configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/lead/getGeneralConfig/).
|
|
98
98
|
*/
|
|
99
99
|
getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigDetails>;
|
|
100
100
|
}
|