@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PartnerValidator = require("./PartnerPlatformApplicationValidator");
+const PartnerModel = require("./PartnerPlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class Partner {
   constructor(config, applicationId) {
@@ -14,10 +16,11 @@ class Partner {
    * @param {string} arg.extensionId - Extension id for which proxy URL will
    *   be generated
    * @param {AddProxyReq} arg.body
+   * @returns {Promise<AddProxyResponse>} - Success response
    * @summary: Create proxy URL for the external URL
    * @description: Use this API to generate proxy URL for the external URL
    */
-  addProxyPath({ extensionId, body } = {}) {
+  async addProxyPath({ extensionId, body } = {}) {
     const { error } = PartnerValidator.addProxyPath().validate(
       {
         extensionId,
@@ -38,19 +41,39 @@ class Partner {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for addProxyPath");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for addProxyPath",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = PartnerModel.AddProxyResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for addProxyPath",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -58,10 +81,11 @@ class Partner {
    * @param {string} arg.extensionId - Extension id for which proxy URL needs
    *   to be removed
    * @param {string} arg.attachedPath - Attachaed path slug
+   * @returns {Promise<RemoveProxyResponse>} - Success response
    * @summary: Remove proxy URL for the external URL
    * @description: Use this API to remove the proxy URL which is already generated for the external URL
    */
-  removeProxyPath({ extensionId, attachedPath } = {}) {
+  async removeProxyPath({ extensionId, attachedPath } = {}) {
     const { error } = PartnerValidator.removeProxyPath().validate(
       {
         extensionId,
@@ -82,19 +106,39 @@ class Partner {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for removeProxyPath");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for removeProxyPath",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "delete",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = PartnerModel.RemoveProxyResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for removeProxyPath",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = Partner;

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -4,50 +4,34 @@ class PartnerModel {
   static AddProxyReq() {
     return Joi.object({
       attached_path: Joi.string().allow(""),
-
       proxy_url: Joi.string().allow(""),
     });
   }
-
   static AddProxyResponse() {
     return Joi.object({
       _id: Joi.string().allow(""),
-
+      application_id: Joi.string().allow(""),
       attached_path: Joi.string().allow(""),
-
-      proxy_url: Joi.string().allow(""),
-
       company_id: Joi.string().allow(""),
-
-      application_id: Joi.string().allow(""),
-
-      extension_id: Joi.string().allow(""),
-
       created_at: Joi.string().allow(""),
-
+      extension_id: Joi.string().allow(""),
       modified_at: Joi.string().allow(""),
+      proxy_url: Joi.string().allow(""),
     });
   }
-
   static APIError() {
     return Joi.object({
       code: Joi.string().allow(""),
-
-      message: Joi.string().allow(""),
-
       info: Joi.string().allow(""),
-
-      request_id: Joi.string().allow(""),
-
+      message: Joi.string().allow(""),
       meta: Joi.any(),
+      request_id: Joi.string().allow(""),
     });
   }
-
   static RemoveProxyResponse() {
     return Joi.object({
-      message: Joi.string().allow(""),
-
       data: Joi.any(),
+      message: Joi.string().allow(""),
     });
   }
 }

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

@@ -5,104 +5,115 @@ declare class Payment {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
-     * @summary: Get All Brand Payment Gateway Config Secret
-     * @description: Get All Brand Payment Gateway Config Secret
-     */
-    getBrandPaymentGatewayConfig({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {PaymentGatewayConfigRequest} arg.body
-     * @summary: Save Config Secret For Brand Payment Gateway
-     * @description: Save Config Secret For Brand Payment Gateway
-     */
-    saveBrandPaymentGatewayConfig({ body }?: {
-        body: PaymentGatewayConfigRequest;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {PaymentGatewayConfigRequest} arg.body
-     * @summary: Save Config Secret For Brand Payment Gateway
-     * @description: Save Config Secret For Brand Payment Gateway
+     * @param {AddBeneficiaryDetailsOTPRequest} arg.body
+     * @returns {Promise<RefundAccountResponse>} - Success response
+     * @summary: Save bank details for cancelled/returned order
+     * @description: Use this API to save bank details for returned/cancelled order to refund amount in his account.
      */
-    updateBrandPaymentGatewayConfig({ body }?: {
-        body: PaymentGatewayConfigRequest;
-    }): Promise<any>;
+    addRefundBankAccountUsingOTP({ body }?: {
+        body: AddBeneficiaryDetailsOTPRequest;
+    }): Promise<RefundAccountResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {boolean} arg.refresh -
-     * @param {string} arg.requestType -
-     * @summary: Get All Valid Payment Options
-     * @description: Use this API to get Get All Valid Payment Options for making payment
+     * @param {PaymentConfirmationRequest} arg.body
+     * @returns {Promise<PaymentConfirmationResponse>} - Success response
+     * @summary: Confirm payment after successful payment from payment gateway
+     * @description: Use this API to confirm payment after payment gateway accepted payment.
      */
-    getPaymentModeRoutes({ refresh, requestType }?: {
-        refresh: boolean;
-        requestType: string;
-    }): Promise<any>;
+    confirmPayment({ body }?: {
+        body: PaymentConfirmationRequest;
+    }): Promise<PaymentConfirmationResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
      * @param {string} [arg.requestHash] -
+     * @returns {Promise<RefundAccountResponse>} - Success response
      * @summary: Get bank details
      * @description: Use this API to get saved bank details for returned/cancelled order using order id.
      */
     getBankAccountDetailsOpenAPI({ orderId, requestHash }?: {
         orderId: string;
         requestHash?: string;
-    }): Promise<any>;
+    }): Promise<RefundAccountResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {AddBeneficiaryDetailsOTPRequest} arg.body
-     * @summary: Save bank details for cancelled/returned order
-     * @description: Use this API to save bank details for returned/cancelled order to refund amount in his account.
+     * @returns {Promise<PaymentGatewayConfigResponse>} - Success response
+     * @summary: Get All Brand Payment Gateway Config Secret
+     * @description: Get All Brand Payment Gateway Config Secret
      */
-    addRefundBankAccountUsingOTP({ body }?: {
-        body: AddBeneficiaryDetailsOTPRequest;
-    }): Promise<any>;
+    getBrandPaymentGatewayConfig({}?: any): Promise<PaymentGatewayConfigResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.orderId -
-     * @summary: List Order Beneficiary
-     * @description: Get all active  beneficiary details added by the user for refund
+     * @param {boolean} arg.refresh -
+     * @param {string} arg.requestType -
+     * @returns {Promise<PaymentOptionsResponse>} - Success response
+     * @summary: Get All Valid Payment Options
+     * @description: Use this API to get Get All Valid Payment Options for making payment
      */
-    getUserOrderBeneficiaries({ orderId }?: {
-        orderId: string;
-    }): Promise<any>;
+    getPaymentModeRoutes({ refresh, requestType }?: {
+        refresh: boolean;
+        requestType: string;
+    }): Promise<PaymentOptionsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
+     * @returns {Promise<OrderBeneficiaryResponse>} - Success response
      * @summary: List User Beneficiary
      * @description: Get all active  beneficiary details added by the user for refund
      */
     getUserBeneficiaries({ orderId }?: {
         orderId: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {PaymentConfirmationRequest} arg.body
-     * @summary: Confirm payment after successful payment from payment gateway
-     * @description: Use this API to confirm payment after payment gateway accepted payment.
-     */
-    confirmPayment({ body }?: {
-        body: PaymentConfirmationRequest;
-    }): Promise<any>;
+    }): Promise<OrderBeneficiaryResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.merchantUserId -
      * @param {string} arg.mobileNo -
+     * @returns {Promise<GetUserCODLimitResponse>} - Success response
      * @summary: Get COD limit for user
      * @description: Use this API to get user cod limit and reamining limit for the payment
      */
     getUserCODlimitRoutes({ merchantUserId, mobileNo }?: {
         merchantUserId: string;
         mobileNo: string;
-    }): Promise<any>;
+    }): Promise<GetUserCODLimitResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId -
+     * @returns {Promise<OrderBeneficiaryResponse>} - Success response
+     * @summary: List Order Beneficiary
+     * @description: Get all active  beneficiary details added by the user for refund
+     */
+    getUserOrderBeneficiaries({ orderId }?: {
+        orderId: string;
+    }): Promise<OrderBeneficiaryResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PaymentGatewayConfigRequest} arg.body
+     * @returns {Promise<PaymentGatewayToBeReviewed>} - Success response
+     * @summary: Save Config Secret For Brand Payment Gateway
+     * @description: Save Config Secret For Brand Payment Gateway
+     */
+    saveBrandPaymentGatewayConfig({ body }?: {
+        body: PaymentGatewayConfigRequest;
+    }): Promise<PaymentGatewayToBeReviewed>;
     /**
      * @param {Object} arg - Arg object.
      * @param {SetCODForUserRequest} arg.body
+     * @returns {Promise<SetCODOptionResponse>} - Success response
      * @summary: Set COD option for user for payment
      * @description: Use this API to set cod option as true or false for the payment
      */
     setUserCODlimitRoutes({ body }?: {
         body: SetCODForUserRequest;
-    }): Promise<any>;
+    }): Promise<SetCODOptionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PaymentGatewayConfigRequest} arg.body
+     * @returns {Promise<PaymentGatewayToBeReviewed>} - Success response
+     * @summary: Save Config Secret For Brand Payment Gateway
+     * @description: Save Config Secret For Brand Payment Gateway
+     */
+    updateBrandPaymentGatewayConfig({ body }?: {
+        body: PaymentGatewayConfigRequest;
+    }): Promise<PaymentGatewayToBeReviewed>;
 }