@gofynd/fdk-client-javascript 3.3.5 → 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 +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -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 +41 -3
- package/sdk/platform/Cart/CartPlatformModel.js +24 -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 +77 -77
- package/sdk/platform/Catalog/CatalogPlatformClient.js +77 -77
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +56 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +40 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
- 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 +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -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 +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1 -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
|
@@ -46,7 +46,7 @@ class Share {
|
|
|
46
46
|
* @returns {Promise<ShortLinkRes>} - Success response
|
|
47
47
|
* @name createShortLink
|
|
48
48
|
* @summary: Shorten URL
|
|
49
|
-
* @description: Creates a shortened version of a given URL for easier sharing. - Check out [method documentation](https://
|
|
49
|
+
* @description: Creates a shortened version of a given URL for easier sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/createShortLink/).
|
|
50
50
|
*/
|
|
51
51
|
async createShortLink(
|
|
52
52
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -83,7 +83,7 @@ class Share {
|
|
|
83
83
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
84
84
|
* @name getApplicationQRCode
|
|
85
85
|
* @summary: App QR code
|
|
86
|
-
* @description: Generates a QR code for the application for easy sharing. - Check out [method documentation](https://
|
|
86
|
+
* @description: Generates a QR code for the application for easy sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getApplicationQRCode/).
|
|
87
87
|
*/
|
|
88
88
|
async getApplicationQRCode(
|
|
89
89
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -120,7 +120,7 @@ class Share {
|
|
|
120
120
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
121
121
|
* @name getCollectionQRCodeBySlug
|
|
122
122
|
* @summary: Collection QR code
|
|
123
|
-
* @description: Generates a QR code for a specific product collection using its slug. - Check out [method documentation](https://
|
|
123
|
+
* @description: Generates a QR code for a specific product collection using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getCollectionQRCodeBySlug/).
|
|
124
124
|
*/
|
|
125
125
|
async getCollectionQRCodeBySlug(
|
|
126
126
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -166,7 +166,7 @@ class Share {
|
|
|
166
166
|
* @returns {Promise<ShortLinkRes>} - Success response
|
|
167
167
|
* @name getOriginalShortLinkByHash
|
|
168
168
|
* @summary: Original URL
|
|
169
|
-
* @description: Retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://
|
|
169
|
+
* @description: Retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getOriginalShortLinkByHash/).
|
|
170
170
|
*/
|
|
171
171
|
async getOriginalShortLinkByHash(
|
|
172
172
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -212,7 +212,7 @@ class Share {
|
|
|
212
212
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
213
213
|
* @name getProductQRCodeBySlug
|
|
214
214
|
* @summary: Product QR code
|
|
215
|
-
* @description: Creates a QR code for a specific product identified by its slug. - Check out [method documentation](https://
|
|
215
|
+
* @description: Creates a QR code for a specific product identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getProductQRCodeBySlug/).
|
|
216
216
|
*/
|
|
217
217
|
async getProductQRCodeBySlug(
|
|
218
218
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -258,7 +258,7 @@ class Share {
|
|
|
258
258
|
* @returns {Promise<ShortLinkRes>} - Success response
|
|
259
259
|
* @name getShortLinkByHash
|
|
260
260
|
* @summary: Get short link
|
|
261
|
-
* @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://
|
|
261
|
+
* @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getShortLinkByHash/).
|
|
262
262
|
*/
|
|
263
263
|
async getShortLinkByHash(
|
|
264
264
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -304,7 +304,7 @@ class Share {
|
|
|
304
304
|
* @returns {Promise<QRCodeResp>} - Success response
|
|
305
305
|
* @name getUrlQRCode
|
|
306
306
|
* @summary: URL to QR code
|
|
307
|
-
* @description: Converts a given URL into a scannable QR code. - Check out [method documentation](https://
|
|
307
|
+
* @description: Converts a given URL into a scannable QR code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/share/getUrlQRCode/).
|
|
308
308
|
*/
|
|
309
309
|
async getUrlQRCode(
|
|
310
310
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -16,7 +16,7 @@ declare class Theme {
|
|
|
16
16
|
* @returns {Promise<AllAvailablePageSchema>} - Success response
|
|
17
17
|
* @name getAllPages
|
|
18
18
|
* @summary: List pages
|
|
19
|
-
* @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://
|
|
19
|
+
* @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getAllPages/).
|
|
20
20
|
*/
|
|
21
21
|
getAllPages({ themeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<AllAvailablePageSchema>;
|
|
22
22
|
/**
|
|
@@ -25,7 +25,7 @@ declare class Theme {
|
|
|
25
25
|
* @returns {Promise<ThemesSchema>} - Success response
|
|
26
26
|
* @name getAppliedTheme
|
|
27
27
|
* @summary: Get applied theme
|
|
28
|
-
* @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://
|
|
28
|
+
* @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getAppliedTheme/).
|
|
29
29
|
*/
|
|
30
30
|
getAppliedTheme({ filters, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ThemesSchema>;
|
|
31
31
|
/**
|
|
@@ -34,7 +34,7 @@ declare class Theme {
|
|
|
34
34
|
* @returns {Promise<AvailablePageSchema>} - Success response
|
|
35
35
|
* @name getPage
|
|
36
36
|
* @summary: Get theme page
|
|
37
|
-
* @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://
|
|
37
|
+
* @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getPage/).
|
|
38
38
|
*/
|
|
39
39
|
getPage({ themeId, pageValue, filters, sectionPreviewHash, company, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<AvailablePageSchema>;
|
|
40
40
|
/**
|
|
@@ -43,7 +43,7 @@ declare class Theme {
|
|
|
43
43
|
* @returns {Promise<ThemesSchema>} - Success response
|
|
44
44
|
* @name getThemeForPreview
|
|
45
45
|
* @summary: Get theme for preview
|
|
46
|
-
* @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://
|
|
46
|
+
* @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getThemeForPreview/).
|
|
47
47
|
*/
|
|
48
48
|
getThemeForPreview({ themeId, filters, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ThemesSchema>;
|
|
49
49
|
}
|
|
@@ -39,7 +39,7 @@ class Theme {
|
|
|
39
39
|
* @returns {Promise<AllAvailablePageSchema>} - Success response
|
|
40
40
|
* @name getAllPages
|
|
41
41
|
* @summary: List pages
|
|
42
|
-
* @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://
|
|
42
|
+
* @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getAllPages/).
|
|
43
43
|
*/
|
|
44
44
|
async getAllPages(
|
|
45
45
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -85,7 +85,7 @@ class Theme {
|
|
|
85
85
|
* @returns {Promise<ThemesSchema>} - Success response
|
|
86
86
|
* @name getAppliedTheme
|
|
87
87
|
* @summary: Get applied theme
|
|
88
|
-
* @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://
|
|
88
|
+
* @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getAppliedTheme/).
|
|
89
89
|
*/
|
|
90
90
|
async getAppliedTheme(
|
|
91
91
|
{ filters, requestHeaders } = { requestHeaders: {} },
|
|
@@ -123,7 +123,7 @@ class Theme {
|
|
|
123
123
|
* @returns {Promise<AvailablePageSchema>} - Success response
|
|
124
124
|
* @name getPage
|
|
125
125
|
* @summary: Get theme page
|
|
126
|
-
* @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://
|
|
126
|
+
* @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getPage/).
|
|
127
127
|
*/
|
|
128
128
|
async getPage(
|
|
129
129
|
{
|
|
@@ -182,7 +182,7 @@ class Theme {
|
|
|
182
182
|
* @returns {Promise<ThemesSchema>} - Success response
|
|
183
183
|
* @name getThemeForPreview
|
|
184
184
|
* @summary: Get theme for preview
|
|
185
|
-
* @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://
|
|
185
|
+
* @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/theme/getThemeForPreview/).
|
|
186
186
|
*/
|
|
187
187
|
async getThemeForPreview(
|
|
188
188
|
{ themeId, filters, requestHeaders } = { requestHeaders: {} },
|
|
@@ -59,7 +59,7 @@ declare class User {
|
|
|
59
59
|
* @returns {Promise<VerifyEmailOTPSuccess>} - Success response
|
|
60
60
|
* @name addEmail
|
|
61
61
|
* @summary: Add Email to Profile
|
|
62
|
-
* @description: Add a new email address to the user's profile. - Check out [method documentation](https://
|
|
62
|
+
* @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/).
|
|
63
63
|
*/
|
|
64
64
|
addEmail({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyEmailOTPSuccess>;
|
|
65
65
|
/**
|
|
@@ -68,7 +68,7 @@ declare class User {
|
|
|
68
68
|
* @returns {Promise<VerifyMobileOTPSuccess>} - Success response
|
|
69
69
|
* @name addMobileNumber
|
|
70
70
|
* @summary: Add Mobile Number to Profile
|
|
71
|
-
* @description: Add a new mobile number to the user's profile. - Check out [method documentation](https://
|
|
71
|
+
* @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/).
|
|
72
72
|
*/
|
|
73
73
|
addMobileNumber({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyMobileOTPSuccess>;
|
|
74
74
|
/**
|
|
@@ -77,7 +77,7 @@ declare class User {
|
|
|
77
77
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
78
78
|
* @name deleteEmail
|
|
79
79
|
* @summary: Delete Email From Profile
|
|
80
|
-
* @description: Delete email from profile. - Check out [method documentation](https://
|
|
80
|
+
* @description: Delete email from profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/deleteEmail/).
|
|
81
81
|
*/
|
|
82
82
|
deleteEmail({ active, primary, verified, email, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
83
83
|
/**
|
|
@@ -86,7 +86,7 @@ declare class User {
|
|
|
86
86
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
87
87
|
* @name deleteMobileNumber
|
|
88
88
|
* @summary: Delete Mobile Number From Profile
|
|
89
|
-
* @description: Delete mobile number from profile. - Check out [method documentation](https://
|
|
89
|
+
* @description: Delete mobile number from profile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/deleteMobileNumber/).
|
|
90
90
|
*/
|
|
91
91
|
deleteMobileNumber({ active, primary, verified, countryCode, phone, platform, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
92
92
|
/**
|
|
@@ -95,7 +95,7 @@ declare class User {
|
|
|
95
95
|
* @returns {Promise<DeleteUserSuccess>} - Success response
|
|
96
96
|
* @name deleteUser
|
|
97
97
|
* @summary: Verify OTP and Delete User
|
|
98
|
-
* @description: Verify OTP sent to mobile/email and delete the user's account. - Check out [method documentation](https://
|
|
98
|
+
* @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/).
|
|
99
99
|
*/
|
|
100
100
|
deleteUser({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DeleteUserSuccess>;
|
|
101
101
|
/**
|
|
@@ -104,7 +104,7 @@ declare class User {
|
|
|
104
104
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
105
105
|
* @name forgotPassword
|
|
106
106
|
* @summary: Reset Password via Code and login
|
|
107
|
-
* @description: Reset a password using the code sent on email or sms the login. - Check out [method documentation](https://
|
|
107
|
+
* @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/).
|
|
108
108
|
*/
|
|
109
109
|
forgotPassword({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
110
110
|
/**
|
|
@@ -113,7 +113,7 @@ declare class User {
|
|
|
113
113
|
* @returns {Promise<SessionListSuccess>} - Success response
|
|
114
114
|
* @name getListOfActiveSessions
|
|
115
115
|
* @summary: Get List OF Active Sessions
|
|
116
|
-
* @description: Retrieve all active sessions of a user. - Check out [method documentation](https://
|
|
116
|
+
* @description: Retrieve all active sessions of a user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getListOfActiveSessions/).
|
|
117
117
|
*/
|
|
118
118
|
getListOfActiveSessions({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SessionListSuccess>;
|
|
119
119
|
/**
|
|
@@ -122,7 +122,7 @@ declare class User {
|
|
|
122
122
|
* @returns {Promise<UserObjectSchema>} - Success response
|
|
123
123
|
* @name getLoggedInUser
|
|
124
124
|
* @summary: Get Logged in User
|
|
125
|
-
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://
|
|
125
|
+
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getLoggedInUser/).
|
|
126
126
|
*/
|
|
127
127
|
getLoggedInUser({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserObjectSchema>;
|
|
128
128
|
/**
|
|
@@ -131,7 +131,7 @@ declare class User {
|
|
|
131
131
|
* @returns {Promise<PlatformSchema>} - Success response
|
|
132
132
|
* @name getPlatformConfig
|
|
133
133
|
* @summary: Get Platform Configuration
|
|
134
|
-
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://
|
|
134
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getPlatformConfig/).
|
|
135
135
|
*/
|
|
136
136
|
getPlatformConfig({ name, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PlatformSchema>;
|
|
137
137
|
/**
|
|
@@ -140,7 +140,7 @@ declare class User {
|
|
|
140
140
|
* @returns {Promise<UserAttributes>} - Success response
|
|
141
141
|
* @name getUserAttributes
|
|
142
142
|
* @summary: Get User Attributes
|
|
143
|
-
* @description: Get the list of user attributes. - Check out [method documentation](https://
|
|
143
|
+
* @description: Get the list of user attributes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/getUserAttributes/).
|
|
144
144
|
*/
|
|
145
145
|
getUserAttributes({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserAttributes>;
|
|
146
146
|
/**
|
|
@@ -149,7 +149,7 @@ declare class User {
|
|
|
149
149
|
* @returns {Promise<HasPasswordSuccess>} - Success response
|
|
150
150
|
* @name hasPassword
|
|
151
151
|
* @summary: Check Password Existence
|
|
152
|
-
* @description: Check if user has set an account password. - Check out [method documentation](https://
|
|
152
|
+
* @description: Check if user has set an account password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/hasPassword/).
|
|
153
153
|
*/
|
|
154
154
|
hasPassword({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HasPasswordSuccess>;
|
|
155
155
|
/**
|
|
@@ -158,7 +158,7 @@ declare class User {
|
|
|
158
158
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
159
159
|
* @name loginWithAppleIOS
|
|
160
160
|
* @summary: iOS Login with Apple
|
|
161
|
-
* @description: Enable ios users to log in to the system using their apple id. - Check out [method documentation](https://
|
|
161
|
+
* @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/).
|
|
162
162
|
*/
|
|
163
163
|
loginWithAppleIOS({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AuthSuccess>;
|
|
164
164
|
/**
|
|
@@ -167,7 +167,7 @@ declare class User {
|
|
|
167
167
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
168
168
|
* @name loginWithEmailAndPassword
|
|
169
169
|
* @summary: Email and Password Login
|
|
170
|
-
* @description: Allow login using an email and password combination. - Check out [method documentation](https://
|
|
170
|
+
* @description: Allow login using an email and password combination. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithEmailAndPassword/).
|
|
171
171
|
*/
|
|
172
172
|
loginWithEmailAndPassword({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
173
173
|
/**
|
|
@@ -176,7 +176,7 @@ declare class User {
|
|
|
176
176
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
177
177
|
* @name loginWithFacebook
|
|
178
178
|
* @summary: Login with Facebook
|
|
179
|
-
* @description: Enable users to log in to the system using their facebook accounts. - Check out [method documentation](https://
|
|
179
|
+
* @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/).
|
|
180
180
|
*/
|
|
181
181
|
loginWithFacebook({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AuthSuccess>;
|
|
182
182
|
/**
|
|
@@ -185,7 +185,7 @@ declare class User {
|
|
|
185
185
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
186
186
|
* @name loginWithGoogle
|
|
187
187
|
* @summary: Login with Google
|
|
188
|
-
* @description: Enable website users to log in to the system using their google accounts. - Check out [method documentation](https://
|
|
188
|
+
* @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/).
|
|
189
189
|
*/
|
|
190
190
|
loginWithGoogle({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AuthSuccess>;
|
|
191
191
|
/**
|
|
@@ -194,7 +194,7 @@ declare class User {
|
|
|
194
194
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
195
195
|
* @name loginWithGoogleAndroid
|
|
196
196
|
* @summary: Android Login with Google
|
|
197
|
-
* @description: Enable android users to log in to the system using their facebook accounts. - Check out [method documentation](https://
|
|
197
|
+
* @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/).
|
|
198
198
|
*/
|
|
199
199
|
loginWithGoogleAndroid({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AuthSuccess>;
|
|
200
200
|
/**
|
|
@@ -203,7 +203,7 @@ declare class User {
|
|
|
203
203
|
* @returns {Promise<AuthSuccess>} - Success response
|
|
204
204
|
* @name loginWithGoogleIOS
|
|
205
205
|
* @summary: iOS Login with Google
|
|
206
|
-
* @description: Enable ios users to log in to the system using their facebook accounts. - Check out [method documentation](https://
|
|
206
|
+
* @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/).
|
|
207
207
|
*/
|
|
208
208
|
loginWithGoogleIOS({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AuthSuccess>;
|
|
209
209
|
/**
|
|
@@ -212,7 +212,7 @@ declare class User {
|
|
|
212
212
|
* @returns {Promise<SendOtp>} - Success response
|
|
213
213
|
* @name loginWithOTP
|
|
214
214
|
* @summary: Login with Mobile OTP
|
|
215
|
-
* @description: Allow users to log in using a one-time password sent to their mobile. - Check out [method documentation](https://
|
|
215
|
+
* @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/).
|
|
216
216
|
*/
|
|
217
217
|
loginWithOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtp>;
|
|
218
218
|
/**
|
|
@@ -221,7 +221,7 @@ declare class User {
|
|
|
221
221
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
222
222
|
* @name loginWithToken
|
|
223
223
|
* @summary: Login with Token
|
|
224
|
-
* @description: Login user using a token for authentication. - Check out [method documentation](https://
|
|
224
|
+
* @description: Login user using a token for authentication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/loginWithToken/).
|
|
225
225
|
*/
|
|
226
226
|
loginWithToken({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
227
227
|
/**
|
|
@@ -230,7 +230,7 @@ declare class User {
|
|
|
230
230
|
* @returns {Promise<LogoutSuccess>} - Success response
|
|
231
231
|
* @name logout
|
|
232
232
|
* @summary: Logout Current User
|
|
233
|
-
* @description: Logout currently logged-in user. - Check out [method documentation](https://
|
|
233
|
+
* @description: Logout currently logged-in user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/logout/).
|
|
234
234
|
*/
|
|
235
235
|
logout({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LogoutSuccess>;
|
|
236
236
|
/**
|
|
@@ -239,7 +239,7 @@ declare class User {
|
|
|
239
239
|
* @returns {Promise<RegisterFormSuccess>} - Success response
|
|
240
240
|
* @name registerWithForm
|
|
241
241
|
* @summary: Register User with Form
|
|
242
|
-
* @description: Enable new users to register using a form. - Check out [method documentation](https://
|
|
242
|
+
* @description: Enable new users to register using a form. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/registerWithForm/).
|
|
243
243
|
*/
|
|
244
244
|
registerWithForm({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RegisterFormSuccess>;
|
|
245
245
|
/**
|
|
@@ -248,7 +248,7 @@ declare class User {
|
|
|
248
248
|
* @returns {Promise<ResetForgotPasswordSuccess>} - Success response
|
|
249
249
|
* @name resetForgotPassword
|
|
250
250
|
* @summary: Reset Password via Code
|
|
251
|
-
* @description: Reset a password using the code sent on email or sms. - Check out [method documentation](https://
|
|
251
|
+
* @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/).
|
|
252
252
|
*/
|
|
253
253
|
resetForgotPassword({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ResetForgotPasswordSuccess>;
|
|
254
254
|
/**
|
|
@@ -257,7 +257,7 @@ declare class User {
|
|
|
257
257
|
* @returns {Promise<EmailOtpSuccess>} - Success response
|
|
258
258
|
* @name sendForgotOTPOnEmail
|
|
259
259
|
* @summary: Send Email OTP for Forgot Password
|
|
260
|
-
* @description: Send a one-time password to the user's email for verification when resetting a forgotten password. - Check out [method documentation](https://
|
|
260
|
+
* @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/).
|
|
261
261
|
*/
|
|
262
262
|
sendForgotOTPOnEmail({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<EmailOtpSuccess>;
|
|
263
263
|
/**
|
|
@@ -266,7 +266,7 @@ declare class User {
|
|
|
266
266
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
267
267
|
* @name sendForgotOTPOnMobile
|
|
268
268
|
* @summary: Send mobile OTP for forgot-password
|
|
269
|
-
* @description: Send a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://
|
|
269
|
+
* @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/).
|
|
270
270
|
*/
|
|
271
271
|
sendForgotOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpSuccess>;
|
|
272
272
|
/**
|
|
@@ -275,7 +275,7 @@ declare class User {
|
|
|
275
275
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
276
276
|
* @name sendOTPForUpdate
|
|
277
277
|
* @summary: Send OTP to update Mobile or Email
|
|
278
|
-
* @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://
|
|
278
|
+
* @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/).
|
|
279
279
|
*/
|
|
280
280
|
sendOTPForUpdate({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpSuccess>;
|
|
281
281
|
/**
|
|
@@ -284,7 +284,7 @@ declare class User {
|
|
|
284
284
|
* @returns {Promise<EmailOtpSuccess>} - Success response
|
|
285
285
|
* @name sendOTPOnEmail
|
|
286
286
|
* @summary: Send OTP on Email
|
|
287
|
-
* @description: Send a one-time password to the user's email for verification. - Check out [method documentation](https://
|
|
287
|
+
* @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/).
|
|
288
288
|
*/
|
|
289
289
|
sendOTPOnEmail({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<EmailOtpSuccess>;
|
|
290
290
|
/**
|
|
@@ -293,7 +293,7 @@ declare class User {
|
|
|
293
293
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
294
294
|
* @name sendOTPOnMobile
|
|
295
295
|
* @summary: Send OTP on Mobile
|
|
296
|
-
* @description: Send a one-time password to the user's mobile for verification. - Check out [method documentation](https://
|
|
296
|
+
* @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/).
|
|
297
297
|
*/
|
|
298
298
|
sendOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpSuccess>;
|
|
299
299
|
/**
|
|
@@ -302,7 +302,7 @@ declare class User {
|
|
|
302
302
|
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
303
303
|
* @name sendOTPOnPrimary
|
|
304
304
|
* @summary: Send OTP to Primary Mobile or Email
|
|
305
|
-
* @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://
|
|
305
|
+
* @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/).
|
|
306
306
|
*/
|
|
307
307
|
sendOTPOnPrimary({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpSuccess>;
|
|
308
308
|
/**
|
|
@@ -311,7 +311,7 @@ declare class User {
|
|
|
311
311
|
* @returns {Promise<ResetPasswordSuccess>} - Success response
|
|
312
312
|
* @name sendResetPasswordEmail
|
|
313
313
|
* @summary: Reset Password via Email
|
|
314
|
-
* @description: Send a password reset link to the user's email. - Check out [method documentation](https://
|
|
314
|
+
* @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/).
|
|
315
315
|
*/
|
|
316
316
|
sendResetPasswordEmail({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ResetPasswordSuccess>;
|
|
317
317
|
/**
|
|
@@ -320,7 +320,7 @@ declare class User {
|
|
|
320
320
|
* @returns {Promise<any>} - Success response
|
|
321
321
|
* @name sendResetPasswordMobile
|
|
322
322
|
* @summary: Reset Password via Mobile
|
|
323
|
-
* @description: Send a password reset link to the user's mobile. - Check out [method documentation](https://
|
|
323
|
+
* @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/).
|
|
324
324
|
*/
|
|
325
325
|
sendResetPasswordMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<any>;
|
|
326
326
|
/**
|
|
@@ -329,7 +329,7 @@ declare class User {
|
|
|
329
329
|
* @returns {Promise<ResetPasswordSuccess>} - Success response
|
|
330
330
|
* @name sendResetToken
|
|
331
331
|
* @summary: Validate Password Reset Code
|
|
332
|
-
* @description: Validate password reset link code. - Check out [method documentation](https://
|
|
332
|
+
* @description: Validate password reset link code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/sendResetToken/).
|
|
333
333
|
*/
|
|
334
334
|
sendResetToken({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ResetPasswordSuccess>;
|
|
335
335
|
/**
|
|
@@ -338,7 +338,7 @@ declare class User {
|
|
|
338
338
|
* @returns {Promise<SendEmailVerifyLinkSuccess>} - Success response
|
|
339
339
|
* @name sendVerificationLinkToEmail
|
|
340
340
|
* @summary: Send Verification Link to Email
|
|
341
|
-
* @description: Send a verification link to a newly added email address. - Check out [method documentation](https://
|
|
341
|
+
* @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/).
|
|
342
342
|
*/
|
|
343
343
|
sendVerificationLinkToEmail({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendEmailVerifyLinkSuccess>;
|
|
344
344
|
/**
|
|
@@ -347,7 +347,7 @@ declare class User {
|
|
|
347
347
|
* @returns {Promise<SendMobileVerifyLinkSuccess>} - Success response
|
|
348
348
|
* @name sendVerificationLinkToMobile
|
|
349
349
|
* @summary: Send Verification Link to Mobile
|
|
350
|
-
* @description: Send a verification link to a newly added mobile number. - Check out [method documentation](https://
|
|
350
|
+
* @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/).
|
|
351
351
|
*/
|
|
352
352
|
sendVerificationLinkToMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendMobileVerifyLinkSuccess>;
|
|
353
353
|
/**
|
|
@@ -356,7 +356,7 @@ declare class User {
|
|
|
356
356
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
357
357
|
* @name setEmailAsPrimary
|
|
358
358
|
* @summary: Set Email as Primary
|
|
359
|
-
* @description: Set an email address as the primary contact for the user. - Check out [method documentation](https://
|
|
359
|
+
* @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/).
|
|
360
360
|
*/
|
|
361
361
|
setEmailAsPrimary({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
362
362
|
/**
|
|
@@ -365,7 +365,7 @@ declare class User {
|
|
|
365
365
|
* @returns {Promise<LoginSuccess>} - Success response
|
|
366
366
|
* @name setMobileNumberAsPrimary
|
|
367
367
|
* @summary: Set Mobile as Primary
|
|
368
|
-
* @description: Set a mobile number as the primary contact for the user. - Check out [method documentation](https://
|
|
368
|
+
* @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/).
|
|
369
369
|
*/
|
|
370
370
|
setMobileNumberAsPrimary({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LoginSuccess>;
|
|
371
371
|
/**
|
|
@@ -374,7 +374,7 @@ declare class User {
|
|
|
374
374
|
* @returns {Promise<VerifyEmailSuccess>} - Success response
|
|
375
375
|
* @name updatePassword
|
|
376
376
|
* @summary: Update password
|
|
377
|
-
* @description: Allow user to change their password. - Check out [method documentation](https://
|
|
377
|
+
* @description: Allow user to change their password. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/updatePassword/).
|
|
378
378
|
*/
|
|
379
379
|
updatePassword({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyEmailSuccess>;
|
|
380
380
|
/**
|
|
@@ -383,7 +383,7 @@ declare class User {
|
|
|
383
383
|
* @returns {Promise<ProfileEditSuccess>} - Success response
|
|
384
384
|
* @name updateProfile
|
|
385
385
|
* @summary: Edit User Profile Details
|
|
386
|
-
* @description: Allow users to modify and update their profile details. - Check out [method documentation](https://
|
|
386
|
+
* @description: Allow users to modify and update their profile details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/updateProfile/).
|
|
387
387
|
*/
|
|
388
388
|
updateProfile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProfileEditSuccess>;
|
|
389
389
|
/**
|
|
@@ -392,7 +392,7 @@ declare class User {
|
|
|
392
392
|
* @returns {Promise<UserAttributes>} - Success response
|
|
393
393
|
* @name updateUserAttributes
|
|
394
394
|
* @summary: Update User Attributes
|
|
395
|
-
* @description: Update user attributes. - Check out [method documentation](https://
|
|
395
|
+
* @description: Update user attributes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/updateUserAttributes/).
|
|
396
396
|
*/
|
|
397
397
|
updateUserAttributes({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserAttributes>;
|
|
398
398
|
/**
|
|
@@ -401,7 +401,7 @@ declare class User {
|
|
|
401
401
|
* @returns {Promise<UserExistsDetails>} - Success response
|
|
402
402
|
* @name userExists
|
|
403
403
|
* @summary: Chcek User Existence
|
|
404
|
-
* @description: Check whether user is already registered or not to the sales channel. - Check out [method documentation](https://
|
|
404
|
+
* @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/).
|
|
405
405
|
*/
|
|
406
406
|
userExists({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserExistsDetails>;
|
|
407
407
|
/**
|
|
@@ -410,7 +410,7 @@ declare class User {
|
|
|
410
410
|
* @returns {Promise<VerifyEmailSuccess>} - Success response
|
|
411
411
|
* @name verifyEmail
|
|
412
412
|
* @summary: Verify Email with Code
|
|
413
|
-
* @description: Verify user email with a code sent within a link sent to their email. - Check out [method documentation](https://
|
|
413
|
+
* @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/).
|
|
414
414
|
*/
|
|
415
415
|
verifyEmail({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyEmailSuccess>;
|
|
416
416
|
/**
|
|
@@ -419,7 +419,7 @@ declare class User {
|
|
|
419
419
|
* @returns {Promise<VerifyForgotOtpSuccess>} - Success response
|
|
420
420
|
* @name verifyEmailForgotOTP
|
|
421
421
|
* @summary: Verify Email OTP for Forgot Password
|
|
422
|
-
* @description: Verify one-time password sent to user's email for resetting a forgotten password. - Check out [method documentation](https://
|
|
422
|
+
* @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/).
|
|
423
423
|
*/
|
|
424
424
|
verifyEmailForgotOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyForgotOtpSuccess>;
|
|
425
425
|
/**
|
|
@@ -428,7 +428,7 @@ declare class User {
|
|
|
428
428
|
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
429
429
|
* @name verifyEmailOTP
|
|
430
430
|
* @summary: Verify Email OTP
|
|
431
|
-
* @description: Verify one-time password sent to user's email. - Check out [method documentation](https://
|
|
431
|
+
* @description: Verify one-time password sent to user's email. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyEmailOTP/).
|
|
432
432
|
*/
|
|
433
433
|
verifyEmailOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyOtpSuccess>;
|
|
434
434
|
/**
|
|
@@ -437,7 +437,7 @@ declare class User {
|
|
|
437
437
|
* @returns {Promise<VerifyEmailSuccess>} - Success response
|
|
438
438
|
* @name verifyMobile
|
|
439
439
|
* @summary: Verify Mobile with Code
|
|
440
|
-
* @description: Verify user mobile with a code sent within a link sent to their mobile. - Check out [method documentation](https://
|
|
440
|
+
* @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/).
|
|
441
441
|
*/
|
|
442
442
|
verifyMobile({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyEmailSuccess>;
|
|
443
443
|
/**
|
|
@@ -446,7 +446,7 @@ declare class User {
|
|
|
446
446
|
* @returns {Promise<VerifyForgotOtpSuccess>} - Success response
|
|
447
447
|
* @name verifyMobileForgotOTP
|
|
448
448
|
* @summary: Verify Mobile OTP for Forgot Password
|
|
449
|
-
* @description: Verify one-time password sent to user's mobile for resetting a forgotten password. - Check out [method documentation](https://
|
|
449
|
+
* @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/).
|
|
450
450
|
*/
|
|
451
451
|
verifyMobileForgotOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyForgotOtpSuccess>;
|
|
452
452
|
/**
|
|
@@ -455,7 +455,7 @@ declare class User {
|
|
|
455
455
|
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
456
456
|
* @name verifyMobileOTP
|
|
457
457
|
* @summary: Verify mobile OTP
|
|
458
|
-
* @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://
|
|
458
|
+
* @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/user/verifyMobileOTP/).
|
|
459
459
|
*/
|
|
460
460
|
verifyMobileOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyOtpSuccess>;
|
|
461
461
|
/**
|
|
@@ -464,7 +464,7 @@ declare class User {
|
|
|
464
464
|
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
465
465
|
* @name verifyOTPForUpdate
|
|
466
466
|
* @summary: Verify OTP sent to Mobile or Email to update primary details.
|
|
467
|
-
* @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://
|
|
467
|
+
* @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/).
|
|
468
468
|
*/
|
|
469
469
|
verifyOTPForUpdate({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyOtpSuccess>;
|
|
470
470
|
/**
|
|
@@ -473,7 +473,7 @@ declare class User {
|
|
|
473
473
|
* @returns {Promise<VerifyPrimaryOTPSuccess>} - Success response
|
|
474
474
|
* @name verifyOTPonPrimary
|
|
475
475
|
* @summary: Verify OTP sent to Primary Mobile or Email
|
|
476
|
-
* @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://
|
|
476
|
+
* @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/).
|
|
477
477
|
*/
|
|
478
478
|
verifyOTPonPrimary({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyPrimaryOTPSuccess>;
|
|
479
479
|
}
|