@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.10
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.js +0 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +55 -90
- package/sdk/application/Cart/CartApplicationClient.js +60 -1185
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1293
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +5 -89
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -718
- package/sdk/application/Content/ContentApplicationClient.d.ts +46 -78
- package/sdk/application/Content/ContentApplicationClient.js +77 -914
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -12
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +22 -125
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +32 -202
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +50 -478
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -42
- package/sdk/application/Order/OrderApplicationClient.js +86 -472
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -212
- package/sdk/application/Payment/PaymentApplicationClient.js +57 -2102
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -28
- package/sdk/application/Rewards/RewardsApplicationClient.js +16 -305
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +34 -294
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +28 -162
- package/sdk/application/User/UserApplicationClient.d.ts +85 -136
- package/sdk/application/User/UserApplicationClient.js +45 -1815
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +2 -5
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -47
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +2 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -0
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +0 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +14 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +6 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +3 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +3 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformClient.js +99 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -0
- package/sdk/platform/Order/OrderPlatformModel.js +3 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +56 -19
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +1 -1
- package/sdk/public/Content/ContentPublicClient.js +14 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +14 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -2
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
|
@@ -14,80 +14,66 @@ declare class Rewards {
|
|
|
14
14
|
_urls: {};
|
|
15
15
|
updateUrls(urls: any): void;
|
|
16
16
|
/**
|
|
17
|
-
* @param {RewardsApplicationValidator.CatalogueOrderParam} arg - Arg object.
|
|
18
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
18
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<
|
|
21
|
-
* Success response
|
|
19
|
+
* @returns {Promise<CatalogueOrderResponse>} - Success response
|
|
22
20
|
* @name catalogueOrder
|
|
23
21
|
* @summary: Order from catalogue
|
|
24
22
|
* @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
23
|
*/
|
|
26
|
-
catalogueOrder({ body, requestHeaders }?:
|
|
24
|
+
catalogueOrder({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CatalogueOrderResponse>;
|
|
27
25
|
/**
|
|
28
|
-
* @param {RewardsApplicationValidator.GetOfferByNameParam} arg - Arg object.
|
|
29
26
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
30
27
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
31
|
-
* @returns {Promise<
|
|
28
|
+
* @returns {Promise<Offer>} - Success response
|
|
32
29
|
* @name getOfferByName
|
|
33
30
|
* @summary: Get specific offer
|
|
34
31
|
* @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
32
|
*/
|
|
36
|
-
getOfferByName({ name, requestHeaders }?:
|
|
33
|
+
getOfferByName({ name, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Offer>;
|
|
37
34
|
/**
|
|
38
|
-
* @param {RewardsApplicationValidator.GetOrderDiscountParam} arg - Arg object.
|
|
39
35
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
40
36
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
41
|
-
* @returns {Promise<
|
|
42
|
-
* Success response
|
|
37
|
+
* @returns {Promise<OrderDiscountResponse>} - Success response
|
|
43
38
|
* @name getOrderDiscount
|
|
44
39
|
* @summary: Order discount
|
|
45
40
|
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
|
|
46
41
|
*/
|
|
47
|
-
getOrderDiscount({ body, requestHeaders }?:
|
|
42
|
+
getOrderDiscount({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderDiscountResponse>;
|
|
48
43
|
/**
|
|
49
|
-
* @param {RewardsApplicationValidator.GetUserPointsParam} arg - Arg object.
|
|
50
44
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
45
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<
|
|
46
|
+
* @returns {Promise<PointsResponse>} - Success response
|
|
53
47
|
* @name getUserPoints
|
|
54
48
|
* @summary: Current points
|
|
55
49
|
* @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
50
|
*/
|
|
57
|
-
getUserPoints({ requestHeaders }?:
|
|
51
|
+
getUserPoints({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsResponse>;
|
|
58
52
|
/**
|
|
59
|
-
* @param {RewardsApplicationValidator.GetUserPointsHistoryParam} arg - Arg object.
|
|
60
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
61
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
62
|
-
* @returns {Promise<
|
|
63
|
-
* Success response
|
|
55
|
+
* @returns {Promise<PointsHistoryResponse>} - Success response
|
|
64
56
|
* @name getUserPointsHistory
|
|
65
57
|
* @summary: Points history
|
|
66
58
|
* @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
59
|
*/
|
|
68
|
-
getUserPointsHistory({ pageId, pageSize, requestHeaders }?:
|
|
60
|
+
getUserPointsHistory({ pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PointsHistoryResponse>;
|
|
69
61
|
/**
|
|
70
|
-
* @param {RewardsApplicationValidator.GetUserReferralDetailsParam} arg - Arg object.
|
|
71
62
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
72
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
73
|
-
* @returns {Promise<
|
|
74
|
-
* Success response
|
|
64
|
+
* @returns {Promise<ReferralDetailsResponse>} - Success response
|
|
75
65
|
* @name getUserReferralDetails
|
|
76
66
|
* @summary: Referral details
|
|
77
67
|
* @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/).
|
|
78
68
|
*/
|
|
79
|
-
getUserReferralDetails({ requestHeaders }?:
|
|
69
|
+
getUserReferralDetails({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReferralDetailsResponse>;
|
|
80
70
|
/**
|
|
81
|
-
* @param {RewardsApplicationValidator.RedeemReferralCodeParam} arg - Arg object.
|
|
82
71
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
83
72
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
84
|
-
* @returns {Promise<
|
|
85
|
-
* Success response
|
|
73
|
+
* @returns {Promise<RedeemReferralCodeResponse>} - Success response
|
|
86
74
|
* @name redeemReferralCode
|
|
87
75
|
* @summary: Redeem code
|
|
88
76
|
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
|
|
89
77
|
*/
|
|
90
|
-
redeemReferralCode({ body, requestHeaders }?:
|
|
78
|
+
redeemReferralCode({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<RedeemReferralCodeResponse>;
|
|
91
79
|
}
|
|
92
|
-
import RewardsApplicationValidator = require("./RewardsApplicationValidator");
|
|
93
|
-
import RewardsApplicationModel = require("./RewardsApplicationModel");
|
|
@@ -1,14 +1,12 @@
|
|
|
1
|
-
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
2
1
|
const {
|
|
3
2
|
FDKClientValidationError,
|
|
4
3
|
FDKResponseValidationError,
|
|
5
4
|
} = require("../../common/FDKError");
|
|
5
|
+
|
|
6
|
+
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
6
7
|
const constructUrl = require("../constructUrl");
|
|
7
8
|
const Paginator = require("../../common/Paginator");
|
|
8
|
-
const
|
|
9
|
-
const RewardsApplicationModel = require("./RewardsApplicationModel");
|
|
10
|
-
const { Logger } = require("./../../common/Logger");
|
|
11
|
-
const Joi = require("joi");
|
|
9
|
+
const { validateRequiredParams } = require("../../common/Validator");
|
|
12
10
|
|
|
13
11
|
class Rewards {
|
|
14
12
|
constructor(_conf) {
|
|
@@ -44,11 +42,9 @@ class Rewards {
|
|
|
44
42
|
}
|
|
45
43
|
|
|
46
44
|
/**
|
|
47
|
-
* @param {RewardsApplicationValidator.CatalogueOrderParam} arg - Arg object.
|
|
48
45
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
50
|
-
* @returns {Promise<
|
|
51
|
-
* Success response
|
|
47
|
+
* @returns {Promise<CatalogueOrderResponse>} - Success response
|
|
52
48
|
* @name catalogueOrder
|
|
53
49
|
* @summary: Order from catalogue
|
|
54
50
|
* @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/).
|
|
@@ -57,28 +53,6 @@ class Rewards {
|
|
|
57
53
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
58
54
|
{ responseHeaders } = { responseHeaders: false }
|
|
59
55
|
) {
|
|
60
|
-
const { error } = RewardsApplicationValidator.catalogueOrder().validate(
|
|
61
|
-
{ body },
|
|
62
|
-
{ abortEarly: false, allowUnknown: true }
|
|
63
|
-
);
|
|
64
|
-
if (error) {
|
|
65
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
// Showing warrnings if extra unknown parameters are found
|
|
69
|
-
const {
|
|
70
|
-
error: warrning,
|
|
71
|
-
} = RewardsApplicationValidator.catalogueOrder().validate(
|
|
72
|
-
{ body },
|
|
73
|
-
{ abortEarly: false, allowUnknown: false }
|
|
74
|
-
);
|
|
75
|
-
if (warrning) {
|
|
76
|
-
Logger({
|
|
77
|
-
level: "WARN",
|
|
78
|
-
message: `Parameter Validation warrnings for application > Rewards > catalogueOrder \n ${warrning}`,
|
|
79
|
-
});
|
|
80
|
-
}
|
|
81
|
-
|
|
82
56
|
const query_params = {};
|
|
83
57
|
|
|
84
58
|
const xHeaders = {};
|
|
@@ -101,32 +75,13 @@ class Rewards {
|
|
|
101
75
|
responseData = response[0];
|
|
102
76
|
}
|
|
103
77
|
|
|
104
|
-
const {
|
|
105
|
-
error: res_error,
|
|
106
|
-
} = RewardsApplicationModel.CatalogueOrderResponse().validate(
|
|
107
|
-
responseData,
|
|
108
|
-
{ abortEarly: false, allowUnknown: true }
|
|
109
|
-
);
|
|
110
|
-
|
|
111
|
-
if (res_error) {
|
|
112
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
113
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
114
|
-
} else {
|
|
115
|
-
Logger({
|
|
116
|
-
level: "WARN",
|
|
117
|
-
message: `Response Validation Warnings for application > Rewards > catalogueOrder \n ${res_error}`,
|
|
118
|
-
});
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
|
|
122
78
|
return response;
|
|
123
79
|
}
|
|
124
80
|
|
|
125
81
|
/**
|
|
126
|
-
* @param {RewardsApplicationValidator.GetOfferByNameParam} arg - Arg object.
|
|
127
82
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
128
83
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
129
|
-
* @returns {Promise<
|
|
84
|
+
* @returns {Promise<Offer>} - Success response
|
|
130
85
|
* @name getOfferByName
|
|
131
86
|
* @summary: Get specific offer
|
|
132
87
|
* @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
|
|
@@ -135,26 +90,13 @@ class Rewards {
|
|
|
135
90
|
{ name, requestHeaders } = { requestHeaders: {} },
|
|
136
91
|
{ responseHeaders } = { responseHeaders: false }
|
|
137
92
|
) {
|
|
138
|
-
const
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
// Showing warrnings if extra unknown parameters are found
|
|
147
|
-
const {
|
|
148
|
-
error: warrning,
|
|
149
|
-
} = RewardsApplicationValidator.getOfferByName().validate(
|
|
150
|
-
{ name },
|
|
151
|
-
{ abortEarly: false, allowUnknown: false }
|
|
152
|
-
);
|
|
153
|
-
if (warrning) {
|
|
154
|
-
Logger({
|
|
155
|
-
level: "WARN",
|
|
156
|
-
message: `Parameter Validation warrnings for application > Rewards > getOfferByName \n ${warrning}`,
|
|
93
|
+
const errors = validateRequiredParams(arguments[0], ["name"]);
|
|
94
|
+
if (errors.length > 0) {
|
|
95
|
+
const error = new FDKClientValidationError({
|
|
96
|
+
message: "Missing required field",
|
|
97
|
+
details: errors,
|
|
157
98
|
});
|
|
99
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
158
100
|
}
|
|
159
101
|
|
|
160
102
|
const query_params = {};
|
|
@@ -179,33 +121,13 @@ class Rewards {
|
|
|
179
121
|
responseData = response[0];
|
|
180
122
|
}
|
|
181
123
|
|
|
182
|
-
const {
|
|
183
|
-
error: res_error,
|
|
184
|
-
} = RewardsApplicationModel.Offer().validate(responseData, {
|
|
185
|
-
abortEarly: false,
|
|
186
|
-
allowUnknown: true,
|
|
187
|
-
});
|
|
188
|
-
|
|
189
|
-
if (res_error) {
|
|
190
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
191
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
192
|
-
} else {
|
|
193
|
-
Logger({
|
|
194
|
-
level: "WARN",
|
|
195
|
-
message: `Response Validation Warnings for application > Rewards > getOfferByName \n ${res_error}`,
|
|
196
|
-
});
|
|
197
|
-
}
|
|
198
|
-
}
|
|
199
|
-
|
|
200
124
|
return response;
|
|
201
125
|
}
|
|
202
126
|
|
|
203
127
|
/**
|
|
204
|
-
* @param {RewardsApplicationValidator.GetOrderDiscountParam} arg - Arg object.
|
|
205
128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
206
129
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
207
|
-
* @returns {Promise<
|
|
208
|
-
* Success response
|
|
130
|
+
* @returns {Promise<OrderDiscountResponse>} - Success response
|
|
209
131
|
* @name getOrderDiscount
|
|
210
132
|
* @summary: Order discount
|
|
211
133
|
* @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
|
|
@@ -214,28 +136,6 @@ class Rewards {
|
|
|
214
136
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
215
137
|
{ responseHeaders } = { responseHeaders: false }
|
|
216
138
|
) {
|
|
217
|
-
const { error } = RewardsApplicationValidator.getOrderDiscount().validate(
|
|
218
|
-
{ body },
|
|
219
|
-
{ abortEarly: false, allowUnknown: true }
|
|
220
|
-
);
|
|
221
|
-
if (error) {
|
|
222
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
// Showing warrnings if extra unknown parameters are found
|
|
226
|
-
const {
|
|
227
|
-
error: warrning,
|
|
228
|
-
} = RewardsApplicationValidator.getOrderDiscount().validate(
|
|
229
|
-
{ body },
|
|
230
|
-
{ abortEarly: false, allowUnknown: false }
|
|
231
|
-
);
|
|
232
|
-
if (warrning) {
|
|
233
|
-
Logger({
|
|
234
|
-
level: "WARN",
|
|
235
|
-
message: `Parameter Validation warrnings for application > Rewards > getOrderDiscount \n ${warrning}`,
|
|
236
|
-
});
|
|
237
|
-
}
|
|
238
|
-
|
|
239
139
|
const query_params = {};
|
|
240
140
|
|
|
241
141
|
const xHeaders = {};
|
|
@@ -258,32 +158,13 @@ class Rewards {
|
|
|
258
158
|
responseData = response[0];
|
|
259
159
|
}
|
|
260
160
|
|
|
261
|
-
const {
|
|
262
|
-
error: res_error,
|
|
263
|
-
} = RewardsApplicationModel.OrderDiscountResponse().validate(responseData, {
|
|
264
|
-
abortEarly: false,
|
|
265
|
-
allowUnknown: true,
|
|
266
|
-
});
|
|
267
|
-
|
|
268
|
-
if (res_error) {
|
|
269
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
270
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
271
|
-
} else {
|
|
272
|
-
Logger({
|
|
273
|
-
level: "WARN",
|
|
274
|
-
message: `Response Validation Warnings for application > Rewards > getOrderDiscount \n ${res_error}`,
|
|
275
|
-
});
|
|
276
|
-
}
|
|
277
|
-
}
|
|
278
|
-
|
|
279
161
|
return response;
|
|
280
162
|
}
|
|
281
163
|
|
|
282
164
|
/**
|
|
283
|
-
* @param {RewardsApplicationValidator.GetUserPointsParam} arg - Arg object.
|
|
284
165
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
285
166
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
286
|
-
* @returns {Promise<
|
|
167
|
+
* @returns {Promise<PointsResponse>} - Success response
|
|
287
168
|
* @name getUserPoints
|
|
288
169
|
* @summary: Current points
|
|
289
170
|
* @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
|
|
@@ -292,28 +173,6 @@ class Rewards {
|
|
|
292
173
|
{ requestHeaders } = { requestHeaders: {} },
|
|
293
174
|
{ responseHeaders } = { responseHeaders: false }
|
|
294
175
|
) {
|
|
295
|
-
const { error } = RewardsApplicationValidator.getUserPoints().validate(
|
|
296
|
-
{},
|
|
297
|
-
{ abortEarly: false, allowUnknown: true }
|
|
298
|
-
);
|
|
299
|
-
if (error) {
|
|
300
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
// Showing warrnings if extra unknown parameters are found
|
|
304
|
-
const {
|
|
305
|
-
error: warrning,
|
|
306
|
-
} = RewardsApplicationValidator.getUserPoints().validate(
|
|
307
|
-
{},
|
|
308
|
-
{ abortEarly: false, allowUnknown: false }
|
|
309
|
-
);
|
|
310
|
-
if (warrning) {
|
|
311
|
-
Logger({
|
|
312
|
-
level: "WARN",
|
|
313
|
-
message: `Parameter Validation warrnings for application > Rewards > getUserPoints \n ${warrning}`,
|
|
314
|
-
});
|
|
315
|
-
}
|
|
316
|
-
|
|
317
176
|
const query_params = {};
|
|
318
177
|
|
|
319
178
|
const xHeaders = {};
|
|
@@ -336,33 +195,13 @@ class Rewards {
|
|
|
336
195
|
responseData = response[0];
|
|
337
196
|
}
|
|
338
197
|
|
|
339
|
-
const {
|
|
340
|
-
error: res_error,
|
|
341
|
-
} = RewardsApplicationModel.PointsResponse().validate(responseData, {
|
|
342
|
-
abortEarly: false,
|
|
343
|
-
allowUnknown: true,
|
|
344
|
-
});
|
|
345
|
-
|
|
346
|
-
if (res_error) {
|
|
347
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
348
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
349
|
-
} else {
|
|
350
|
-
Logger({
|
|
351
|
-
level: "WARN",
|
|
352
|
-
message: `Response Validation Warnings for application > Rewards > getUserPoints \n ${res_error}`,
|
|
353
|
-
});
|
|
354
|
-
}
|
|
355
|
-
}
|
|
356
|
-
|
|
357
198
|
return response;
|
|
358
199
|
}
|
|
359
200
|
|
|
360
201
|
/**
|
|
361
|
-
* @param {RewardsApplicationValidator.GetUserPointsHistoryParam} arg - Arg object.
|
|
362
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
363
203
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
364
|
-
* @returns {Promise<
|
|
365
|
-
* Success response
|
|
204
|
+
* @returns {Promise<PointsHistoryResponse>} - Success response
|
|
366
205
|
* @name getUserPointsHistory
|
|
367
206
|
* @summary: Points history
|
|
368
207
|
* @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/).
|
|
@@ -371,30 +210,6 @@ class Rewards {
|
|
|
371
210
|
{ pageId, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
372
211
|
{ responseHeaders } = { responseHeaders: false }
|
|
373
212
|
) {
|
|
374
|
-
const {
|
|
375
|
-
error,
|
|
376
|
-
} = RewardsApplicationValidator.getUserPointsHistory().validate(
|
|
377
|
-
{ pageId, pageSize },
|
|
378
|
-
{ abortEarly: false, allowUnknown: true }
|
|
379
|
-
);
|
|
380
|
-
if (error) {
|
|
381
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
// Showing warrnings if extra unknown parameters are found
|
|
385
|
-
const {
|
|
386
|
-
error: warrning,
|
|
387
|
-
} = RewardsApplicationValidator.getUserPointsHistory().validate(
|
|
388
|
-
{ pageId, pageSize },
|
|
389
|
-
{ abortEarly: false, allowUnknown: false }
|
|
390
|
-
);
|
|
391
|
-
if (warrning) {
|
|
392
|
-
Logger({
|
|
393
|
-
level: "WARN",
|
|
394
|
-
message: `Parameter Validation warrnings for application > Rewards > getUserPointsHistory \n ${warrning}`,
|
|
395
|
-
});
|
|
396
|
-
}
|
|
397
|
-
|
|
398
213
|
const query_params = {};
|
|
399
214
|
query_params["page_id"] = pageId;
|
|
400
215
|
query_params["page_size"] = pageSize;
|
|
@@ -419,33 +234,13 @@ class Rewards {
|
|
|
419
234
|
responseData = response[0];
|
|
420
235
|
}
|
|
421
236
|
|
|
422
|
-
const {
|
|
423
|
-
error: res_error,
|
|
424
|
-
} = RewardsApplicationModel.PointsHistoryResponse().validate(responseData, {
|
|
425
|
-
abortEarly: false,
|
|
426
|
-
allowUnknown: true,
|
|
427
|
-
});
|
|
428
|
-
|
|
429
|
-
if (res_error) {
|
|
430
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
431
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
432
|
-
} else {
|
|
433
|
-
Logger({
|
|
434
|
-
level: "WARN",
|
|
435
|
-
message: `Response Validation Warnings for application > Rewards > getUserPointsHistory \n ${res_error}`,
|
|
436
|
-
});
|
|
437
|
-
}
|
|
438
|
-
}
|
|
439
|
-
|
|
440
237
|
return response;
|
|
441
238
|
}
|
|
442
239
|
|
|
443
240
|
/**
|
|
444
|
-
* @param {RewardsApplicationValidator.GetUserReferralDetailsParam} arg - Arg object.
|
|
445
241
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
446
242
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
447
|
-
* @returns {Promise<
|
|
448
|
-
* Success response
|
|
243
|
+
* @returns {Promise<ReferralDetailsResponse>} - Success response
|
|
449
244
|
* @name getUserReferralDetails
|
|
450
245
|
* @summary: Referral details
|
|
451
246
|
* @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/).
|
|
@@ -454,30 +249,6 @@ class Rewards {
|
|
|
454
249
|
{ requestHeaders } = { requestHeaders: {} },
|
|
455
250
|
{ responseHeaders } = { responseHeaders: false }
|
|
456
251
|
) {
|
|
457
|
-
const {
|
|
458
|
-
error,
|
|
459
|
-
} = RewardsApplicationValidator.getUserReferralDetails().validate(
|
|
460
|
-
{},
|
|
461
|
-
{ abortEarly: false, allowUnknown: true }
|
|
462
|
-
);
|
|
463
|
-
if (error) {
|
|
464
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
465
|
-
}
|
|
466
|
-
|
|
467
|
-
// Showing warrnings if extra unknown parameters are found
|
|
468
|
-
const {
|
|
469
|
-
error: warrning,
|
|
470
|
-
} = RewardsApplicationValidator.getUserReferralDetails().validate(
|
|
471
|
-
{},
|
|
472
|
-
{ abortEarly: false, allowUnknown: false }
|
|
473
|
-
);
|
|
474
|
-
if (warrning) {
|
|
475
|
-
Logger({
|
|
476
|
-
level: "WARN",
|
|
477
|
-
message: `Parameter Validation warrnings for application > Rewards > getUserReferralDetails \n ${warrning}`,
|
|
478
|
-
});
|
|
479
|
-
}
|
|
480
|
-
|
|
481
252
|
const query_params = {};
|
|
482
253
|
|
|
483
254
|
const xHeaders = {};
|
|
@@ -500,33 +271,13 @@ class Rewards {
|
|
|
500
271
|
responseData = response[0];
|
|
501
272
|
}
|
|
502
273
|
|
|
503
|
-
const {
|
|
504
|
-
error: res_error,
|
|
505
|
-
} = RewardsApplicationModel.ReferralDetailsResponse().validate(
|
|
506
|
-
responseData,
|
|
507
|
-
{ abortEarly: false, allowUnknown: true }
|
|
508
|
-
);
|
|
509
|
-
|
|
510
|
-
if (res_error) {
|
|
511
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
512
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
513
|
-
} else {
|
|
514
|
-
Logger({
|
|
515
|
-
level: "WARN",
|
|
516
|
-
message: `Response Validation Warnings for application > Rewards > getUserReferralDetails \n ${res_error}`,
|
|
517
|
-
});
|
|
518
|
-
}
|
|
519
|
-
}
|
|
520
|
-
|
|
521
274
|
return response;
|
|
522
275
|
}
|
|
523
276
|
|
|
524
277
|
/**
|
|
525
|
-
* @param {RewardsApplicationValidator.RedeemReferralCodeParam} arg - Arg object.
|
|
526
278
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
527
279
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
528
|
-
* @returns {Promise<
|
|
529
|
-
* Success response
|
|
280
|
+
* @returns {Promise<RedeemReferralCodeResponse>} - Success response
|
|
530
281
|
* @name redeemReferralCode
|
|
531
282
|
* @summary: Redeem code
|
|
532
283
|
* @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
|
|
@@ -535,28 +286,6 @@ class Rewards {
|
|
|
535
286
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
536
287
|
{ responseHeaders } = { responseHeaders: false }
|
|
537
288
|
) {
|
|
538
|
-
const { error } = RewardsApplicationValidator.redeemReferralCode().validate(
|
|
539
|
-
{ body },
|
|
540
|
-
{ abortEarly: false, allowUnknown: true }
|
|
541
|
-
);
|
|
542
|
-
if (error) {
|
|
543
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
544
|
-
}
|
|
545
|
-
|
|
546
|
-
// Showing warrnings if extra unknown parameters are found
|
|
547
|
-
const {
|
|
548
|
-
error: warrning,
|
|
549
|
-
} = RewardsApplicationValidator.redeemReferralCode().validate(
|
|
550
|
-
{ body },
|
|
551
|
-
{ abortEarly: false, allowUnknown: false }
|
|
552
|
-
);
|
|
553
|
-
if (warrning) {
|
|
554
|
-
Logger({
|
|
555
|
-
level: "WARN",
|
|
556
|
-
message: `Parameter Validation warrnings for application > Rewards > redeemReferralCode \n ${warrning}`,
|
|
557
|
-
});
|
|
558
|
-
}
|
|
559
|
-
|
|
560
289
|
const query_params = {};
|
|
561
290
|
|
|
562
291
|
const xHeaders = {};
|
|
@@ -579,24 +308,6 @@ class Rewards {
|
|
|
579
308
|
responseData = response[0];
|
|
580
309
|
}
|
|
581
310
|
|
|
582
|
-
const {
|
|
583
|
-
error: res_error,
|
|
584
|
-
} = RewardsApplicationModel.RedeemReferralCodeResponse().validate(
|
|
585
|
-
responseData,
|
|
586
|
-
{ abortEarly: false, allowUnknown: true }
|
|
587
|
-
);
|
|
588
|
-
|
|
589
|
-
if (res_error) {
|
|
590
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
591
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
592
|
-
} else {
|
|
593
|
-
Logger({
|
|
594
|
-
level: "WARN",
|
|
595
|
-
message: `Response Validation Warnings for application > Rewards > redeemReferralCode \n ${res_error}`,
|
|
596
|
-
});
|
|
597
|
-
}
|
|
598
|
-
}
|
|
599
|
-
|
|
600
311
|
return response;
|
|
601
312
|
}
|
|
602
313
|
}
|
|
@@ -14,76 +14,66 @@ declare class Share {
|
|
|
14
14
|
_urls: {};
|
|
15
15
|
updateUrls(urls: any): void;
|
|
16
16
|
/**
|
|
17
|
-
* @param {ShareApplicationValidator.CreateShortLinkParam} arg - Arg object.
|
|
18
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
18
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<
|
|
19
|
+
* @returns {Promise<ShortLinkRes>} - Success response
|
|
21
20
|
* @name createShortLink
|
|
22
21
|
* @summary: Shorten URL
|
|
23
22
|
* @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
23
|
*/
|
|
25
|
-
createShortLink({ body, requestHeaders }?:
|
|
24
|
+
createShortLink({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShortLinkRes>;
|
|
26
25
|
/**
|
|
27
|
-
* @param {ShareApplicationValidator.GetApplicationQRCodeParam} arg - Arg object.
|
|
28
26
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
29
27
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
30
|
-
* @returns {Promise<
|
|
28
|
+
* @returns {Promise<QRCodeResp>} - Success response
|
|
31
29
|
* @name getApplicationQRCode
|
|
32
30
|
* @summary: App QR code
|
|
33
31
|
* @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
32
|
*/
|
|
35
|
-
getApplicationQRCode({ requestHeaders }?:
|
|
33
|
+
getApplicationQRCode({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<QRCodeResp>;
|
|
36
34
|
/**
|
|
37
|
-
* @param {ShareApplicationValidator.GetCollectionQRCodeBySlugParam} arg - Arg object.
|
|
38
35
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
39
36
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
40
|
-
* @returns {Promise<
|
|
37
|
+
* @returns {Promise<QRCodeResp>} - Success response
|
|
41
38
|
* @name getCollectionQRCodeBySlug
|
|
42
39
|
* @summary: Collection QR code
|
|
43
40
|
* @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
41
|
*/
|
|
45
|
-
getCollectionQRCodeBySlug({ slug, requestHeaders }?:
|
|
42
|
+
getCollectionQRCodeBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<QRCodeResp>;
|
|
46
43
|
/**
|
|
47
|
-
* @param {ShareApplicationValidator.GetOriginalShortLinkByHashParam} arg -
|
|
48
|
-
* Arg object.
|
|
49
44
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
45
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
|
-
* @returns {Promise<
|
|
46
|
+
* @returns {Promise<ShortLinkRes>} - Success response
|
|
52
47
|
* @name getOriginalShortLinkByHash
|
|
53
48
|
* @summary: Original URL
|
|
54
49
|
* @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
50
|
*/
|
|
56
|
-
getOriginalShortLinkByHash({ hash, requestHeaders }?:
|
|
51
|
+
getOriginalShortLinkByHash({ hash, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShortLinkRes>;
|
|
57
52
|
/**
|
|
58
|
-
* @param {ShareApplicationValidator.GetProductQRCodeBySlugParam} arg - Arg object.
|
|
59
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
60
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
|
-
* @returns {Promise<
|
|
55
|
+
* @returns {Promise<QRCodeResp>} - Success response
|
|
62
56
|
* @name getProductQRCodeBySlug
|
|
63
57
|
* @summary: Product QR code
|
|
64
58
|
* @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
59
|
*/
|
|
66
|
-
getProductQRCodeBySlug({ slug, requestHeaders }?:
|
|
60
|
+
getProductQRCodeBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<QRCodeResp>;
|
|
67
61
|
/**
|
|
68
|
-
* @param {ShareApplicationValidator.GetShortLinkByHashParam} arg - Arg object.
|
|
69
62
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
71
|
-
* @returns {Promise<
|
|
64
|
+
* @returns {Promise<ShortLinkRes>} - Success response
|
|
72
65
|
* @name getShortLinkByHash
|
|
73
66
|
* @summary: Get short link
|
|
74
67
|
* @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
68
|
*/
|
|
76
|
-
getShortLinkByHash({ hash, requestHeaders }?:
|
|
69
|
+
getShortLinkByHash({ hash, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShortLinkRes>;
|
|
77
70
|
/**
|
|
78
|
-
* @param {ShareApplicationValidator.GetUrlQRCodeParam} arg - Arg object.
|
|
79
71
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
80
72
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
81
|
-
* @returns {Promise<
|
|
73
|
+
* @returns {Promise<QRCodeResp>} - Success response
|
|
82
74
|
* @name getUrlQRCode
|
|
83
75
|
* @summary: URL to QR code
|
|
84
76
|
* @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
77
|
*/
|
|
86
|
-
getUrlQRCode({ url, requestHeaders }?:
|
|
78
|
+
getUrlQRCode({ url, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<QRCodeResp>;
|
|
87
79
|
}
|
|
88
|
-
import ShareApplicationValidator = require("./ShareApplicationValidator");
|
|
89
|
-
import ShareApplicationModel = require("./ShareApplicationModel");
|