@gofynd/fdk-client-javascript 3.17.0 → 3.17.1

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.
Files changed (44) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
  4. package/sdk/application/Cart/CartApplicationClient.js +176 -0
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
  7. package/sdk/application/Content/ContentApplicationClient.d.ts +11 -1
  8. package/sdk/application/Content/ContentApplicationClient.js +40 -2
  9. package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -1
  10. package/sdk/application/Payment/PaymentApplicationClient.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +72 -10
  12. package/sdk/platform/Cart/CartPlatformApplicationClient.js +634 -33
  13. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
  14. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
  15. package/sdk/platform/Cart/CartPlatformModel.d.ts +951 -1
  16. package/sdk/platform/Cart/CartPlatformModel.js +597 -1
  17. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +123 -3
  18. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +829 -39
  19. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
  20. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
  21. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -5
  22. package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -5
  23. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1020 -29
  24. package/sdk/platform/Catalog/CatalogPlatformModel.js +836 -24
  25. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -0
  26. package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -0
  27. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
  28. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
  29. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
  30. package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
  31. package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
  32. package/sdk/platform/Order/OrderPlatformClient.js +1 -1
  33. package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -2
  34. package/sdk/platform/Order/OrderPlatformModel.js +9 -1
  35. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
  36. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
  37. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
  38. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
  39. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +356 -1
  40. package/sdk/platform/Payment/PaymentPlatformModel.js +229 -0
  41. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
  42. package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
  43. package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
  44. package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
