@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/platform/{models/OrderValidator.d.ts → Order/OrderPlatformValidator.d.ts}

@@ -14,8 +14,6 @@ declare class OrderValidator {
     static getBulkInvoiceLabel(): any;
     static getBulkShipmentExcelFile(): any;
     static getBulkList(): any;
-    static getManifestList(): any;
-    static getManifestDetailsWithShipments(): any;
     static getBulkActionFailedReport(): any;
     static getShipmentReasons(): any;
     static bulkActionProcessXlsxFile(): any;
@@ -33,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/{models/OrderValidator.js → Order/OrderPlatformValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const OrderModel = require("./OrderPlatformModel");
 class OrderValidator {
   static getShipments() {
     return Joi.object({
@@ -58,6 +59,10 @@ class OrderValidator {
     return Joi.object({
       lane: Joi.string().allow(""),
       searchType: Joi.string().allow(""),
+      bagStatus: Joi.string().allow(""),
+      timeToDispatch: Joi.string().allow(""),
+      paymentMethods: Joi.string().allow(""),
+      tags: Joi.string().allow(""),
       searchValue: Joi.string().allow(""),
       fromDate: Joi.string().allow(""),
       toDate: Joi.string().allow(""),
@@ -101,7 +106,7 @@ class OrderValidator {
 
   static upsertJioCode() {
     return Joi.object({
-      body: Validator.JioCodeUpsertPayload().required(),
+      body: OrderModel.JioCodeUpsertPayload().required(),
     }).required();
   }
 
@@ -156,33 +161,6 @@ class OrderValidator {
     }).required();
   }
 
-  static getManifestList() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      storeId: Joi.number(),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      searchValue: Joi.string().allow(""),
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
-    }).required();
-  }
-
-  static getManifestDetailsWithShipments() {
-    return Joi.object({
-      manifestId: Joi.string().allow("").required(),
-      fromDate: Joi.string().allow(""),
-      toDate: Joi.string().allow(""),
-      storeId: Joi.number().required(),
-      page: Joi.number(),
-      pageSize: Joi.number(),
-      lane: Joi.string().allow(""),
-      dpIds: Joi.number(),
-      searchType: Joi.string().allow(""),
-      searchValue: Joi.string().allow(""),
-    }).required();
-  }
-
   static getBulkActionFailedReport() {
     return Joi.object({
       batchId: Joi.string().allow("").required(),
@@ -200,7 +178,7 @@ class OrderValidator {
 
   static bulkActionProcessXlsxFile() {
     return Joi.object({
-      body: Validator.BulkActionPayload().required(),
+      body: OrderModel.BulkActionPayload().required(),
     }).required();
   }
 
@@ -234,19 +212,19 @@ class OrderValidator {
 
   static invalidateShipmentCache() {
     return Joi.object({
-      body: Validator.InvalidateShipmentCachePayload().required(),
+      body: OrderModel.InvalidateShipmentCachePayload().required(),
     }).required();
   }
 
   static reassignLocation() {
     return Joi.object({
-      body: Validator.StoreReassign().required(),
+      body: OrderModel.StoreReassign().required(),
     }).required();
   }
 
   static updateShipmentLock() {
     return Joi.object({
-      body: Validator.UpdateShipmentLockPayload().required(),
+      body: OrderModel.UpdateShipmentLockPayload().required(),
     }).required();
   }
 
@@ -285,19 +263,19 @@ class OrderValidator {
 
   static updateShipmentStatus() {
     return Joi.object({
-      body: Validator.UpdateShipmentStatusRequest().required(),
+      body: OrderModel.UpdateShipmentStatusRequest().required(),
     }).required();
   }
 
   static processManifest() {
     return Joi.object({
-      body: Validator.CreateOrderPayload().required(),
+      body: OrderModel.CreateOrderPayload().required(),
     }).required();
   }
 
   static dispatchManifest() {
     return Joi.object({
-      body: Validator.DispatchManifest().required(),
+      body: OrderModel.DispatchManifest().required(),
     }).required();
   }
 
@@ -312,55 +290,61 @@ class OrderValidator {
     }).required();
   }
 
+  static postShipmentHistory() {
+    return Joi.object({
+      body: OrderModel.PostShipmentHistory().required(),
+    }).required();
+  }
+
   static sendSmsNinja() {
     return Joi.object({
-      body: Validator.SendSmsPayload().required(),
+      body: OrderModel.SendSmsPayload().required(),
     }).required();
   }
 
   static platformManualAssignDPToShipment() {
     return Joi.object({
-      body: Validator.ManualAssignDPToShipment().required(),
+      body: OrderModel.ManualAssignDPToShipment().required(),
     }).required();
   }
 
   static updatePackagingDimensions() {
     return Joi.object({
-      body: Validator.CreateOrderPayload().required(),
+      body: OrderModel.CreateOrderPayload().required(),
     }).required();
   }
 
   static createOrder() {
     return Joi.object({
-      body: Validator.CreateOrderAPI().required(),
+      body: OrderModel.CreateOrderAPI().required(),
     }).required();
   }
 
+  static getChannelConfig() {
+    return Joi.object({}).required();
+  }
+
   static createChannelConfig() {
     return Joi.object({
-      body: Validator.CreateChannelConfigData().required(),
+      body: OrderModel.CreateChannelConfigData().required(),
     }).required();
   }
 
-  static getChannelConfig() {
-    return Joi.object({}).required();
-  }
-
   static uploadConsent() {
     return Joi.object({
-      body: Validator.UploadConsent().required(),
+      body: OrderModel.UploadConsent().required(),
     }).required();
   }
 
   static orderUpdate() {
     return Joi.object({
-      body: Validator.PlatformOrderUpdate().required(),
+      body: OrderModel.PlatformOrderUpdate().required(),
     }).required();
   }
 
   static checkOrderStatus() {
     return Joi.object({
-      body: Validator.OrderStatus().required(),
+      body: OrderModel.OrderStatus().required(),
     }).required();
   }
 

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

@@ -0,0 +1,30 @@
+export = Partner;
+declare class Partner {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension id for which proxy URL will
+     *   be generated
+     * @param {AddProxyReq} arg.body
+     * @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>;
+    /**
+     * @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
+     * @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>;
+}

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -0,0 +1,100 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const PartnerValidator = require("./PartnerPlatformApplicationValidator");
+
+class Partner {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.extensionId - Extension id for which proxy URL will
+   *   be generated
+   * @param {AddProxyReq} arg.body
+   * @summary: Create proxy URL for the external URL
+   * @description: Use this API to generate proxy URL for the external URL
+   */
+  addProxyPath({ extensionId, body } = {}) {
+    const { error } = PartnerValidator.addProxyPath().validate(
+      {
+        extensionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      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) {
+      console.log("Parameter Validation warrnings for addProxyPath");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @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
+   * @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 } = {}) {
+    const { error } = PartnerValidator.removeProxyPath().validate(
+      {
+        extensionId,
+        attachedPath,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      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) {
+      console.log("Parameter Validation warrnings for removeProxyPath");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
+      query_params,
+      undefined
+    );
+  }
+}
+module.exports = Partner;

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

@@ -0,0 +1,5 @@
+export = PartnerValidator;
+declare class PartnerValidator {
+    static addProxyPath(): any;
+    static removeProxyPath(): any;
+}

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -0,0 +1,20 @@
+const Joi = require("joi");
+const PartnerModel = require("./PartnerPlatformModel");
+
+class PartnerValidator {
+  static addProxyPath() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      body: PartnerModel.AddProxyReq().required(),
+    }).required();
+  }
+
+  static removeProxyPath() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      attachedPath: Joi.string().allow("").required(),
+    }).required();
+  }
+}
+
+module.exports = PartnerValidator;

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

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

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -0,0 +1,54 @@
+const Joi = require("joi");
+
+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(""),
+
+      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(""),
+
+      modified_at: 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(""),
+
+      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

@@ -0,0 +1,108 @@
+export = Payment;
+declare class Payment {
+    constructor(config: any, applicationId: any);
+    config: any;
+    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
+     */
+    updateBrandPaymentGatewayConfig({ body }?: {
+        body: PaymentGatewayConfigRequest;
+    }): Promise<any>;
+    /**
+     * @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
+     */
+    getPaymentModeRoutes({ refresh, requestType }?: {
+        refresh: boolean;
+        requestType: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId -
+     * @param {string} [arg.requestHash] -
+     * @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>;
+    /**
+     * @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.
+     */
+    addRefundBankAccountUsingOTP({ body }?: {
+        body: AddBeneficiaryDetailsOTPRequest;
+    }): Promise<any>;
+    /**
+     * @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
+     */
+    getUserOrderBeneficiaries({ orderId }?: {
+        orderId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.orderId -
+     * @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>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.merchantUserId -
+     * @param {string} arg.mobileNo -
+     * @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>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SetCODForUserRequest} arg.body
+     * @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>;
+}