@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
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 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -34,11 +34,6 @@ export = OrderApplicationValidator;
|
|
|
34
34
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
35
35
|
* shipments are allowed
|
|
36
36
|
*/
|
|
37
|
-
/**
|
|
38
|
-
* @typedef GetPosOrderByIdParam
|
|
39
|
-
* @property {string} orderId - A unique number used for identifying and
|
|
40
|
-
* tracking your orders.
|
|
41
|
-
*/
|
|
42
37
|
/**
|
|
43
38
|
* @typedef GetShipmentBagReasonsParam
|
|
44
39
|
* @property {string} shipmentId - ID of the bag. An order may contain multiple
|
|
@@ -98,8 +93,6 @@ declare class OrderApplicationValidator {
|
|
|
98
93
|
static getOrderById(): GetOrderByIdParam;
|
|
99
94
|
/** @returns {GetOrdersParam} */
|
|
100
95
|
static getOrders(): GetOrdersParam;
|
|
101
|
-
/** @returns {GetPosOrderByIdParam} */
|
|
102
|
-
static getPosOrderById(): GetPosOrderByIdParam;
|
|
103
96
|
/** @returns {GetShipmentBagReasonsParam} */
|
|
104
97
|
static getShipmentBagReasons(): GetShipmentBagReasonsParam;
|
|
105
98
|
/** @returns {GetShipmentByIdParam} */
|
|
@@ -116,7 +109,7 @@ declare class OrderApplicationValidator {
|
|
|
116
109
|
static verifyOtpShipmentCustomer(): VerifyOtpShipmentCustomerParam;
|
|
117
110
|
}
|
|
118
111
|
declare namespace OrderApplicationValidator {
|
|
119
|
-
export { GetCustomerDetailsByShipmentIdParam, GetInvoiceByShipmentIdParam, GetOrderByIdParam, GetOrdersParam,
|
|
112
|
+
export { GetCustomerDetailsByShipmentIdParam, GetInvoiceByShipmentIdParam, GetOrderByIdParam, GetOrdersParam, GetShipmentBagReasonsParam, GetShipmentByIdParam, GetShipmentReasonsParam, SendOtpToShipmentCustomerParam, TrackShipmentParam, UpdateShipmentStatusParam, VerifyOtpShipmentCustomerParam };
|
|
120
113
|
}
|
|
121
114
|
type GetCustomerDetailsByShipmentIdParam = {
|
|
122
115
|
/**
|
|
@@ -191,13 +184,6 @@ type GetOrdersParam = {
|
|
|
191
184
|
*/
|
|
192
185
|
allowInactive?: boolean;
|
|
193
186
|
};
|
|
194
|
-
type GetPosOrderByIdParam = {
|
|
195
|
-
/**
|
|
196
|
-
* - A unique number used for identifying and
|
|
197
|
-
* tracking your orders.
|
|
198
|
-
*/
|
|
199
|
-
orderId: string;
|
|
200
|
-
};
|
|
201
187
|
type GetShipmentBagReasonsParam = {
|
|
202
188
|
/**
|
|
203
189
|
* - ID of the bag. An order may contain multiple
|
|
@@ -274,4 +260,4 @@ type VerifyOtpShipmentCustomerParam = {
|
|
|
274
260
|
shipmentId: string;
|
|
275
261
|
body: OrderApplicationModel.VerifyOtp;
|
|
276
262
|
};
|
|
277
|
-
import OrderApplicationModel = require("
|
|
263
|
+
import OrderApplicationModel = require("sdk/output/javascript/code/sdk/application/Order/OrderApplicationModel");
|
|
@@ -41,12 +41,6 @@ const OrderApplicationModel = require("./OrderApplicationModel");
|
|
|
41
41
|
* shipments are allowed
|
|
42
42
|
*/
|
|
43
43
|
|
|
44
|
-
/**
|
|
45
|
-
* @typedef GetPosOrderByIdParam
|
|
46
|
-
* @property {string} orderId - A unique number used for identifying and
|
|
47
|
-
* tracking your orders.
|
|
48
|
-
*/
|
|
49
|
-
|
|
50
44
|
/**
|
|
51
45
|
* @typedef GetShipmentBagReasonsParam
|
|
52
46
|
* @property {string} shipmentId - ID of the bag. An order may contain multiple
|
|
@@ -143,13 +137,6 @@ class OrderApplicationValidator {
|
|
|
143
137
|
});
|
|
144
138
|
}
|
|
145
139
|
|
|
146
|
-
/** @returns {GetPosOrderByIdParam} */
|
|
147
|
-
static getPosOrderById() {
|
|
148
|
-
return Joi.object({
|
|
149
|
-
orderId: Joi.string().allow("").required(),
|
|
150
|
-
}).required();
|
|
151
|
-
}
|
|
152
|
-
|
|
153
140
|
/** @returns {GetShipmentBagReasonsParam} */
|
|
154
141
|
static getShipmentBagReasons() {
|
|
155
142
|
return Joi.object({
|
|
@@ -48,7 +48,7 @@ declare class Payment {
|
|
|
48
48
|
verifyIfscCode: string;
|
|
49
49
|
verifyOtpAndAddBeneficiaryForBank: string;
|
|
50
50
|
verifyOtpAndAddBeneficiaryForWallet: string;
|
|
51
|
-
|
|
51
|
+
walletLinkInitiate: string;
|
|
52
52
|
};
|
|
53
53
|
_urls: {};
|
|
54
54
|
updateUrls(urls: any): void;
|
|
@@ -59,8 +59,8 @@ declare class Payment {
|
|
|
59
59
|
* @returns {Promise<PaymentApplicationModel.RefundAccountResponse>} -
|
|
60
60
|
* Success response
|
|
61
61
|
* @name addBeneficiaryDetails
|
|
62
|
-
* @summary: Add beneficiary
|
|
63
|
-
* @description: Adds beneficiary details for
|
|
62
|
+
* @summary: Add beneficiary for refund
|
|
63
|
+
* @description: Adds beneficiary details specifically for refund transactions, including account holder name, account number and bank details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addBeneficiaryDetails/).
|
|
64
64
|
*/
|
|
65
65
|
addBeneficiaryDetails({ body, requestHeaders }?: PaymentApplicationValidator.AddBeneficiaryDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.RefundAccountResponse>;
|
|
66
66
|
/**
|
|
@@ -72,8 +72,8 @@ declare class Payment {
|
|
|
72
72
|
* @returns {Promise<PaymentApplicationModel.RefundAccountResponse>} -
|
|
73
73
|
* Success response
|
|
74
74
|
* @name addRefundBankAccountUsingOTP
|
|
75
|
-
* @summary: Add refund account
|
|
76
|
-
* @description:
|
|
75
|
+
* @summary: Add refund account using OTP verification
|
|
76
|
+
* @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addRefundBankAccountUsingOTP/).
|
|
77
77
|
*/
|
|
78
78
|
addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.RefundAccountResponse>;
|
|
79
79
|
/**
|
|
@@ -82,8 +82,8 @@ declare class Payment {
|
|
|
82
82
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
83
83
|
* @returns {Promise<PaymentApplicationModel.AttachCardsResponse>} - Success response
|
|
84
84
|
* @name attachCardToCustomer
|
|
85
|
-
* @summary:
|
|
86
|
-
* @description:
|
|
85
|
+
* @summary: Link payment card to customer
|
|
86
|
+
* @description: Linking of a payment card to a user's account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/attachCardToCustomer/).
|
|
87
87
|
*/
|
|
88
88
|
attachCardToCustomer({ body, requestHeaders }?: PaymentApplicationValidator.AttachCardToCustomerParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.AttachCardsResponse>;
|
|
89
89
|
/**
|
|
@@ -93,7 +93,7 @@ declare class Payment {
|
|
|
93
93
|
* @returns {Promise<PaymentApplicationModel.CancelPaymentLinkResponse>} -
|
|
94
94
|
* Success response
|
|
95
95
|
* @name cancelPaymentLink
|
|
96
|
-
* @summary: Cancel link
|
|
96
|
+
* @summary: Cancel payment link
|
|
97
97
|
* @description: Cancels a previously generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cancelPaymentLink/).
|
|
98
98
|
*/
|
|
99
99
|
cancelPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CancelPaymentLinkResponse>;
|
|
@@ -103,8 +103,8 @@ declare class Payment {
|
|
|
103
103
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
104
104
|
* @returns {Promise<PaymentApplicationModel.CardDetailsResponse>} - Success response
|
|
105
105
|
* @name cardDetails
|
|
106
|
-
* @summary:
|
|
107
|
-
* @description:
|
|
106
|
+
* @summary: Get card details
|
|
107
|
+
* @description: Fetches the details of a specified payment card, including information such as the card type, brand, country, and expiration date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cardDetails/).
|
|
108
108
|
*/
|
|
109
109
|
cardDetails({ cardInfo, aggregator, requestHeaders }?: PaymentApplicationValidator.CardDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CardDetailsResponse>;
|
|
110
110
|
/**
|
|
@@ -117,8 +117,8 @@ declare class Payment {
|
|
|
117
117
|
* - Success response
|
|
118
118
|
*
|
|
119
119
|
* @name checkAndUpdatePaymentStatus
|
|
120
|
-
* @summary: Update payment status
|
|
121
|
-
* @description:
|
|
120
|
+
* @summary: Update payment status
|
|
121
|
+
* @description: Polling process to confirm the payment status. It periodically checks and updates the current status of a payment, ensuring timely and accurate confirmation of payment transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatus/).
|
|
122
122
|
*/
|
|
123
123
|
checkAndUpdatePaymentStatus({ body, requestHeaders }?: PaymentApplicationValidator.CheckAndUpdatePaymentStatusParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentStatusUpdateResponse>;
|
|
124
124
|
/**
|
|
@@ -131,8 +131,8 @@ declare class Payment {
|
|
|
131
131
|
* - Success response
|
|
132
132
|
*
|
|
133
133
|
* @name checkAndUpdatePaymentStatusPaymentLink
|
|
134
|
-
* @summary: Update link status
|
|
135
|
-
* @description:
|
|
134
|
+
* @summary: Update payment link status
|
|
135
|
+
* @description: Verifies and updates the status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
|
|
136
136
|
*/
|
|
137
137
|
checkAndUpdatePaymentStatusPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CheckAndUpdatePaymentStatusPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentStatusUpdateResponse>;
|
|
138
138
|
/**
|
|
@@ -141,8 +141,8 @@ declare class Payment {
|
|
|
141
141
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
142
142
|
* @returns {Promise<PaymentApplicationModel.CheckCreditResponse>} - Success response
|
|
143
143
|
* @name checkCredit
|
|
144
|
-
* @summary: Verify credit
|
|
145
|
-
* @description: Checks the availability and status of customer credit. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
|
|
144
|
+
* @summary: Verify credit availability and status
|
|
145
|
+
* @description: Checks the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
|
|
146
146
|
*/
|
|
147
147
|
checkCredit({ aggregator, requestHeaders }?: PaymentApplicationValidator.CheckCreditParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CheckCreditResponse>;
|
|
148
148
|
/**
|
|
@@ -154,8 +154,8 @@ declare class Payment {
|
|
|
154
154
|
* @returns {Promise<PaymentApplicationModel.CreateOrderUserResponse>} -
|
|
155
155
|
* Success response
|
|
156
156
|
* @name createOrderHandlerPaymentLink
|
|
157
|
-
* @summary:
|
|
158
|
-
* @description:
|
|
157
|
+
* @summary: Create order for payment via link
|
|
158
|
+
* @description: Initiates the creation of an order handler for processing payments through a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createOrderHandlerPaymentLink/).
|
|
159
159
|
*/
|
|
160
160
|
createOrderHandlerPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CreateOrderHandlerPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CreateOrderUserResponse>;
|
|
161
161
|
/**
|
|
@@ -165,7 +165,7 @@ declare class Payment {
|
|
|
165
165
|
* @returns {Promise<PaymentApplicationModel.CreatePaymentLinkResponse>} -
|
|
166
166
|
* Success response
|
|
167
167
|
* @name createPaymentLink
|
|
168
|
-
* @summary: Create payment link
|
|
168
|
+
* @summary: Create payment link
|
|
169
169
|
* @description: Generates a new payment link for transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentLink/).
|
|
170
170
|
*/
|
|
171
171
|
createPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CreatePaymentLinkResponse>;
|
|
@@ -176,7 +176,7 @@ declare class Payment {
|
|
|
176
176
|
* @returns {Promise<PaymentApplicationModel.PaymentOrderResponse>} - Success response
|
|
177
177
|
* @name createPaymentOrder
|
|
178
178
|
* @summary: Create Order
|
|
179
|
-
* @description:
|
|
179
|
+
* @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentOrder/).
|
|
180
180
|
*/
|
|
181
181
|
createPaymentOrder({ body, requestHeaders }?: PaymentApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentOrderResponse>;
|
|
182
182
|
/**
|
|
@@ -187,8 +187,8 @@ declare class Payment {
|
|
|
187
187
|
* - Success response
|
|
188
188
|
*
|
|
189
189
|
* @name customerCreditSummary
|
|
190
|
-
* @summary: Credit summary
|
|
191
|
-
* @description:
|
|
190
|
+
* @summary: Credit summary
|
|
191
|
+
* @description: Fetches a summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerCreditSummary/).
|
|
192
192
|
*/
|
|
193
193
|
customerCreditSummary({ aggregator, requestHeaders }?: PaymentApplicationValidator.CustomerCreditSummaryParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CustomerCreditSummaryResponse>;
|
|
194
194
|
/**
|
|
@@ -198,8 +198,8 @@ declare class Payment {
|
|
|
198
198
|
* @returns {Promise<PaymentApplicationModel.CustomerOnboardingResponse>} -
|
|
199
199
|
* Success response
|
|
200
200
|
* @name customerOnboard
|
|
201
|
-
* @summary: Onboard customer
|
|
202
|
-
* @description: Initiates the onboarding process for payment services. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
|
|
201
|
+
* @summary: Onboard customer for payment
|
|
202
|
+
* @description: Initiates the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
|
|
203
203
|
*/
|
|
204
204
|
customerOnboard({ body, requestHeaders }?: PaymentApplicationValidator.CustomerOnboardParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CustomerOnboardingResponse>;
|
|
205
205
|
/**
|
|
@@ -208,8 +208,8 @@ declare class Payment {
|
|
|
208
208
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
209
209
|
* @returns {Promise<PaymentApplicationModel.DeleteCardsResponse>} - Success response
|
|
210
210
|
* @name deleteUserCard
|
|
211
|
-
* @summary:
|
|
212
|
-
* @description:
|
|
211
|
+
* @summary: Delete customer card
|
|
212
|
+
* @description: Deletion of a payment card from the user's account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/deleteUserCard/).
|
|
213
213
|
*/
|
|
214
214
|
deleteUserCard({ body, requestHeaders }?: PaymentApplicationValidator.DeleteUserCardParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.DeleteCardsResponse>;
|
|
215
215
|
/**
|
|
@@ -219,7 +219,7 @@ declare class Payment {
|
|
|
219
219
|
* @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
|
|
220
220
|
* @name delinkWallet
|
|
221
221
|
* @summary: Delink the wallet
|
|
222
|
-
* @description:
|
|
222
|
+
* @description: User removes already linked wallet. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/delinkWallet/).
|
|
223
223
|
*/
|
|
224
224
|
delinkWallet({ body, requestHeaders }?: PaymentApplicationValidator.DelinkWalletParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletResponseSchema>;
|
|
225
225
|
/**
|
|
@@ -232,8 +232,8 @@ declare class Payment {
|
|
|
232
232
|
* - Success response
|
|
233
233
|
*
|
|
234
234
|
* @name enableOrDisableRefundTransferMode
|
|
235
|
-
* @summary: Toggle refund mode
|
|
236
|
-
* @description: Enables or disables a particular refund transfer mode
|
|
235
|
+
* @summary: Toggle refund mode
|
|
236
|
+
* @description: Enables or disables a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/enableOrDisableRefundTransferMode/).
|
|
237
237
|
*/
|
|
238
238
|
enableOrDisableRefundTransferMode({ body, requestHeaders }?: PaymentApplicationValidator.EnableOrDisableRefundTransferModeParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.UpdateRefundTransferModeResponse>;
|
|
239
239
|
/**
|
|
@@ -244,8 +244,8 @@ declare class Payment {
|
|
|
244
244
|
* - Success response
|
|
245
245
|
*
|
|
246
246
|
* @name getActiveCardAggregator
|
|
247
|
-
* @summary:
|
|
248
|
-
* @description:
|
|
247
|
+
* @summary: Retrieve active card aggregator
|
|
248
|
+
* @description: Fetches details about the active card aggregator used by the user, including the aggregator's name.You can refresh the data by setting the "refresh" parameter to true if needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveCardAggregator/).
|
|
249
249
|
*/
|
|
250
250
|
getActiveCardAggregator({ refresh, requestHeaders }?: PaymentApplicationValidator.GetActiveCardAggregatorParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ActiveCardPaymentGatewayResponse>;
|
|
251
251
|
/**
|
|
@@ -256,8 +256,8 @@ declare class Payment {
|
|
|
256
256
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
257
257
|
* @returns {Promise<PaymentApplicationModel.TransferModeResponse>} - Success response
|
|
258
258
|
* @name getActiveRefundTransferModes
|
|
259
|
-
* @summary:
|
|
260
|
-
* @description: Lists the
|
|
259
|
+
* @summary: Get refund transfer modes
|
|
260
|
+
* @description: Lists the available refund modes, such as UPI, providing details like display name, logo, and ID for each mode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveRefundTransferModes/).
|
|
261
261
|
*/
|
|
262
262
|
getActiveRefundTransferModes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentApplicationModel.TransferModeResponse>;
|
|
263
263
|
/**
|
|
@@ -266,8 +266,8 @@ declare class Payment {
|
|
|
266
266
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
267
267
|
* @returns {Promise<PaymentApplicationModel.ListCardsResponse>} - Success response
|
|
268
268
|
* @name getActiveUserCards
|
|
269
|
-
* @summary:
|
|
270
|
-
* @description: Retrieves all active cards
|
|
269
|
+
* @summary: Get customer cards
|
|
270
|
+
* @description: Retrieves a list of all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveUserCards/).
|
|
271
271
|
*/
|
|
272
272
|
getActiveUserCards({ forceRefresh, requestHeaders }?: PaymentApplicationValidator.GetActiveUserCardsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ListCardsResponse>;
|
|
273
273
|
/**
|
|
@@ -278,8 +278,8 @@ declare class Payment {
|
|
|
278
278
|
* - Success response
|
|
279
279
|
*
|
|
280
280
|
* @name getAggregatorsConfig
|
|
281
|
-
* @summary:
|
|
282
|
-
* @description:
|
|
281
|
+
* @summary: Get payment aggregators
|
|
282
|
+
* @description: Retrieve the aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getAggregatorsConfig/).
|
|
283
283
|
*/
|
|
284
284
|
getAggregatorsConfig({ xApiToken, refresh, requestHeaders }?: PaymentApplicationValidator.GetAggregatorsConfigParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.AggregatorsConfigDetailResponse>;
|
|
285
285
|
/**
|
|
@@ -291,8 +291,8 @@ declare class Payment {
|
|
|
291
291
|
* @returns {Promise<PaymentApplicationModel.EpaylaterBannerResponse>} -
|
|
292
292
|
* Success response
|
|
293
293
|
* @name getEpaylaterBannerDetails
|
|
294
|
-
* @summary:
|
|
295
|
-
* @description:
|
|
294
|
+
* @summary: Epaylater banner info
|
|
295
|
+
* @description: Retrieves details required to display the Epaylater payment banner. It provides information about the banner's display status, along with relevant messages and the user's registration status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getEpaylaterBannerDetails/).
|
|
296
296
|
*/
|
|
297
297
|
getEpaylaterBannerDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentApplicationModel.EpaylaterBannerResponse>;
|
|
298
298
|
/**
|
|
@@ -304,8 +304,8 @@ declare class Payment {
|
|
|
304
304
|
* @returns {Promise<PaymentApplicationModel.OrderBeneficiaryResponse>} -
|
|
305
305
|
* Success response
|
|
306
306
|
* @name getOrderBeneficiariesDetail
|
|
307
|
-
* @summary:
|
|
308
|
-
* @description: Retrieve
|
|
307
|
+
* @summary: Retrieve beneficiary details
|
|
308
|
+
* @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getOrderBeneficiariesDetail/).
|
|
309
309
|
*/
|
|
310
310
|
getOrderBeneficiariesDetail({ orderId, requestHeaders }?: PaymentApplicationValidator.GetOrderBeneficiariesDetailParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.OrderBeneficiaryResponse>;
|
|
311
311
|
/**
|
|
@@ -315,7 +315,7 @@ declare class Payment {
|
|
|
315
315
|
* @returns {Promise<PaymentApplicationModel.GetPaymentLinkResponse>} -
|
|
316
316
|
* Success response
|
|
317
317
|
* @name getPaymentLink
|
|
318
|
-
* @summary:
|
|
318
|
+
* @summary: Get payment link
|
|
319
319
|
* @description: Retrieves a generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentLink/).
|
|
320
320
|
*/
|
|
321
321
|
getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.GetPaymentLinkResponse>;
|
|
@@ -326,8 +326,8 @@ declare class Payment {
|
|
|
326
326
|
* @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
|
|
327
327
|
* Success response
|
|
328
328
|
* @name getPaymentModeRoutes
|
|
329
|
-
* @summary: Get payment modes
|
|
330
|
-
* @description:
|
|
329
|
+
* @summary: Get payment modes
|
|
330
|
+
* @description: Available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutes/).
|
|
331
331
|
*/
|
|
332
332
|
getPaymentModeRoutes({ amount, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentModeRouteResponse>;
|
|
333
333
|
/**
|
|
@@ -339,7 +339,7 @@ declare class Payment {
|
|
|
339
339
|
* @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
|
|
340
340
|
* Success response
|
|
341
341
|
* @name getPaymentModeRoutesPaymentLink
|
|
342
|
-
* @summary: Payment link
|
|
342
|
+
* @summary: Payment modes for payment link
|
|
343
343
|
* @description: Lists payment modes available for a given payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutesPaymentLink/).
|
|
344
344
|
*/
|
|
345
345
|
getPaymentModeRoutesPaymentLink({ paymentLinkId, requestHeaders }?: PaymentApplicationValidator.GetPaymentModeRoutesPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentModeRouteResponse>;
|
|
@@ -350,8 +350,8 @@ declare class Payment {
|
|
|
350
350
|
* @returns {Promise<PaymentApplicationModel.PaymentModeRouteResponse>} -
|
|
351
351
|
* Success response
|
|
352
352
|
* @name getPosPaymentModeRoutes
|
|
353
|
-
* @summary: POS payment modes
|
|
354
|
-
* @description:
|
|
353
|
+
* @summary: POS payment modes
|
|
354
|
+
* @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/application/payment/getPosPaymentModeRoutes/).
|
|
355
355
|
*/
|
|
356
356
|
getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, cardReference, userDetails, requestHeaders, }?: PaymentApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentModeRouteResponse>;
|
|
357
357
|
/**
|
|
@@ -360,8 +360,8 @@ declare class Payment {
|
|
|
360
360
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
361
361
|
* @returns {Promise<PaymentApplicationModel.RupifiBannerResponse>} - Success response
|
|
362
362
|
* @name getRupifiBannerDetails
|
|
363
|
-
* @summary: Rupifi banner info
|
|
364
|
-
* @description:
|
|
363
|
+
* @summary: Rupifi banner info
|
|
364
|
+
* @description: Retrieves details necessary for displaying the Rupifi payment banner. It provides information such as the KYC URL and the current status of the Rupifi payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getRupifiBannerDetails/).
|
|
365
365
|
*/
|
|
366
366
|
getRupifiBannerDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentApplicationModel.RupifiBannerResponse>;
|
|
367
367
|
/**
|
|
@@ -373,8 +373,8 @@ declare class Payment {
|
|
|
373
373
|
* @returns {Promise<PaymentApplicationModel.OrderBeneficiaryResponse>} -
|
|
374
374
|
* Success response
|
|
375
375
|
* @name getUserBeneficiariesDetail
|
|
376
|
-
* @summary:
|
|
377
|
-
* @description: Retrieves
|
|
376
|
+
* @summary: Retrieve beneficiary details
|
|
377
|
+
* @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getUserBeneficiariesDetail/).
|
|
378
378
|
*/
|
|
379
379
|
getUserBeneficiariesDetail({ orderId, requestHeaders }?: PaymentApplicationValidator.GetUserBeneficiariesDetailParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.OrderBeneficiaryResponse>;
|
|
380
380
|
/**
|
|
@@ -385,8 +385,8 @@ declare class Payment {
|
|
|
385
385
|
* - Success response
|
|
386
386
|
*
|
|
387
387
|
* @name initialisePayment
|
|
388
|
-
* @summary: Start payment process
|
|
389
|
-
* @description:
|
|
388
|
+
* @summary: Start payment process
|
|
389
|
+
* @description: Initiates the payment procedure for an order.Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePayment/).
|
|
390
390
|
*/
|
|
391
391
|
initialisePayment({ body, requestHeaders }?: PaymentApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentInitializationResponse>;
|
|
392
392
|
/**
|
|
@@ -399,8 +399,8 @@ declare class Payment {
|
|
|
399
399
|
* - Success response
|
|
400
400
|
*
|
|
401
401
|
* @name initialisePaymentPaymentLink
|
|
402
|
-
* @summary:
|
|
403
|
-
* @description:
|
|
402
|
+
* @summary: Initialize payment link
|
|
403
|
+
* @description: Begins the payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePaymentPaymentLink/).
|
|
404
404
|
*/
|
|
405
405
|
initialisePaymentPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.InitialisePaymentPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentInitializationResponse>;
|
|
406
406
|
/**
|
|
@@ -409,8 +409,8 @@ declare class Payment {
|
|
|
409
409
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
410
410
|
* @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
|
|
411
411
|
* @name linkWallet
|
|
412
|
-
* @summary: OTP verification
|
|
413
|
-
* @description:
|
|
412
|
+
* @summary: OTP verification
|
|
413
|
+
* @description: Verifies the linking of wallet using OTP for further processing of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/linkWallet/).
|
|
414
414
|
*/
|
|
415
415
|
linkWallet({ body, requestHeaders }?: PaymentApplicationValidator.LinkWalletParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletResponseSchema>;
|
|
416
416
|
/**
|
|
@@ -421,8 +421,8 @@ declare class Payment {
|
|
|
421
421
|
* - Success response
|
|
422
422
|
*
|
|
423
423
|
* @name outstandingOrderDetails
|
|
424
|
-
* @summary: Outstanding orders
|
|
425
|
-
* @description:
|
|
424
|
+
* @summary: Outstanding orders
|
|
425
|
+
* @description: Retrieve details of orders with outstanding payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/outstandingOrderDetails/).
|
|
426
426
|
*/
|
|
427
427
|
outstandingOrderDetails({ aggregator, requestHeaders }?: PaymentApplicationValidator.OutstandingOrderDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.OutstandingOrderDetailsResponse>;
|
|
428
428
|
/**
|
|
@@ -432,8 +432,8 @@ declare class Payment {
|
|
|
432
432
|
* @returns {Promise<PaymentApplicationModel.PaidOrderDetailsResponse>} -
|
|
433
433
|
* Success response
|
|
434
434
|
* @name paidOrderDetails
|
|
435
|
-
* @summary:
|
|
436
|
-
* @description: Retrieves details of orders that have been paid for. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
|
|
435
|
+
* @summary: Retrieve details of paid orders
|
|
436
|
+
* @description: Retrieves details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator's merchant user ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
|
|
437
437
|
*/
|
|
438
438
|
paidOrderDetails({ aggregator, requestHeaders }?: PaymentApplicationValidator.PaidOrderDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaidOrderDetailsResponse>;
|
|
439
439
|
/**
|
|
@@ -443,8 +443,8 @@ declare class Payment {
|
|
|
443
443
|
* @returns {Promise<PaymentApplicationModel.PollingPaymentLinkResponse>} -
|
|
444
444
|
* Success response
|
|
445
445
|
* @name pollingPaymentLink
|
|
446
|
-
* @summary: Poll payment link
|
|
447
|
-
* @description:
|
|
446
|
+
* @summary: Poll status of payment link
|
|
447
|
+
* @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/pollingPaymentLink/).
|
|
448
448
|
*/
|
|
449
449
|
pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PollingPaymentLinkResponse>;
|
|
450
450
|
/**
|
|
@@ -455,8 +455,8 @@ declare class Payment {
|
|
|
455
455
|
* - Success response
|
|
456
456
|
*
|
|
457
457
|
* @name redirectToAggregator
|
|
458
|
-
* @summary:
|
|
459
|
-
* @description: Redirects
|
|
458
|
+
* @summary: Redirects users to the payment aggregator's interface
|
|
459
|
+
* @description: Redirects users to the payment aggregator's interface and provides necessary parameters such as the callback URL and aggregator name. Returns the status of the payment along with the redirect URL and signup URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/redirectToAggregator/).
|
|
460
460
|
*/
|
|
461
461
|
redirectToAggregator({ source, aggregator, requestHeaders }?: PaymentApplicationValidator.RedirectToAggregatorParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.RedirectToAggregatorResponse>;
|
|
462
462
|
/**
|
|
@@ -465,8 +465,8 @@ declare class Payment {
|
|
|
465
465
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
466
466
|
* @returns {Promise<PaymentApplicationModel.renderHTMLResponse>} - Success response
|
|
467
467
|
* @name renderHTML
|
|
468
|
-
* @summary: Render HTML
|
|
469
|
-
* @description:
|
|
468
|
+
* @summary: Render HTML
|
|
469
|
+
* @description: Render HTML for a payment aggregator page - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/renderHTML/).
|
|
470
470
|
*/
|
|
471
471
|
renderHTML({ body, requestHeaders }?: PaymentApplicationValidator.RenderHTMLParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.renderHTMLResponse>;
|
|
472
472
|
/**
|
|
@@ -477,8 +477,8 @@ declare class Payment {
|
|
|
477
477
|
* - Success response
|
|
478
478
|
*
|
|
479
479
|
* @name resendOrCancelPayment
|
|
480
|
-
* @summary:
|
|
481
|
-
* @description:
|
|
480
|
+
* @summary: Resend or cancel a pending payment transaction
|
|
481
|
+
* @description: Enable you to perform actions related to the resending and cancellation of payment links through SMS or E-mail. Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendOrCancelPayment/).
|
|
482
482
|
*/
|
|
483
483
|
resendOrCancelPayment({ body, requestHeaders }?: PaymentApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ResendOrCancelPaymentResponse>;
|
|
484
484
|
/**
|
|
@@ -488,8 +488,8 @@ declare class Payment {
|
|
|
488
488
|
* @returns {Promise<PaymentApplicationModel.ResendPaymentLinkResponse>} -
|
|
489
489
|
* Success response
|
|
490
490
|
* @name resendPaymentLink
|
|
491
|
-
* @summary: Resend link
|
|
492
|
-
* @description: Resends an existing payment link to the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
|
|
491
|
+
* @summary: Resend payment link
|
|
492
|
+
* @description: Resends an existing payment link to the user to complete the payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
|
|
493
493
|
*/
|
|
494
494
|
resendPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ResendPaymentLinkResponse>;
|
|
495
495
|
/**
|
|
@@ -501,8 +501,8 @@ declare class Payment {
|
|
|
501
501
|
* - Success response
|
|
502
502
|
*
|
|
503
503
|
* @name updateDefaultBeneficiary
|
|
504
|
-
* @summary: Set default beneficiary
|
|
505
|
-
* @description: Updates the default beneficiary for the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
|
|
504
|
+
* @summary: Set default beneficiary for refund
|
|
505
|
+
* @description: Updates the default beneficiary for the order refund of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
|
|
506
506
|
*/
|
|
507
507
|
updateDefaultBeneficiary({ body, requestHeaders }?: PaymentApplicationValidator.UpdateDefaultBeneficiaryParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.SetDefaultBeneficiaryResponse>;
|
|
508
508
|
/**
|
|
@@ -511,8 +511,8 @@ declare class Payment {
|
|
|
511
511
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
512
512
|
* @returns {Promise<PaymentApplicationModel.ValidateVPAResponse>} - Success response
|
|
513
513
|
* @name validateVPA
|
|
514
|
-
* @summary: Validate VPA
|
|
515
|
-
* @description: Checks
|
|
514
|
+
* @summary: Validate VPA
|
|
515
|
+
* @description: Checks whether a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/validateVPA/).
|
|
516
516
|
*/
|
|
517
517
|
validateVPA({ body, requestHeaders }?: PaymentApplicationValidator.ValidateVPAParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ValidateVPAResponse>;
|
|
518
518
|
/**
|
|
@@ -522,8 +522,8 @@ declare class Payment {
|
|
|
522
522
|
* @returns {Promise<PaymentApplicationModel.ChargeCustomerResponse>} -
|
|
523
523
|
* Success response
|
|
524
524
|
* @name verifyAndChargePayment
|
|
525
|
-
* @summary: Verify and charge
|
|
526
|
-
* @description:
|
|
525
|
+
* @summary: Verify order confirmation and charge
|
|
526
|
+
* @description: Verify the payment status and charge from the customer's BNPL (Buy Now, Pay Later) account after order confirmation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyAndChargePayment/).
|
|
527
527
|
*/
|
|
528
528
|
verifyAndChargePayment({ body, requestHeaders }?: PaymentApplicationValidator.VerifyAndChargePaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ChargeCustomerResponse>;
|
|
529
529
|
/**
|
|
@@ -534,8 +534,8 @@ declare class Payment {
|
|
|
534
534
|
* @returns {Promise<PaymentApplicationModel.ValidateCustomerResponse>} -
|
|
535
535
|
* Success response
|
|
536
536
|
* @name verifyCustomerForPayment
|
|
537
|
-
* @summary: Verify payment customer
|
|
538
|
-
* @description:
|
|
537
|
+
* @summary: Verify payment customer
|
|
538
|
+
* @description: Verify whether the user is eligible for pay-later payment from the payment aggregator's side using the customer's phone number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyCustomerForPayment/).
|
|
539
539
|
*/
|
|
540
540
|
verifyCustomerForPayment({ body, requestHeaders }?: PaymentApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ValidateCustomerResponse>;
|
|
541
541
|
/**
|
|
@@ -544,8 +544,8 @@ declare class Payment {
|
|
|
544
544
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
545
545
|
* @returns {Promise<PaymentApplicationModel.IfscCodeResponse>} - Success response
|
|
546
546
|
* @name verifyIfscCode
|
|
547
|
-
* @summary: Verify IFSC
|
|
548
|
-
* @description: Checks the validity of
|
|
547
|
+
* @summary: Verify IFSC
|
|
548
|
+
* @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyIfscCode/).
|
|
549
549
|
*/
|
|
550
550
|
verifyIfscCode({ ifscCode, requestHeaders }?: PaymentApplicationValidator.VerifyIfscCodeParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.IfscCodeResponse>;
|
|
551
551
|
/**
|
|
@@ -558,8 +558,8 @@ declare class Payment {
|
|
|
558
558
|
* - Success response
|
|
559
559
|
*
|
|
560
560
|
* @name verifyOtpAndAddBeneficiaryForBank
|
|
561
|
-
* @summary: Verify OTP for bank
|
|
562
|
-
* @description:
|
|
561
|
+
* @summary: Verify OTP for bank and add beneficiary
|
|
562
|
+
* @description: This endpoint confirms the OTP provided by the user and adds a bank beneficiary for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
|
|
563
563
|
*/
|
|
564
564
|
verifyOtpAndAddBeneficiaryForBank({ body, requestHeaders }?: PaymentApplicationValidator.VerifyOtpAndAddBeneficiaryForBankParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.AddBeneficiaryViaOtpVerificationResponse>;
|
|
565
565
|
/**
|
|
@@ -570,20 +570,20 @@ declare class Payment {
|
|
|
570
570
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
571
571
|
* @returns {Promise<PaymentApplicationModel.WalletOtpResponse>} - Success response
|
|
572
572
|
* @name verifyOtpAndAddBeneficiaryForWallet
|
|
573
|
-
* @summary: Verify OTP for wallet
|
|
574
|
-
* @description:
|
|
573
|
+
* @summary: Verify OTP for wallet
|
|
574
|
+
* @description: Confirm OTP provided by the user and adds a wallet beneficiary - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
|
|
575
575
|
*/
|
|
576
576
|
verifyOtpAndAddBeneficiaryForWallet({ body, requestHeaders }?: PaymentApplicationValidator.VerifyOtpAndAddBeneficiaryForWalletParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletOtpResponse>;
|
|
577
577
|
/**
|
|
578
|
-
* @param {PaymentApplicationValidator.
|
|
578
|
+
* @param {PaymentApplicationValidator.WalletLinkInitiateParam} arg - Arg object.
|
|
579
579
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
580
580
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
581
581
|
* @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
|
|
582
|
-
* @name
|
|
582
|
+
* @name walletLinkInitiate
|
|
583
583
|
* @summary: Initiate linking of wallet
|
|
584
|
-
* @description:
|
|
584
|
+
* @description: Link wallet for the aggregator for processing of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/walletLinkInitiate/).
|
|
585
585
|
*/
|
|
586
|
-
|
|
586
|
+
walletLinkInitiate({ body, requestHeaders }?: PaymentApplicationValidator.WalletLinkInitiateParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletResponseSchema>;
|
|
587
587
|
}
|
|
588
|
-
import PaymentApplicationValidator = require("
|
|
589
|
-
import PaymentApplicationModel = require("
|
|
588
|
+
import PaymentApplicationValidator = require("sdk/output/javascript/code/sdk/application/Payment/PaymentApplicationValidator");
|
|
589
|
+
import PaymentApplicationModel = require("sdk/output/javascript/code/sdk/application/Payment/PaymentApplicationModel");
|