@gofynd/fdk-client-javascript 1.3.4-beta.1 → 1.3.4

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

@@ -20,6 +20,11 @@ export = PaymentPlatformApplicationValidator;
  * @typedef ConfirmPaymentParam
  * @property {PaymentPlatformModel.PaymentConfirmationRequest} body
  */
+/**
+ * @typedef CreateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
 /**
  * @typedef CreatePaymentLinkParam
  * @property {PaymentPlatformModel.CreatePaymentLinkRequest} body
@@ -55,6 +60,10 @@ export = PaymentPlatformApplicationValidator;
  * @property {string} device
  */
 /** @typedef GetMerchantPaymentOptionParam */
+/**
+ * @typedef GetMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ */
 /** @typedef GetPGConfigAggregatorsParam */
 /** @typedef GetPaymentCodeOptionParam */
 /**
@@ -153,6 +162,11 @@ export = PaymentPlatformApplicationValidator;
  * @typedef UpdateEdcDeviceParam
  * @property {PaymentPlatformModel.EdcAddRequest} body
  */
+/**
+ * @typedef UpdateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
 /**
  * @typedef UpdatePaymentSessionParam
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
@@ -184,6 +198,8 @@ declare class PaymentPlatformApplicationValidator {
     static checkAndUpdatePaymentStatus(): CheckAndUpdatePaymentStatusParam;
     /** @returns {ConfirmPaymentParam} */
     static confirmPayment(): ConfirmPaymentParam;
+    /** @returns {CreateMerchantRefundPriorityParam} */
+    static createMerchantRefundPriority(): CreateMerchantRefundPriorityParam;
     /** @returns {CreatePaymentLinkParam} */
     static createPaymentLink(): CreatePaymentLinkParam;
     /** @returns {EdcAggregatorsAndModelListParam} */
