@gofynd/fdk-client-javascript 3.27.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/CatalogPlatformModel.d.ts +175 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +83 -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/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
|
@@ -1636,6 +1636,47 @@ class Configuration {
|
|
|
1636
1636
|
return response;
|
|
1637
1637
|
}
|
|
1638
1638
|
|
|
1639
|
+
/**
|
|
1640
|
+
* @param {Object} arg - Arg object.
|
|
1641
|
+
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
1642
|
+
* on Fynd Platform
|
|
1643
|
+
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
1644
|
+
* application (sales channel website) created within a business account
|
|
1645
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
1646
|
+
* page. Default value is 10.
|
|
1647
|
+
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
1648
|
+
* @returns {Paginator<ConfigurationPlatformModel.OrderingStoresResponseSchema>}
|
|
1649
|
+
* @summary: Get staff ordering stores
|
|
1650
|
+
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders).
|
|
1651
|
+
*/
|
|
1652
|
+
getStaffOrderingStoresPaginator({
|
|
1653
|
+
companyId,
|
|
1654
|
+
applicationId,
|
|
1655
|
+
pageSize,
|
|
1656
|
+
q,
|
|
1657
|
+
} = {}) {
|
|
1658
|
+
const paginator = new Paginator();
|
|
1659
|
+
const callback = async () => {
|
|
1660
|
+
const pageId = paginator.nextId;
|
|
1661
|
+
const pageNo = paginator.pageNo;
|
|
1662
|
+
const pageType = "number";
|
|
1663
|
+
const data = await this.getStaffOrderingStores({
|
|
1664
|
+
companyId: companyId,
|
|
1665
|
+
applicationId: applicationId,
|
|
1666
|
+
pageNo: pageNo,
|
|
1667
|
+
pageSize: pageSize,
|
|
1668
|
+
q: q,
|
|
1669
|
+
});
|
|
1670
|
+
paginator.setPaginator({
|
|
1671
|
+
hasNext: data.page.has_next ? true : false,
|
|
1672
|
+
nextId: data.page.next_id,
|
|
1673
|
+
});
|
|
1674
|
+
return data;
|
|
1675
|
+
};
|
|
1676
|
+
paginator.setCallback(callback.bind(this));
|
|
1677
|
+
return paginator;
|
|
1678
|
+
}
|
|
1679
|
+
|
|
1639
1680
|
/**
|
|
1640
1681
|
* @param {ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam} arg
|
|
1641
1682
|
* - Arg object
|
|
@@ -135,6 +135,12 @@ export = LeadPlatformModel;
|
|
|
135
135
|
* @property {string} [description] - Long description of issue
|
|
136
136
|
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
137
137
|
*/
|
|
138
|
+
/**
|
|
139
|
+
* @typedef AdditionalInfo
|
|
140
|
+
* @property {string} [display_name] - Human readable name for this info
|
|
141
|
+
* @property {string} [display_value] - Human readable value for the info
|
|
142
|
+
* @property {number} [priority] - Priority of this additional info
|
|
143
|
+
*/
|
|
138
144
|
/**
|
|
139
145
|
* @typedef AddTicketPayload
|
|
140
146
|
* @property {Object} [created_by] - Creator of the ticket
|
|
@@ -143,6 +149,8 @@ export = LeadPlatformModel;
|
|
|
143
149
|
* @property {string} category - Category of the ticket
|
|
144
150
|
* @property {TicketContent} content
|
|
145
151
|
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
152
|
+
* @property {AdditionalInfo[]} [additional_info] - Additional information
|
|
153
|
+
* related to the ticket
|
|
146
154
|
*/
|
|
147
155
|
/**
|
|
148
156
|
* @typedef Priority
|
|
@@ -289,7 +297,7 @@ export = LeadPlatformModel;
|
|
|
289
297
|
declare class LeadPlatformModel {
|
|
290
298
|
}
|
|
291
299
|
declare namespace LeadPlatformModel {
|
|
292
|
-
export { GeneralConfigDetails, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
300
|
+
export { GeneralConfigDetails, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AdditionalInfo, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
293
301
|
}
|
|
294
302
|
/** @returns {GeneralConfigDetails} */
|
|
295
303
|
declare function GeneralConfigDetails(): GeneralConfigDetails;
|
|
@@ -577,6 +585,22 @@ type TicketContent = {
|
|
|
577
585
|
*/
|
|
578
586
|
attachments?: TicketAsset[];
|
|
579
587
|
};
|
|
588
|
+
/** @returns {AdditionalInfo} */
|
|
589
|
+
declare function AdditionalInfo(): AdditionalInfo;
|
|
590
|
+
type AdditionalInfo = {
|
|
591
|
+
/**
|
|
592
|
+
* - Human readable name for this info
|
|
593
|
+
*/
|
|
594
|
+
display_name?: string;
|
|
595
|
+
/**
|
|
596
|
+
* - Human readable value for the info
|
|
597
|
+
*/
|
|
598
|
+
display_value?: string;
|
|
599
|
+
/**
|
|
600
|
+
* - Priority of this additional info
|
|
601
|
+
*/
|
|
602
|
+
priority?: number;
|
|
603
|
+
};
|
|
580
604
|
/** @returns {AddTicketPayload} */
|
|
581
605
|
declare function AddTicketPayload(): AddTicketPayload;
|
|
582
606
|
type AddTicketPayload = {
|
|
@@ -598,6 +622,11 @@ type AddTicketPayload = {
|
|
|
598
622
|
* - Optional custom data that needs to be sent
|
|
599
623
|
*/
|
|
600
624
|
_custom_json?: any;
|
|
625
|
+
/**
|
|
626
|
+
* - Additional information
|
|
627
|
+
* related to the ticket
|
|
628
|
+
*/
|
|
629
|
+
additional_info?: AdditionalInfo[];
|
|
601
630
|
};
|
|
602
631
|
/** @returns {Priority} */
|
|
603
632
|
declare function Priority(): Priority;
|
|
@@ -154,6 +154,13 @@ const Joi = require("joi");
|
|
|
154
154
|
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
155
155
|
*/
|
|
156
156
|
|
|
157
|
+
/**
|
|
158
|
+
* @typedef AdditionalInfo
|
|
159
|
+
* @property {string} [display_name] - Human readable name for this info
|
|
160
|
+
* @property {string} [display_value] - Human readable value for the info
|
|
161
|
+
* @property {number} [priority] - Priority of this additional info
|
|
162
|
+
*/
|
|
163
|
+
|
|
157
164
|
/**
|
|
158
165
|
* @typedef AddTicketPayload
|
|
159
166
|
* @property {Object} [created_by] - Creator of the ticket
|
|
@@ -162,6 +169,8 @@ const Joi = require("joi");
|
|
|
162
169
|
* @property {string} category - Category of the ticket
|
|
163
170
|
* @property {TicketContent} content
|
|
164
171
|
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
172
|
+
* @property {AdditionalInfo[]} [additional_info] - Additional information
|
|
173
|
+
* related to the ticket
|
|
165
174
|
*/
|
|
166
175
|
|
|
167
176
|
/**
|
|
@@ -514,6 +523,15 @@ class LeadPlatformModel {
|
|
|
514
523
|
});
|
|
515
524
|
}
|
|
516
525
|
|
|
526
|
+
/** @returns {AdditionalInfo} */
|
|
527
|
+
static AdditionalInfo() {
|
|
528
|
+
return Joi.object({
|
|
529
|
+
display_name: Joi.string().allow(""),
|
|
530
|
+
display_value: Joi.string().allow(""),
|
|
531
|
+
priority: Joi.number(),
|
|
532
|
+
});
|
|
533
|
+
}
|
|
534
|
+
|
|
517
535
|
/** @returns {AddTicketPayload} */
|
|
518
536
|
static AddTicketPayload() {
|
|
519
537
|
return Joi.object({
|
|
@@ -523,6 +541,7 @@ class LeadPlatformModel {
|
|
|
523
541
|
category: Joi.string().allow("").required(),
|
|
524
542
|
content: LeadPlatformModel.TicketContent().required(),
|
|
525
543
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
544
|
+
additional_info: Joi.array().items(LeadPlatformModel.AdditionalInfo()),
|
|
526
545
|
});
|
|
527
546
|
}
|
|
528
547
|
|
|
@@ -164,6 +164,18 @@ declare class Payment {
|
|
|
164
164
|
* @description: Retrieve merchant refund priority configurations, returning the status of the update and the refund sources priority with their descriptions and priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantRefundPriority/).
|
|
165
165
|
*/
|
|
166
166
|
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
167
|
+
/**
|
|
168
|
+
* @param {PaymentPlatformApplicationValidator.GetOrderTransactionsParam} arg
|
|
169
|
+
* - Arg object
|
|
170
|
+
*
|
|
171
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
|
+
* @returns {Promise<PaymentPlatformModel.OrderTransactionList>} - Success response
|
|
174
|
+
* @name getOrderTransactions
|
|
175
|
+
* @summary: List all transactions for an order
|
|
176
|
+
* @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/).
|
|
177
|
+
*/
|
|
178
|
+
getOrderTransactions({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetOrderTransactionsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderTransactionList>;
|
|
167
179
|
/**
|
|
168
180
|
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
169
181
|
* - Arg object
|
|
@@ -502,6 +514,16 @@ declare class Payment {
|
|
|
502
514
|
* @description: Update merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updateMerchantRefundPriority/).
|
|
503
515
|
*/
|
|
504
516
|
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
517
|
+
/**
|
|
518
|
+
* @param {PaymentPlatformApplicationValidator.UpdateOrderMetaParam} arg - Arg object
|
|
519
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
520
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
521
|
+
* @returns {Promise<PaymentPlatformModel.OrderMetaResult>} - Success response
|
|
522
|
+
* @name updateOrderMeta
|
|
523
|
+
* @summary: Update order metadata
|
|
524
|
+
* @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/).
|
|
525
|
+
*/
|
|
526
|
+
updateOrderMeta({ orderId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateOrderMetaParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderMetaResult>;
|
|
505
527
|
/**
|
|
506
528
|
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
507
529
|
* - Arg object
|
|
@@ -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 = {
|