@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- 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 +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- 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 +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
- package/sdk/platform/Order/OrderPlatformClient.js +41 -41
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- 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 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -48,7 +48,7 @@ class Share {
|
|
|
48
48
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
50
50
|
* @name createShortLink
|
|
51
|
-
* @summary: Shorten URL
|
|
51
|
+
* @summary: Shorten URL
|
|
52
52
|
* @description: Creates a shortened version of a given URL for easier sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/createShortLink/).
|
|
53
53
|
*/
|
|
54
54
|
async createShortLink(
|
|
@@ -126,7 +126,7 @@ class Share {
|
|
|
126
126
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
127
127
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
128
128
|
* @name getApplicationQRCode
|
|
129
|
-
* @summary: App QR code
|
|
129
|
+
* @summary: App QR code
|
|
130
130
|
* @description: Generates a QR code for the application for easy sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getApplicationQRCode/).
|
|
131
131
|
*/
|
|
132
132
|
async getApplicationQRCode(
|
|
@@ -204,7 +204,7 @@ class Share {
|
|
|
204
204
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
205
205
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
206
206
|
* @name getCollectionQRCodeBySlug
|
|
207
|
-
* @summary: Collection QR code
|
|
207
|
+
* @summary: Collection QR code
|
|
208
208
|
* @description: Generates a QR code for a specific product collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getCollectionQRCodeBySlug/).
|
|
209
209
|
*/
|
|
210
210
|
async getCollectionQRCodeBySlug(
|
|
@@ -285,7 +285,7 @@ class Share {
|
|
|
285
285
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
286
286
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
287
287
|
* @name getOriginalShortLinkByHash
|
|
288
|
-
* @summary: Original URL
|
|
288
|
+
* @summary: Original URL
|
|
289
289
|
* @description: Retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getOriginalShortLinkByHash/).
|
|
290
290
|
*/
|
|
291
291
|
async getOriginalShortLinkByHash(
|
|
@@ -365,7 +365,7 @@ class Share {
|
|
|
365
365
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
366
366
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
367
367
|
* @name getProductQRCodeBySlug
|
|
368
|
-
* @summary: Product QR code
|
|
368
|
+
* @summary: Product QR code
|
|
369
369
|
* @description: Creates a QR code for a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getProductQRCodeBySlug/).
|
|
370
370
|
*/
|
|
371
371
|
async getProductQRCodeBySlug(
|
|
@@ -445,7 +445,7 @@ class Share {
|
|
|
445
445
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
446
446
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
447
447
|
* @name getShortLinkByHash
|
|
448
|
-
* @summary: Fetch short link
|
|
448
|
+
* @summary: Fetch short link
|
|
449
449
|
* @description: Retrieves a previously created short link using its hash identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
|
|
450
450
|
*/
|
|
451
451
|
async getShortLinkByHash(
|
|
@@ -523,7 +523,7 @@ class Share {
|
|
|
523
523
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
524
524
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
525
525
|
* @name getUrlQRCode
|
|
526
|
-
* @summary: URL to QR code
|
|
526
|
+
* @summary: URL to QR code
|
|
527
527
|
* @description: Converts a given URL into a scannable QR code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getUrlQRCode/).
|
|
528
528
|
*/
|
|
529
529
|
async getUrlQRCode(
|
|
@@ -53,6 +53,7 @@ export = ShareApplicationModel;
|
|
|
53
53
|
*/
|
|
54
54
|
/**
|
|
55
55
|
* @typedef UrlInfo
|
|
56
|
+
* @property {string} [original]
|
|
56
57
|
* @property {string} [hash]
|
|
57
58
|
*/
|
|
58
59
|
/**
|
|
@@ -159,6 +160,7 @@ type ShortLinkReq = {
|
|
|
159
160
|
/** @returns {UrlInfo} */
|
|
160
161
|
declare function UrlInfo(): UrlInfo;
|
|
161
162
|
type UrlInfo = {
|
|
163
|
+
original?: string;
|
|
162
164
|
hash?: string;
|
|
163
165
|
};
|
|
164
166
|
/** @returns {ShortLinkRes} */
|
|
@@ -62,6 +62,7 @@ const Joi = require("joi");
|
|
|
62
62
|
|
|
63
63
|
/**
|
|
64
64
|
* @typedef UrlInfo
|
|
65
|
+
* @property {string} [original]
|
|
65
66
|
* @property {string} [hash]
|
|
66
67
|
*/
|
|
67
68
|
|
|
@@ -174,6 +175,7 @@ class ShareApplicationModel {
|
|
|
174
175
|
/** @returns {UrlInfo} */
|
|
175
176
|
static UrlInfo() {
|
|
176
177
|
return Joi.object({
|
|
178
|
+
original: Joi.string().allow(""),
|
|
177
179
|
hash: Joi.string().allow(""),
|
|
178
180
|
});
|
|
179
181
|
}
|
|
@@ -16,7 +16,7 @@ declare class Theme {
|
|
|
16
16
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
17
17
|
* @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
|
|
18
18
|
* @name getAllPages
|
|
19
|
-
* @summary: Fetch all pages
|
|
19
|
+
* @summary: Fetch all pages
|
|
20
20
|
* @description: Retrieves a list of all the pages available within the applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
|
|
21
21
|
*/
|
|
22
22
|
getAllPages({ themeId, requestHeaders }?: ThemeApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AllAvailablePageSchema>;
|
|
@@ -26,7 +26,7 @@ declare class Theme {
|
|
|
26
26
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
27
27
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
28
28
|
* @name getAppliedTheme
|
|
29
|
-
* @summary: Current theme
|
|
29
|
+
* @summary: Current theme
|
|
30
30
|
* @description: Gets the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
|
|
31
31
|
*/
|
|
32
32
|
getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
|
|
@@ -36,7 +36,7 @@ declare class Theme {
|
|
|
36
36
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
37
37
|
* @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
|
|
38
38
|
* @name getPage
|
|
39
|
-
* @summary: Single page details
|
|
39
|
+
* @summary: Single page details
|
|
40
40
|
* @description: Retrieve detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
|
|
41
41
|
*/
|
|
42
42
|
getPage({ themeId, pageValue, filters, company, requestHeaders }?: ThemeApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.AvailablePageSchema>;
|
|
@@ -46,7 +46,7 @@ declare class Theme {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
48
48
|
* @name getThemeForPreview
|
|
49
|
-
* @summary: Preview theme
|
|
49
|
+
* @summary: Preview theme
|
|
50
50
|
* @description: Retrieves a theme for previewing before applying it to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
|
|
51
51
|
*/
|
|
52
52
|
getThemeForPreview({ themeId, requestHeaders }?: ThemeApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemeApplicationModel.ThemesSchema>;
|
|
@@ -41,7 +41,7 @@ class Theme {
|
|
|
41
41
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
42
|
* @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
|
|
43
43
|
* @name getAllPages
|
|
44
|
-
* @summary: Fetch all pages
|
|
44
|
+
* @summary: Fetch all pages
|
|
45
45
|
* @description: Retrieves a list of all the pages available within the applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
|
|
46
46
|
*/
|
|
47
47
|
async getAllPages(
|
|
@@ -119,7 +119,7 @@ class Theme {
|
|
|
119
119
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
120
120
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
121
121
|
* @name getAppliedTheme
|
|
122
|
-
* @summary: Current theme
|
|
122
|
+
* @summary: Current theme
|
|
123
123
|
* @description: Gets the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
|
|
124
124
|
*/
|
|
125
125
|
async getAppliedTheme(
|
|
@@ -197,7 +197,7 @@ class Theme {
|
|
|
197
197
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
198
198
|
* @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
|
|
199
199
|
* @name getPage
|
|
200
|
-
* @summary: Single page details
|
|
200
|
+
* @summary: Single page details
|
|
201
201
|
* @description: Retrieve detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
|
|
202
202
|
*/
|
|
203
203
|
async getPage(
|
|
@@ -277,7 +277,7 @@ class Theme {
|
|
|
277
277
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
278
278
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
279
279
|
* @name getThemeForPreview
|
|
280
|
-
* @summary: Preview theme
|
|
280
|
+
* @summary: Preview theme
|
|
281
281
|
* @description: Retrieves a theme for previewing before applying it to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
|
|
282
282
|
*/
|
|
283
283
|
async getThemeForPreview(
|
|
@@ -42,16 +42,9 @@ export = ThemeApplicationModel;
|
|
|
42
42
|
*/
|
|
43
43
|
/**
|
|
44
44
|
* @typedef Action
|
|
45
|
+
* @property {string} [type]
|
|
45
46
|
* @property {ActionPage} [page]
|
|
46
47
|
* @property {ActionPage} [popup]
|
|
47
|
-
* @property {string} [type]
|
|
48
|
-
*/
|
|
49
|
-
/**
|
|
50
|
-
* @typedef ActionPage
|
|
51
|
-
* @property {Object} [params]
|
|
52
|
-
* @property {Object} [query]
|
|
53
|
-
* @property {string} [url]
|
|
54
|
-
* @property {PageType} type
|
|
55
48
|
*/
|
|
56
49
|
/**
|
|
57
50
|
* @typedef AvailablePageSeo
|
|
@@ -374,13 +367,8 @@ export = ThemeApplicationModel;
|
|
|
374
367
|
*/
|
|
375
368
|
/**
|
|
376
369
|
* @typedef Page
|
|
377
|
-
* @property {
|
|
378
|
-
* @property {string} [
|
|
379
|
-
* @property {boolean} [has_previous]
|
|
380
|
-
* @property {boolean} [has_next]
|
|
381
|
-
* @property {number} [current]
|
|
382
|
-
* @property {string} type
|
|
383
|
-
* @property {number} [size]
|
|
370
|
+
* @property {Section[]} [sections]
|
|
371
|
+
* @property {string} [value] - The value of the page.
|
|
384
372
|
*/
|
|
385
373
|
/**
|
|
386
374
|
* @typedef SectionProps
|
|
@@ -473,6 +461,13 @@ export = ThemeApplicationModel;
|
|
|
473
461
|
* @typedef BlitzkriegApiErrorSchema
|
|
474
462
|
* @property {string} [message]
|
|
475
463
|
*/
|
|
464
|
+
/**
|
|
465
|
+
* @typedef ActionPage
|
|
466
|
+
* @property {Object} [params]
|
|
467
|
+
* @property {Object} [query]
|
|
468
|
+
* @property {string} [url]
|
|
469
|
+
* @property {PageType} type
|
|
470
|
+
*/
|
|
476
471
|
/**
|
|
477
472
|
* @typedef {| "about-us"
|
|
478
473
|
* | "addresses"
|
|
@@ -524,7 +519,7 @@ export = ThemeApplicationModel;
|
|
|
524
519
|
declare class ThemeApplicationModel {
|
|
525
520
|
}
|
|
526
521
|
declare namespace ThemeApplicationModel {
|
|
527
|
-
export { AllAvailablePageSchema, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action,
|
|
522
|
+
export { AllAvailablePageSchema, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePageSchedulePredicate, ThemesSchema, Font, FontVariants, FontVariant, Config, ThemeConfiguration, CustomConfig, CustomProps, GlobalConfig, GeneralSetting, AdvanceSetting, UserAlertsSetting, ThemeSetting, TextSetting, ButtonSetting, SaleDiscountSetting, HeaderSetting, FooterSetting, OverlayPopupSetting, DividerStrokeHighlightSetting, StaticConfig, StaticProps, Colors, AuthConfig, PaletteConfig, ThemeMeta, ThemePayment, Release, Images, Assets, UMDJs, CommonJS, CSS, SectionItem, GlobalSchema, Prop, Preset, Page, SectionProps, SectionPreset, ImagePickerProp, UrlProp, BlockProps, TextProp, CheckboxProp, RangeProp, Section, Block, Predicate, Screen, ThemeUserSchema, Route, AvailablePagePlatformPredicate, BlitzkriegInternalServerErrorSchema, BlitzkriegApiErrorSchema, ActionPage, PageType };
|
|
528
523
|
}
|
|
529
524
|
/** @returns {AllAvailablePageSchema} */
|
|
530
525
|
declare function AllAvailablePageSchema(): AllAvailablePageSchema;
|
|
@@ -577,17 +572,9 @@ type SEObreadcrumb = {
|
|
|
577
572
|
/** @returns {Action} */
|
|
578
573
|
declare function Action(): Action;
|
|
579
574
|
type Action = {
|
|
575
|
+
type?: string;
|
|
580
576
|
page?: ActionPage;
|
|
581
577
|
popup?: ActionPage;
|
|
582
|
-
type?: string;
|
|
583
|
-
};
|
|
584
|
-
/** @returns {ActionPage} */
|
|
585
|
-
declare function ActionPage(): ActionPage;
|
|
586
|
-
type ActionPage = {
|
|
587
|
-
params?: any;
|
|
588
|
-
query?: any;
|
|
589
|
-
url?: string;
|
|
590
|
-
type: PageType;
|
|
591
578
|
};
|
|
592
579
|
/** @returns {AvailablePageSeo} */
|
|
593
580
|
declare function AvailablePageSeo(): AvailablePageSeo;
|
|
@@ -1282,13 +1269,11 @@ type Preset = {
|
|
|
1282
1269
|
/** @returns {Page} */
|
|
1283
1270
|
declare function Page(): Page;
|
|
1284
1271
|
type Page = {
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
type: string;
|
|
1291
|
-
size?: number;
|
|
1272
|
+
sections?: Section[];
|
|
1273
|
+
/**
|
|
1274
|
+
* - The value of the page.
|
|
1275
|
+
*/
|
|
1276
|
+
value?: string;
|
|
1292
1277
|
};
|
|
1293
1278
|
/** @returns {SectionProps} */
|
|
1294
1279
|
declare function SectionProps(): SectionProps;
|
|
@@ -1467,6 +1452,14 @@ declare function BlitzkriegApiErrorSchema(): BlitzkriegApiErrorSchema;
|
|
|
1467
1452
|
type BlitzkriegApiErrorSchema = {
|
|
1468
1453
|
message?: string;
|
|
1469
1454
|
};
|
|
1455
|
+
/** @returns {ActionPage} */
|
|
1456
|
+
declare function ActionPage(): ActionPage;
|
|
1457
|
+
type ActionPage = {
|
|
1458
|
+
params?: any;
|
|
1459
|
+
query?: any;
|
|
1460
|
+
url?: string;
|
|
1461
|
+
type: PageType;
|
|
1462
|
+
};
|
|
1470
1463
|
/**
|
|
1471
1464
|
* Enum: PageType Used By: Theme
|
|
1472
1465
|
*
|
|
@@ -50,17 +50,9 @@ const Joi = require("joi");
|
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
52
|
* @typedef Action
|
|
53
|
+
* @property {string} [type]
|
|
53
54
|
* @property {ActionPage} [page]
|
|
54
55
|
* @property {ActionPage} [popup]
|
|
55
|
-
* @property {string} [type]
|
|
56
|
-
*/
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* @typedef ActionPage
|
|
60
|
-
* @property {Object} [params]
|
|
61
|
-
* @property {Object} [query]
|
|
62
|
-
* @property {string} [url]
|
|
63
|
-
* @property {PageType} type
|
|
64
56
|
*/
|
|
65
57
|
|
|
66
58
|
/**
|
|
@@ -428,13 +420,8 @@ const Joi = require("joi");
|
|
|
428
420
|
|
|
429
421
|
/**
|
|
430
422
|
* @typedef Page
|
|
431
|
-
* @property {
|
|
432
|
-
* @property {string} [
|
|
433
|
-
* @property {boolean} [has_previous]
|
|
434
|
-
* @property {boolean} [has_next]
|
|
435
|
-
* @property {number} [current]
|
|
436
|
-
* @property {string} type
|
|
437
|
-
* @property {number} [size]
|
|
423
|
+
* @property {Section[]} [sections]
|
|
424
|
+
* @property {string} [value] - The value of the page.
|
|
438
425
|
*/
|
|
439
426
|
|
|
440
427
|
/**
|
|
@@ -545,6 +532,14 @@ const Joi = require("joi");
|
|
|
545
532
|
* @property {string} [message]
|
|
546
533
|
*/
|
|
547
534
|
|
|
535
|
+
/**
|
|
536
|
+
* @typedef ActionPage
|
|
537
|
+
* @property {Object} [params]
|
|
538
|
+
* @property {Object} [query]
|
|
539
|
+
* @property {string} [url]
|
|
540
|
+
* @property {PageType} type
|
|
541
|
+
*/
|
|
542
|
+
|
|
548
543
|
/**
|
|
549
544
|
* @typedef {| "about-us"
|
|
550
545
|
* | "addresses"
|
|
@@ -664,25 +659,9 @@ class ThemeApplicationModel {
|
|
|
664
659
|
/** @returns {Action} */
|
|
665
660
|
static Action() {
|
|
666
661
|
return Joi.object({
|
|
662
|
+
type: Joi.string().allow(""),
|
|
667
663
|
page: ThemeApplicationModel.ActionPage(),
|
|
668
664
|
popup: ThemeApplicationModel.ActionPage(),
|
|
669
|
-
type: Joi.string().allow(""),
|
|
670
|
-
});
|
|
671
|
-
}
|
|
672
|
-
|
|
673
|
-
/** @returns {ActionPage} */
|
|
674
|
-
static ActionPage() {
|
|
675
|
-
return Joi.object({
|
|
676
|
-
params: Joi.object().pattern(
|
|
677
|
-
/\S/,
|
|
678
|
-
Joi.array().items(Joi.string().allow(""))
|
|
679
|
-
),
|
|
680
|
-
query: Joi.object().pattern(
|
|
681
|
-
/\S/,
|
|
682
|
-
Joi.array().items(Joi.string().allow(""))
|
|
683
|
-
),
|
|
684
|
-
url: Joi.string().allow(""),
|
|
685
|
-
type: ThemeApplicationModel.PageType().required(),
|
|
686
665
|
});
|
|
687
666
|
}
|
|
688
667
|
|
|
@@ -1139,13 +1118,8 @@ class ThemeApplicationModel {
|
|
|
1139
1118
|
/** @returns {Page} */
|
|
1140
1119
|
static Page() {
|
|
1141
1120
|
return Joi.object({
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
has_previous: Joi.boolean(),
|
|
1145
|
-
has_next: Joi.boolean(),
|
|
1146
|
-
current: Joi.number(),
|
|
1147
|
-
type: Joi.string().allow("").required(),
|
|
1148
|
-
size: Joi.number(),
|
|
1121
|
+
sections: Joi.array().items(ThemeApplicationModel.Section()),
|
|
1122
|
+
value: Joi.string().allow(""),
|
|
1149
1123
|
});
|
|
1150
1124
|
}
|
|
1151
1125
|
|
|
@@ -1291,6 +1265,22 @@ class ThemeApplicationModel {
|
|
|
1291
1265
|
});
|
|
1292
1266
|
}
|
|
1293
1267
|
|
|
1268
|
+
/** @returns {ActionPage} */
|
|
1269
|
+
static ActionPage() {
|
|
1270
|
+
return Joi.object({
|
|
1271
|
+
params: Joi.object().pattern(
|
|
1272
|
+
/\S/,
|
|
1273
|
+
Joi.array().items(Joi.string().allow(""))
|
|
1274
|
+
),
|
|
1275
|
+
query: Joi.object().pattern(
|
|
1276
|
+
/\S/,
|
|
1277
|
+
Joi.array().items(Joi.string().allow(""))
|
|
1278
|
+
),
|
|
1279
|
+
url: Joi.string().allow(""),
|
|
1280
|
+
type: ThemeApplicationModel.PageType().required(),
|
|
1281
|
+
});
|
|
1282
|
+
}
|
|
1283
|
+
|
|
1294
1284
|
/**
|
|
1295
1285
|
* Enum: PageType Used By: Theme
|
|
1296
1286
|
*
|
|
@@ -55,7 +55,7 @@ declare class User {
|
|
|
55
55
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
56
56
|
* @returns {Promise<UserApplicationModel.VerifyEmailOTPSuccess>} - Success response
|
|
57
57
|
* @name addEmail
|
|
58
|
-
* @summary: Add email
|
|
58
|
+
* @summary: Add email
|
|
59
59
|
* @description: Adds a new email address to the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/addEmail/).
|
|
60
60
|
*/
|
|
61
61
|
addEmail({ body, platform, requestHeaders }?: UserApplicationValidator.AddEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailOTPSuccess>;
|
|
@@ -65,7 +65,7 @@ declare class User {
|
|
|
65
65
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
66
66
|
* @returns {Promise<UserApplicationModel.VerifyMobileOTPSuccess>} - Success response
|
|
67
67
|
* @name addMobileNumber
|
|
68
|
-
* @summary: Add mobile
|
|
68
|
+
* @summary: Add mobile
|
|
69
69
|
* @description: Adds a new mobile number to the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/addMobileNumber/).
|
|
70
70
|
*/
|
|
71
71
|
addMobileNumber({ body, platform, requestHeaders }?: UserApplicationValidator.AddMobileNumberParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyMobileOTPSuccess>;
|
|
@@ -75,7 +75,7 @@ declare class User {
|
|
|
75
75
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
76
76
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
77
77
|
* @name deleteEmail
|
|
78
|
-
* @summary: Delete email
|
|
78
|
+
* @summary: Delete email
|
|
79
79
|
* @description: Removes an email address from the user's profile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/deleteEmail/).
|
|
80
80
|
*/
|
|
81
81
|
deleteEmail({ active, primary, verified, email, platform, requestHeaders }?: UserApplicationValidator.DeleteEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
@@ -105,7 +105,7 @@ declare class User {
|
|
|
105
105
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
107
107
|
* @name forgotPassword
|
|
108
|
-
* @summary: Forgot password
|
|
108
|
+
* @summary: Forgot password
|
|
109
109
|
* @description: Initiates the password recovery process for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/forgotPassword/).
|
|
110
110
|
*/
|
|
111
111
|
forgotPassword({ body, requestHeaders }?: UserApplicationValidator.ForgotPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
@@ -125,7 +125,7 @@ declare class User {
|
|
|
125
125
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
126
126
|
* @returns {Promise<UserApplicationModel.UserObjectSchema>} - Success response
|
|
127
127
|
* @name getLoggedInUser
|
|
128
|
-
* @summary: Current user
|
|
128
|
+
* @summary: Current user
|
|
129
129
|
* @description: Retrieve information about the currently logged-in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getLoggedInUser/).
|
|
130
130
|
*/
|
|
131
131
|
getLoggedInUser({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserApplicationModel.UserObjectSchema>;
|
|
@@ -135,7 +135,7 @@ declare class User {
|
|
|
135
135
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
136
136
|
* @returns {Promise<UserApplicationModel.PlatformSchema>} - Success response
|
|
137
137
|
* @name getPlatformConfig
|
|
138
|
-
* @summary: Platform config
|
|
138
|
+
* @summary: Platform config
|
|
139
139
|
* @description: Retrieve configuration settings related to the user platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getPlatformConfig/).
|
|
140
140
|
*/
|
|
141
141
|
getPlatformConfig({ name, requestHeaders }?: UserApplicationValidator.GetPlatformConfigParam, { responseHeaders }?: object): Promise<UserApplicationModel.PlatformSchema>;
|
|
@@ -155,7 +155,7 @@ declare class User {
|
|
|
155
155
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
156
156
|
* @returns {Promise<UserApplicationModel.HasPasswordSuccess>} - Success response
|
|
157
157
|
* @name hasPassword
|
|
158
|
-
* @summary: Check password
|
|
158
|
+
* @summary: Check password
|
|
159
159
|
* @description: Checks if the user has set a password for the account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/hasPassword/).
|
|
160
160
|
*/
|
|
161
161
|
hasPassword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserApplicationModel.HasPasswordSuccess>;
|
|
@@ -165,7 +165,7 @@ declare class User {
|
|
|
165
165
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
166
166
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
167
167
|
* @name loginWithAppleIOS
|
|
168
|
-
* @summary: Apple iOS login
|
|
168
|
+
* @summary: Apple iOS login
|
|
169
169
|
* @description: Enables login through Apple ID specifically for iOS users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithAppleIOS/).
|
|
170
170
|
*/
|
|
171
171
|
loginWithAppleIOS({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithAppleIOSParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
@@ -175,7 +175,7 @@ declare class User {
|
|
|
175
175
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
176
176
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
177
177
|
* @name loginWithEmailAndPassword
|
|
178
|
-
* @summary: Email/password login
|
|
178
|
+
* @summary: Email/password login
|
|
179
179
|
* @description: Enables login using an email and password combination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithEmailAndPassword/).
|
|
180
180
|
*/
|
|
181
181
|
loginWithEmailAndPassword({ body, requestHeaders }?: UserApplicationValidator.LoginWithEmailAndPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
@@ -185,7 +185,7 @@ declare class User {
|
|
|
185
185
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
186
186
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
187
187
|
* @name loginWithFacebook
|
|
188
|
-
* @summary: Facebook login
|
|
188
|
+
* @summary: Facebook login
|
|
189
189
|
* @description: Enables login through Facebook accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithFacebook/).
|
|
190
190
|
*/
|
|
191
191
|
loginWithFacebook({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithFacebookParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
@@ -195,7 +195,7 @@ declare class User {
|
|
|
195
195
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
196
196
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
197
197
|
* @name loginWithGoogle
|
|
198
|
-
* @summary: Google login
|
|
198
|
+
* @summary: Google login
|
|
199
199
|
* @description: Enables login through Google accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogle/).
|
|
200
200
|
*/
|
|
201
201
|
loginWithGoogle({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithGoogleParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
@@ -205,7 +205,7 @@ declare class User {
|
|
|
205
205
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
206
206
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
207
207
|
* @name loginWithGoogleAndroid
|
|
208
|
-
* @summary: Android Google login
|
|
208
|
+
* @summary: Android Google login
|
|
209
209
|
* @description: Facilitates Google login specifically for Android users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleAndroid/).
|
|
210
210
|
*/
|
|
211
211
|
loginWithGoogleAndroid({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithGoogleAndroidParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
@@ -215,7 +215,7 @@ declare class User {
|
|
|
215
215
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
216
216
|
* @returns {Promise<UserApplicationModel.AuthSuccess>} - Success response
|
|
217
217
|
* @name loginWithGoogleIOS
|
|
218
|
-
* @summary: iOS Google login
|
|
218
|
+
* @summary: iOS Google login
|
|
219
219
|
* @description: Facilitates Google login specifically for iOS users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithGoogleIOS/).
|
|
220
220
|
*/
|
|
221
221
|
loginWithGoogleIOS({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithGoogleIOSParam, { responseHeaders }?: object): Promise<UserApplicationModel.AuthSuccess>;
|
|
@@ -225,7 +225,7 @@ declare class User {
|
|
|
225
225
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
226
226
|
* @returns {Promise<UserApplicationModel.SendOtpResponse>} - Success response
|
|
227
227
|
* @name loginWithOTP
|
|
228
|
-
* @summary: OTP login
|
|
228
|
+
* @summary: OTP login
|
|
229
229
|
* @description: Allows users to log in using a one-time password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithOTP/).
|
|
230
230
|
*/
|
|
231
231
|
loginWithOTP({ body, platform, requestHeaders }?: UserApplicationValidator.LoginWithOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendOtpResponse>;
|
|
@@ -255,7 +255,7 @@ declare class User {
|
|
|
255
255
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
256
256
|
* @returns {Promise<UserApplicationModel.RegisterFormSuccess>} - Success response
|
|
257
257
|
* @name registerWithForm
|
|
258
|
-
* @summary: User registration
|
|
258
|
+
* @summary: User registration
|
|
259
259
|
* @description: Enables new users to register using a form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/registerWithForm/).
|
|
260
260
|
*/
|
|
261
261
|
registerWithForm({ body, platform, requestHeaders }?: UserApplicationValidator.RegisterWithFormParam, { responseHeaders }?: object): Promise<UserApplicationModel.RegisterFormSuccess>;
|
|
@@ -266,7 +266,7 @@ declare class User {
|
|
|
266
266
|
* @returns {Promise<UserApplicationModel.ResetForgotPasswordSuccess>} -
|
|
267
267
|
* Success response
|
|
268
268
|
* @name resetForgotPassword
|
|
269
|
-
* @summary: Forgot password
|
|
269
|
+
* @summary: Forgot password
|
|
270
270
|
* @description: Initiates the password recovery process for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/resetForgotPassword/).
|
|
271
271
|
*/
|
|
272
272
|
resetForgotPassword({ body, requestHeaders }?: UserApplicationValidator.ResetForgotPasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.ResetForgotPasswordSuccess>;
|
|
@@ -296,7 +296,7 @@ declare class User {
|
|
|
296
296
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
297
297
|
* @returns {Promise<UserApplicationModel.EmailOtpSuccess>} - Success response
|
|
298
298
|
* @name sendOTPOnEmail
|
|
299
|
-
* @summary: Send email OTP
|
|
299
|
+
* @summary: Send email OTP
|
|
300
300
|
* @description: Sends a one-time password to the user's email for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnEmail/).
|
|
301
301
|
*/
|
|
302
302
|
sendOTPOnEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendOTPOnEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.EmailOtpSuccess>;
|
|
@@ -306,7 +306,7 @@ declare class User {
|
|
|
306
306
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
307
307
|
* @returns {Promise<UserApplicationModel.OtpSuccess>} - Success response
|
|
308
308
|
* @name sendOTPOnMobile
|
|
309
|
-
* @summary: Send mobile OTP
|
|
309
|
+
* @summary: Send mobile OTP
|
|
310
310
|
* @description: Sends a one-time password to the user's mobile for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnMobile/).
|
|
311
311
|
*/
|
|
312
312
|
sendOTPOnMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendOTPOnMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.OtpSuccess>;
|
|
@@ -316,7 +316,7 @@ declare class User {
|
|
|
316
316
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
317
317
|
* @returns {Promise<UserApplicationModel.ResetPasswordSuccess>} - Success response
|
|
318
318
|
* @name sendResetPasswordEmail
|
|
319
|
-
* @summary: Reset password (Email)
|
|
319
|
+
* @summary: Reset password (Email)
|
|
320
320
|
* @description: Sends a password reset link to the user's email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordEmail/).
|
|
321
321
|
*/
|
|
322
322
|
sendResetPasswordEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendResetPasswordEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.ResetPasswordSuccess>;
|
|
@@ -326,7 +326,7 @@ declare class User {
|
|
|
326
326
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
327
327
|
* @returns {Promise<any>} - Success response
|
|
328
328
|
* @name sendResetPasswordMobile
|
|
329
|
-
* @summary: Reset password (Mobile)
|
|
329
|
+
* @summary: Reset password (Mobile)
|
|
330
330
|
* @description: Sends a password reset OTP to the user's mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordMobile/).
|
|
331
331
|
*/
|
|
332
332
|
sendResetPasswordMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendResetPasswordMobileParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -348,7 +348,7 @@ declare class User {
|
|
|
348
348
|
* @returns {Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>} -
|
|
349
349
|
* Success response
|
|
350
350
|
* @name sendVerificationLinkToEmail
|
|
351
|
-
* @summary: Verify new email
|
|
351
|
+
* @summary: Verify new email
|
|
352
352
|
* @description: Sends a verification link to a newly added email address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendVerificationLinkToEmail/).
|
|
353
353
|
*/
|
|
354
354
|
sendVerificationLinkToEmail({ body, platform, requestHeaders }?: UserApplicationValidator.SendVerificationLinkToEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendEmailVerifyLinkSuccess>;
|
|
@@ -361,7 +361,7 @@ declare class User {
|
|
|
361
361
|
* @returns {Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>} -
|
|
362
362
|
* Success response
|
|
363
363
|
* @name sendVerificationLinkToMobile
|
|
364
|
-
* @summary: Verify new mobile
|
|
364
|
+
* @summary: Verify new mobile
|
|
365
365
|
* @description: Sends a verification link to a newly added mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendVerificationLinkToMobile/).
|
|
366
366
|
*/
|
|
367
367
|
sendVerificationLinkToMobile({ body, platform, requestHeaders }?: UserApplicationValidator.SendVerificationLinkToMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.SendMobileVerifyLinkSuccess>;
|
|
@@ -371,7 +371,7 @@ declare class User {
|
|
|
371
371
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
372
372
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
373
373
|
* @name setEmailAsPrimary
|
|
374
|
-
* @summary: Set primary email
|
|
374
|
+
* @summary: Set primary email
|
|
375
375
|
* @description: Sets an email address as the primary contact for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/setEmailAsPrimary/).
|
|
376
376
|
*/
|
|
377
377
|
setEmailAsPrimary({ body, requestHeaders }?: UserApplicationValidator.SetEmailAsPrimaryParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
@@ -381,7 +381,7 @@ declare class User {
|
|
|
381
381
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
382
382
|
* @returns {Promise<UserApplicationModel.LoginSuccess>} - Success response
|
|
383
383
|
* @name setMobileNumberAsPrimary
|
|
384
|
-
* @summary: Set primary mobile
|
|
384
|
+
* @summary: Set primary mobile
|
|
385
385
|
* @description: Sets a mobile number as the primary contact for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/setMobileNumberAsPrimary/).
|
|
386
386
|
*/
|
|
387
387
|
setMobileNumberAsPrimary({ body, requestHeaders }?: UserApplicationValidator.SetMobileNumberAsPrimaryParam, { responseHeaders }?: object): Promise<UserApplicationModel.LoginSuccess>;
|
|
@@ -391,7 +391,7 @@ declare class User {
|
|
|
391
391
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
392
392
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
393
393
|
* @name updatePassword
|
|
394
|
-
* @summary: Update password
|
|
394
|
+
* @summary: Update password
|
|
395
395
|
* @description: Allows users to update their existing password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updatePassword/).
|
|
396
396
|
*/
|
|
397
397
|
updatePassword({ body, requestHeaders }?: UserApplicationValidator.UpdatePasswordParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
@@ -431,7 +431,7 @@ declare class User {
|
|
|
431
431
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
432
432
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
433
433
|
* @name verifyEmail
|
|
434
|
-
* @summary: Verify email
|
|
434
|
+
* @summary: Verify email
|
|
435
435
|
* @description: Verifies the user's email address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyEmail/).
|
|
436
436
|
*/
|
|
437
437
|
verifyEmail({ body, requestHeaders }?: UserApplicationValidator.VerifyEmailParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
@@ -461,7 +461,7 @@ declare class User {
|
|
|
461
461
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
462
462
|
* @returns {Promise<UserApplicationModel.VerifyEmailSuccess>} - Success response
|
|
463
463
|
* @name verifyMobile
|
|
464
|
-
* @summary: Verify mobile
|
|
464
|
+
* @summary: Verify mobile
|
|
465
465
|
* @description: Verifies the user's mobile number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobile/).
|
|
466
466
|
*/
|
|
467
467
|
verifyMobile({ body, requestHeaders }?: UserApplicationValidator.VerifyMobileParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyEmailSuccess>;
|
|
@@ -481,7 +481,7 @@ declare class User {
|
|
|
481
481
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
482
482
|
* @returns {Promise<UserApplicationModel.VerifyOtpSuccess>} - Success response
|
|
483
483
|
* @name verifyMobileOTP
|
|
484
|
-
* @summary: Verify mobile OTP
|
|
484
|
+
* @summary: Verify mobile OTP
|
|
485
485
|
* @description: Validates the OTP sent to the user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
|
|
486
486
|
*/
|
|
487
487
|
verifyMobileOTP({ body, platform, requestHeaders }?: UserApplicationValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<UserApplicationModel.VerifyOtpSuccess>;
|