@gofynd/fdk-client-javascript 3.3.1 → 3.3.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 +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +14 -3
- package/sdk/application/User/UserApplicationClient.d.ts +40 -0
- package/sdk/application/User/UserApplicationClient.js +192 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +20 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +17 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +54 -0
- package/sdk/platform/Cart/CartPlatformModel.js +23 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +41 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +33 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +4 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +23 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +22 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +1 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +21 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +20 -0
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.3.3' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -197,7 +197,7 @@ declare class Cart {
|
|
|
197
197
|
* @summary: List available promotion offers
|
|
198
198
|
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionOffers/).
|
|
199
199
|
*/
|
|
200
|
-
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PromotionOffersResult>;
|
|
200
|
+
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, promotionType, cartId, autoApply, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PromotionOffersResult>;
|
|
201
201
|
/**
|
|
202
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
203
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -830,9 +830,17 @@ class Cart {
|
|
|
830
830
|
* @description: List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionOffers/).
|
|
831
831
|
*/
|
|
832
832
|
async getPromotionOffers(
|
|
833
|
-
{
|
|
834
|
-
|
|
835
|
-
|
|
833
|
+
{
|
|
834
|
+
slug,
|
|
835
|
+
pageSize,
|
|
836
|
+
promotionGroup,
|
|
837
|
+
storeId,
|
|
838
|
+
cartType,
|
|
839
|
+
promotionType,
|
|
840
|
+
cartId,
|
|
841
|
+
autoApply,
|
|
842
|
+
requestHeaders,
|
|
843
|
+
} = { requestHeaders: {} },
|
|
836
844
|
{ responseHeaders } = { responseHeaders: false }
|
|
837
845
|
) {
|
|
838
846
|
const query_params = {};
|
|
@@ -841,6 +849,9 @@ class Cart {
|
|
|
841
849
|
query_params["promotion_group"] = promotionGroup;
|
|
842
850
|
query_params["store_id"] = storeId;
|
|
843
851
|
query_params["cart_type"] = cartType;
|
|
852
|
+
query_params["promotion_type"] = promotionType;
|
|
853
|
+
query_params["cart_id"] = cartId;
|
|
854
|
+
query_params["auto_apply"] = autoApply;
|
|
844
855
|
|
|
845
856
|
const xHeaders = {};
|
|
846
857
|
|
|
@@ -27,8 +27,10 @@ declare class User {
|
|
|
27
27
|
resetForgotPassword: string;
|
|
28
28
|
sendForgotOTPOnEmail: string;
|
|
29
29
|
sendForgotOTPOnMobile: string;
|
|
30
|
+
sendOTPForUpdate: string;
|
|
30
31
|
sendOTPOnEmail: string;
|
|
31
32
|
sendOTPOnMobile: string;
|
|
33
|
+
sendOTPOnPrimary: string;
|
|
32
34
|
sendResetPasswordEmail: string;
|
|
33
35
|
sendResetPasswordMobile: string;
|
|
34
36
|
sendResetToken: string;
|
|
@@ -46,6 +48,8 @@ declare class User {
|
|
|
46
48
|
verifyMobile: string;
|
|
47
49
|
verifyMobileForgotOTP: string;
|
|
48
50
|
verifyMobileOTP: string;
|
|
51
|
+
verifyOTPForUpdate: string;
|
|
52
|
+
verifyOTPonPrimary: string;
|
|
49
53
|
};
|
|
50
54
|
_urls: {};
|
|
51
55
|
updateUrls(urls: any): void;
|
|
@@ -265,6 +269,15 @@ declare class User {
|
|
|
265
269
|
* @description: Send a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnMobile/).
|
|
266
270
|
*/
|
|
267
271
|
sendForgotOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpSuccess>;
|
|
272
|
+
/**
|
|
273
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
274
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
275
|
+
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
276
|
+
* @name sendOTPForUpdate
|
|
277
|
+
* @summary: Send OTP to update Mobile or Email
|
|
278
|
+
* @description: Send OTP to mobile number or email. User needs to use sendOTPOnPrimary and verifyOTPonPrimary before using this method to update details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPForUpdate/).
|
|
279
|
+
*/
|
|
280
|
+
sendOTPForUpdate({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpSuccess>;
|
|
268
281
|
/**
|
|
269
282
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
283
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -283,6 +296,15 @@ declare class User {
|
|
|
283
296
|
* @description: Send 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/).
|
|
284
297
|
*/
|
|
285
298
|
sendOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpSuccess>;
|
|
299
|
+
/**
|
|
300
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
301
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
302
|
+
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
303
|
+
* @name sendOTPOnPrimary
|
|
304
|
+
* @summary: Send OTP to Primary Mobile or Email
|
|
305
|
+
* @description: Send OTP to primary mobile number or email to verify primary details. Use this to update Email or Mobile, other APIs will be deprecated. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnPrimary/).
|
|
306
|
+
*/
|
|
307
|
+
sendOTPOnPrimary({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpSuccess>;
|
|
286
308
|
/**
|
|
287
309
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
288
310
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -436,4 +458,22 @@ declare class User {
|
|
|
436
458
|
* @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
|
|
437
459
|
*/
|
|
438
460
|
verifyMobileOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyOtpSuccess>;
|
|
461
|
+
/**
|
|
462
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
463
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
464
|
+
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
465
|
+
* @name verifyOTPForUpdate
|
|
466
|
+
* @summary: Verify OTP sent to Mobile or Email to update primary details.
|
|
467
|
+
* @description: Verify OTP sent to Mobile number or Email to update primary details. User needs to use sendOTPOnPrimary, verifyOTPonPrimary and sendOTPForUpdate before using this method to verify update details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyOTPForUpdate/).
|
|
468
|
+
*/
|
|
469
|
+
verifyOTPForUpdate({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyOtpSuccess>;
|
|
470
|
+
/**
|
|
471
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
472
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
473
|
+
* @returns {Promise<VerifyPrimaryOTPSuccess>} - Success response
|
|
474
|
+
* @name verifyOTPonPrimary
|
|
475
|
+
* @summary: Verify OTP sent to Primary Mobile or Email
|
|
476
|
+
* @description: Verify OTP sent to primary mobile number or email to verify primary details. User needs to use sendOTPOnPrimary before verifying OTP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyOTPonPrimary/).
|
|
477
|
+
*/
|
|
478
|
+
verifyOTPonPrimary({ entity, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyPrimaryOTPSuccess>;
|
|
439
479
|
}
|
|
@@ -50,10 +50,14 @@ class User {
|
|
|
50
50
|
"/service/application/user/authentication/v1.0/otp/forgot/email/send",
|
|
51
51
|
sendForgotOTPOnMobile:
|
|
52
52
|
"/service/application/user/authentication/v1.0/otp/forgot/mobile/send",
|
|
53
|
+
sendOTPForUpdate:
|
|
54
|
+
"/service/application/user/profile/v2.0/{entity}/otp/send",
|
|
53
55
|
sendOTPOnEmail:
|
|
54
56
|
"/service/application/user/authentication/v1.0/otp/email/send",
|
|
55
57
|
sendOTPOnMobile:
|
|
56
58
|
"/service/application/user/authentication/v1.0/otp/mobile/send",
|
|
59
|
+
sendOTPOnPrimary:
|
|
60
|
+
"/service/application/user/profile/v2.0/{entity}/primary/otp/send",
|
|
57
61
|
sendResetPasswordEmail:
|
|
58
62
|
"/service/application/user/authentication/v1.0/login/password/reset",
|
|
59
63
|
sendResetPasswordMobile:
|
|
@@ -83,6 +87,10 @@ class User {
|
|
|
83
87
|
"/service/application/user/authentication/v1.0/otp/forgot/mobile/verify",
|
|
84
88
|
verifyMobileOTP:
|
|
85
89
|
"/service/application/user/authentication/v1.0/otp/mobile/verify",
|
|
90
|
+
verifyOTPForUpdate:
|
|
91
|
+
"/service/application/user/profile/v2.0/{entity}/otp/verify",
|
|
92
|
+
verifyOTPonPrimary:
|
|
93
|
+
"/service/application/user/profile/v2.0/{entity}/primary/otp/verify",
|
|
86
94
|
};
|
|
87
95
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
88
96
|
(urls, [method, relativeUrl]) => {
|
|
@@ -1022,6 +1030,52 @@ class User {
|
|
|
1022
1030
|
return response;
|
|
1023
1031
|
}
|
|
1024
1032
|
|
|
1033
|
+
/**
|
|
1034
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1035
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1036
|
+
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
1037
|
+
* @name sendOTPForUpdate
|
|
1038
|
+
* @summary: Send OTP to update Mobile or Email
|
|
1039
|
+
* @description: Send OTP to mobile number or email. User needs to use sendOTPOnPrimary and verifyOTPonPrimary before using this method to update details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPForUpdate/).
|
|
1040
|
+
*/
|
|
1041
|
+
async sendOTPForUpdate(
|
|
1042
|
+
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
1043
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1044
|
+
) {
|
|
1045
|
+
const errors = validateRequiredParams(arguments[0], ["entity"]);
|
|
1046
|
+
if (errors.length > 0) {
|
|
1047
|
+
const error = new FDKClientValidationError({
|
|
1048
|
+
message: "Missing required field",
|
|
1049
|
+
details: errors,
|
|
1050
|
+
});
|
|
1051
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1052
|
+
}
|
|
1053
|
+
|
|
1054
|
+
const query_params = {};
|
|
1055
|
+
|
|
1056
|
+
const xHeaders = {};
|
|
1057
|
+
|
|
1058
|
+
const response = await ApplicationAPIClient.execute(
|
|
1059
|
+
this._conf,
|
|
1060
|
+
"post",
|
|
1061
|
+
constructUrl({
|
|
1062
|
+
url: this._urls["sendOTPForUpdate"],
|
|
1063
|
+
params: { entity },
|
|
1064
|
+
}),
|
|
1065
|
+
query_params,
|
|
1066
|
+
body,
|
|
1067
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1068
|
+
{ responseHeaders }
|
|
1069
|
+
);
|
|
1070
|
+
|
|
1071
|
+
let responseData = response;
|
|
1072
|
+
if (responseHeaders) {
|
|
1073
|
+
responseData = response[0];
|
|
1074
|
+
}
|
|
1075
|
+
|
|
1076
|
+
return response;
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1025
1079
|
/**
|
|
1026
1080
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1027
1081
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -1098,6 +1152,52 @@ class User {
|
|
|
1098
1152
|
return response;
|
|
1099
1153
|
}
|
|
1100
1154
|
|
|
1155
|
+
/**
|
|
1156
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1157
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1158
|
+
* @returns {Promise<SendOtpSuccess>} - Success response
|
|
1159
|
+
* @name sendOTPOnPrimary
|
|
1160
|
+
* @summary: Send OTP to Primary Mobile or Email
|
|
1161
|
+
* @description: Send OTP to primary mobile number or email to verify primary details. Use this to update Email or Mobile, other APIs will be deprecated. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnPrimary/).
|
|
1162
|
+
*/
|
|
1163
|
+
async sendOTPOnPrimary(
|
|
1164
|
+
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
1165
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1166
|
+
) {
|
|
1167
|
+
const errors = validateRequiredParams(arguments[0], ["entity"]);
|
|
1168
|
+
if (errors.length > 0) {
|
|
1169
|
+
const error = new FDKClientValidationError({
|
|
1170
|
+
message: "Missing required field",
|
|
1171
|
+
details: errors,
|
|
1172
|
+
});
|
|
1173
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1174
|
+
}
|
|
1175
|
+
|
|
1176
|
+
const query_params = {};
|
|
1177
|
+
|
|
1178
|
+
const xHeaders = {};
|
|
1179
|
+
|
|
1180
|
+
const response = await ApplicationAPIClient.execute(
|
|
1181
|
+
this._conf,
|
|
1182
|
+
"post",
|
|
1183
|
+
constructUrl({
|
|
1184
|
+
url: this._urls["sendOTPOnPrimary"],
|
|
1185
|
+
params: { entity },
|
|
1186
|
+
}),
|
|
1187
|
+
query_params,
|
|
1188
|
+
body,
|
|
1189
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1190
|
+
{ responseHeaders }
|
|
1191
|
+
);
|
|
1192
|
+
|
|
1193
|
+
let responseData = response;
|
|
1194
|
+
if (responseHeaders) {
|
|
1195
|
+
responseData = response[0];
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1198
|
+
return response;
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1101
1201
|
/**
|
|
1102
1202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1103
1203
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -1736,6 +1836,98 @@ class User {
|
|
|
1736
1836
|
|
|
1737
1837
|
return response;
|
|
1738
1838
|
}
|
|
1839
|
+
|
|
1840
|
+
/**
|
|
1841
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1842
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1843
|
+
* @returns {Promise<VerifyOtpSuccess>} - Success response
|
|
1844
|
+
* @name verifyOTPForUpdate
|
|
1845
|
+
* @summary: Verify OTP sent to Mobile or Email to update primary details.
|
|
1846
|
+
* @description: Verify OTP sent to Mobile number or Email to update primary details. User needs to use sendOTPOnPrimary, verifyOTPonPrimary and sendOTPForUpdate before using this method to verify update details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyOTPForUpdate/).
|
|
1847
|
+
*/
|
|
1848
|
+
async verifyOTPForUpdate(
|
|
1849
|
+
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
1850
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1851
|
+
) {
|
|
1852
|
+
const errors = validateRequiredParams(arguments[0], ["entity"]);
|
|
1853
|
+
if (errors.length > 0) {
|
|
1854
|
+
const error = new FDKClientValidationError({
|
|
1855
|
+
message: "Missing required field",
|
|
1856
|
+
details: errors,
|
|
1857
|
+
});
|
|
1858
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1859
|
+
}
|
|
1860
|
+
|
|
1861
|
+
const query_params = {};
|
|
1862
|
+
|
|
1863
|
+
const xHeaders = {};
|
|
1864
|
+
|
|
1865
|
+
const response = await ApplicationAPIClient.execute(
|
|
1866
|
+
this._conf,
|
|
1867
|
+
"post",
|
|
1868
|
+
constructUrl({
|
|
1869
|
+
url: this._urls["verifyOTPForUpdate"],
|
|
1870
|
+
params: { entity },
|
|
1871
|
+
}),
|
|
1872
|
+
query_params,
|
|
1873
|
+
body,
|
|
1874
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1875
|
+
{ responseHeaders }
|
|
1876
|
+
);
|
|
1877
|
+
|
|
1878
|
+
let responseData = response;
|
|
1879
|
+
if (responseHeaders) {
|
|
1880
|
+
responseData = response[0];
|
|
1881
|
+
}
|
|
1882
|
+
|
|
1883
|
+
return response;
|
|
1884
|
+
}
|
|
1885
|
+
|
|
1886
|
+
/**
|
|
1887
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1888
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1889
|
+
* @returns {Promise<VerifyPrimaryOTPSuccess>} - Success response
|
|
1890
|
+
* @name verifyOTPonPrimary
|
|
1891
|
+
* @summary: Verify OTP sent to Primary Mobile or Email
|
|
1892
|
+
* @description: Verify OTP sent to primary mobile number or email to verify primary details. User needs to use sendOTPOnPrimary before verifying OTP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyOTPonPrimary/).
|
|
1893
|
+
*/
|
|
1894
|
+
async verifyOTPonPrimary(
|
|
1895
|
+
{ entity, body, requestHeaders } = { requestHeaders: {} },
|
|
1896
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1897
|
+
) {
|
|
1898
|
+
const errors = validateRequiredParams(arguments[0], ["entity"]);
|
|
1899
|
+
if (errors.length > 0) {
|
|
1900
|
+
const error = new FDKClientValidationError({
|
|
1901
|
+
message: "Missing required field",
|
|
1902
|
+
details: errors,
|
|
1903
|
+
});
|
|
1904
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1905
|
+
}
|
|
1906
|
+
|
|
1907
|
+
const query_params = {};
|
|
1908
|
+
|
|
1909
|
+
const xHeaders = {};
|
|
1910
|
+
|
|
1911
|
+
const response = await ApplicationAPIClient.execute(
|
|
1912
|
+
this._conf,
|
|
1913
|
+
"post",
|
|
1914
|
+
constructUrl({
|
|
1915
|
+
url: this._urls["verifyOTPonPrimary"],
|
|
1916
|
+
params: { entity },
|
|
1917
|
+
}),
|
|
1918
|
+
query_params,
|
|
1919
|
+
body,
|
|
1920
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1921
|
+
{ responseHeaders }
|
|
1922
|
+
);
|
|
1923
|
+
|
|
1924
|
+
let responseData = response;
|
|
1925
|
+
if (responseHeaders) {
|
|
1926
|
+
responseData = response[0];
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1929
|
+
return response;
|
|
1930
|
+
}
|
|
1739
1931
|
}
|
|
1740
1932
|
|
|
1741
1933
|
module.exports = User;
|
|
@@ -360,7 +360,7 @@ declare class Cart {
|
|
|
360
360
|
* @summary: List of all available promotion offers
|
|
361
361
|
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
362
362
|
*/
|
|
363
|
-
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersDetails>;
|
|
363
|
+
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, promotionType, cartId, autoApply, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersDetails>;
|
|
364
364
|
/**
|
|
365
365
|
* @param {CartPlatformApplicationValidator.GetPromotionPaymentOffersParam} arg
|
|
366
366
|
* - Arg object
|
|
@@ -2861,9 +2861,17 @@ class Cart {
|
|
|
2861
2861
|
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
2862
2862
|
*/
|
|
2863
2863
|
async getPromotionOffers(
|
|
2864
|
-
{
|
|
2865
|
-
|
|
2866
|
-
|
|
2864
|
+
{
|
|
2865
|
+
slug,
|
|
2866
|
+
pageSize,
|
|
2867
|
+
promotionGroup,
|
|
2868
|
+
storeId,
|
|
2869
|
+
cartType,
|
|
2870
|
+
promotionType,
|
|
2871
|
+
cartId,
|
|
2872
|
+
autoApply,
|
|
2873
|
+
requestHeaders,
|
|
2874
|
+
} = { requestHeaders: {} },
|
|
2867
2875
|
{ responseHeaders } = { responseHeaders: false }
|
|
2868
2876
|
) {
|
|
2869
2877
|
const {
|
|
@@ -2875,6 +2883,9 @@ class Cart {
|
|
|
2875
2883
|
promotionGroup,
|
|
2876
2884
|
storeId,
|
|
2877
2885
|
cartType,
|
|
2886
|
+
promotionType,
|
|
2887
|
+
cartId,
|
|
2888
|
+
autoApply,
|
|
2878
2889
|
},
|
|
2879
2890
|
{ abortEarly: false, allowUnknown: true }
|
|
2880
2891
|
);
|
|
@@ -2892,6 +2903,9 @@ class Cart {
|
|
|
2892
2903
|
promotionGroup,
|
|
2893
2904
|
storeId,
|
|
2894
2905
|
cartType,
|
|
2906
|
+
promotionType,
|
|
2907
|
+
cartId,
|
|
2908
|
+
autoApply,
|
|
2895
2909
|
},
|
|
2896
2910
|
{ abortEarly: false, allowUnknown: false }
|
|
2897
2911
|
);
|
|
@@ -2908,6 +2922,9 @@ class Cart {
|
|
|
2908
2922
|
query_params["promotion_group"] = promotionGroup;
|
|
2909
2923
|
query_params["store_id"] = storeId;
|
|
2910
2924
|
query_params["cart_type"] = cartType;
|
|
2925
|
+
query_params["promotion_type"] = promotionType;
|
|
2926
|
+
query_params["cart_id"] = cartId;
|
|
2927
|
+
query_params["auto_apply"] = autoApply;
|
|
2911
2928
|
|
|
2912
2929
|
const response = await PlatformAPIClient.execute(
|
|
2913
2930
|
this.config,
|
|
@@ -207,6 +207,10 @@ export = CartPlatformApplicationValidator;
|
|
|
207
207
|
* @property {string} [promotionGroup] - Type of promotion groups
|
|
208
208
|
* @property {number} [storeId] - Unique identifier of a store
|
|
209
209
|
* @property {string} [cartType] - The type of cart
|
|
210
|
+
* @property {string} [promotionType] - Type of promotion to be fetched
|
|
211
|
+
* @property {string} [cartId] - The unique identifier of the user cart.
|
|
212
|
+
* @property {boolean} [autoApply] - Indicates whether to filter promotions
|
|
213
|
+
* based on their auto_apply status.
|
|
210
214
|
*/
|
|
211
215
|
/**
|
|
212
216
|
* @typedef GetPromotionPaymentOffersParam
|
|
@@ -809,6 +813,19 @@ type GetPromotionOffersParam = {
|
|
|
809
813
|
* - The type of cart
|
|
810
814
|
*/
|
|
811
815
|
cartType?: string;
|
|
816
|
+
/**
|
|
817
|
+
* - Type of promotion to be fetched
|
|
818
|
+
*/
|
|
819
|
+
promotionType?: string;
|
|
820
|
+
/**
|
|
821
|
+
* - The unique identifier of the user cart.
|
|
822
|
+
*/
|
|
823
|
+
cartId?: string;
|
|
824
|
+
/**
|
|
825
|
+
* - Indicates whether to filter promotions
|
|
826
|
+
* based on their auto_apply status.
|
|
827
|
+
*/
|
|
828
|
+
autoApply?: boolean;
|
|
812
829
|
};
|
|
813
830
|
type GetPromotionPaymentOffersParam = {
|
|
814
831
|
/**
|
|
@@ -243,6 +243,10 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
243
243
|
* @property {string} [promotionGroup] - Type of promotion groups
|
|
244
244
|
* @property {number} [storeId] - Unique identifier of a store
|
|
245
245
|
* @property {string} [cartType] - The type of cart
|
|
246
|
+
* @property {string} [promotionType] - Type of promotion to be fetched
|
|
247
|
+
* @property {string} [cartId] - The unique identifier of the user cart.
|
|
248
|
+
* @property {boolean} [autoApply] - Indicates whether to filter promotions
|
|
249
|
+
* based on their auto_apply status.
|
|
246
250
|
*/
|
|
247
251
|
|
|
248
252
|
/**
|
|
@@ -800,6 +804,9 @@ class CartPlatformApplicationValidator {
|
|
|
800
804
|
promotionGroup: Joi.string().allow(""),
|
|
801
805
|
storeId: Joi.number(),
|
|
802
806
|
cartType: Joi.string().allow(""),
|
|
807
|
+
promotionType: Joi.string().allow(""),
|
|
808
|
+
cartId: Joi.string().allow(""),
|
|
809
|
+
autoApply: Joi.boolean(),
|
|
803
810
|
}).required();
|
|
804
811
|
}
|
|
805
812
|
|
|
@@ -462,6 +462,8 @@ export = CartPlatformModel;
|
|
|
462
462
|
* @property {PromotionDateMeta} [date_meta]
|
|
463
463
|
* @property {string} [_id] - Unique identifier of promotion
|
|
464
464
|
* @property {string[]} [tags] - List of tags on which promotion is applicable
|
|
465
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
466
|
+
* promotion should be applied automatically or not
|
|
465
467
|
*/
|
|
466
468
|
/**
|
|
467
469
|
* @typedef PromotionsResult
|
|
@@ -497,6 +499,8 @@ export = CartPlatformModel;
|
|
|
497
499
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
498
500
|
* @property {PromotionDateMeta} [date_meta]
|
|
499
501
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
502
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
503
|
+
* promotion should be applied automatically or not
|
|
500
504
|
*/
|
|
501
505
|
/**
|
|
502
506
|
* @typedef PromotionAddResult
|
|
@@ -529,6 +533,8 @@ export = CartPlatformModel;
|
|
|
529
533
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
530
534
|
* @property {PromotionDateMeta} [date_meta]
|
|
531
535
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
536
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
537
|
+
* promotion should be applied automatically or not
|
|
532
538
|
*/
|
|
533
539
|
/**
|
|
534
540
|
* @typedef PromotionUpdate
|
|
@@ -561,6 +567,8 @@ export = CartPlatformModel;
|
|
|
561
567
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
562
568
|
* @property {PromotionDateMeta} [date_meta]
|
|
563
569
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
570
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
571
|
+
* promotion should be applied automatically or not
|
|
564
572
|
*/
|
|
565
573
|
/**
|
|
566
574
|
* @typedef PromotionUpdateResult
|
|
@@ -595,6 +603,8 @@ export = CartPlatformModel;
|
|
|
595
603
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
596
604
|
* @property {PromotionDateMeta} [date_meta]
|
|
597
605
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
606
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
607
|
+
* promotion should be applied automatically or not
|
|
598
608
|
*/
|
|
599
609
|
/**
|
|
600
610
|
* @typedef PromotionPartialUpdate
|
|
@@ -1409,6 +1419,8 @@ export = CartPlatformModel;
|
|
|
1409
1419
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1410
1420
|
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
1411
1421
|
* checkout API payload
|
|
1422
|
+
* @property {boolean} [free_gift_selection_available] - Determines if the cart
|
|
1423
|
+
* has available promotion free gift items to choose on its added items
|
|
1412
1424
|
*/
|
|
1413
1425
|
/**
|
|
1414
1426
|
* @typedef AddProductCart
|
|
@@ -1702,6 +1714,8 @@ export = CartPlatformModel;
|
|
|
1702
1714
|
* items with updated sizes.
|
|
1703
1715
|
* @property {string} operation - Field to determine if item to be removed from
|
|
1704
1716
|
* cart or it needs to be updated
|
|
1717
|
+
* @property {string} [free_gift_items_operation] - Field to determine if free
|
|
1718
|
+
* gift item to be removed from cart or it needs to be added.
|
|
1705
1719
|
*/
|
|
1706
1720
|
/**
|
|
1707
1721
|
* @typedef DeleteCartDetails
|
|
@@ -1905,6 +1919,7 @@ export = CartPlatformModel;
|
|
|
1905
1919
|
* includes type of error, error code and error message
|
|
1906
1920
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1907
1921
|
* @property {Object} [custom_cart_meta] - Custom cart meta details added in cart
|
|
1922
|
+
* @property {string} [customer_id] - Customer user id associated with cart
|
|
1908
1923
|
*/
|
|
1909
1924
|
/**
|
|
1910
1925
|
* @typedef UpdateCartShipmentItem
|
|
@@ -3440,6 +3455,11 @@ type PromotionListItem = {
|
|
|
3440
3455
|
* - List of tags on which promotion is applicable
|
|
3441
3456
|
*/
|
|
3442
3457
|
tags?: string[];
|
|
3458
|
+
/**
|
|
3459
|
+
* - Boolean value to determine if the
|
|
3460
|
+
* promotion should be applied automatically or not
|
|
3461
|
+
*/
|
|
3462
|
+
auto_apply?: boolean;
|
|
3443
3463
|
};
|
|
3444
3464
|
/** @returns {PromotionsResult} */
|
|
3445
3465
|
declare function PromotionsResult(): PromotionsResult;
|
|
@@ -3522,6 +3542,11 @@ type PromotionAdd = {
|
|
|
3522
3542
|
* - List of tags applicable for promotion
|
|
3523
3543
|
*/
|
|
3524
3544
|
tags?: string[];
|
|
3545
|
+
/**
|
|
3546
|
+
* - Boolean value to determine if the
|
|
3547
|
+
* promotion should be applied automatically or not
|
|
3548
|
+
*/
|
|
3549
|
+
auto_apply?: boolean;
|
|
3525
3550
|
};
|
|
3526
3551
|
/** @returns {PromotionAddResult} */
|
|
3527
3552
|
declare function PromotionAddResult(): PromotionAddResult;
|
|
@@ -3600,6 +3625,11 @@ type PromotionAddResult = {
|
|
|
3600
3625
|
* - List of tags applicable for promotion
|
|
3601
3626
|
*/
|
|
3602
3627
|
tags?: string[];
|
|
3628
|
+
/**
|
|
3629
|
+
* - Boolean value to determine if the
|
|
3630
|
+
* promotion should be applied automatically or not
|
|
3631
|
+
*/
|
|
3632
|
+
auto_apply?: boolean;
|
|
3603
3633
|
};
|
|
3604
3634
|
/** @returns {PromotionUpdate} */
|
|
3605
3635
|
declare function PromotionUpdate(): PromotionUpdate;
|
|
@@ -3678,6 +3708,11 @@ type PromotionUpdate = {
|
|
|
3678
3708
|
* - List of tags applicable for promotion
|
|
3679
3709
|
*/
|
|
3680
3710
|
tags?: string[];
|
|
3711
|
+
/**
|
|
3712
|
+
* - Boolean value to determine if the
|
|
3713
|
+
* promotion should be applied automatically or not
|
|
3714
|
+
*/
|
|
3715
|
+
auto_apply?: boolean;
|
|
3681
3716
|
};
|
|
3682
3717
|
/** @returns {PromotionUpdateResult} */
|
|
3683
3718
|
declare function PromotionUpdateResult(): PromotionUpdateResult;
|
|
@@ -3761,6 +3796,11 @@ type PromotionUpdateResult = {
|
|
|
3761
3796
|
* - List of tags applicable for promotion
|
|
3762
3797
|
*/
|
|
3763
3798
|
tags?: string[];
|
|
3799
|
+
/**
|
|
3800
|
+
* - Boolean value to determine if the
|
|
3801
|
+
* promotion should be applied automatically or not
|
|
3802
|
+
*/
|
|
3803
|
+
auto_apply?: boolean;
|
|
3764
3804
|
};
|
|
3765
3805
|
/** @returns {PromotionPartialUpdate} */
|
|
3766
3806
|
declare function PromotionPartialUpdate(): PromotionPartialUpdate;
|
|
@@ -5851,6 +5891,11 @@ type CartDetailResult = {
|
|
|
5851
5891
|
* checkout API payload
|
|
5852
5892
|
*/
|
|
5853
5893
|
custom_cart_meta?: any;
|
|
5894
|
+
/**
|
|
5895
|
+
* - Determines if the cart
|
|
5896
|
+
* has available promotion free gift items to choose on its added items
|
|
5897
|
+
*/
|
|
5898
|
+
free_gift_selection_available?: boolean;
|
|
5854
5899
|
};
|
|
5855
5900
|
/** @returns {AddProductCart} */
|
|
5856
5901
|
declare function AddProductCart(): AddProductCart;
|
|
@@ -6600,6 +6645,11 @@ type PlatformUpdateCartDetails = {
|
|
|
6600
6645
|
* cart or it needs to be updated
|
|
6601
6646
|
*/
|
|
6602
6647
|
operation: string;
|
|
6648
|
+
/**
|
|
6649
|
+
* - Field to determine if free
|
|
6650
|
+
* gift item to be removed from cart or it needs to be added.
|
|
6651
|
+
*/
|
|
6652
|
+
free_gift_items_operation?: string;
|
|
6603
6653
|
};
|
|
6604
6654
|
/** @returns {DeleteCartDetails} */
|
|
6605
6655
|
declare function DeleteCartDetails(): DeleteCartDetails;
|
|
@@ -7139,6 +7189,10 @@ type PlatformCartShipmentsResult = {
|
|
|
7139
7189
|
* - Custom cart meta details added in cart
|
|
7140
7190
|
*/
|
|
7141
7191
|
custom_cart_meta?: any;
|
|
7192
|
+
/**
|
|
7193
|
+
* - Customer user id associated with cart
|
|
7194
|
+
*/
|
|
7195
|
+
customer_id?: string;
|
|
7142
7196
|
};
|
|
7143
7197
|
/** @returns {UpdateCartShipmentItem} */
|
|
7144
7198
|
declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
|
|
@@ -511,6 +511,8 @@ const Joi = require("joi");
|
|
|
511
511
|
* @property {PromotionDateMeta} [date_meta]
|
|
512
512
|
* @property {string} [_id] - Unique identifier of promotion
|
|
513
513
|
* @property {string[]} [tags] - List of tags on which promotion is applicable
|
|
514
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
515
|
+
* promotion should be applied automatically or not
|
|
514
516
|
*/
|
|
515
517
|
|
|
516
518
|
/**
|
|
@@ -548,6 +550,8 @@ const Joi = require("joi");
|
|
|
548
550
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
549
551
|
* @property {PromotionDateMeta} [date_meta]
|
|
550
552
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
553
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
554
|
+
* promotion should be applied automatically or not
|
|
551
555
|
*/
|
|
552
556
|
|
|
553
557
|
/**
|
|
@@ -581,6 +585,8 @@ const Joi = require("joi");
|
|
|
581
585
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
582
586
|
* @property {PromotionDateMeta} [date_meta]
|
|
583
587
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
588
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
589
|
+
* promotion should be applied automatically or not
|
|
584
590
|
*/
|
|
585
591
|
|
|
586
592
|
/**
|
|
@@ -614,6 +620,8 @@ const Joi = require("joi");
|
|
|
614
620
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
615
621
|
* @property {PromotionDateMeta} [date_meta]
|
|
616
622
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
623
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
624
|
+
* promotion should be applied automatically or not
|
|
617
625
|
*/
|
|
618
626
|
|
|
619
627
|
/**
|
|
@@ -649,6 +657,8 @@ const Joi = require("joi");
|
|
|
649
657
|
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
650
658
|
* @property {PromotionDateMeta} [date_meta]
|
|
651
659
|
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
660
|
+
* @property {boolean} [auto_apply] - Boolean value to determine if the
|
|
661
|
+
* promotion should be applied automatically or not
|
|
652
662
|
*/
|
|
653
663
|
|
|
654
664
|
/**
|
|
@@ -1539,6 +1549,8 @@ const Joi = require("joi");
|
|
|
1539
1549
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
1540
1550
|
* @property {Object} [custom_cart_meta] - Custom meta details added cart
|
|
1541
1551
|
* checkout API payload
|
|
1552
|
+
* @property {boolean} [free_gift_selection_available] - Determines if the cart
|
|
1553
|
+
* has available promotion free gift items to choose on its added items
|
|
1542
1554
|
*/
|
|
1543
1555
|
|
|
1544
1556
|
/**
|
|
@@ -1856,6 +1868,8 @@ const Joi = require("joi");
|
|
|
1856
1868
|
* items with updated sizes.
|
|
1857
1869
|
* @property {string} operation - Field to determine if item to be removed from
|
|
1858
1870
|
* cart or it needs to be updated
|
|
1871
|
+
* @property {string} [free_gift_items_operation] - Field to determine if free
|
|
1872
|
+
* gift item to be removed from cart or it needs to be added.
|
|
1859
1873
|
*/
|
|
1860
1874
|
|
|
1861
1875
|
/**
|
|
@@ -2077,6 +2091,7 @@ const Joi = require("joi");
|
|
|
2077
2091
|
* includes type of error, error code and error message
|
|
2078
2092
|
* @property {string} [pan_no] - Permanent Account Number of the user
|
|
2079
2093
|
* @property {Object} [custom_cart_meta] - Custom cart meta details added in cart
|
|
2094
|
+
* @property {string} [customer_id] - Customer user id associated with cart
|
|
2080
2095
|
*/
|
|
2081
2096
|
|
|
2082
2097
|
/**
|
|
@@ -3084,6 +3099,7 @@ class CartPlatformModel {
|
|
|
3084
3099
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3085
3100
|
_id: Joi.string().allow(""),
|
|
3086
3101
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3102
|
+
auto_apply: Joi.boolean(),
|
|
3087
3103
|
});
|
|
3088
3104
|
}
|
|
3089
3105
|
|
|
@@ -3121,6 +3137,7 @@ class CartPlatformModel {
|
|
|
3121
3137
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3122
3138
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3123
3139
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3140
|
+
auto_apply: Joi.boolean(),
|
|
3124
3141
|
});
|
|
3125
3142
|
}
|
|
3126
3143
|
|
|
@@ -3151,6 +3168,7 @@ class CartPlatformModel {
|
|
|
3151
3168
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3152
3169
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3153
3170
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3171
|
+
auto_apply: Joi.boolean(),
|
|
3154
3172
|
});
|
|
3155
3173
|
}
|
|
3156
3174
|
|
|
@@ -3181,6 +3199,7 @@ class CartPlatformModel {
|
|
|
3181
3199
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3182
3200
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3183
3201
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3202
|
+
auto_apply: Joi.boolean(),
|
|
3184
3203
|
});
|
|
3185
3204
|
}
|
|
3186
3205
|
|
|
@@ -3212,6 +3231,7 @@ class CartPlatformModel {
|
|
|
3212
3231
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
3213
3232
|
date_meta: CartPlatformModel.PromotionDateMeta(),
|
|
3214
3233
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3234
|
+
auto_apply: Joi.boolean(),
|
|
3215
3235
|
});
|
|
3216
3236
|
}
|
|
3217
3237
|
|
|
@@ -4143,6 +4163,7 @@ class CartPlatformModel {
|
|
|
4143
4163
|
),
|
|
4144
4164
|
pan_no: Joi.string().allow(""),
|
|
4145
4165
|
custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4166
|
+
free_gift_selection_available: Joi.boolean(),
|
|
4146
4167
|
});
|
|
4147
4168
|
}
|
|
4148
4169
|
|
|
@@ -4457,6 +4478,7 @@ class CartPlatformModel {
|
|
|
4457
4478
|
CartPlatformModel.FreeGiftItemCreation()
|
|
4458
4479
|
),
|
|
4459
4480
|
operation: Joi.string().allow("").required(),
|
|
4481
|
+
free_gift_items_operation: Joi.string().allow(""),
|
|
4460
4482
|
});
|
|
4461
4483
|
}
|
|
4462
4484
|
|
|
@@ -4681,6 +4703,7 @@ class CartPlatformModel {
|
|
|
4681
4703
|
error: Joi.boolean(),
|
|
4682
4704
|
pan_no: Joi.string().allow(""),
|
|
4683
4705
|
custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4706
|
+
customer_id: Joi.string().allow(""),
|
|
4684
4707
|
});
|
|
4685
4708
|
}
|
|
4686
4709
|
|
|
@@ -244,6 +244,19 @@ export = ConfigurationPlatformModel;
|
|
|
244
244
|
* @property {boolean} [enabled] - Allow orders to be accepted from the sales channel
|
|
245
245
|
* @property {boolean} [force_reassignment] - Allow force reassigning of an order
|
|
246
246
|
* @property {string} [message] - Reason for reassigning an order
|
|
247
|
+
* @property {ProcessingSchedule} [processing_schedule]
|
|
248
|
+
*/
|
|
249
|
+
/**
|
|
250
|
+
* @typedef ProcessingSchedule
|
|
251
|
+
* @property {boolean} [is_scheduled] - Indicates whether the order processing
|
|
252
|
+
* is scheduled for future.
|
|
253
|
+
* @property {StartAfter} [start_after]
|
|
254
|
+
*/
|
|
255
|
+
/**
|
|
256
|
+
* @typedef StartAfter
|
|
257
|
+
* @property {number} [days] - Number of days to wait before starting the process.
|
|
258
|
+
* @property {number} [hours] - Number of hours to wait before starting the process.
|
|
259
|
+
* @property {number} [minutes] - Number of minutes to wait before starting the process.
|
|
247
260
|
*/
|
|
248
261
|
/**
|
|
249
262
|
* @typedef AppLogisticsConfig
|
|
@@ -1390,7 +1403,7 @@ export = ConfigurationPlatformModel;
|
|
|
1390
1403
|
declare class ConfigurationPlatformModel {
|
|
1391
1404
|
}
|
|
1392
1405
|
declare namespace ConfigurationPlatformModel {
|
|
1393
|
-
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1406
|
+
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1394
1407
|
}
|
|
1395
1408
|
/** @returns {CurrencyExchangeResponseV2} */
|
|
1396
1409
|
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
@@ -1875,6 +1888,33 @@ type AppOrderConfig = {
|
|
|
1875
1888
|
* - Reason for reassigning an order
|
|
1876
1889
|
*/
|
|
1877
1890
|
message?: string;
|
|
1891
|
+
processing_schedule?: ProcessingSchedule;
|
|
1892
|
+
};
|
|
1893
|
+
/** @returns {ProcessingSchedule} */
|
|
1894
|
+
declare function ProcessingSchedule(): ProcessingSchedule;
|
|
1895
|
+
type ProcessingSchedule = {
|
|
1896
|
+
/**
|
|
1897
|
+
* - Indicates whether the order processing
|
|
1898
|
+
* is scheduled for future.
|
|
1899
|
+
*/
|
|
1900
|
+
is_scheduled?: boolean;
|
|
1901
|
+
start_after?: StartAfter;
|
|
1902
|
+
};
|
|
1903
|
+
/** @returns {StartAfter} */
|
|
1904
|
+
declare function StartAfter(): StartAfter;
|
|
1905
|
+
type StartAfter = {
|
|
1906
|
+
/**
|
|
1907
|
+
* - Number of days to wait before starting the process.
|
|
1908
|
+
*/
|
|
1909
|
+
days?: number;
|
|
1910
|
+
/**
|
|
1911
|
+
* - Number of hours to wait before starting the process.
|
|
1912
|
+
*/
|
|
1913
|
+
hours?: number;
|
|
1914
|
+
/**
|
|
1915
|
+
* - Number of minutes to wait before starting the process.
|
|
1916
|
+
*/
|
|
1917
|
+
minutes?: number;
|
|
1878
1918
|
};
|
|
1879
1919
|
/** @returns {AppLogisticsConfig} */
|
|
1880
1920
|
declare function AppLogisticsConfig(): AppLogisticsConfig;
|
|
@@ -272,6 +272,21 @@ const Joi = require("joi");
|
|
|
272
272
|
* @property {boolean} [enabled] - Allow orders to be accepted from the sales channel
|
|
273
273
|
* @property {boolean} [force_reassignment] - Allow force reassigning of an order
|
|
274
274
|
* @property {string} [message] - Reason for reassigning an order
|
|
275
|
+
* @property {ProcessingSchedule} [processing_schedule]
|
|
276
|
+
*/
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* @typedef ProcessingSchedule
|
|
280
|
+
* @property {boolean} [is_scheduled] - Indicates whether the order processing
|
|
281
|
+
* is scheduled for future.
|
|
282
|
+
* @property {StartAfter} [start_after]
|
|
283
|
+
*/
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* @typedef StartAfter
|
|
287
|
+
* @property {number} [days] - Number of days to wait before starting the process.
|
|
288
|
+
* @property {number} [hours] - Number of hours to wait before starting the process.
|
|
289
|
+
* @property {number} [minutes] - Number of minutes to wait before starting the process.
|
|
275
290
|
*/
|
|
276
291
|
|
|
277
292
|
/**
|
|
@@ -1860,6 +1875,24 @@ class ConfigurationPlatformModel {
|
|
|
1860
1875
|
enabled: Joi.boolean(),
|
|
1861
1876
|
force_reassignment: Joi.boolean(),
|
|
1862
1877
|
message: Joi.string().allow(""),
|
|
1878
|
+
processing_schedule: ConfigurationPlatformModel.ProcessingSchedule(),
|
|
1879
|
+
});
|
|
1880
|
+
}
|
|
1881
|
+
|
|
1882
|
+
/** @returns {ProcessingSchedule} */
|
|
1883
|
+
static ProcessingSchedule() {
|
|
1884
|
+
return Joi.object({
|
|
1885
|
+
is_scheduled: Joi.boolean(),
|
|
1886
|
+
start_after: ConfigurationPlatformModel.StartAfter(),
|
|
1887
|
+
});
|
|
1888
|
+
}
|
|
1889
|
+
|
|
1890
|
+
/** @returns {StartAfter} */
|
|
1891
|
+
static StartAfter() {
|
|
1892
|
+
return Joi.object({
|
|
1893
|
+
days: Joi.number(),
|
|
1894
|
+
hours: Joi.number(),
|
|
1895
|
+
minutes: Joi.number(),
|
|
1863
1896
|
});
|
|
1864
1897
|
}
|
|
1865
1898
|
|
|
@@ -317,7 +317,7 @@ declare class Payment {
|
|
|
317
317
|
* @summary: List POS payment modes
|
|
318
318
|
* @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
|
|
319
319
|
*/
|
|
320
|
-
getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
320
|
+
getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, customerId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
|
|
321
321
|
/**
|
|
322
322
|
* @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
|
|
323
323
|
* - Arg object
|
|
@@ -2124,6 +2124,7 @@ class Payment {
|
|
|
2124
2124
|
displaySplit,
|
|
2125
2125
|
advancePayment,
|
|
2126
2126
|
shipmentId,
|
|
2127
|
+
customerId,
|
|
2127
2128
|
requestHeaders,
|
|
2128
2129
|
} = { requestHeaders: {} },
|
|
2129
2130
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -2145,6 +2146,7 @@ class Payment {
|
|
|
2145
2146
|
displaySplit,
|
|
2146
2147
|
advancePayment,
|
|
2147
2148
|
shipmentId,
|
|
2149
|
+
customerId,
|
|
2148
2150
|
},
|
|
2149
2151
|
{ abortEarly: false, allowUnknown: true }
|
|
2150
2152
|
);
|
|
@@ -2170,6 +2172,7 @@ class Payment {
|
|
|
2170
2172
|
displaySplit,
|
|
2171
2173
|
advancePayment,
|
|
2172
2174
|
shipmentId,
|
|
2175
|
+
customerId,
|
|
2173
2176
|
},
|
|
2174
2177
|
{ abortEarly: false, allowUnknown: false }
|
|
2175
2178
|
);
|
|
@@ -2193,6 +2196,7 @@ class Payment {
|
|
|
2193
2196
|
query_params["display_split"] = displaySplit;
|
|
2194
2197
|
query_params["advance_payment"] = advancePayment;
|
|
2195
2198
|
query_params["shipment_id"] = shipmentId;
|
|
2199
|
+
query_params["customer_id"] = customerId;
|
|
2196
2200
|
|
|
2197
2201
|
const response = await PlatformAPIClient.execute(
|
|
2198
2202
|
this.config,
|
|
@@ -132,6 +132,7 @@ export = PaymentPlatformApplicationValidator;
|
|
|
132
132
|
* @property {boolean} [displaySplit] - Display Split Payment Option or not
|
|
133
133
|
* @property {boolean} [advancePayment] - Display Advance Payment Options or Normal
|
|
134
134
|
* @property {string} [shipmentId]
|
|
135
|
+
* @property {string} [customerId]
|
|
135
136
|
*/
|
|
136
137
|
/**
|
|
137
138
|
* @typedef GetUserBeneficiariesParam
|
|
@@ -544,6 +545,7 @@ type GetPosPaymentModeRoutesParam = {
|
|
|
544
545
|
*/
|
|
545
546
|
advancePayment?: boolean;
|
|
546
547
|
shipmentId?: string;
|
|
548
|
+
customerId?: string;
|
|
547
549
|
};
|
|
548
550
|
type GetUserBeneficiariesParam = {
|
|
549
551
|
orderId: string;
|
|
@@ -160,6 +160,7 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
|
|
|
160
160
|
* @property {boolean} [displaySplit] - Display Split Payment Option or not
|
|
161
161
|
* @property {boolean} [advancePayment] - Display Advance Payment Options or Normal
|
|
162
162
|
* @property {string} [shipmentId]
|
|
163
|
+
* @property {string} [customerId]
|
|
163
164
|
*/
|
|
164
165
|
|
|
165
166
|
/**
|
|
@@ -505,6 +506,7 @@ class PaymentPlatformApplicationValidator {
|
|
|
505
506
|
displaySplit: Joi.boolean(),
|
|
506
507
|
advancePayment: Joi.boolean(),
|
|
507
508
|
shipmentId: Joi.string().allow(""),
|
|
509
|
+
customerId: Joi.string().allow(""),
|
|
508
510
|
}).required();
|
|
509
511
|
}
|
|
510
512
|
|
|
@@ -112,6 +112,15 @@ export = PaymentPlatformModel;
|
|
|
112
112
|
* @property {number} [exp_year] - Exp_year
|
|
113
113
|
* @property {string} [name] - Name
|
|
114
114
|
* @property {string[]} [intent_app_error_list] - Intent_app_error_list
|
|
115
|
+
* @property {PaymentConfirmationElement[]} [payment_confirmation_elements] -
|
|
116
|
+
* List of additional fields required to confirm the payment, such as
|
|
117
|
+
* transaction ID or receipt image.
|
|
118
|
+
*/
|
|
119
|
+
/**
|
|
120
|
+
* @typedef PaymentConfirmationElement
|
|
121
|
+
* @property {boolean} [is_required]
|
|
122
|
+
* @property {string} [display_label]
|
|
123
|
+
* @property {string} [slug]
|
|
115
124
|
*/
|
|
116
125
|
/**
|
|
117
126
|
* @typedef RootPaymentMode
|
|
@@ -1262,7 +1271,7 @@ export = PaymentPlatformModel;
|
|
|
1262
1271
|
declare class PaymentPlatformModel {
|
|
1263
1272
|
}
|
|
1264
1273
|
declare namespace PaymentPlatformModel {
|
|
1265
|
-
export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
|
|
1274
|
+
export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
|
|
1266
1275
|
}
|
|
1267
1276
|
/** @returns {PaymentGatewayConfigDetails} */
|
|
1268
1277
|
declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
|
|
@@ -1585,6 +1594,19 @@ type PaymentModeList = {
|
|
|
1585
1594
|
* - Intent_app_error_list
|
|
1586
1595
|
*/
|
|
1587
1596
|
intent_app_error_list?: string[];
|
|
1597
|
+
/**
|
|
1598
|
+
* -
|
|
1599
|
+
* List of additional fields required to confirm the payment, such as
|
|
1600
|
+
* transaction ID or receipt image.
|
|
1601
|
+
*/
|
|
1602
|
+
payment_confirmation_elements?: PaymentConfirmationElement[];
|
|
1603
|
+
};
|
|
1604
|
+
/** @returns {PaymentConfirmationElement} */
|
|
1605
|
+
declare function PaymentConfirmationElement(): PaymentConfirmationElement;
|
|
1606
|
+
type PaymentConfirmationElement = {
|
|
1607
|
+
is_required?: boolean;
|
|
1608
|
+
display_label?: string;
|
|
1609
|
+
slug?: string;
|
|
1588
1610
|
};
|
|
1589
1611
|
/** @returns {RootPaymentMode} */
|
|
1590
1612
|
declare function RootPaymentMode(): RootPaymentMode;
|
|
@@ -125,6 +125,16 @@ const Joi = require("joi");
|
|
|
125
125
|
* @property {number} [exp_year] - Exp_year
|
|
126
126
|
* @property {string} [name] - Name
|
|
127
127
|
* @property {string[]} [intent_app_error_list] - Intent_app_error_list
|
|
128
|
+
* @property {PaymentConfirmationElement[]} [payment_confirmation_elements] -
|
|
129
|
+
* List of additional fields required to confirm the payment, such as
|
|
130
|
+
* transaction ID or receipt image.
|
|
131
|
+
*/
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* @typedef PaymentConfirmationElement
|
|
135
|
+
* @property {boolean} [is_required]
|
|
136
|
+
* @property {string} [display_label]
|
|
137
|
+
* @property {string} [slug]
|
|
128
138
|
*/
|
|
129
139
|
|
|
130
140
|
/**
|
|
@@ -1560,6 +1570,18 @@ class PaymentPlatformModel {
|
|
|
1560
1570
|
intent_app_error_list: Joi.array()
|
|
1561
1571
|
.items(Joi.string().allow(""))
|
|
1562
1572
|
.allow(null, ""),
|
|
1573
|
+
payment_confirmation_elements: Joi.array().items(
|
|
1574
|
+
PaymentPlatformModel.PaymentConfirmationElement()
|
|
1575
|
+
),
|
|
1576
|
+
});
|
|
1577
|
+
}
|
|
1578
|
+
|
|
1579
|
+
/** @returns {PaymentConfirmationElement} */
|
|
1580
|
+
static PaymentConfirmationElement() {
|
|
1581
|
+
return Joi.object({
|
|
1582
|
+
is_required: Joi.boolean(),
|
|
1583
|
+
display_label: Joi.string().allow(""),
|
|
1584
|
+
slug: Joi.string().allow(""),
|
|
1563
1585
|
});
|
|
1564
1586
|
}
|
|
1565
1587
|
|
|
@@ -180,7 +180,7 @@ declare class Theme {
|
|
|
180
180
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
|
|
183
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
185
|
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
186
186
|
/**
|
|
@@ -1268,7 +1268,7 @@ class Theme {
|
|
|
1268
1268
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
1269
1269
|
* @name isUpgradable
|
|
1270
1270
|
* @summary: Check theme is upgradable
|
|
1271
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
|
|
1271
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
1272
1272
|
*/
|
|
1273
1273
|
async isUpgradable(
|
|
1274
1274
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -91,6 +91,12 @@ export = ThemePlatformModel;
|
|
|
91
91
|
/**
|
|
92
92
|
* @typedef AvailablePageSectionMetaAttributes
|
|
93
93
|
* @property {Object} [attributes]
|
|
94
|
+
* @property {CanvasItem} [canvas]
|
|
95
|
+
*/
|
|
96
|
+
/**
|
|
97
|
+
* @typedef CanvasItem
|
|
98
|
+
* @property {string} [value]
|
|
99
|
+
* @property {string} [label]
|
|
94
100
|
*/
|
|
95
101
|
/**
|
|
96
102
|
* @typedef SEOMetaItem
|
|
@@ -131,7 +137,9 @@ export = ThemePlatformModel;
|
|
|
131
137
|
* @typedef AvailablePageSchemaSections
|
|
132
138
|
* @property {string} [name]
|
|
133
139
|
* @property {string} [label]
|
|
140
|
+
* @property {string} [canvas]
|
|
134
141
|
* @property {Object} [props]
|
|
142
|
+
* @property {string} [custom_css] - Custom CSS for a section
|
|
135
143
|
* @property {Object[]} [blocks]
|
|
136
144
|
* @property {Object} [preset]
|
|
137
145
|
* @property {AvailablePagePredicate} [predicate]
|
|
@@ -598,7 +606,7 @@ export = ThemePlatformModel;
|
|
|
598
606
|
declare class ThemePlatformModel {
|
|
599
607
|
}
|
|
600
608
|
declare namespace ThemePlatformModel {
|
|
601
|
-
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
609
|
+
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, CanvasItem, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
602
610
|
}
|
|
603
611
|
/** @returns {GetExtensionSectionRes} */
|
|
604
612
|
declare function GetExtensionSectionRes(): GetExtensionSectionRes;
|
|
@@ -761,6 +769,13 @@ type AvailablePageSchema = {
|
|
|
761
769
|
declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
|
|
762
770
|
type AvailablePageSectionMetaAttributes = {
|
|
763
771
|
attributes?: any;
|
|
772
|
+
canvas?: CanvasItem;
|
|
773
|
+
};
|
|
774
|
+
/** @returns {CanvasItem} */
|
|
775
|
+
declare function CanvasItem(): CanvasItem;
|
|
776
|
+
type CanvasItem = {
|
|
777
|
+
value?: string;
|
|
778
|
+
label?: string;
|
|
764
779
|
};
|
|
765
780
|
/** @returns {SEOMetaItem} */
|
|
766
781
|
declare function SEOMetaItem(): SEOMetaItem;
|
|
@@ -811,7 +826,12 @@ declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
|
|
|
811
826
|
type AvailablePageSchemaSections = {
|
|
812
827
|
name?: string;
|
|
813
828
|
label?: string;
|
|
829
|
+
canvas?: string;
|
|
814
830
|
props?: any;
|
|
831
|
+
/**
|
|
832
|
+
* - Custom CSS for a section
|
|
833
|
+
*/
|
|
834
|
+
custom_css?: string;
|
|
815
835
|
blocks?: any[];
|
|
816
836
|
preset?: any;
|
|
817
837
|
predicate?: AvailablePagePredicate;
|
|
@@ -103,6 +103,13 @@ const Joi = require("joi");
|
|
|
103
103
|
/**
|
|
104
104
|
* @typedef AvailablePageSectionMetaAttributes
|
|
105
105
|
* @property {Object} [attributes]
|
|
106
|
+
* @property {CanvasItem} [canvas]
|
|
107
|
+
*/
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* @typedef CanvasItem
|
|
111
|
+
* @property {string} [value]
|
|
112
|
+
* @property {string} [label]
|
|
106
113
|
*/
|
|
107
114
|
|
|
108
115
|
/**
|
|
@@ -150,7 +157,9 @@ const Joi = require("joi");
|
|
|
150
157
|
* @typedef AvailablePageSchemaSections
|
|
151
158
|
* @property {string} [name]
|
|
152
159
|
* @property {string} [label]
|
|
160
|
+
* @property {string} [canvas]
|
|
153
161
|
* @property {Object} [props]
|
|
162
|
+
* @property {string} [custom_css] - Custom CSS for a section
|
|
154
163
|
* @property {Object[]} [blocks]
|
|
155
164
|
* @property {Object} [preset]
|
|
156
165
|
* @property {AvailablePagePredicate} [predicate]
|
|
@@ -807,6 +816,15 @@ class ThemePlatformModel {
|
|
|
807
816
|
static AvailablePageSectionMetaAttributes() {
|
|
808
817
|
return Joi.object({
|
|
809
818
|
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
819
|
+
canvas: ThemePlatformModel.CanvasItem(),
|
|
820
|
+
});
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
/** @returns {CanvasItem} */
|
|
824
|
+
static CanvasItem() {
|
|
825
|
+
return Joi.object({
|
|
826
|
+
value: Joi.string().allow(""),
|
|
827
|
+
label: Joi.string().allow(""),
|
|
810
828
|
});
|
|
811
829
|
}
|
|
812
830
|
|
|
@@ -868,7 +886,9 @@ class ThemePlatformModel {
|
|
|
868
886
|
return Joi.object({
|
|
869
887
|
name: Joi.string().allow(""),
|
|
870
888
|
label: Joi.string().allow(""),
|
|
889
|
+
canvas: Joi.string().allow(""),
|
|
871
890
|
props: Joi.object().pattern(/\S/, Joi.any()),
|
|
891
|
+
custom_css: Joi.string().allow(""),
|
|
872
892
|
blocks: Joi.array().items(Joi.any()),
|
|
873
893
|
preset: Joi.object().pattern(/\S/, Joi.any()),
|
|
874
894
|
predicate: ThemePlatformModel.AvailablePagePredicate(),
|