@gofynd/fdk-client-javascript 3.26.0 → 3.28.0
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/Configuration/ConfigurationApplicationClient.d.ts +4 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +5 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +11 -1
- package/sdk/application/Payment/PaymentApplicationClient.js +50 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +61 -1
- package/sdk/platform/Cart/CartPlatformModel.js +40 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.js +75 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +203 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +103 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +7 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +52 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +20 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -0
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +30 -1
- package/sdk/platform/Lead/LeadPlatformModel.js +19 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +163 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +27 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +26 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +106 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +79 -0
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +83 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +10 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +121 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +112 -0
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +0 -44
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +0 -263
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +0 -42
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +0 -45
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +0 -136
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +0 -95
|
@@ -1108,6 +1108,87 @@ class Payment {
|
|
|
1108
1108
|
return response;
|
|
1109
1109
|
}
|
|
1110
1110
|
|
|
1111
|
+
/**
|
|
1112
|
+
* @param {PaymentPlatformApplicationValidator.GetOrderTransactionsParam} arg
|
|
1113
|
+
* - Arg object
|
|
1114
|
+
*
|
|
1115
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1116
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1117
|
+
* @returns {Promise<PaymentPlatformModel.OrderTransactionList>} - Success response
|
|
1118
|
+
* @name getOrderTransactions
|
|
1119
|
+
* @summary: List all transactions for an order
|
|
1120
|
+
* @description: Returns all payment transactions associated with the given order ID, ordered by creation timestamp ascending. Each entry includes the merchant transaction ID, payment mode name, logo URL (small, falling back to large), transaction amount, latest status, and creation timestamp. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getOrderTransactions/).
|
|
1121
|
+
*/
|
|
1122
|
+
async getOrderTransactions(
|
|
1123
|
+
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
1124
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1125
|
+
) {
|
|
1126
|
+
const {
|
|
1127
|
+
error,
|
|
1128
|
+
} = PaymentPlatformApplicationValidator.getOrderTransactions().validate(
|
|
1129
|
+
{
|
|
1130
|
+
orderId,
|
|
1131
|
+
},
|
|
1132
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1133
|
+
);
|
|
1134
|
+
if (error) {
|
|
1135
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1136
|
+
}
|
|
1137
|
+
|
|
1138
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1139
|
+
const {
|
|
1140
|
+
error: warrning,
|
|
1141
|
+
} = PaymentPlatformApplicationValidator.getOrderTransactions().validate(
|
|
1142
|
+
{
|
|
1143
|
+
orderId,
|
|
1144
|
+
},
|
|
1145
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1146
|
+
);
|
|
1147
|
+
if (warrning) {
|
|
1148
|
+
Logger({
|
|
1149
|
+
level: "WARN",
|
|
1150
|
+
message: `Parameter Validation warrnings for platform > Payment > getOrderTransactions \n ${warrning}`,
|
|
1151
|
+
});
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
const query_params = {};
|
|
1155
|
+
|
|
1156
|
+
const response = await PlatformAPIClient.execute(
|
|
1157
|
+
this.config,
|
|
1158
|
+
"get",
|
|
1159
|
+
`/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/${orderId}/transactions`,
|
|
1160
|
+
query_params,
|
|
1161
|
+
undefined,
|
|
1162
|
+
requestHeaders,
|
|
1163
|
+
{ responseHeaders }
|
|
1164
|
+
);
|
|
1165
|
+
|
|
1166
|
+
let responseData = response;
|
|
1167
|
+
if (responseHeaders) {
|
|
1168
|
+
responseData = response[0];
|
|
1169
|
+
}
|
|
1170
|
+
|
|
1171
|
+
const {
|
|
1172
|
+
error: res_error,
|
|
1173
|
+
} = PaymentPlatformModel.OrderTransactionList().validate(responseData, {
|
|
1174
|
+
abortEarly: false,
|
|
1175
|
+
allowUnknown: true,
|
|
1176
|
+
});
|
|
1177
|
+
|
|
1178
|
+
if (res_error) {
|
|
1179
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1180
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1181
|
+
} else {
|
|
1182
|
+
Logger({
|
|
1183
|
+
level: "WARN",
|
|
1184
|
+
message: `Response Validation Warnings for platform > Payment > getOrderTransactions \n ${res_error}`,
|
|
1185
|
+
});
|
|
1186
|
+
}
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
return response;
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1111
1192
|
/**
|
|
1112
1193
|
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
1113
1194
|
* - Arg object
|
|
@@ -3394,6 +3475,88 @@ class Payment {
|
|
|
3394
3475
|
return response;
|
|
3395
3476
|
}
|
|
3396
3477
|
|
|
3478
|
+
/**
|
|
3479
|
+
* @param {PaymentPlatformApplicationValidator.UpdateOrderMetaParam} arg - Arg object
|
|
3480
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3481
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3482
|
+
* @returns {Promise<PaymentPlatformModel.OrderMetaResult>} - Success response
|
|
3483
|
+
* @name updateOrderMeta
|
|
3484
|
+
* @summary: Update order metadata
|
|
3485
|
+
* @description: Update metadata associated with a payment order. Use this to set or update PAN (Permanent Account Number) for an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updateOrderMeta/).
|
|
3486
|
+
*/
|
|
3487
|
+
async updateOrderMeta(
|
|
3488
|
+
{ orderId, body, requestHeaders } = { requestHeaders: {} },
|
|
3489
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3490
|
+
) {
|
|
3491
|
+
const {
|
|
3492
|
+
error,
|
|
3493
|
+
} = PaymentPlatformApplicationValidator.updateOrderMeta().validate(
|
|
3494
|
+
{
|
|
3495
|
+
orderId,
|
|
3496
|
+
body,
|
|
3497
|
+
},
|
|
3498
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3499
|
+
);
|
|
3500
|
+
if (error) {
|
|
3501
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3502
|
+
}
|
|
3503
|
+
|
|
3504
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3505
|
+
const {
|
|
3506
|
+
error: warrning,
|
|
3507
|
+
} = PaymentPlatformApplicationValidator.updateOrderMeta().validate(
|
|
3508
|
+
{
|
|
3509
|
+
orderId,
|
|
3510
|
+
body,
|
|
3511
|
+
},
|
|
3512
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3513
|
+
);
|
|
3514
|
+
if (warrning) {
|
|
3515
|
+
Logger({
|
|
3516
|
+
level: "WARN",
|
|
3517
|
+
message: `Parameter Validation warrnings for platform > Payment > updateOrderMeta \n ${warrning}`,
|
|
3518
|
+
});
|
|
3519
|
+
}
|
|
3520
|
+
|
|
3521
|
+
const query_params = {};
|
|
3522
|
+
query_params["order_id"] = orderId;
|
|
3523
|
+
|
|
3524
|
+
const response = await PlatformAPIClient.execute(
|
|
3525
|
+
this.config,
|
|
3526
|
+
"put",
|
|
3527
|
+
`/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/payment/order/meta`,
|
|
3528
|
+
query_params,
|
|
3529
|
+
body,
|
|
3530
|
+
requestHeaders,
|
|
3531
|
+
{ responseHeaders }
|
|
3532
|
+
);
|
|
3533
|
+
|
|
3534
|
+
let responseData = response;
|
|
3535
|
+
if (responseHeaders) {
|
|
3536
|
+
responseData = response[0];
|
|
3537
|
+
}
|
|
3538
|
+
|
|
3539
|
+
const {
|
|
3540
|
+
error: res_error,
|
|
3541
|
+
} = PaymentPlatformModel.OrderMetaResult().validate(responseData, {
|
|
3542
|
+
abortEarly: false,
|
|
3543
|
+
allowUnknown: true,
|
|
3544
|
+
});
|
|
3545
|
+
|
|
3546
|
+
if (res_error) {
|
|
3547
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3548
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3549
|
+
} else {
|
|
3550
|
+
Logger({
|
|
3551
|
+
level: "WARN",
|
|
3552
|
+
message: `Response Validation Warnings for platform > Payment > updateOrderMeta \n ${res_error}`,
|
|
3553
|
+
});
|
|
3554
|
+
}
|
|
3555
|
+
}
|
|
3556
|
+
|
|
3557
|
+
return response;
|
|
3558
|
+
}
|
|
3559
|
+
|
|
3397
3560
|
/**
|
|
3398
3561
|
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
3399
3562
|
* - Arg object
|
|
@@ -57,6 +57,10 @@ export = PaymentPlatformApplicationValidator;
|
|
|
57
57
|
* @typedef GetMerchantRefundPriorityParam
|
|
58
58
|
* @property {string} configType - Configuration for merchant or customer
|
|
59
59
|
*/
|
|
60
|
+
/**
|
|
61
|
+
* @typedef GetOrderTransactionsParam
|
|
62
|
+
* @property {string} orderId - Merchant order ID (e.g. FY692D2AC45171FB895B).
|
|
63
|
+
*/
|
|
60
64
|
/** @typedef GetPGConfigAggregatorsParam */
|
|
61
65
|
/** @typedef GetPaymentCodeOptionParam */
|
|
62
66
|
/**
|
|
@@ -206,6 +210,11 @@ export = PaymentPlatformApplicationValidator;
|
|
|
206
210
|
* @property {string} configType - Configuration for merchant or customer
|
|
207
211
|
* @property {PaymentPlatformModel.RefundPriorityCreation} body
|
|
208
212
|
*/
|
|
213
|
+
/**
|
|
214
|
+
* @typedef UpdateOrderMetaParam
|
|
215
|
+
* @property {string} orderId - The unique identifier of the order (merchant_order_id).
|
|
216
|
+
* @property {PaymentPlatformModel.OrderMetaUpdate} body
|
|
217
|
+
*/
|
|
209
218
|
/**
|
|
210
219
|
* @typedef UpdatePaymentSessionParam
|
|
211
220
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -257,6 +266,8 @@ declare class PaymentPlatformApplicationValidator {
|
|
|
257
266
|
static getMerchantPaymentOption(): any;
|
|
258
267
|
/** @returns {GetMerchantRefundPriorityParam} */
|
|
259
268
|
static getMerchantRefundPriority(): GetMerchantRefundPriorityParam;
|
|
269
|
+
/** @returns {GetOrderTransactionsParam} */
|
|
270
|
+
static getOrderTransactions(): GetOrderTransactionsParam;
|
|
260
271
|
/** @returns {GetPGConfigAggregatorsParam} */
|
|
261
272
|
static getPGConfigAggregators(): any;
|
|
262
273
|
/** @returns {GetPaymentCodeOptionParam} */
|
|
@@ -311,6 +322,8 @@ declare class PaymentPlatformApplicationValidator {
|
|
|
311
322
|
static setUserCODlimitRoutes(): SetUserCODlimitRoutesParam;
|
|
312
323
|
/** @returns {UpdateMerchantRefundPriorityParam} */
|
|
313
324
|
static updateMerchantRefundPriority(): UpdateMerchantRefundPriorityParam;
|
|
325
|
+
/** @returns {UpdateOrderMetaParam} */
|
|
326
|
+
static updateOrderMeta(): UpdateOrderMetaParam;
|
|
314
327
|
/** @returns {UpdatePaymentSessionParam} */
|
|
315
328
|
static updatePaymentSession(): UpdatePaymentSessionParam;
|
|
316
329
|
/** @returns {UpdateRefundSessionParam} */
|
|
@@ -321,7 +334,7 @@ declare class PaymentPlatformApplicationValidator {
|
|
|
321
334
|
static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
|
|
322
335
|
}
|
|
323
336
|
declare namespace PaymentPlatformApplicationValidator {
|
|
324
|
-
export { AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreateMerchantRefundPriorityParam, CreatePaymentLinkParam, CreatePaymentOrderParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetMerchantAggregatorAppVersionParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetMerchantRefundPriorityParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeControlRoutesParam, GetPaymentModeCustomConfigParam, GetPaymentModeRoutesParam, GetPaymentSessionParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PatchMerchantPaymentOptionVersionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SaveTokenForAggregatorParam, SetMerchantModeControlRoutesParam, SetPaymentModeCustomConfigParam, SetUserCODlimitRoutesParam, UpdateMerchantRefundPriorityParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, ValidateCustomerAndCreditSummaryParam, VerifyCustomerForPaymentParam };
|
|
337
|
+
export { AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreateMerchantRefundPriorityParam, CreatePaymentLinkParam, CreatePaymentOrderParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetMerchantAggregatorAppVersionParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetMerchantRefundPriorityParam, GetOrderTransactionsParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeControlRoutesParam, GetPaymentModeCustomConfigParam, GetPaymentModeRoutesParam, GetPaymentSessionParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PatchMerchantPaymentOptionVersionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SaveTokenForAggregatorParam, SetMerchantModeControlRoutesParam, SetPaymentModeCustomConfigParam, SetUserCODlimitRoutesParam, UpdateMerchantRefundPriorityParam, UpdateOrderMetaParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, ValidateCustomerAndCreditSummaryParam, VerifyCustomerForPaymentParam };
|
|
325
338
|
}
|
|
326
339
|
type AddRefundBankAccountUsingOTPParam = {
|
|
327
340
|
body: PaymentPlatformModel.AddBeneficiaryDetailsOTPCreation;
|
|
@@ -383,6 +396,12 @@ type GetMerchantRefundPriorityParam = {
|
|
|
383
396
|
*/
|
|
384
397
|
configType: string;
|
|
385
398
|
};
|
|
399
|
+
type GetOrderTransactionsParam = {
|
|
400
|
+
/**
|
|
401
|
+
* - Merchant order ID (e.g. FY692D2AC45171FB895B).
|
|
402
|
+
*/
|
|
403
|
+
orderId: string;
|
|
404
|
+
};
|
|
386
405
|
type GetPaymentLinkParam = {
|
|
387
406
|
paymentLinkId: string;
|
|
388
407
|
};
|
|
@@ -588,6 +607,13 @@ type UpdateMerchantRefundPriorityParam = {
|
|
|
588
607
|
configType: string;
|
|
589
608
|
body: PaymentPlatformModel.RefundPriorityCreation;
|
|
590
609
|
};
|
|
610
|
+
type UpdateOrderMetaParam = {
|
|
611
|
+
/**
|
|
612
|
+
* - The unique identifier of the order (merchant_order_id).
|
|
613
|
+
*/
|
|
614
|
+
orderId: string;
|
|
615
|
+
body: PaymentPlatformModel.OrderMetaUpdate;
|
|
616
|
+
};
|
|
591
617
|
type UpdatePaymentSessionParam = {
|
|
592
618
|
/**
|
|
593
619
|
* - Global identifier of the entity (e.g. order, cart
|
|
@@ -73,6 +73,11 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
|
|
|
73
73
|
* @property {string} configType - Configuration for merchant or customer
|
|
74
74
|
*/
|
|
75
75
|
|
|
76
|
+
/**
|
|
77
|
+
* @typedef GetOrderTransactionsParam
|
|
78
|
+
* @property {string} orderId - Merchant order ID (e.g. FY692D2AC45171FB895B).
|
|
79
|
+
*/
|
|
80
|
+
|
|
76
81
|
/** @typedef GetPGConfigAggregatorsParam */
|
|
77
82
|
|
|
78
83
|
/** @typedef GetPaymentCodeOptionParam */
|
|
@@ -249,6 +254,12 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
|
|
|
249
254
|
* @property {PaymentPlatformModel.RefundPriorityCreation} body
|
|
250
255
|
*/
|
|
251
256
|
|
|
257
|
+
/**
|
|
258
|
+
* @typedef UpdateOrderMetaParam
|
|
259
|
+
* @property {string} orderId - The unique identifier of the order (merchant_order_id).
|
|
260
|
+
* @property {PaymentPlatformModel.OrderMetaUpdate} body
|
|
261
|
+
*/
|
|
262
|
+
|
|
252
263
|
/**
|
|
253
264
|
* @typedef UpdatePaymentSessionParam
|
|
254
265
|
* @property {string} gid - Global identifier of the entity (e.g. order, cart
|
|
@@ -376,6 +387,13 @@ class PaymentPlatformApplicationValidator {
|
|
|
376
387
|
}).required();
|
|
377
388
|
}
|
|
378
389
|
|
|
390
|
+
/** @returns {GetOrderTransactionsParam} */
|
|
391
|
+
static getOrderTransactions() {
|
|
392
|
+
return Joi.object({
|
|
393
|
+
orderId: Joi.string().allow("").required(),
|
|
394
|
+
}).required();
|
|
395
|
+
}
|
|
396
|
+
|
|
379
397
|
/** @returns {GetPGConfigAggregatorsParam} */
|
|
380
398
|
static getPGConfigAggregators() {
|
|
381
399
|
return Joi.object({}).required();
|
|
@@ -589,6 +607,14 @@ class PaymentPlatformApplicationValidator {
|
|
|
589
607
|
}).required();
|
|
590
608
|
}
|
|
591
609
|
|
|
610
|
+
/** @returns {UpdateOrderMetaParam} */
|
|
611
|
+
static updateOrderMeta() {
|
|
612
|
+
return Joi.object({
|
|
613
|
+
orderId: Joi.string().allow("").required(),
|
|
614
|
+
body: PaymentPlatformModel.OrderMetaUpdate().required(),
|
|
615
|
+
}).required();
|
|
616
|
+
}
|
|
617
|
+
|
|
592
618
|
/** @returns {UpdatePaymentSessionParam} */
|
|
593
619
|
static updatePaymentSession() {
|
|
594
620
|
return Joi.object({
|
|
@@ -872,6 +872,21 @@ export = PaymentPlatformModel;
|
|
|
872
872
|
* @property {string} aggregator - Name of the payment gateway aggregator.
|
|
873
873
|
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
874
874
|
*/
|
|
875
|
+
/**
|
|
876
|
+
* @typedef OrderMetaUpdate
|
|
877
|
+
* @property {string} pan_no - Valid Indian PAN (Permanent Account Number).
|
|
878
|
+
* Format: 5 letters, 4 digits, 1 letter (e.g. AAAAA9999A). Case-insensitive;
|
|
879
|
+
* stored in uppercase.
|
|
880
|
+
*/
|
|
881
|
+
/**
|
|
882
|
+
* @typedef OrderMetaResult
|
|
883
|
+
* @property {string} [message] - Success message indicating order meta was updated.
|
|
884
|
+
*/
|
|
885
|
+
/**
|
|
886
|
+
* @typedef OrderMetaErrorResult
|
|
887
|
+
* @property {boolean} [success] - Indicates whether the request was successful.
|
|
888
|
+
* @property {string} [message] - Error message describing the failure.
|
|
889
|
+
*/
|
|
875
890
|
/**
|
|
876
891
|
* @typedef AddressDetail
|
|
877
892
|
* @property {Object} [google_map_point] - Google map point of location
|
|
@@ -1260,6 +1275,23 @@ export = PaymentPlatformModel;
|
|
|
1260
1275
|
* @property {string} [cart_id] - Unique identifier for the shopping cart.
|
|
1261
1276
|
* @property {CreditAccountSummary} [account]
|
|
1262
1277
|
*/
|
|
1278
|
+
/**
|
|
1279
|
+
* @typedef OrderTransactionList
|
|
1280
|
+
* @property {boolean} [success] - Whether the request was successful.
|
|
1281
|
+
* @property {OrderTransactionItem[]} [items] - List of transactions ordered by
|
|
1282
|
+
* created_on ascending.
|
|
1283
|
+
*/
|
|
1284
|
+
/**
|
|
1285
|
+
* @typedef OrderTransactionItem
|
|
1286
|
+
* @property {string} [transaction_id] - Merchant transaction ID.
|
|
1287
|
+
* @property {string} [payment_mode] - Payment mode name (e.g. UPI, Card, COD).
|
|
1288
|
+
* @property {string} [logo] - Payment mode logo URL. Returns the small logo if
|
|
1289
|
+
* available, falls back to large logo. Null if no logo is configured.
|
|
1290
|
+
* @property {number} [amount] - Transaction amount.
|
|
1291
|
+
* @property {string} [status] - Latest transaction status (e.g. complete,
|
|
1292
|
+
* pending, failed, cancelled).
|
|
1293
|
+
* @property {string} [created_on] - Transaction creation timestamp (ISO 8601).
|
|
1294
|
+
*/
|
|
1263
1295
|
/**
|
|
1264
1296
|
* @typedef OperationResponseSchema
|
|
1265
1297
|
* @property {boolean} success - Indicates if the operation was successful
|
|
@@ -1269,7 +1301,7 @@ export = PaymentPlatformModel;
|
|
|
1269
1301
|
declare class PaymentPlatformModel {
|
|
1270
1302
|
}
|
|
1271
1303
|
declare namespace PaymentPlatformModel {
|
|
1272
|
-
export { AggregatorToken, 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, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, PaymentModeConfig, PaymentModeItems, SubPaymentMode, LogoSet, PlatformLogoSet, PlatformConfigPaymentModeDetails, PlatformPaymentModeItem, PlatformSubPaymentMode, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, 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, OperationResponseSchema };
|
|
1304
|
+
export { AggregatorToken, 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, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, PaymentModeConfig, PaymentModeItems, SubPaymentMode, LogoSet, PlatformLogoSet, PlatformConfigPaymentModeDetails, PlatformPaymentModeItem, PlatformSubPaymentMode, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, OrderDetail, OrderMetaUpdate, OrderMetaResult, OrderMetaErrorResult, 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, OrderTransactionList, OrderTransactionItem, OperationResponseSchema };
|
|
1273
1305
|
}
|
|
1274
1306
|
/** @returns {AggregatorToken} */
|
|
1275
1307
|
declare function AggregatorToken(): AggregatorToken;
|
|
@@ -3550,6 +3582,36 @@ type OrderDetail = {
|
|
|
3550
3582
|
*/
|
|
3551
3583
|
applied_offers?: AppliedOffer[];
|
|
3552
3584
|
};
|
|
3585
|
+
/** @returns {OrderMetaUpdate} */
|
|
3586
|
+
declare function OrderMetaUpdate(): OrderMetaUpdate;
|
|
3587
|
+
type OrderMetaUpdate = {
|
|
3588
|
+
/**
|
|
3589
|
+
* - Valid Indian PAN (Permanent Account Number).
|
|
3590
|
+
* Format: 5 letters, 4 digits, 1 letter (e.g. AAAAA9999A). Case-insensitive;
|
|
3591
|
+
* stored in uppercase.
|
|
3592
|
+
*/
|
|
3593
|
+
pan_no: string;
|
|
3594
|
+
};
|
|
3595
|
+
/** @returns {OrderMetaResult} */
|
|
3596
|
+
declare function OrderMetaResult(): OrderMetaResult;
|
|
3597
|
+
type OrderMetaResult = {
|
|
3598
|
+
/**
|
|
3599
|
+
* - Success message indicating order meta was updated.
|
|
3600
|
+
*/
|
|
3601
|
+
message?: string;
|
|
3602
|
+
};
|
|
3603
|
+
/** @returns {OrderMetaErrorResult} */
|
|
3604
|
+
declare function OrderMetaErrorResult(): OrderMetaErrorResult;
|
|
3605
|
+
type OrderMetaErrorResult = {
|
|
3606
|
+
/**
|
|
3607
|
+
* - Indicates whether the request was successful.
|
|
3608
|
+
*/
|
|
3609
|
+
success?: boolean;
|
|
3610
|
+
/**
|
|
3611
|
+
* - Error message describing the failure.
|
|
3612
|
+
*/
|
|
3613
|
+
message?: string;
|
|
3614
|
+
};
|
|
3553
3615
|
/** @returns {AddressDetail} */
|
|
3554
3616
|
declare function AddressDetail(): AddressDetail;
|
|
3555
3617
|
type AddressDetail = {
|
|
@@ -4563,6 +4625,49 @@ type ValidateCustomerCreditSchema = {
|
|
|
4563
4625
|
cart_id?: string;
|
|
4564
4626
|
account?: CreditAccountSummary;
|
|
4565
4627
|
};
|
|
4628
|
+
/** @returns {OrderTransactionList} */
|
|
4629
|
+
declare function OrderTransactionList(): OrderTransactionList;
|
|
4630
|
+
type OrderTransactionList = {
|
|
4631
|
+
/**
|
|
4632
|
+
* - Whether the request was successful.
|
|
4633
|
+
*/
|
|
4634
|
+
success?: boolean;
|
|
4635
|
+
/**
|
|
4636
|
+
* - List of transactions ordered by
|
|
4637
|
+
* created_on ascending.
|
|
4638
|
+
*/
|
|
4639
|
+
items?: OrderTransactionItem[];
|
|
4640
|
+
};
|
|
4641
|
+
/** @returns {OrderTransactionItem} */
|
|
4642
|
+
declare function OrderTransactionItem(): OrderTransactionItem;
|
|
4643
|
+
type OrderTransactionItem = {
|
|
4644
|
+
/**
|
|
4645
|
+
* - Merchant transaction ID.
|
|
4646
|
+
*/
|
|
4647
|
+
transaction_id?: string;
|
|
4648
|
+
/**
|
|
4649
|
+
* - Payment mode name (e.g. UPI, Card, COD).
|
|
4650
|
+
*/
|
|
4651
|
+
payment_mode?: string;
|
|
4652
|
+
/**
|
|
4653
|
+
* - Payment mode logo URL. Returns the small logo if
|
|
4654
|
+
* available, falls back to large logo. Null if no logo is configured.
|
|
4655
|
+
*/
|
|
4656
|
+
logo?: string;
|
|
4657
|
+
/**
|
|
4658
|
+
* - Transaction amount.
|
|
4659
|
+
*/
|
|
4660
|
+
amount?: number;
|
|
4661
|
+
/**
|
|
4662
|
+
* - Latest transaction status (e.g. complete,
|
|
4663
|
+
* pending, failed, cancelled).
|
|
4664
|
+
*/
|
|
4665
|
+
status?: string;
|
|
4666
|
+
/**
|
|
4667
|
+
* - Transaction creation timestamp (ISO 8601).
|
|
4668
|
+
*/
|
|
4669
|
+
created_on?: string;
|
|
4670
|
+
};
|
|
4566
4671
|
/** @returns {OperationResponseSchema} */
|
|
4567
4672
|
declare function OperationResponseSchema(): OperationResponseSchema;
|
|
4568
4673
|
type OperationResponseSchema = {
|
|
@@ -975,6 +975,24 @@ const Joi = require("joi");
|
|
|
975
975
|
* @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
|
|
976
976
|
*/
|
|
977
977
|
|
|
978
|
+
/**
|
|
979
|
+
* @typedef OrderMetaUpdate
|
|
980
|
+
* @property {string} pan_no - Valid Indian PAN (Permanent Account Number).
|
|
981
|
+
* Format: 5 letters, 4 digits, 1 letter (e.g. AAAAA9999A). Case-insensitive;
|
|
982
|
+
* stored in uppercase.
|
|
983
|
+
*/
|
|
984
|
+
|
|
985
|
+
/**
|
|
986
|
+
* @typedef OrderMetaResult
|
|
987
|
+
* @property {string} [message] - Success message indicating order meta was updated.
|
|
988
|
+
*/
|
|
989
|
+
|
|
990
|
+
/**
|
|
991
|
+
* @typedef OrderMetaErrorResult
|
|
992
|
+
* @property {boolean} [success] - Indicates whether the request was successful.
|
|
993
|
+
* @property {string} [message] - Error message describing the failure.
|
|
994
|
+
*/
|
|
995
|
+
|
|
978
996
|
/**
|
|
979
997
|
* @typedef AddressDetail
|
|
980
998
|
* @property {Object} [google_map_point] - Google map point of location
|
|
@@ -1403,6 +1421,25 @@ const Joi = require("joi");
|
|
|
1403
1421
|
* @property {CreditAccountSummary} [account]
|
|
1404
1422
|
*/
|
|
1405
1423
|
|
|
1424
|
+
/**
|
|
1425
|
+
* @typedef OrderTransactionList
|
|
1426
|
+
* @property {boolean} [success] - Whether the request was successful.
|
|
1427
|
+
* @property {OrderTransactionItem[]} [items] - List of transactions ordered by
|
|
1428
|
+
* created_on ascending.
|
|
1429
|
+
*/
|
|
1430
|
+
|
|
1431
|
+
/**
|
|
1432
|
+
* @typedef OrderTransactionItem
|
|
1433
|
+
* @property {string} [transaction_id] - Merchant transaction ID.
|
|
1434
|
+
* @property {string} [payment_mode] - Payment mode name (e.g. UPI, Card, COD).
|
|
1435
|
+
* @property {string} [logo] - Payment mode logo URL. Returns the small logo if
|
|
1436
|
+
* available, falls back to large logo. Null if no logo is configured.
|
|
1437
|
+
* @property {number} [amount] - Transaction amount.
|
|
1438
|
+
* @property {string} [status] - Latest transaction status (e.g. complete,
|
|
1439
|
+
* pending, failed, cancelled).
|
|
1440
|
+
* @property {string} [created_on] - Transaction creation timestamp (ISO 8601).
|
|
1441
|
+
*/
|
|
1442
|
+
|
|
1406
1443
|
/**
|
|
1407
1444
|
* @typedef OperationResponseSchema
|
|
1408
1445
|
* @property {boolean} success - Indicates if the operation was successful
|
|
@@ -2571,6 +2608,28 @@ class PaymentPlatformModel {
|
|
|
2571
2608
|
});
|
|
2572
2609
|
}
|
|
2573
2610
|
|
|
2611
|
+
/** @returns {OrderMetaUpdate} */
|
|
2612
|
+
static OrderMetaUpdate() {
|
|
2613
|
+
return Joi.object({
|
|
2614
|
+
pan_no: Joi.string().allow("").required(),
|
|
2615
|
+
});
|
|
2616
|
+
}
|
|
2617
|
+
|
|
2618
|
+
/** @returns {OrderMetaResult} */
|
|
2619
|
+
static OrderMetaResult() {
|
|
2620
|
+
return Joi.object({
|
|
2621
|
+
message: Joi.string().allow(""),
|
|
2622
|
+
});
|
|
2623
|
+
}
|
|
2624
|
+
|
|
2625
|
+
/** @returns {OrderMetaErrorResult} */
|
|
2626
|
+
static OrderMetaErrorResult() {
|
|
2627
|
+
return Joi.object({
|
|
2628
|
+
success: Joi.boolean(),
|
|
2629
|
+
message: Joi.string().allow(""),
|
|
2630
|
+
});
|
|
2631
|
+
}
|
|
2632
|
+
|
|
2574
2633
|
/** @returns {AddressDetail} */
|
|
2575
2634
|
static AddressDetail() {
|
|
2576
2635
|
return Joi.object({
|
|
@@ -3053,6 +3112,26 @@ class PaymentPlatformModel {
|
|
|
3053
3112
|
});
|
|
3054
3113
|
}
|
|
3055
3114
|
|
|
3115
|
+
/** @returns {OrderTransactionList} */
|
|
3116
|
+
static OrderTransactionList() {
|
|
3117
|
+
return Joi.object({
|
|
3118
|
+
success: Joi.boolean(),
|
|
3119
|
+
items: Joi.array().items(PaymentPlatformModel.OrderTransactionItem()),
|
|
3120
|
+
});
|
|
3121
|
+
}
|
|
3122
|
+
|
|
3123
|
+
/** @returns {OrderTransactionItem} */
|
|
3124
|
+
static OrderTransactionItem() {
|
|
3125
|
+
return Joi.object({
|
|
3126
|
+
transaction_id: Joi.string().allow(""),
|
|
3127
|
+
payment_mode: Joi.string().allow("").allow(null),
|
|
3128
|
+
logo: Joi.string().allow("").allow(null),
|
|
3129
|
+
amount: Joi.number().allow(null),
|
|
3130
|
+
status: Joi.string().allow("").allow(null),
|
|
3131
|
+
created_on: Joi.string().allow(""),
|
|
3132
|
+
});
|
|
3133
|
+
}
|
|
3134
|
+
|
|
3056
3135
|
/** @returns {OperationResponseSchema} */
|
|
3057
3136
|
static OperationResponseSchema() {
|
|
3058
3137
|
return Joi.object({
|
|
@@ -15,7 +15,6 @@ declare class PlatformApplicationClient {
|
|
|
15
15
|
config: import("./PlatformConfig");
|
|
16
16
|
companyId: string;
|
|
17
17
|
applicationId: string;
|
|
18
|
-
analytics: Analytics;
|
|
19
18
|
cart: Cart;
|
|
20
19
|
catalog: Catalog;
|
|
21
20
|
communication: Communication;
|
|
@@ -38,7 +37,6 @@ declare class PlatformApplicationClient {
|
|
|
38
37
|
*/
|
|
39
38
|
setExtraHeaders(header: object): void;
|
|
40
39
|
}
|
|
41
|
-
import Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
|
|
42
40
|
import Cart = require("./Cart/CartPlatformApplicationClient");
|
|
43
41
|
import Catalog = require("./Catalog/CatalogPlatformApplicationClient");
|
|
44
42
|
import Communication = require("./Communication/CommunicationPlatformApplicationClient");
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
const Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
|
|
2
|
-
|
|
3
1
|
const Cart = require("./Cart/CartPlatformApplicationClient");
|
|
4
2
|
|
|
5
3
|
const Catalog = require("./Catalog/CatalogPlatformApplicationClient");
|
|
@@ -47,8 +45,6 @@ class PlatformApplicationClient {
|
|
|
47
45
|
this.companyId = config.companyId;
|
|
48
46
|
this.applicationId = applicationId;
|
|
49
47
|
|
|
50
|
-
this.analytics = new Analytics(config, applicationId);
|
|
51
|
-
|
|
52
48
|
this.cart = new Cart(config, applicationId);
|
|
53
49
|
|
|
54
50
|
this.catalog = new Catalog(config, applicationId);
|
|
@@ -517,6 +517,20 @@ declare class Serviceability {
|
|
|
517
517
|
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchApplicationConfiguration/).
|
|
518
518
|
*/
|
|
519
519
|
patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
|
|
520
|
+
/**
|
|
521
|
+
* @param {ServiceabilityPlatformApplicationValidator.PatchZoneProductsAtomicParam} arg
|
|
522
|
+
* - Arg object
|
|
523
|
+
*
|
|
524
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
525
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
526
|
+
* @returns {Promise<ServiceabilityPlatformModel.ZoneProductsAtomicPatchResult>}
|
|
527
|
+
* - Success response
|
|
528
|
+
*
|
|
529
|
+
* @name patchZoneProductsAtomic
|
|
530
|
+
* @summary: Atomically add or remove products on zones (concurrency-safe)
|
|
531
|
+
* @description: Synchronously adds or removes products on one or more zones. Each item is applied with an atomic MongoDB array operator (`$addToSet` for add, `$pull` for remove) rather than a read-modify-write of the whole product list, so concurrent writes to the same zone never lose each other's changes. `product_type` must match the existing zone's product type. Product ids are not validated against the catalog (this is a synchronous API; callers send already-known ids). Returns a per-item status and a summary; per-item failures (e.g. zone not found, product type mismatch) do not fail the whole request. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchZoneProductsAtomic/).
|
|
532
|
+
*/
|
|
533
|
+
patchZoneProductsAtomic({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchZoneProductsAtomicParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneProductsAtomicPatchResult>;
|
|
520
534
|
/**
|
|
521
535
|
* @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
|
|
522
536
|
* - Arg object
|