@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,13 +1,113 @@
-export = PaymentValidator;
-declare class PaymentValidator {
-    static activateAndDectivatePayout(): any;
-    static deletePayout(): any;
-    static deleteSubscriptionPaymentMethod(): any;
-    static getAllPayouts(): any;
+export = PaymentPlatformValidator;
+/**
+ * @typedef ActivateAndDectivatePayoutParam
+ * @property {string} uniqueTransferNo - Unique transfer id
+ * @property {PaymentPlatformModel.UpdatePayoutRequest} body
+ */
+/**
+ * @typedef DeletePayoutParam
+ * @property {string} uniqueTransferNo - Unique transfer id
+ */
+/**
+ * @typedef DeleteSubscriptionPaymentMethodParam
+ * @property {string} uniqueExternalId
+ * @property {string} paymentMethodId
+ */
+/**
+ * @typedef GetAllPayoutsParam
+ * @property {string} [uniqueExternalId] - Fetch payouts using unique external id
+ */
+/** @typedef GetSubscriptionConfigParam */
+/**
+ * @typedef GetSubscriptionPaymentMethodParam
+ * @property {string} [uniqueExternalId] - Unique external id
+ */
+/**
+ * @typedef SavePayoutParam
+ * @property {PaymentPlatformModel.PayoutRequest} body
+ */
+/**
+ * @typedef SaveSubscriptionSetupIntentParam
+ * @property {PaymentPlatformModel.SaveSubscriptionSetupIntentRequest} body
+ */
+/**
+ * @typedef UpdatePayoutParam
+ * @property {string} uniqueTransferNo - Unique transfer id
+ * @property {PaymentPlatformModel.PayoutRequest} body
+ */
+/**
+ * @typedef VerifyIfscCodeParam
+ * @property {string} [ifscCode]
+ */
+declare class PaymentPlatformValidator {
+    /** @returns {ActivateAndDectivatePayoutParam} */
+    static activateAndDectivatePayout(): ActivateAndDectivatePayoutParam;
+    /** @returns {DeletePayoutParam} */
+    static deletePayout(): DeletePayoutParam;
+    /** @returns {DeleteSubscriptionPaymentMethodParam} */
+    static deleteSubscriptionPaymentMethod(): DeleteSubscriptionPaymentMethodParam;
+    /** @returns {GetAllPayoutsParam} */
+    static getAllPayouts(): GetAllPayoutsParam;
+    /** @returns {GetSubscriptionConfigParam} */
     static getSubscriptionConfig(): any;
-    static getSubscriptionPaymentMethod(): any;
-    static savePayout(): any;
-    static saveSubscriptionSetupIntent(): any;
-    static updatePayout(): any;
-    static verifyIfscCode(): any;
+    /** @returns {GetSubscriptionPaymentMethodParam} */
+    static getSubscriptionPaymentMethod(): GetSubscriptionPaymentMethodParam;
+    /** @returns {SavePayoutParam} */
+    static savePayout(): SavePayoutParam;
+    /** @returns {SaveSubscriptionSetupIntentParam} */
+    static saveSubscriptionSetupIntent(): SaveSubscriptionSetupIntentParam;
+    /** @returns {UpdatePayoutParam} */
+    static updatePayout(): UpdatePayoutParam;
+    /** @returns {VerifyIfscCodeParam} */
+    static verifyIfscCode(): VerifyIfscCodeParam;
 }
+declare namespace PaymentPlatformValidator {
+    export { ActivateAndDectivatePayoutParam, DeletePayoutParam, DeleteSubscriptionPaymentMethodParam, GetAllPayoutsParam, GetSubscriptionConfigParam, GetSubscriptionPaymentMethodParam, SavePayoutParam, SaveSubscriptionSetupIntentParam, UpdatePayoutParam, VerifyIfscCodeParam };
+}
+type ActivateAndDectivatePayoutParam = {
+    /**
+     * - Unique transfer id
+     */
+    uniqueTransferNo: string;
+    body: PaymentPlatformModel.UpdatePayoutRequest;
+};
+type DeletePayoutParam = {
+    /**
+     * - Unique transfer id
+     */
+    uniqueTransferNo: string;
+};
+type DeleteSubscriptionPaymentMethodParam = {
+    uniqueExternalId: string;
+    paymentMethodId: string;
+};
+type GetAllPayoutsParam = {
+    /**
+     * - Fetch payouts using unique external id
+     */
+    uniqueExternalId?: string;
+};
+type GetSubscriptionPaymentMethodParam = {
+    /**
+     * - Unique external id
+     */
+    uniqueExternalId?: string;
+};
+type SavePayoutParam = {
+    body: PaymentPlatformModel.PayoutRequest;
+};
+type SaveSubscriptionSetupIntentParam = {
+    body: PaymentPlatformModel.SaveSubscriptionSetupIntentRequest;
+};
+type UpdatePayoutParam = {
+    /**
+     * - Unique transfer id
+     */
+    uniqueTransferNo: string;
+    body: PaymentPlatformModel.PayoutRequest;
+};
+type VerifyIfscCodeParam = {
+    ifscCode?: string;
+};
+type GetSubscriptionConfigParam = any;
+import PaymentPlatformModel = require("./PaymentPlatformModel");

package/sdk/platform/Payment/PaymentPlatformValidator.js

@@ -1,20 +1,74 @@
 const Joi = require("joi");
 
-const PaymentModel = require("./PaymentPlatformModel");
-class PaymentValidator {
+const PaymentPlatformModel = require("./PaymentPlatformModel");
+
+/**
+ * @typedef ActivateAndDectivatePayoutParam
+ * @property {string} uniqueTransferNo - Unique transfer id
+ * @property {PaymentPlatformModel.UpdatePayoutRequest} body
+ */
+
+/**
+ * @typedef DeletePayoutParam
+ * @property {string} uniqueTransferNo - Unique transfer id
+ */
+
+/**
+ * @typedef DeleteSubscriptionPaymentMethodParam
+ * @property {string} uniqueExternalId
+ * @property {string} paymentMethodId
+ */
+
+/**
+ * @typedef GetAllPayoutsParam
+ * @property {string} [uniqueExternalId] - Fetch payouts using unique external id
+ */
+
+/** @typedef GetSubscriptionConfigParam */
+
+/**
+ * @typedef GetSubscriptionPaymentMethodParam
+ * @property {string} [uniqueExternalId] - Unique external id
+ */
+
+/**
+ * @typedef SavePayoutParam
+ * @property {PaymentPlatformModel.PayoutRequest} body
+ */
+
+/**
+ * @typedef SaveSubscriptionSetupIntentParam
+ * @property {PaymentPlatformModel.SaveSubscriptionSetupIntentRequest} body
+ */
+
+/**
+ * @typedef UpdatePayoutParam
+ * @property {string} uniqueTransferNo - Unique transfer id
+ * @property {PaymentPlatformModel.PayoutRequest} body
+ */
+
+/**
+ * @typedef VerifyIfscCodeParam
+ * @property {string} [ifscCode]
+ */
+
+class PaymentPlatformValidator {
+  /** @returns {ActivateAndDectivatePayoutParam} */
   static activateAndDectivatePayout() {
     return Joi.object({
       uniqueTransferNo: Joi.string().allow("").required(),
-      body: PaymentModel.UpdatePayoutRequest().required(),
+      body: PaymentPlatformModel.UpdatePayoutRequest().required(),
     }).required();
   }
 
+  /** @returns {DeletePayoutParam} */
   static deletePayout() {
     return Joi.object({
       uniqueTransferNo: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {DeleteSubscriptionPaymentMethodParam} */
   static deleteSubscriptionPaymentMethod() {
     return Joi.object({
       uniqueExternalId: Joi.string().allow("").required(),
@@ -22,41 +76,48 @@ class PaymentValidator {
     }).required();
   }
 
+  /** @returns {GetAllPayoutsParam} */
   static getAllPayouts() {
     return Joi.object({
       uniqueExternalId: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {GetSubscriptionConfigParam} */
   static getSubscriptionConfig() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSubscriptionPaymentMethodParam} */
   static getSubscriptionPaymentMethod() {
     return Joi.object({
       uniqueExternalId: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {SavePayoutParam} */
   static savePayout() {
     return Joi.object({
-      body: PaymentModel.PayoutRequest().required(),
+      body: PaymentPlatformModel.PayoutRequest().required(),
     }).required();
   }
 
+  /** @returns {SaveSubscriptionSetupIntentParam} */
   static saveSubscriptionSetupIntent() {
     return Joi.object({
-      body: PaymentModel.SaveSubscriptionSetupIntentRequest().required(),
+      body: PaymentPlatformModel.SaveSubscriptionSetupIntentRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdatePayoutParam} */
   static updatePayout() {
     return Joi.object({
       uniqueTransferNo: Joi.string().allow("").required(),
-      body: PaymentModel.PayoutRequest().required(),
+      body: PaymentPlatformModel.PayoutRequest().required(),
     }).required();
   }
 
+  /** @returns {VerifyIfscCodeParam} */
   static verifyIfscCode() {
     return Joi.object({
       ifscCode: Joi.string().allow(""),
@@ -64,4 +125,4 @@ class PaymentValidator {
   }
 }
 
-module.exports = PaymentValidator;
+module.exports = PaymentPlatformValidator;

package/sdk/platform/PlatformAPIClient.d.ts

@@ -1,4 +1,8 @@
 export = APIClient;
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
 declare class APIClient {
     /**
      * @param {object} conf
@@ -6,7 +10,18 @@ declare class APIClient {
      * @param {string} url
      * @param {object} query
      * @param {object} body
+     * @param {object} xHeaders
+     * @param {Options} options
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any): Promise<any>;
+    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<any>;
     get(url: any, config: any): Promise<any>;
 }
+declare namespace APIClient {
+    export { Options };
+}
+type Options = {
+    /**
+     * - Whether response headers are returned or not.
+     */
+    responseHeaders: boolean;
+};

package/sdk/platform/PlatformAPIClient.js

@@ -1,5 +1,10 @@
 const { fdkAxios } = require("../common/AxiosHelper");
 
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
+
 class APIClient {
   /**
    * @param {object} conf
@@ -7,8 +12,10 @@ class APIClient {
    * @param {string} url
    * @param {object} query
    * @param {object} body
+   * @param {object} xHeaders
+   * @param {Options} options
    */
-  static async execute(conf, method, url, query, body, xHeaders) {
+  static async execute(conf, method, url, query, body, xHeaders, options) {
     const token = await conf.oauthClient.getAccessToken();
 
     const extraHeaders = conf.extraHeaders.reduce((acc, curr) => {
@@ -27,6 +34,7 @@ class APIClient {
         ...extraHeaders,
         ...xHeaders,
       },
+      responseHeaders: options.responseHeaders,
     };
     rawRequest = JSON.parse(JSON.stringify(rawRequest));