@@ -866,8 +866,7 @@ class Payment {
866
866
  *
867
867
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
868
868
  * @param {import("../PlatformAPIClient").Options} - Options
869
- * @returns {Promise<PaymentPlatformModel.PlatformPaymentModeDetails>} -
870
- * Success response
869
+ * @returns {Promise<PaymentPlatformModel.PaymentModeConfig>} - Success response
871
870
  * @name getMerchantAggregatorPaymentModeDetails
872
871
  * @summary: Get merchant aggregator and their payment mode
873
872
  * @description: Get available payment gateways and payment mode and it's sub payment mode details like for razorpay their active/inactive payment modes netbanking , wallet, upi are shown. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantAggregatorPaymentModeDetails/).
@@ -931,10 +930,10 @@ class Payment {
931
930
 
932
931
  const {
933
932
  error: res_error,
934
- } = PaymentPlatformModel.PlatformPaymentModeDetails().validate(
935
- responseData,
936
- { abortEarly: false, allowUnknown: true }
937
- );
933
+ } = PaymentPlatformModel.PaymentModeConfig().validate(responseData, {
934
+ abortEarly: false,
935
+ allowUnknown: true,
936
+ });
938
937
 
939
938
  if (res_error) {
940
939
  if (this.config.options.strictResponseCheck === true) {
@@ -2979,6 +2978,89 @@ class Payment {
2979
2978
  return response;
2980
2979
  }
2981
2980
 
2981
+ /**
2982
+ * @param {PaymentPlatformApplicationValidator.SaveTokenForAggregatorParam} arg
2983
+ * - Arg object
2984
+ *
2985
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
2986
+ * @param {import("../PlatformAPIClient").Options} - Options
2987
+ * @returns {Promise<PaymentPlatformModel.OperationResponseSchema>} - Success response
2988
+ * @name saveTokenForAggregator
2989
+ * @summary: Save token details for a payment aggregator
2990
+ * @description: Save token and verification status for a specific payment aggregator, such as Apple Pay or others. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/saveTokenForAggregator/).
2991
+ */
2992
+ async saveTokenForAggregator(
2993
+ { aggregatorId, body, requestHeaders } = { requestHeaders: {} },
2994
+ { responseHeaders } = { responseHeaders: false }
2995
+ ) {
2996
+ const {
2997
+ error,
2998
+ } = PaymentPlatformApplicationValidator.saveTokenForAggregator().validate(
2999
+ {
3000
+ aggregatorId,
3001
+ body,
3002
+ },
3003
+ { abortEarly: false, allowUnknown: true }
3004
+ );
3005
+ if (error) {
3006
+ return Promise.reject(new FDKClientValidationError(error));
3007
+ }
3008
+
3009
+ // Showing warrnings if extra unknown parameters are found
3010
+ const {
3011
+ error: warrning,
3012
+ } = PaymentPlatformApplicationValidator.saveTokenForAggregator().validate(
3013
+ {
3014
+ aggregatorId,
3015
+ body,
3016
+ },
3017
+ { abortEarly: false, allowUnknown: false }
3018
+ );
3019
+ if (warrning) {
3020
+ Logger({
3021
+ level: "WARN",
3022
+ message: `Parameter Validation warrnings for platform > Payment > saveTokenForAggregator \n ${warrning}`,
3023
+ });
3024
+ }
3025
+
3026
+ const query_params = {};
3027
+
3028
+ const response = await PlatformAPIClient.execute(
3029
+ this.config,
3030
+ "post",
3031
+ `/service/platform/payment/v1.0/company/${this.config.companyId}/application/${this.applicationId}/aggregators/${aggregatorId}/token`,
3032
+ query_params,
3033
+ body,
3034
+ requestHeaders,
3035
+ { responseHeaders }
3036
+ );
3037
+
3038
+ let responseData = response;
3039
+ if (responseHeaders) {
3040
+ responseData = response[0];
3041
+ }
3042
+
3043
+ const {
3044
+ error: res_error,
3045
+ } = PaymentPlatformModel.OperationResponseSchema().validate(responseData, {
3046
+ abortEarly: false,
3047
+ allowUnknown: true,
3048
+ });
3049
+
3050
+ if (res_error) {
3051
+ if (this.config.options.strictResponseCheck === true) {
3052
+ return Promise.reject(new FDKResponseValidationError(res_error));
3053
+ } else {
3054
+ Logger({
3055
+ level: "WARN",
3056
+ message: `Response Validation Warnings for platform > Payment > saveTokenForAggregator \n ${res_error}`,
3057
+ });
3058
+ }
3059
+ }
3060
+
3061
+ return response;
3062
+ }
3063
+
2982
3064
  /**
2983
3065
  * @param {PaymentPlatformApplicationValidator.SetMerchantModeControlRoutesParam} arg
2984
3066
  * - Arg object
@@ -141,7 +141,7 @@ export = PaymentPlatformApplicationValidator;
141
141
  /**
142
142
  * @typedef PatchMerchantAggregatorPaymentModeDetailsParam
143
143
  * @property {number} aggregatorId - Aggregators Id
144
- * @property {PaymentPlatformModel.PlatformPaymentModeDetails} body
144
+ * @property {PaymentPlatformModel.PlatformConfigPaymentModeDetails} body
145
145
  */
146
146
  /**
147
147
  * @typedef PatchMerchantPaymentOptionParam
@@ -176,6 +176,17 @@ export = PaymentPlatformApplicationValidator;
176
176
  * @typedef SaveBrandPaymentGatewayConfigParam
177
177
  * @property {PaymentPlatformModel.PaymentGatewayConfigCreation} body
178
178
  */
179
+ /**
180
+ * @typedef SaveTokenForAggregatorParam
181
+ * @property {string} aggregatorId - Payment aggregator identifier. Supported values are:
182
+ *
183
+ * - **1**: Razorpay
184
+ * - **2**: Juspay
185
+ * - **3**: Checkout Extension
186
+ * - **4**: PayU India Extension
187
+ *
188
+ * @property {PaymentPlatformModel.AggregatorToken} body
189
+ */
179
190
  /**
180
191
  * @typedef SetMerchantModeControlRoutesParam
181
192
  * @property {string} mode - Offline / advance payment mode
@@ -290,6 +301,8 @@ declare class PaymentPlatformApplicationValidator {
290
301
  static revokeOauthToken(): RevokeOauthTokenParam;
291
302
  /** @returns {SaveBrandPaymentGatewayConfigParam} */
292
303
  static saveBrandPaymentGatewayConfig(): SaveBrandPaymentGatewayConfigParam;
304
+ /** @returns {SaveTokenForAggregatorParam} */
305
+ static saveTokenForAggregator(): SaveTokenForAggregatorParam;
293
306
  /** @returns {SetMerchantModeControlRoutesParam} */
294
307
  static setMerchantModeControlRoutes(): SetMerchantModeControlRoutesParam;
295
308
  /** @returns {SetPaymentModeCustomConfigParam} */
@@ -308,7 +321,7 @@ declare class PaymentPlatformApplicationValidator {
308
321
  static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
309
322
  }
310
323
  declare namespace PaymentPlatformApplicationValidator {
311
- 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, SetMerchantModeControlRoutesParam, SetPaymentModeCustomConfigParam, SetUserCODlimitRoutesParam, UpdateMerchantRefundPriorityParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, ValidateCustomerAndCreditSummaryParam, VerifyCustomerForPaymentParam };
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 };
312
325
  }
313
326
  type AddRefundBankAccountUsingOTPParam = {
314
327
  body: PaymentPlatformModel.AddBeneficiaryDetailsOTPCreation;
@@ -506,7 +519,7 @@ type PatchMerchantAggregatorPaymentModeDetailsParam = {
506
519
  * - Aggregators Id
507
520
  */
508
521
  aggregatorId: number;
509
- body: PaymentPlatformModel.PlatformPaymentModeDetails;
522
+ body: PaymentPlatformModel.PlatformConfigPaymentModeDetails;
510
523
  };
511
524
  type PatchMerchantPaymentOptionParam = {
512
525
  body: PaymentPlatformModel.MerchnatPaymentModeCreation;
@@ -539,6 +552,18 @@ type RevokeOauthTokenParam = {
539
552
  type SaveBrandPaymentGatewayConfigParam = {
540
553
  body: PaymentPlatformModel.PaymentGatewayConfigCreation;
541
554
  };
555
+ type SaveTokenForAggregatorParam = {
556
+ /**
557
+ * - Payment aggregator identifier. Supported values are:
558
+ *
559
+ * - **1**: Razorpay
560
+ * - **2**: Juspay
561
+ * - **3**: Checkout Extension
562
+ * - **4**: PayU India Extension
563
+ */
564
+ aggregatorId: string;
565
+ body: PaymentPlatformModel.AggregatorToken;
566
+ };
542
567
  type SetMerchantModeControlRoutesParam = {
543
568
  /**
544
569
  * - Offline / advance payment mode
@@ -170,7 +170,7 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
170
170
  /**
171
171
  * @typedef PatchMerchantAggregatorPaymentModeDetailsParam
172
172
  * @property {number} aggregatorId - Aggregators Id
173
- * @property {PaymentPlatformModel.PlatformPaymentModeDetails} body
173
+ * @property {PaymentPlatformModel.PlatformConfigPaymentModeDetails} body
174
174
  */
175
175
 
176
176
  /**
@@ -214,6 +214,18 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
214
214
  * @property {PaymentPlatformModel.PaymentGatewayConfigCreation} body
215
215
  */
216
216
 
217
+ /**
218
+ * @typedef SaveTokenForAggregatorParam
219
+ * @property {string} aggregatorId - Payment aggregator identifier. Supported values are:
220
+ *
221
+ * - **1**: Razorpay
222
+ * - **2**: Juspay
223
+ * - **3**: Checkout Extension
224
+ * - **4**: PayU India Extension
225
+ *
226
+ * @property {PaymentPlatformModel.AggregatorToken} body
227
+ */
228
+
217
229
  /**
218
230
  * @typedef SetMerchantModeControlRoutesParam
219
231
  * @property {string} mode - Offline / advance payment mode
@@ -477,7 +489,7 @@ class PaymentPlatformApplicationValidator {
477
489
  static patchMerchantAggregatorPaymentModeDetails() {
478
490
  return Joi.object({
479
491
  aggregatorId: Joi.number().required(),
480
- body: PaymentPlatformModel.PlatformPaymentModeDetails().required(),
492
+ body: PaymentPlatformModel.PlatformConfigPaymentModeDetails().required(),
481
493
  }).required();
482
494
  }
483
495
 
@@ -538,6 +550,14 @@ class PaymentPlatformApplicationValidator {
538
550
  }).required();
539
551
  }
540
552
 
553
+ /** @returns {SaveTokenForAggregatorParam} */
554
+ static saveTokenForAggregator() {
555
+ return Joi.object({
556
+ aggregatorId: Joi.string().allow("").required(),
557
+ body: PaymentPlatformModel.AggregatorToken().required(),
558
+ }).required();
559
+ }
560
+
541
561
  /** @returns {SetMerchantModeControlRoutesParam} */
542
562
  static setMerchantModeControlRoutes() {
543
563
  return Joi.object({
@@ -1,4 +1,19 @@
1
1
  export = PaymentPlatformModel;
2
+ /**
3
+ * @typedef AggregatorToken
4
+ * @property {number} payment_mode_id - Payment mode identifier Supported values are:
5
+ *
6
+ * - **4**: Wallet
7
+ * - **3**: Net Banking
8
+ * - **2**: Card
9
+ * - **1**: Pay Later
10
+ *
11
+ * @property {string} sub_payment_mode_code - Sub-payment method code
12
+ * @property {string} token - Token value to be saved for the aggregator
13
+ * @property {string} status - Status of the token verification
14
+ * @property {boolean} is_active - Enable or Disable Flag
15
+ * @property {string} domain - Name of domain
16
+ */
2
17
  /**
3
18
  * @typedef PaymentGatewayConfigDetails
4
19
  * @property {Object[]} [aggregators] - List of all config specific to the
@@ -734,6 +749,92 @@ export = PaymentPlatformModel;
734
749
  * @property {Object[]} [items] - List of all aggregator and payment mode details.
735
750
  * @property {boolean} success - Response is successful or not.
736
751
  */
752
+ /**
753
+ * @typedef PaymentModeConfig
754
+ * @property {string} [business_unit] - Business unit for which the configuration applies.
755
+ * @property {string} [device] - Device type for which the configuration applies.
756
+ * @property {boolean} [is_active] - Indicates if the payment configuration is
757
+ * currently active.
758
+ * @property {PaymentModeItems[]} [items] - List of payment modes available for
759
+ * the given business unit and device. This list is dynamic and can contain
760
+ * one or more payment modes.
761
+ */
762
+ /**
763
+ * @typedef PaymentModeItems
764
+ * @property {number} [id] - Unique identifier for the payment mode.
765
+ * @property {string} [name] - Display name of the payment mode.
766
+ * @property {string} [short_code] - Short code for the payment mode.
767
+ * @property {LogoSet} [logos]
768
+ * @property {boolean} [is_active] - Indicates if this payment mode is active in
769
+ * the system.
770
+ * @property {SubPaymentMode[]} [sub_payment_mode] - Dynamic list of sub-payment
771
+ * modes under this payment mode.
772
+ * @property {boolean} [is_active_at_pg] - Indicates if this payment mode is
773
+ * active at the payment gateway (PG) side.
774
+ * @property {Object} [fulfillment_options] - Fulfillment options applicable for
775
+ * these payment modes. Keys are option slugs and values indicate whether the
776
+ * option is enabled.
777
+ */
778
+ /**
779
+ * @typedef SubPaymentMode
780
+ * @property {string} [code] - Unique code of the sub-payment mode.
781
+ * @property {boolean} [is_active] - Indicates if this sub-payment mode is
782
+ * active in the system.
783
+ * @property {number} [priority] - Priority used for ordering in UI. Lower
784
+ * numbers can represent higher priority, depending on implementation.
785
+ * @property {LogoSet} [logos]
786
+ * @property {string} [name] - Human-readable name of the sub-payment mode.
787
+ * @property {boolean} [is_active_at_pg] - Indicates if this sub-payment mode is
788
+ * active at the payment gateway (PG) side.
789
+ */
790
+ /**
791
+ * @typedef LogoSet
792
+ * @property {string} [large] - URL of the large-sized logo.
793
+ * @property {string} [small] - URL of the small-sized logo.
794
+ */
795
+ /**
796
+ * @typedef PlatformLogoSet
797
+ * @property {string} [large] - URL of the large-sized logo.
798
+ * @property {string} [small] - URL of the small-sized logo.
799
+ */
800
+ /**
801
+ * @typedef PlatformConfigPaymentModeDetails
802
+ * @property {string} [business_unit] - Business unit for which the
803
+ * configuration applies (e.g. "storefront", "pos").
804
+ * @property {string} [device] - Device or channel for which the configuration
805
+ * applies (e.g. "desktop", "android", "ios").
806
+ * @property {Object} [fulfillment_options] - Fulfillment options applicable for
807
+ * these payment modes. Keys are option slugs (e.g. "self-pickup", "delivery")
808
+ * and values indicate whether the option is enabled.
809
+ * @property {boolean} [is_active] - Overall active status for this aggregator
810
+ * payment configuration for the given application and device.
811
+ * @property {PlatformPaymentModeItem[]} [items] - List of payment modes and
812
+ * their configuration.
813
+ */
814
+ /**
815
+ * @typedef PlatformPaymentModeItem
816
+ * @property {number} [id] - Unique identifier of the payment mode.
817
+ * @property {string} [name] - Human readable name of the payment mode.
818
+ * @property {string} [short_code] - Short code representing the payment mode.
819
+ * @property {PlatformLogoSet} [logos]
820
+ * @property {boolean} [is_active] - Indicates if the payment mode is enabled on
821
+ * the platform.
822
+ * @property {boolean} [is_active_at_pg] - Indicates if the payment mode is
823
+ * active at the payment gateway.
824
+ * @property {PlatformSubPaymentMode[]} [sub_payment_mode] - List of sub payment
825
+ * modes (e.g. card networks like VISA, MASTERCARD).
826
+ */
827
+ /**
828
+ * @typedef PlatformSubPaymentMode
829
+ * @property {string} [code] - Code of the sub payment mode (e.g. "VISA", "AMEX").
830
+ * @property {string} [name] - Human readable name of the sub payment mode.
831
+ * @property {boolean} [is_active] - Indicates if the sub payment mode is enabled.
832
+ * @property {boolean} [is_active_at_pg] - Indicates if the sub payment mode is
833
+ * active at payment gateway.
834
+ * @property {number} [priority] - Display priority for the sub payment mode.
835
+ * Lower numbers indicate higher priority.
836
+ * @property {PlatformLogoSet} [logos]
837
+ */
737
838
  /**
738
839
  * @typedef MerchnatPaymentModeCreation
739
840
  * @property {Object} [offline] - Details to be updated for online payment configuration.
@@ -1159,11 +1260,50 @@ export = PaymentPlatformModel;
1159
1260
  * @property {string} [cart_id] - Unique identifier for the shopping cart.
1160
1261
  * @property {CreditAccountSummary} [account]
1161
1262
  */
1263
+ /**
1264
+ * @typedef OperationResponseSchema
1265
+ * @property {boolean} success - Indicates if the operation was successful
1266
+ * @property {string} [message] - Optional message providing additional
1267
+ * information about the operation
1268
+ */
1162
1269
  declare class PaymentPlatformModel {
1163
1270
  }
1164
1271
  declare namespace PaymentPlatformModel {
1165
- export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, 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, 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 };
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 };
1166
1273
  }
1274
+ /** @returns {AggregatorToken} */
1275
+ declare function AggregatorToken(): AggregatorToken;
1276
+ type AggregatorToken = {
1277
+ /**
1278
+ * - Payment mode identifier Supported values are:
1279
+ *
1280
+ * - **4**: Wallet
1281
+ * - **3**: Net Banking
1282
+ * - **2**: Card
1283
+ * - **1**: Pay Later
1284
+ */
1285
+ payment_mode_id: number;
1286
+ /**
1287
+ * - Sub-payment method code
1288
+ */
1289
+ sub_payment_mode_code: string;
1290
+ /**
1291
+ * - Token value to be saved for the aggregator
1292
+ */
1293
+ token: string;
1294
+ /**
1295
+ * - Status of the token verification
1296
+ */
1297
+ status: string;
1298
+ /**
1299
+ * - Enable or Disable Flag
1300
+ */
1301
+ is_active: boolean;
1302
+ /**
1303
+ * - Name of domain
1304
+ */
1305
+ domain: string;
1306
+ };
1167
1307
  /** @returns {PaymentGatewayConfigDetails} */
1168
1308
  declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
1169
1309
  type PaymentGatewayConfigDetails = {
@@ -3110,6 +3250,208 @@ type PlatformPaymentModeDetails = {
3110
3250
  */
3111
3251
  success: boolean;
3112
3252
  };
3253
+ /** @returns {PaymentModeConfig} */
3254
+ declare function PaymentModeConfig(): PaymentModeConfig;
3255
+ type PaymentModeConfig = {
3256
+ /**
3257
+ * - Business unit for which the configuration applies.
3258
+ */
3259
+ business_unit?: string;
3260
+ /**
3261
+ * - Device type for which the configuration applies.
3262
+ */
3263
+ device?: string;
3264
+ /**
3265
+ * - Indicates if the payment configuration is
3266
+ * currently active.
3267
+ */
3268
+ is_active?: boolean;
3269
+ /**
3270
+ * - List of payment modes available for
3271
+ * the given business unit and device. This list is dynamic and can contain
3272
+ * one or more payment modes.
3273
+ */
3274
+ items?: PaymentModeItems[];
3275
+ };
3276
+ /** @returns {PaymentModeItems} */
3277
+ declare function PaymentModeItems(): PaymentModeItems;
3278
+ type PaymentModeItems = {
3279
+ /**
3280
+ * - Unique identifier for the payment mode.
3281
+ */
3282
+ id?: number;
3283
+ /**
3284
+ * - Display name of the payment mode.
3285
+ */
3286
+ name?: string;
3287
+ /**
3288
+ * - Short code for the payment mode.
3289
+ */
3290
+ short_code?: string;
3291
+ logos?: LogoSet;
3292
+ /**
3293
+ * - Indicates if this payment mode is active in
3294
+ * the system.
3295
+ */
3296
+ is_active?: boolean;
3297
+ /**
3298
+ * - Dynamic list of sub-payment
3299
+ * modes under this payment mode.
3300
+ */
3301
+ sub_payment_mode?: SubPaymentMode[];
3302
+ /**
3303
+ * - Indicates if this payment mode is
3304
+ * active at the payment gateway (PG) side.
3305
+ */
3306
+ is_active_at_pg?: boolean;
3307
+ /**
3308
+ * - Fulfillment options applicable for
3309
+ * these payment modes. Keys are option slugs and values indicate whether the
3310
+ * option is enabled.
3311
+ */
3312
+ fulfillment_options?: any;
3313
+ };
3314
+ /** @returns {SubPaymentMode} */
3315
+ declare function SubPaymentMode(): SubPaymentMode;
3316
+ type SubPaymentMode = {
3317
+ /**
3318
+ * - Unique code of the sub-payment mode.
3319
+ */
3320
+ code?: string;
3321
+ /**
3322
+ * - Indicates if this sub-payment mode is
3323
+ * active in the system.
3324
+ */
3325
+ is_active?: boolean;
3326
+ /**
3327
+ * - Priority used for ordering in UI. Lower
3328
+ * numbers can represent higher priority, depending on implementation.
3329
+ */
3330
+ priority?: number;
3331
+ logos?: LogoSet;
3332
+ /**
3333
+ * - Human-readable name of the sub-payment mode.
3334
+ */
3335
+ name?: string;
3336
+ /**
3337
+ * - Indicates if this sub-payment mode is
3338
+ * active at the payment gateway (PG) side.
3339
+ */
3340
+ is_active_at_pg?: boolean;
3341
+ };
3342
+ /** @returns {LogoSet} */
3343
+ declare function LogoSet(): LogoSet;
3344
+ type LogoSet = {
3345
+ /**
3346
+ * - URL of the large-sized logo.
3347
+ */
3348
+ large?: string;
3349
+ /**
3350
+ * - URL of the small-sized logo.
3351
+ */
3352
+ small?: string;
3353
+ };
3354
+ /** @returns {PlatformLogoSet} */
3355
+ declare function PlatformLogoSet(): PlatformLogoSet;
3356
+ type PlatformLogoSet = {
3357
+ /**
3358
+ * - URL of the large-sized logo.
3359
+ */
3360
+ large?: string;
3361
+ /**
3362
+ * - URL of the small-sized logo.
3363
+ */
3364
+ small?: string;
3365
+ };
3366
+ /** @returns {PlatformConfigPaymentModeDetails} */
3367
+ declare function PlatformConfigPaymentModeDetails(): PlatformConfigPaymentModeDetails;
3368
+ type PlatformConfigPaymentModeDetails = {
3369
+ /**
3370
+ * - Business unit for which the
3371
+ * configuration applies (e.g. "storefront", "pos").
3372
+ */
3373
+ business_unit?: string;
3374
+ /**
3375
+ * - Device or channel for which the configuration
3376
+ * applies (e.g. "desktop", "android", "ios").
3377
+ */
3378
+ device?: string;
3379
+ /**
3380
+ * - Fulfillment options applicable for
3381
+ * these payment modes. Keys are option slugs (e.g. "self-pickup", "delivery")
3382
+ * and values indicate whether the option is enabled.
3383
+ */
3384
+ fulfillment_options?: any;
3385
+ /**
3386
+ * - Overall active status for this aggregator
3387
+ * payment configuration for the given application and device.
3388
+ */
3389
+ is_active?: boolean;
3390
+ /**
3391
+ * - List of payment modes and
3392
+ * their configuration.
3393
+ */
3394
+ items?: PlatformPaymentModeItem[];
3395
+ };
3396
+ /** @returns {PlatformPaymentModeItem} */
3397
+ declare function PlatformPaymentModeItem(): PlatformPaymentModeItem;
3398
+ type PlatformPaymentModeItem = {
3399
+ /**
3400
+ * - Unique identifier of the payment mode.
3401
+ */
3402
+ id?: number;
3403
+ /**
3404
+ * - Human readable name of the payment mode.
3405
+ */
3406
+ name?: string;
3407
+ /**
3408
+ * - Short code representing the payment mode.
3409
+ */
3410
+ short_code?: string;
3411
+ logos?: PlatformLogoSet;
3412
+ /**
3413
+ * - Indicates if the payment mode is enabled on
3414
+ * the platform.
3415
+ */
3416
+ is_active?: boolean;
3417
+ /**
3418
+ * - Indicates if the payment mode is
3419
+ * active at the payment gateway.
3420
+ */
3421
+ is_active_at_pg?: boolean;
3422
+ /**
3423
+ * - List of sub payment
3424
+ * modes (e.g. card networks like VISA, MASTERCARD).
3425
+ */
3426
+ sub_payment_mode?: PlatformSubPaymentMode[];
3427
+ };
3428
+ /** @returns {PlatformSubPaymentMode} */
3429
+ declare function PlatformSubPaymentMode(): PlatformSubPaymentMode;
3430
+ type PlatformSubPaymentMode = {
3431
+ /**
3432
+ * - Code of the sub payment mode (e.g. "VISA", "AMEX").
3433
+ */
3434
+ code?: string;
3435
+ /**
3436
+ * - Human readable name of the sub payment mode.
3437
+ */
3438
+ name?: string;
3439
+ /**
3440
+ * - Indicates if the sub payment mode is enabled.
3441
+ */
3442
+ is_active?: boolean;
3443
+ /**
3444
+ * - Indicates if the sub payment mode is
3445
+ * active at payment gateway.
3446
+ */
3447
+ is_active_at_pg?: boolean;
3448
+ /**
3449
+ * - Display priority for the sub payment mode.
3450
+ * Lower numbers indicate higher priority.
3451
+ */
3452
+ priority?: number;
3453
+ logos?: PlatformLogoSet;
3454
+ };
3113
3455
  /** @returns {MerchnatPaymentModeCreation} */
3114
3456
  declare function MerchnatPaymentModeCreation(): MerchnatPaymentModeCreation;
3115
3457
  type MerchnatPaymentModeCreation = {
@@ -4221,3 +4563,16 @@ type ValidateCustomerCreditSchema = {
4221
4563
  cart_id?: string;
4222
4564
  account?: CreditAccountSummary;
4223
4565
  };
4566
+ /** @returns {OperationResponseSchema} */
4567
+ declare function OperationResponseSchema(): OperationResponseSchema;
4568
+ type OperationResponseSchema = {
4569
+ /**
4570
+ * - Indicates if the operation was successful
4571
+ */
4572
+ success: boolean;
4573
+ /**
4574
+ * - Optional message providing additional
4575
+ * information about the operation
4576
+ */
4577
+ message?: string;
4578
+ };