@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -20,8 +20,8 @@ declare class Rewards {
|
|
|
20
20
|
* @returns {Promise<RewardsApplicationModel.CatalogueOrderResponse>} -
|
|
21
21
|
* Success response
|
|
22
22
|
* @name catalogueOrder
|
|
23
|
-
* @summary:
|
|
24
|
-
* @description:
|
|
23
|
+
* @summary: Order from catalogue.
|
|
24
|
+
* @description: Place an reward on order items available in the catalogue. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/catalogueOrder/).
|
|
25
25
|
*/
|
|
26
26
|
catalogueOrder({ body, requestHeaders }?: RewardsApplicationValidator.CatalogueOrderParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.CatalogueOrderResponse>;
|
|
27
27
|
/**
|
|
@@ -30,8 +30,8 @@ declare class Rewards {
|
|
|
30
30
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
31
31
|
* @returns {Promise<RewardsApplicationModel.Offer>} - Success response
|
|
32
32
|
* @name getOfferByName
|
|
33
|
-
* @summary:
|
|
34
|
-
* @description:
|
|
33
|
+
* @summary: Fetch specific offer
|
|
34
|
+
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
|
|
35
35
|
*/
|
|
36
36
|
getOfferByName({ name, requestHeaders }?: RewardsApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.Offer>;
|
|
37
37
|
/**
|
|
@@ -41,8 +41,8 @@ declare class Rewards {
|
|
|
41
41
|
* @returns {Promise<RewardsApplicationModel.OrderDiscountResponse>} -
|
|
42
42
|
* Success response
|
|
43
43
|
* @name getOrderDiscount
|
|
44
|
-
* @summary:
|
|
45
|
-
* @description:
|
|
44
|
+
* @summary: Order discount.
|
|
45
|
+
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
|
|
46
46
|
*/
|
|
47
47
|
getOrderDiscount({ body, requestHeaders }?: RewardsApplicationValidator.GetOrderDiscountParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.OrderDiscountResponse>;
|
|
48
48
|
/**
|
|
@@ -51,8 +51,8 @@ declare class Rewards {
|
|
|
51
51
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
52
|
* @returns {Promise<RewardsApplicationModel.PointsResponse>} - Success response
|
|
53
53
|
* @name getUserPoints
|
|
54
|
-
* @summary:
|
|
55
|
-
* @description:
|
|
54
|
+
* @summary: Current points.
|
|
55
|
+
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
|
|
56
56
|
*/
|
|
57
57
|
getUserPoints({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsApplicationModel.PointsResponse>;
|
|
58
58
|
/**
|
|
@@ -62,20 +62,10 @@ declare class Rewards {
|
|
|
62
62
|
* @returns {Promise<RewardsApplicationModel.PointsHistoryResponse>} -
|
|
63
63
|
* Success response
|
|
64
64
|
* @name getUserPointsHistory
|
|
65
|
-
* @summary:
|
|
66
|
-
* @description:
|
|
65
|
+
* @summary: Points history.
|
|
66
|
+
* @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPointsHistory/).
|
|
67
67
|
*/
|
|
68
68
|
getUserPointsHistory({ pageId, pageSize, requestHeaders }?: RewardsApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.PointsHistoryResponse>;
|
|
69
|
-
/**
|
|
70
|
-
* @param {Object} arg - Arg object.
|
|
71
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
72
|
-
* @returns {Paginator<RewardsApplicationModel.PointsHistoryResponse>}
|
|
73
|
-
* @summary: Get all transactions of reward points
|
|
74
|
-
* @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
|
|
75
|
-
*/
|
|
76
|
-
getUserPointsHistoryPaginator({ pageSize }?: {
|
|
77
|
-
pageSize?: number;
|
|
78
|
-
}): Paginator<RewardsApplicationModel.PointsHistoryResponse>;
|
|
79
69
|
/**
|
|
80
70
|
* @param {RewardsApplicationValidator.GetUserReferralDetailsParam} arg - Arg object.
|
|
81
71
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -83,8 +73,8 @@ declare class Rewards {
|
|
|
83
73
|
* @returns {Promise<RewardsApplicationModel.ReferralDetailsResponse>} -
|
|
84
74
|
* Success response
|
|
85
75
|
* @name getUserReferralDetails
|
|
86
|
-
* @summary:
|
|
87
|
-
* @description:
|
|
76
|
+
* @summary: Referral details.
|
|
77
|
+
* @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserReferralDetails/).
|
|
88
78
|
*/
|
|
89
79
|
getUserReferralDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsApplicationModel.ReferralDetailsResponse>;
|
|
90
80
|
/**
|
|
@@ -94,11 +84,10 @@ declare class Rewards {
|
|
|
94
84
|
* @returns {Promise<RewardsApplicationModel.RedeemReferralCodeResponse>} -
|
|
95
85
|
* Success response
|
|
96
86
|
* @name redeemReferralCode
|
|
97
|
-
* @summary:
|
|
98
|
-
* @description:
|
|
87
|
+
* @summary: Redeem code.
|
|
88
|
+
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
|
|
99
89
|
*/
|
|
100
90
|
redeemReferralCode({ body, requestHeaders }?: RewardsApplicationValidator.RedeemReferralCodeParam, { responseHeaders }?: object): Promise<RewardsApplicationModel.RedeemReferralCodeResponse>;
|
|
101
91
|
}
|
|
102
92
|
import RewardsApplicationValidator = require("./RewardsApplicationValidator");
|
|
103
93
|
import RewardsApplicationModel = require("./RewardsApplicationModel");
|
|
104
|
-
import Paginator = require("../../common/Paginator");
|
|
@@ -50,8 +50,8 @@ class Rewards {
|
|
|
50
50
|
* @returns {Promise<RewardsApplicationModel.CatalogueOrderResponse>} -
|
|
51
51
|
* Success response
|
|
52
52
|
* @name catalogueOrder
|
|
53
|
-
* @summary:
|
|
54
|
-
* @description:
|
|
53
|
+
* @summary: Order from catalogue.
|
|
54
|
+
* @description: Place an reward on order items available in the catalogue. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/catalogueOrder/).
|
|
55
55
|
*/
|
|
56
56
|
async catalogueOrder(
|
|
57
57
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -128,8 +128,8 @@ class Rewards {
|
|
|
128
128
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
129
129
|
* @returns {Promise<RewardsApplicationModel.Offer>} - Success response
|
|
130
130
|
* @name getOfferByName
|
|
131
|
-
* @summary:
|
|
132
|
-
* @description:
|
|
131
|
+
* @summary: Fetch specific offer
|
|
132
|
+
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
|
|
133
133
|
*/
|
|
134
134
|
async getOfferByName(
|
|
135
135
|
{ name, requestHeaders } = { requestHeaders: {} },
|
|
@@ -207,8 +207,8 @@ class Rewards {
|
|
|
207
207
|
* @returns {Promise<RewardsApplicationModel.OrderDiscountResponse>} -
|
|
208
208
|
* Success response
|
|
209
209
|
* @name getOrderDiscount
|
|
210
|
-
* @summary:
|
|
211
|
-
* @description:
|
|
210
|
+
* @summary: Order discount.
|
|
211
|
+
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
|
|
212
212
|
*/
|
|
213
213
|
async getOrderDiscount(
|
|
214
214
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -285,8 +285,8 @@ class Rewards {
|
|
|
285
285
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
286
286
|
* @returns {Promise<RewardsApplicationModel.PointsResponse>} - Success response
|
|
287
287
|
* @name getUserPoints
|
|
288
|
-
* @summary:
|
|
289
|
-
* @description:
|
|
288
|
+
* @summary: Current points.
|
|
289
|
+
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
|
|
290
290
|
*/
|
|
291
291
|
async getUserPoints(
|
|
292
292
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -364,8 +364,8 @@ class Rewards {
|
|
|
364
364
|
* @returns {Promise<RewardsApplicationModel.PointsHistoryResponse>} -
|
|
365
365
|
* Success response
|
|
366
366
|
* @name getUserPointsHistory
|
|
367
|
-
* @summary:
|
|
368
|
-
* @description:
|
|
367
|
+
* @summary: Points history.
|
|
368
|
+
* @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPointsHistory/).
|
|
369
369
|
*/
|
|
370
370
|
async getUserPointsHistory(
|
|
371
371
|
{ pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -440,33 +440,6 @@ class Rewards {
|
|
|
440
440
|
return response;
|
|
441
441
|
}
|
|
442
442
|
|
|
443
|
-
/**
|
|
444
|
-
* @param {Object} arg - Arg object.
|
|
445
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
446
|
-
* @returns {Paginator<RewardsApplicationModel.PointsHistoryResponse>}
|
|
447
|
-
* @summary: Get all transactions of reward points
|
|
448
|
-
* @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
|
|
449
|
-
*/
|
|
450
|
-
getUserPointsHistoryPaginator({ pageSize } = {}) {
|
|
451
|
-
const paginator = new Paginator();
|
|
452
|
-
const callback = async () => {
|
|
453
|
-
const pageId = paginator.nextId;
|
|
454
|
-
const pageNo = paginator.pageNo;
|
|
455
|
-
const pageType = "cursor";
|
|
456
|
-
const data = await this.getUserPointsHistory({
|
|
457
|
-
pageId: pageId,
|
|
458
|
-
pageSize: pageSize,
|
|
459
|
-
});
|
|
460
|
-
paginator.setPaginator({
|
|
461
|
-
hasNext: data.page.has_next ? true : false,
|
|
462
|
-
nextId: data.page.next_id,
|
|
463
|
-
});
|
|
464
|
-
return data;
|
|
465
|
-
};
|
|
466
|
-
paginator.setCallback(callback.bind(this));
|
|
467
|
-
return paginator;
|
|
468
|
-
}
|
|
469
|
-
|
|
470
443
|
/**
|
|
471
444
|
* @param {RewardsApplicationValidator.GetUserReferralDetailsParam} arg - Arg object.
|
|
472
445
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -474,8 +447,8 @@ class Rewards {
|
|
|
474
447
|
* @returns {Promise<RewardsApplicationModel.ReferralDetailsResponse>} -
|
|
475
448
|
* Success response
|
|
476
449
|
* @name getUserReferralDetails
|
|
477
|
-
* @summary:
|
|
478
|
-
* @description:
|
|
450
|
+
* @summary: Referral details.
|
|
451
|
+
* @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserReferralDetails/).
|
|
479
452
|
*/
|
|
480
453
|
async getUserReferralDetails(
|
|
481
454
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -555,8 +528,8 @@ class Rewards {
|
|
|
555
528
|
* @returns {Promise<RewardsApplicationModel.RedeemReferralCodeResponse>} -
|
|
556
529
|
* Success response
|
|
557
530
|
* @name redeemReferralCode
|
|
558
|
-
* @summary:
|
|
559
|
-
* @description:
|
|
531
|
+
* @summary: Redeem code.
|
|
532
|
+
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
|
|
560
533
|
*/
|
|
561
534
|
async redeemReferralCode(
|
|
562
535
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -19,8 +19,8 @@ declare class Share {
|
|
|
19
19
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
21
21
|
* @name createShortLink
|
|
22
|
-
* @summary:
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Shorten URL.
|
|
23
|
+
* @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/).
|
|
24
24
|
*/
|
|
25
25
|
createShortLink({ body, requestHeaders }?: ShareApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
26
26
|
/**
|
|
@@ -29,8 +29,8 @@ declare class Share {
|
|
|
29
29
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
31
31
|
* @name getApplicationQRCode
|
|
32
|
-
* @summary:
|
|
33
|
-
* @description:
|
|
32
|
+
* @summary: App QR code.
|
|
33
|
+
* @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/).
|
|
34
34
|
*/
|
|
35
35
|
getApplicationQRCode({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
36
36
|
/**
|
|
@@ -39,8 +39,8 @@ declare class Share {
|
|
|
39
39
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
40
40
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
41
41
|
* @name getCollectionQRCodeBySlug
|
|
42
|
-
* @summary:
|
|
43
|
-
* @description:
|
|
42
|
+
* @summary: Collection QR code.
|
|
43
|
+
* @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/).
|
|
44
44
|
*/
|
|
45
45
|
getCollectionQRCodeBySlug({ slug, requestHeaders }?: ShareApplicationValidator.GetCollectionQRCodeBySlugParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
46
46
|
/**
|
|
@@ -50,8 +50,8 @@ declare class Share {
|
|
|
50
50
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
51
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
52
52
|
* @name getOriginalShortLinkByHash
|
|
53
|
-
* @summary:
|
|
54
|
-
* @description:
|
|
53
|
+
* @summary: Original URL.
|
|
54
|
+
* @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/).
|
|
55
55
|
*/
|
|
56
56
|
getOriginalShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetOriginalShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
57
57
|
/**
|
|
@@ -60,8 +60,8 @@ declare class Share {
|
|
|
60
60
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
61
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
62
62
|
* @name getProductQRCodeBySlug
|
|
63
|
-
* @summary:
|
|
64
|
-
* @description:
|
|
63
|
+
* @summary: Product QR code.
|
|
64
|
+
* @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/).
|
|
65
65
|
*/
|
|
66
66
|
getProductQRCodeBySlug({ slug, requestHeaders }?: ShareApplicationValidator.GetProductQRCodeBySlugParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
67
67
|
/**
|
|
@@ -70,8 +70,8 @@ declare class Share {
|
|
|
70
70
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
71
71
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
72
72
|
* @name getShortLinkByHash
|
|
73
|
-
* @summary:
|
|
74
|
-
* @description:
|
|
73
|
+
* @summary: Fetch short link.
|
|
74
|
+
* @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/).
|
|
75
75
|
*/
|
|
76
76
|
getShortLinkByHash({ hash, requestHeaders }?: ShareApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
77
77
|
/**
|
|
@@ -80,8 +80,8 @@ declare class Share {
|
|
|
80
80
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
81
81
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
82
82
|
* @name getUrlQRCode
|
|
83
|
-
* @summary:
|
|
84
|
-
* @description:
|
|
83
|
+
* @summary: URL to QR code.
|
|
84
|
+
* @description: Converts a given URL into a scannable QR code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getUrlQRCode/).
|
|
85
85
|
*/
|
|
86
86
|
getUrlQRCode({ url, requestHeaders }?: ShareApplicationValidator.GetUrlQRCodeParam, { responseHeaders }?: object): Promise<ShareApplicationModel.QRCodeResp>;
|
|
87
87
|
}
|
|
@@ -48,8 +48,8 @@ class Share {
|
|
|
48
48
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
50
50
|
* @name createShortLink
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
51
|
+
* @summary: Shorten URL.
|
|
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(
|
|
55
55
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -126,8 +126,8 @@ class Share {
|
|
|
126
126
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
127
127
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
128
128
|
* @name getApplicationQRCode
|
|
129
|
-
* @summary:
|
|
130
|
-
* @description:
|
|
129
|
+
* @summary: App QR code.
|
|
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(
|
|
133
133
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -204,8 +204,8 @@ class Share {
|
|
|
204
204
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
205
205
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
206
206
|
* @name getCollectionQRCodeBySlug
|
|
207
|
-
* @summary:
|
|
208
|
-
* @description:
|
|
207
|
+
* @summary: Collection QR code.
|
|
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(
|
|
211
211
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -285,8 +285,8 @@ class Share {
|
|
|
285
285
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
286
286
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
287
287
|
* @name getOriginalShortLinkByHash
|
|
288
|
-
* @summary:
|
|
289
|
-
* @description:
|
|
288
|
+
* @summary: Original URL.
|
|
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(
|
|
292
292
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -365,8 +365,8 @@ class Share {
|
|
|
365
365
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
366
366
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
367
367
|
* @name getProductQRCodeBySlug
|
|
368
|
-
* @summary:
|
|
369
|
-
* @description:
|
|
368
|
+
* @summary: Product QR code.
|
|
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(
|
|
372
372
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -445,8 +445,8 @@ class Share {
|
|
|
445
445
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
446
446
|
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
447
447
|
* @name getShortLinkByHash
|
|
448
|
-
* @summary:
|
|
449
|
-
* @description:
|
|
448
|
+
* @summary: Fetch short link.
|
|
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(
|
|
452
452
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -523,8 +523,8 @@ class Share {
|
|
|
523
523
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
524
524
|
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
525
525
|
* @name getUrlQRCode
|
|
526
|
-
* @summary:
|
|
527
|
-
* @description:
|
|
526
|
+
* @summary: URL to QR code.
|
|
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(
|
|
530
530
|
{ url, requestHeaders } = { requestHeaders: {} },
|
|
@@ -53,8 +53,6 @@ export = ShareApplicationModel;
|
|
|
53
53
|
*/
|
|
54
54
|
/**
|
|
55
55
|
* @typedef UrlInfo
|
|
56
|
-
* @property {string} [original]
|
|
57
|
-
* @property {string} [short]
|
|
58
56
|
* @property {string} [hash]
|
|
59
57
|
*/
|
|
60
58
|
/**
|
|
@@ -161,8 +159,6 @@ type ShortLinkReq = {
|
|
|
161
159
|
/** @returns {UrlInfo} */
|
|
162
160
|
declare function UrlInfo(): UrlInfo;
|
|
163
161
|
type UrlInfo = {
|
|
164
|
-
original?: string;
|
|
165
|
-
short?: string;
|
|
166
162
|
hash?: string;
|
|
167
163
|
};
|
|
168
164
|
/** @returns {ShortLinkRes} */
|
|
@@ -62,8 +62,6 @@ const Joi = require("joi");
|
|
|
62
62
|
|
|
63
63
|
/**
|
|
64
64
|
* @typedef UrlInfo
|
|
65
|
-
* @property {string} [original]
|
|
66
|
-
* @property {string} [short]
|
|
67
65
|
* @property {string} [hash]
|
|
68
66
|
*/
|
|
69
67
|
|
|
@@ -176,8 +174,6 @@ class ShareApplicationModel {
|
|
|
176
174
|
/** @returns {UrlInfo} */
|
|
177
175
|
static UrlInfo() {
|
|
178
176
|
return Joi.object({
|
|
179
|
-
original: Joi.string().allow(""),
|
|
180
|
-
short: Joi.string().allow(""),
|
|
181
177
|
hash: Joi.string().allow(""),
|
|
182
178
|
});
|
|
183
179
|
}
|
|
@@ -16,8 +16,8 @@ declare class Theme {
|
|
|
16
16
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
17
17
|
* @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
|
|
18
18
|
* @name getAllPages
|
|
19
|
-
* @summary:
|
|
20
|
-
* @description:
|
|
19
|
+
* @summary: Fetch all pages.
|
|
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>;
|
|
23
23
|
/**
|
|
@@ -26,8 +26,8 @@ declare class Theme {
|
|
|
26
26
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
27
27
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
28
28
|
* @name getAppliedTheme
|
|
29
|
-
* @summary:
|
|
30
|
-
* @description:
|
|
29
|
+
* @summary: Current theme.
|
|
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>;
|
|
33
33
|
/**
|
|
@@ -36,8 +36,8 @@ declare class Theme {
|
|
|
36
36
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
37
37
|
* @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
|
|
38
38
|
* @name getPage
|
|
39
|
-
* @summary:
|
|
40
|
-
* @description:
|
|
39
|
+
* @summary: Single page details.
|
|
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>;
|
|
43
43
|
/**
|
|
@@ -46,8 +46,8 @@ declare class Theme {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
48
48
|
* @name getThemeForPreview
|
|
49
|
-
* @summary:
|
|
50
|
-
* @description:
|
|
49
|
+
* @summary: Preview theme.
|
|
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>;
|
|
53
53
|
}
|
|
@@ -41,8 +41,8 @@ class Theme {
|
|
|
41
41
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
42
42
|
* @returns {Promise<ThemeApplicationModel.AllAvailablePageSchema>} - Success response
|
|
43
43
|
* @name getAllPages
|
|
44
|
-
* @summary:
|
|
45
|
-
* @description:
|
|
44
|
+
* @summary: Fetch all pages.
|
|
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(
|
|
48
48
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -119,8 +119,8 @@ class Theme {
|
|
|
119
119
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
120
120
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
121
121
|
* @name getAppliedTheme
|
|
122
|
-
* @summary:
|
|
123
|
-
* @description:
|
|
122
|
+
* @summary: Current theme.
|
|
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(
|
|
126
126
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -197,8 +197,8 @@ class Theme {
|
|
|
197
197
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
198
198
|
* @returns {Promise<ThemeApplicationModel.AvailablePageSchema>} - Success response
|
|
199
199
|
* @name getPage
|
|
200
|
-
* @summary:
|
|
201
|
-
* @description:
|
|
200
|
+
* @summary: Single page details.
|
|
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(
|
|
204
204
|
{ themeId, pageValue, filters, company, requestHeaders } = {
|
|
@@ -277,8 +277,8 @@ class Theme {
|
|
|
277
277
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
278
278
|
* @returns {Promise<ThemeApplicationModel.ThemesSchema>} - Success response
|
|
279
279
|
* @name getThemeForPreview
|
|
280
|
-
* @summary:
|
|
281
|
-
* @description:
|
|
280
|
+
* @summary: Preview theme.
|
|
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(
|
|
284
284
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|