@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts

@@ -2,36 +2,36 @@ export = PaymentPlatformApplicationValidator;
 /**
  * @typedef AddEdcDeviceParam
  * @property {string} terminalUniqueIdentifier - Terminal unique identifier
- * @property {PaymentPlatformModel.EdcUpdate} body
+ * @property {PaymentPlatformModel.EdcUpdateRequest} body
  */
 /**
  * @typedef AddRefundBankAccountUsingOTPParam
- * @property {PaymentPlatformModel.AddBeneficiaryDetailsOTPCreation} body
+ * @property {PaymentPlatformModel.AddBeneficiaryDetailsOTPRequest} body
  */
 /**
  * @typedef CancelPaymentLinkParam
- * @property {PaymentPlatformModel.CancelOrResendPaymentLinkCreation} body
+ * @property {PaymentPlatformModel.CancelOrResendPaymentLinkRequest} body
  */
 /**
  * @typedef CheckAndUpdatePaymentStatusParam
- * @property {PaymentPlatformModel.PaymentStatusUpdateCreation} body
+ * @property {PaymentPlatformModel.PaymentStatusUpdateRequest} body
  */
 /**
  * @typedef ConfirmPaymentParam
- * @property {PaymentPlatformModel.PaymentConfirmationCreation} body
+ * @property {PaymentPlatformModel.PaymentConfirmationRequest} body
  */
 /**
  * @typedef CreateMerchantRefundPriorityParam
  * @property {string} configType - Configuration for merchant or customer
- * @property {PaymentPlatformModel.RefundPriorityCreation} body
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
  */
 /**
  * @typedef CreatePaymentLinkParam
- * @property {PaymentPlatformModel.CreatePaymentLinkCreation} body
+ * @property {PaymentPlatformModel.CreatePaymentLinkRequest} body
  */
 /**
  * @typedef CreatePaymentOrderParam
- * @property {PaymentPlatformModel.PaymentOrderCreation} body
+ * @property {PaymentPlatformModel.PaymentOrderRequest} body
  */
 /** @typedef EdcAggregatorsAndModelListParam */
 /**
@@ -50,7 +50,7 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef GetBrandPaymentGatewayConfigParam
- * @property {string} [aggregator] - Aggregator slug
+ * @property {string} aggregator - Aggregator slug
  * @property {string} [configType]
  */
 /**
@@ -80,7 +80,7 @@ export = PaymentPlatformApplicationValidator;
 /** @typedef GetPaymentCodeOptionParam */
 /**
  * @typedef GetPaymentLinkParam
- * @property {string} [paymentLinkId]
+ * @property {string} paymentLinkId
  */
 /**
  * @typedef GetPaymentModeControlRoutesParam
@@ -92,18 +92,25 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef GetPaymentModeRoutesParam
- * @property {boolean} refresh
- * @property {string} requestType
- * @property {string} [orderId]
- * @property {string} [shipmentId]
+ * @property {boolean} [refresh] - Flag to refresh the cache and retrieve the
+ *   updated payment option
+ * @property {string} [requestType] - Type of payment request, i.e. self
+ * @property {string} [orderId] - Order id for the payment
+ * @property {string} [shipmentId] - Shipment id for the payment
+ * @property {number} [amount] - Amount for the payment
  */
 /**
  * @typedef GetPaymentSessionParam
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
  *   etc.) against which payment session was initiated. This is generated by
  *   Fynd payments platform and is unique.
- * @property {boolean} [lineItem] - Line-item to add extra data into response
- *   (e.g. cart details)
+ * @property {boolean} [lineItem] - A boolean flag to include detailed cart and
+ *   line item information in the response. When set to true, the response will
+ *   contain comprehensive details about the cart, including each line item's
+ *   product or service descriptions, quantities, unit prices, applicable taxes,
+ *   discounts, total cart value, and total quantity. This provides a clear
+ *   breakdown of charges to the customer, helping to understand the total
+ *   amount billed in a more granular way.
  */
 /**
  * @typedef GetPosPaymentModeRoutesParam
@@ -139,11 +146,11 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef InitialisePaymentParam
- * @property {PaymentPlatformModel.PaymentInitializationCreation} body
+ * @property {PaymentPlatformModel.PaymentInitializationRequest} body
  */
 /**
  * @typedef MerchantOnBoardingParam
- * @property {PaymentPlatformModel.MerchantOnBoardingCreation} body
+ * @property {PaymentPlatformModel.MerchantOnBoardingRequest} body
  */
 /**
  * @typedef OauthGetUrlParam
@@ -154,24 +161,24 @@ export = PaymentPlatformApplicationValidator;
 /**
  * @typedef PatchMerchantAggregatorPaymentModeDetailsParam
  * @property {number} aggregatorId - Aggregators Id
- * @property {PaymentPlatformModel.PlatformPaymentModeDetails} body
+ * @property {PaymentPlatformModel.PlatformPaymentModeResponse} body
  */
 /**
  * @typedef PatchMerchantPaymentOptionParam
- * @property {PaymentPlatformModel.MerchnatPaymentModeCreation} body
+ * @property {PaymentPlatformModel.MerchnatPaymentModeRequest} body
  */
 /**
  * @typedef PatchMerchantPaymentOptionVersionParam
  * @property {number} aggregatorId - Aggregators Id
- * @property {PaymentPlatformModel.PatchAggregatorControl} body
+ * @property {PaymentPlatformModel.AggregatorControlRequest} body
  */
 /**
  * @typedef PaymentStatusBulkParam
- * @property {PaymentPlatformModel.PaymentStatusBulkHandlerCreation} body
+ * @property {PaymentPlatformModel.PaymentStatusBulkHandlerRequest} body
  */
 /**
  * @typedef PollingPaymentLinkParam
- * @property {string} [paymentLinkId]
+ * @property {string} paymentLinkId
  */
 /**
  * @typedef RepaymentDetailsParam
@@ -179,11 +186,11 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef ResendOrCancelPaymentParam
- * @property {PaymentPlatformModel.ResendOrCancelPaymentCreation} body
+ * @property {PaymentPlatformModel.ResendOrCancelPaymentRequest} body
  */
 /**
  * @typedef ResendPaymentLinkParam
- * @property {PaymentPlatformModel.CancelOrResendPaymentLinkCreation} body
+ * @property {PaymentPlatformModel.CancelOrResendPaymentLinkRequest} body
  */
 /**
  * @typedef RevokeOauthTokenParam
@@ -191,12 +198,12 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef SaveBrandPaymentGatewayConfigParam
- * @property {PaymentPlatformModel.PaymentGatewayConfigCreation} body
+ * @property {PaymentPlatformModel.PaymentGatewayConfigRequest} body
  */
 /**
  * @typedef SetMerchantModeControlRoutesParam
  * @property {string} mode - Offline / advance payment mode
- * @property {PaymentPlatformModel.MerchantPaymentModeCreation} body
+ * @property {PaymentPlatformModel.MerchantPaymentModeRequest} body
  */
 /**
  * @typedef SetPaymentModeCustomConfigParam
@@ -205,23 +212,23 @@ export = PaymentPlatformApplicationValidator;
  */
 /**
  * @typedef SetUserCODlimitRoutesParam
- * @property {PaymentPlatformModel.SetCODForUserCreation} body
+ * @property {PaymentPlatformModel.SetCODForUserRequest} body
  */
 /**
  * @typedef UpdateEdcDeviceParam
- * @property {PaymentPlatformModel.EdcAddCreation} body
+ * @property {PaymentPlatformModel.EdcAddRequest} body
  */
 /**
  * @typedef UpdateMerchantRefundPriorityParam
  * @property {string} configType - Configuration for merchant or customer
- * @property {PaymentPlatformModel.RefundPriorityCreation} body
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
  */
 /**
  * @typedef UpdatePaymentSessionParam
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
  *   etc.) against which payment_session was initiated. This is generated by
  *   Fynd payments platform and is unique.
- * @property {PaymentPlatformModel.PaymentSessionCreation} body
+ * @property {PaymentPlatformModel.PaymentSessionRequestSerializer} body
  */
 /**
  * @typedef UpdateRefundSessionParam
@@ -230,11 +237,11 @@ export = PaymentPlatformApplicationValidator;
  *   Fynd payments platform and is unique.
  * @property {string} requestId - A unique id that was used to initiate a refund
  *   session. This is generated by Fynd platform and is usually shipment_id.
- * @property {PaymentPlatformModel.RefundSessionCreation} body
+ * @property {PaymentPlatformModel.RefundSessionRequestSerializer} body
  */
 /**
  * @typedef VerifyCustomerForPaymentParam
- * @property {PaymentPlatformModel.ValidateCustomerCreation} body
+ * @property {PaymentPlatformModel.ValidateCustomerRequest} body
  */
 declare class PaymentPlatformApplicationValidator {
     /** @returns {AddEdcDeviceParam} */
@@ -346,32 +353,32 @@ type AddEdcDeviceParam = {
      * - Terminal unique identifier
      */
     terminalUniqueIdentifier: string;
-    body: PaymentPlatformModel.EdcUpdate;
+    body: PaymentPlatformModel.EdcUpdateRequest;
 };
 type AddRefundBankAccountUsingOTPParam = {
-    body: PaymentPlatformModel.AddBeneficiaryDetailsOTPCreation;
+    body: PaymentPlatformModel.AddBeneficiaryDetailsOTPRequest;
 };
 type CancelPaymentLinkParam = {
-    body: PaymentPlatformModel.CancelOrResendPaymentLinkCreation;
+    body: PaymentPlatformModel.CancelOrResendPaymentLinkRequest;
 };
 type CheckAndUpdatePaymentStatusParam = {
-    body: PaymentPlatformModel.PaymentStatusUpdateCreation;
+    body: PaymentPlatformModel.PaymentStatusUpdateRequest;
 };
 type ConfirmPaymentParam = {
-    body: PaymentPlatformModel.PaymentConfirmationCreation;
+    body: PaymentPlatformModel.PaymentConfirmationRequest;
 };
 type CreateMerchantRefundPriorityParam = {
     /**
      * - Configuration for merchant or customer
      */
     configType: string;
-    body: PaymentPlatformModel.RefundPriorityCreation;
+    body: PaymentPlatformModel.RefundPriorityRequestSerializer;
 };
 type CreatePaymentLinkParam = {
-    body: PaymentPlatformModel.CreatePaymentLinkCreation;
+    body: PaymentPlatformModel.CreatePaymentLinkRequest;
 };
 type CreatePaymentOrderParam = {
-    body: PaymentPlatformModel.PaymentOrderCreation;
+    body: PaymentPlatformModel.PaymentOrderRequest;
 };
 type EdcDeviceListParam = {
     pageNo?: number;
@@ -388,7 +395,7 @@ type GetBrandPaymentGatewayConfigParam = {
     /**
      * - Aggregator slug
      */
-    aggregator?: string;
+    aggregator: string;
     configType?: string;
 };
 type GetEdcDeviceParam = {
@@ -422,7 +429,7 @@ type GetMerchantRefundPriorityParam = {
     configType: string;
 };
 type GetPaymentLinkParam = {
-    paymentLinkId?: string;
+    paymentLinkId: string;
 };
 type GetPaymentModeControlRoutesParam = {
     /**
@@ -437,10 +444,27 @@ type GetPaymentModeCustomConfigParam = {
     mode: string;
 };
 type GetPaymentModeRoutesParam = {
-    refresh: boolean;
-    requestType: string;
+    /**
+     * - Flag to refresh the cache and retrieve the
+     * updated payment option
+     */
+    refresh?: boolean;
+    /**
+     * - Type of payment request, i.e. self
+     */
+    requestType?: string;
+    /**
+     * - Order id for the payment
+     */
     orderId?: string;
+    /**
+     * - Shipment id for the payment
+     */
     shipmentId?: string;
+    /**
+     * - Amount for the payment
+     */
+    amount?: number;
 };
 type GetPaymentSessionParam = {
     /**
@@ -450,8 +474,13 @@ type GetPaymentSessionParam = {
      */
     gid: string;
     /**
-     * - Line-item to add extra data into response
-     * (e.g. cart details)
+     * - A boolean flag to include detailed cart and
+     * line item information in the response. When set to true, the response will
+     * contain comprehensive details about the cart, including each line item's
+     * product or service descriptions, quantities, unit prices, applicable taxes,
+     * discounts, total cart value, and total quantity. This provides a clear
+     * breakdown of charges to the customer, helping to understand the total
+     * amount billed in a more granular way.
      */
     lineItem?: boolean;
 };
@@ -514,10 +543,10 @@ type GetUserOrderBeneficiariesParam = {
     orderId: string;
 };
 type InitialisePaymentParam = {
-    body: PaymentPlatformModel.PaymentInitializationCreation;
+    body: PaymentPlatformModel.PaymentInitializationRequest;
 };
 type MerchantOnBoardingParam = {
-    body: PaymentPlatformModel.MerchantOnBoardingCreation;
+    body: PaymentPlatformModel.MerchantOnBoardingRequest;
 };
 type OauthGetUrlParam = {
     /**
@@ -532,32 +561,32 @@ type PatchMerchantAggregatorPaymentModeDetailsParam = {
      * - Aggregators Id
      */
     aggregatorId: number;
-    body: PaymentPlatformModel.PlatformPaymentModeDetails;
+    body: PaymentPlatformModel.PlatformPaymentModeResponse;
 };
 type PatchMerchantPaymentOptionParam = {
-    body: PaymentPlatformModel.MerchnatPaymentModeCreation;
+    body: PaymentPlatformModel.MerchnatPaymentModeRequest;
 };
 type PatchMerchantPaymentOptionVersionParam = {
     /**
      * - Aggregators Id
      */
     aggregatorId: number;
-    body: PaymentPlatformModel.PatchAggregatorControl;
+    body: PaymentPlatformModel.AggregatorControlRequest;
 };
 type PaymentStatusBulkParam = {
-    body: PaymentPlatformModel.PaymentStatusBulkHandlerCreation;
+    body: PaymentPlatformModel.PaymentStatusBulkHandlerRequest;
 };
 type PollingPaymentLinkParam = {
-    paymentLinkId?: string;
+    paymentLinkId: string;
 };
 type RepaymentDetailsParam = {
     body: PaymentPlatformModel.RepaymentDetailsSerialiserPayAll;
 };
 type ResendOrCancelPaymentParam = {
-    body: PaymentPlatformModel.ResendOrCancelPaymentCreation;
+    body: PaymentPlatformModel.ResendOrCancelPaymentRequest;
 };
 type ResendPaymentLinkParam = {
-    body: PaymentPlatformModel.CancelOrResendPaymentLinkCreation;
+    body: PaymentPlatformModel.CancelOrResendPaymentLinkRequest;
 };
 type RevokeOauthTokenParam = {
     /**
@@ -566,14 +595,14 @@ type RevokeOauthTokenParam = {
     aggregator: string;
 };
 type SaveBrandPaymentGatewayConfigParam = {
-    body: PaymentPlatformModel.PaymentGatewayConfigCreation;
+    body: PaymentPlatformModel.PaymentGatewayConfigRequest;
 };
 type SetMerchantModeControlRoutesParam = {
     /**
      * - Offline / advance payment mode
      */
     mode: string;
-    body: PaymentPlatformModel.MerchantPaymentModeCreation;
+    body: PaymentPlatformModel.MerchantPaymentModeRequest;
 };
 type SetPaymentModeCustomConfigParam = {
     /**
@@ -583,17 +612,17 @@ type SetPaymentModeCustomConfigParam = {
     body: PaymentPlatformModel.PaymentCustomConfigRequestSchema;
 };
 type SetUserCODlimitRoutesParam = {
-    body: PaymentPlatformModel.SetCODForUserCreation;
+    body: PaymentPlatformModel.SetCODForUserRequest;
 };
 type UpdateEdcDeviceParam = {
-    body: PaymentPlatformModel.EdcAddCreation;
+    body: PaymentPlatformModel.EdcAddRequest;
 };
 type UpdateMerchantRefundPriorityParam = {
     /**
      * - Configuration for merchant or customer
      */
     configType: string;
-    body: PaymentPlatformModel.RefundPriorityCreation;
+    body: PaymentPlatformModel.RefundPriorityRequestSerializer;
 };
 type UpdatePaymentSessionParam = {
     /**
@@ -602,7 +631,7 @@ type UpdatePaymentSessionParam = {
      * Fynd payments platform and is unique.
      */
     gid: string;
-    body: PaymentPlatformModel.PaymentSessionCreation;
+    body: PaymentPlatformModel.PaymentSessionRequestSerializer;
 };
 type UpdateRefundSessionParam = {
     /**
@@ -616,10 +645,10 @@ type UpdateRefundSessionParam = {
      * session. This is generated by Fynd platform and is usually shipment_id.
      */
     requestId: string;
-    body: PaymentPlatformModel.RefundSessionCreation;
+    body: PaymentPlatformModel.RefundSessionRequestSerializer;
 };
 type VerifyCustomerForPaymentParam = {
-    body: PaymentPlatformModel.ValidateCustomerCreation;
+    body: PaymentPlatformModel.ValidateCustomerRequest;
 };
 type EdcAggregatorsAndModelListParam = any;
 type EdcDeviceStatsParam = any;