@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Order/OrderPlatformValidator.d.ts

@@ -31,12 +31,13 @@ declare class OrderValidator {
     static dispatchManifest(): any;
     static getRoleBasedActions(): any;
     static getShipmentHistory(): any;
+    static postShipmentHistory(): any;
     static sendSmsNinja(): any;
     static platformManualAssignDPToShipment(): any;
     static updatePackagingDimensions(): any;
     static createOrder(): any;
-    static createChannelConfig(): any;
     static getChannelConfig(): any;
+    static createChannelConfig(): any;
     static uploadConsent(): any;
     static orderUpdate(): any;
     static checkOrderStatus(): any;

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -5,6 +5,8 @@ class OrderValidator {
   static getShipments() {
     return Joi.object({
       lane: Joi.string().allow(""),
+      bagStatus: Joi.string().allow(""),
+      statusOverrideLane: Joi.boolean(),
       searchType: Joi.string().allow(""),
       searchValue: Joi.string().allow(""),
       searchId: Joi.string().allow(""),
@@ -18,11 +20,14 @@ class OrderValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       isPrioritySort: Joi.boolean(),
+      fetchActiveShipment: Joi.boolean(),
       excludeLockedShipments: Joi.boolean(),
       paymentMethods: Joi.string().allow(""),
       channelShipmentId: Joi.string().allow(""),
       channelOrderId: Joi.string().allow(""),
       customMeta: Joi.string().allow(""),
+      orderingChannel: Joi.string().allow(""),
+      companyAffiliateTag: Joi.string().allow(""),
     }).required();
   }
 
@@ -290,6 +295,12 @@ class OrderValidator {
     }).required();
   }
 
+  static postShipmentHistory() {
+    return Joi.object({
+      body: OrderModel.PostShipmentHistory().required(),
+    }).required();
+  }
+
   static sendSmsNinja() {
     return Joi.object({
       body: OrderModel.SendSmsPayload().required(),
@@ -314,16 +325,16 @@ class OrderValidator {
     }).required();
   }
 
+  static getChannelConfig() {
+    return Joi.object({}).required();
+  }
+
   static createChannelConfig() {
     return Joi.object({
       body: OrderModel.CreateChannelConfigData().required(),
     }).required();
   }
 
-  static getChannelConfig() {
-    return Joi.object({}).required();
-  }
-
   static uploadConsent() {
     return Joi.object({
       body: OrderModel.UploadConsent().required(),

package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts

@@ -8,23 +8,25 @@ declare 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 }?: {
         extensionId: string;
         body: AddProxyReq;
-    }): Promise<any>;
+    }): Promise<AddProxyResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @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 }?: {
         extensionId: string;
         attachedPath: string;
-    }): Promise<any>;
+    }): Promise<RemoveProxyResponse>;
 }

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,
@@ -29,15 +32,48 @@ class Partner {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PartnerValidator.addProxyPath().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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;
   }
 
   /**
@@ -45,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,
@@ -60,15 +97,48 @@ class Partner {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = PartnerValidator.removeProxyPath().validate(
+      {
+        extensionId,
+        attachedPath,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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.d.ts

@@ -2,6 +2,6 @@ export = PartnerModel;
 declare class PartnerModel {
     static AddProxyReq(): any;
     static AddProxyResponse(): any;
-    static APIError(): any;
     static RemoveProxyResponse(): any;
+    static APIError(): any;
 }

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -29,6 +29,14 @@ class PartnerModel {
     });
   }
 
+  static RemoveProxyResponse() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+
+      data: Joi.any(),
+    });
+  }
+
   static APIError() {
     return Joi.object({
       code: Joi.string().allow(""),
@@ -42,13 +50,5 @@ class PartnerModel {
       meta: Joi.any(),
     });
   }
-
-  static RemoveProxyResponse() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-
-      data: Joi.any(),
-    });
-  }
 }
 module.exports = PartnerModel;

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

@@ -5,104 +5,115 @@ declare class Payment {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<PaymentGatewayConfigResponse>} - Success response
      * @summary: Get All Brand Payment Gateway Config Secret
      * @description: Get All Brand Payment Gateway Config Secret
      */
-    getBrandPaymentGatewayConfig({}?: any): Promise<any>;
+    getBrandPaymentGatewayConfig({}?: any): Promise<PaymentGatewayConfigResponse>;
     /**
      * @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<any>;
+    }): Promise<PaymentGatewayToBeReviewed>;
     /**
      * @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<any>;
+    }): Promise<PaymentGatewayToBeReviewed>;
     /**
      * @param {Object} arg - Arg object.
      * @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
      */
     getPaymentModeRoutes({ refresh, requestType }?: {
         refresh: boolean;
         requestType: string;
-    }): Promise<any>;
+    }): Promise<PaymentOptionsResponse>;
     /**
      * @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
+     * @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.
      */
     addRefundBankAccountUsingOTP({ body }?: {
         body: AddBeneficiaryDetailsOTPRequest;
-    }): Promise<any>;
+    }): Promise<RefundAccountResponse>;
     /**
      * @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<any>;
+    }): Promise<OrderBeneficiaryResponse>;
     /**
      * @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>;
+    }): Promise<OrderBeneficiaryResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     confirmPayment({ body }?: {
         body: PaymentConfirmationRequest;
-    }): Promise<any>;
+    }): Promise<PaymentConfirmationResponse>;
     /**
      * @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 {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>;
 }