@@ -202,6 +218,8 @@ declare class PaymentPlatformApplicationValidator {
     static getMerchantAggregatorPaymentModeDetails(): GetMerchantAggregatorPaymentModeDetailsParam;
     /** @returns {GetMerchantPaymentOptionParam} */
     static getMerchantPaymentOption(): any;
+    /** @returns {GetMerchantRefundPriorityParam} */
+    static getMerchantRefundPriority(): GetMerchantRefundPriorityParam;
     /** @returns {GetPGConfigAggregatorsParam} */
     static getPGConfigAggregators(): any;
     /** @returns {GetPaymentCodeOptionParam} */
@@ -246,6 +264,8 @@ declare class PaymentPlatformApplicationValidator {
     static setUserCODlimitRoutes(): SetUserCODlimitRoutesParam;
     /** @returns {UpdateEdcDeviceParam} */
     static updateEdcDevice(): UpdateEdcDeviceParam;
+    /** @returns {UpdateMerchantRefundPriorityParam} */
+    static updateMerchantRefundPriority(): UpdateMerchantRefundPriorityParam;
     /** @returns {UpdatePaymentSessionParam} */
     static updatePaymentSession(): UpdatePaymentSessionParam;
     /** @returns {UpdateRefundSessionParam} */
@@ -254,7 +274,7 @@ declare class PaymentPlatformApplicationValidator {
     static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
 }
 declare namespace PaymentPlatformApplicationValidator {
-    export { AddEdcDeviceParam, AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreatePaymentLinkParam, EdcAggregatorsAndModelListParam, EdcDeviceListParam, EdcDeviceStatsParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetEdcDeviceParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeRoutesParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, MerchantOnBoardingParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, RepaymentDetailsParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SetUserCODlimitRoutesParam, UpdateEdcDeviceParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, VerifyCustomerForPaymentParam };
+    export { AddEdcDeviceParam, AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreateMerchantRefundPriorityParam, CreatePaymentLinkParam, EdcAggregatorsAndModelListParam, EdcDeviceListParam, EdcDeviceStatsParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetEdcDeviceParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetMerchantRefundPriorityParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeRoutesParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, MerchantOnBoardingParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, RepaymentDetailsParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SetUserCODlimitRoutesParam, UpdateEdcDeviceParam, UpdateMerchantRefundPriorityParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, VerifyCustomerForPaymentParam };
 }
 type AddEdcDeviceParam = {
     /**
@@ -275,6 +295,13 @@ type CheckAndUpdatePaymentStatusParam = {
 type ConfirmPaymentParam = {
     body: PaymentPlatformModel.PaymentConfirmationRequest;
 };
+type CreateMerchantRefundPriorityParam = {
+    /**
+     * - Configuration for merchant or customer
+     */
+    configType: string;
+    body: PaymentPlatformModel.RefundPriorityRequestSerializer;
+};
 type CreatePaymentLinkParam = {
     body: PaymentPlatformModel.CreatePaymentLinkRequest;
 };
@@ -310,6 +337,12 @@ type GetMerchantAggregatorPaymentModeDetailsParam = {
     businessUnit: string;
     device: string;
 };
+type GetMerchantRefundPriorityParam = {
+    /**
+     * - Configuration for merchant or customer
+     */
+    configType: string;
+};
 type GetPaymentLinkParam = {
     paymentLinkId?: string;
 };
@@ -419,6 +452,13 @@ type SetUserCODlimitRoutesParam = {
 type UpdateEdcDeviceParam = {
     body: PaymentPlatformModel.EdcAddRequest;
 };
+type UpdateMerchantRefundPriorityParam = {
+    /**
+     * - Configuration for merchant or customer
+     */
+    configType: string;
+    body: PaymentPlatformModel.RefundPriorityRequestSerializer;
+};
 type UpdatePaymentSessionParam = {
     /**
      * - Global identifier of the entity (e.g. order, cart

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -28,6 +28,12 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
  * @property {PaymentPlatformModel.PaymentConfirmationRequest} body
  */
 
+/**
+ * @typedef CreateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
+
 /**
  * @typedef CreatePaymentLinkParam
  * @property {PaymentPlatformModel.CreatePaymentLinkRequest} body
@@ -72,6 +78,11 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
 
 /** @typedef GetMerchantPaymentOptionParam */
 
+/**
+ * @typedef GetMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ */
+
 /** @typedef GetPGConfigAggregatorsParam */
 
 /** @typedef GetPaymentCodeOptionParam */
@@ -192,6 +203,12 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
  * @property {PaymentPlatformModel.EdcAddRequest} body
  */
 
+/**
+ * @typedef UpdateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
+
 /**
  * @typedef UpdatePaymentSessionParam
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
@@ -252,6 +269,14 @@ class PaymentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateMerchantRefundPriorityParam} */
+  static createMerchantRefundPriority() {
+    return Joi.object({
+      configType: Joi.string().allow("").required(),
+      body: PaymentPlatformModel.RefundPriorityRequestSerializer().required(),
+    }).required();
+  }
+
   /** @returns {CreatePaymentLinkParam} */
   static createPaymentLink() {
     return Joi.object({
@@ -317,6 +342,13 @@ class PaymentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetMerchantRefundPriorityParam} */
+  static getMerchantRefundPriority() {
+    return Joi.object({
+      configType: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetPGConfigAggregatorsParam} */
   static getPGConfigAggregators() {
     return Joi.object({}).required();
@@ -479,6 +511,14 @@ class PaymentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateMerchantRefundPriorityParam} */
+  static updateMerchantRefundPriority() {
+    return Joi.object({
+      configType: Joi.string().allow("").required(),
+      body: PaymentPlatformModel.RefundPriorityRequestSerializer().required(),
+    }).required();
+  }
+
   /** @returns {UpdatePaymentSessionParam} */
   static updatePaymentSession() {
     return Joi.object({

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

@@ -710,6 +710,19 @@ export = PaymentPlatformModel;
  * @property {string} message - Response message
  * @property {boolean} success - Success or failure flag.
  */
+/**
+ * @typedef RefundPriorityRequestSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ */
+/**
+ * @typedef RefundPriorityResponseSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {string} configuration - Configuration for merchant or customer
+ * @property {string} [message] - Message
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ * @property {boolean} success - Success
+ */
 /**
  * @typedef RefundSessionDetail
  * @property {number} amount - Amount refunded.
@@ -748,6 +761,12 @@ export = PaymentPlatformModel;
  * @property {string} status - The status of the refund.
  * @property {number} total_refund_amount - The total amount refunded.
  */
+/**
+ * @typedef RefundSourcesPriority
+ * @property {string} description - Description of refund source
+ * @property {number} priority - Priority of refund source, 0 being highest
+ * @property {string} source - Source of refund
+ */
 /**
  * @typedef RepaymentDetailsSerialiserPayAll
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -878,7 +897,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODChargesLimitsResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MerchnatPaymentModeRequest, MerchnatPaymentModeResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OrderDetail, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentModeList, PaymentModeLogo, PaymentObjectListSerializer, PaymentOptions, PaymentOptionsResponse, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PollingPaymentLinkResponse, ProductCODData, RefundAccountResponse, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
+    export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODChargesLimitsResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MerchnatPaymentModeRequest, MerchnatPaymentModeResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OrderDetail, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentModeList, PaymentModeLogo, PaymentObjectListSerializer, PaymentOptions, PaymentOptionsResponse, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PollingPaymentLinkResponse, ProductCODData, RefundAccountResponse, RefundPriorityRequestSerializer, RefundPriorityResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, RefundSourcesPriority, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
 }
 /** @returns {AddBeneficiaryDetailsOTPRequest} */
 declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
@@ -2791,6 +2810,42 @@ type RefundAccountResponse = {
      */
     success: boolean;
 };
+/** @returns {RefundPriorityRequestSerializer} */
+declare function RefundPriorityRequestSerializer(): RefundPriorityRequestSerializer;
+type RefundPriorityRequestSerializer = {
+    /**
+     * - Apportion refund to multiple sources
+     */
+    apportion: boolean;
+    /**
+     * - Refund sources priority
+     */
+    refund_sources_priority: RefundSourcesPriority[];
+};
+/** @returns {RefundPriorityResponseSerializer} */
+declare function RefundPriorityResponseSerializer(): RefundPriorityResponseSerializer;
+type RefundPriorityResponseSerializer = {
+    /**
+     * - Apportion refund to multiple sources
+     */
+    apportion: boolean;
+    /**
+     * - Configuration for merchant or customer
+     */
+    configuration: string;
+    /**
+     * - Message
+     */
+    message?: string;
+    /**
+     * - Refund sources priority
+     */
+    refund_sources_priority: RefundSourcesPriority[];
+    /**
+     * - Success
+     */
+    success: boolean;
+};
 /** @returns {RefundSessionDetail} */
 declare function RefundSessionDetail(): RefundSessionDetail;
 type RefundSessionDetail = {
@@ -2901,6 +2956,22 @@ type RefundSessionResponseSerializer = {
      */
     total_refund_amount: number;
 };
+/** @returns {RefundSourcesPriority} */
+declare function RefundSourcesPriority(): RefundSourcesPriority;
+type RefundSourcesPriority = {
+    /**
+     * - Description of refund source
+     */
+    description: string;
+    /**
+     * - Priority of refund source, 0 being highest
+     */
+    priority: number;
+    /**
+     * - Source of refund
+     */
+    source: string;
+};
 /** @returns {RepaymentDetailsSerialiserPayAll} */
 declare function RepaymentDetailsSerialiserPayAll(): RepaymentDetailsSerialiserPayAll;
 type RepaymentDetailsSerialiserPayAll = {

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -792,6 +792,21 @@ const Joi = require("joi");
  * @property {boolean} success - Success or failure flag.
  */
 
+/**
+ * @typedef RefundPriorityRequestSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ */
+
+/**
+ * @typedef RefundPriorityResponseSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {string} configuration - Configuration for merchant or customer
+ * @property {string} [message] - Message
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ * @property {boolean} success - Success
+ */
+
 /**
  * @typedef RefundSessionDetail
  * @property {number} amount - Amount refunded.
@@ -833,6 +848,13 @@ const Joi = require("joi");
  * @property {number} total_refund_amount - The total amount refunded.
  */
 
+/**
+ * @typedef RefundSourcesPriority
+ * @property {string} description - Description of refund source
+ * @property {number} priority - Priority of refund source, 0 being highest
+ * @property {string} source - Source of refund
+ */
+
 /**
  * @typedef RepaymentDetailsSerialiserPayAll
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -1922,6 +1944,29 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {RefundPriorityRequestSerializer} */
+  static RefundPriorityRequestSerializer() {
+    return Joi.object({
+      apportion: Joi.boolean().required(),
+      refund_sources_priority: Joi.array()
+        .items(PaymentPlatformModel.RefundSourcesPriority())
+        .required(),
+    });
+  }
+
+  /** @returns {RefundPriorityResponseSerializer} */
+  static RefundPriorityResponseSerializer() {
+    return Joi.object({
+      apportion: Joi.boolean().required(),
+      configuration: Joi.string().allow("").required(),
+      message: Joi.string().allow(""),
+      refund_sources_priority: Joi.array()
+        .items(PaymentPlatformModel.RefundSourcesPriority())
+        .required(),
+      success: Joi.boolean().required(),
+    });
+  }
+
   /** @returns {RefundSessionDetail} */
   static RefundSessionDetail() {
     return Joi.object({
@@ -1965,6 +2010,15 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {RefundSourcesPriority} */
+  static RefundSourcesPriority() {
+    return Joi.object({
+      description: Joi.string().allow("").required(),
+      priority: Joi.number().required(),
+      source: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {RepaymentDetailsSerialiserPayAll} */
   static RepaymentDetailsSerialiserPayAll() {
     return Joi.object({