@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts

@@ -1,16 +1,141 @@
-export = ServiceabilityValidator;
-declare class ServiceabilityValidator {
-    static addAppDp(): any;
-    static deleteAppDp(): any;
+export = ServiceabilityPlatformApplicationValidator;
+/**
+ * @typedef AddAppDpParam
+ * @property {ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest} body
+ */
+/**
+ * @typedef DeleteAppDpParam
+ * @property {number} courierPartnerId - A `courier_partner_id` is a unique
+ *   identifier of a particular delivery partner.
+ */
+/** @typedef GetApplicationServiceabilityParam */
+/** @typedef GetDpApplicationRulesParam */
+/** @typedef GetSelfShipParam */
+/**
+ * @typedef GetZoneFromPincodeViewParam
+ * @property {ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest} body
+ */
+/**
+ * @typedef GetZonesFromApplicationIdViewParam
+ * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string[]} [zoneId] - List of zones to query for
+ * @property {string} [q] - Search with name as a free text
+ */
+/**
+ * @typedef UpdateApplicationServiceabilityParam
+ * @property {ServiceabilityPlatformModel.ServiceabilityPayloadSchema} body
+ */
+/**
+ * @typedef UpdatePincodeAuditHistoryParam
+ * @property {ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest} body
+ */
+/**
+ * @typedef UpdatePincodeBulkViewParam
+ * @property {ServiceabilityPlatformModel.PincodeMopBulkData} body
+ */
+/**
+ * @typedef UpdatePincodeCoDListingParam
+ * @property {ServiceabilityPlatformModel.PincodeCodStatusListingRequest} body
+ */
+/**
+ * @typedef UpdatePincodeMopViewParam
+ * @property {ServiceabilityPlatformModel.PincodeMopData} body
+ */
+/**
+ * @typedef UpdateSelfShipParam
+ * @property {ServiceabilityPlatformModel.SelfShipResponse} body
+ */
+/**
+ * @typedef UpsertDpApplicationRulesParam
+ * @property {ServiceabilityPlatformModel.DPApplicationRuleRequest} body
+ */
+declare class ServiceabilityPlatformApplicationValidator {
+    /** @returns {AddAppDpParam} */
+    static addAppDp(): AddAppDpParam;
+    /** @returns {DeleteAppDpParam} */
+    static deleteAppDp(): DeleteAppDpParam;
+    /** @returns {GetApplicationServiceabilityParam} */
     static getApplicationServiceability(): any;
-    static getApplicationServiceabilitySelfShipment(): any;
+    /** @returns {GetDpApplicationRulesParam} */
     static getDpApplicationRules(): any;
-    static getZoneFromPincodeView(): any;
-    static getZonesFromApplicationIdView(): any;
-    static patchApplicationServiceabilitySelfShipment(): any;
-    static updatePincodeAuditHistory(): any;
-    static updatePincodeBulkView(): any;
-    static updatePincodeCoDListing(): any;
-    static updatePincodeMopView(): any;
-    static upsertDpApplicationRules(): any;
+    /** @returns {GetSelfShipParam} */
+    static getSelfShip(): any;
+    /** @returns {GetZoneFromPincodeViewParam} */
+    static getZoneFromPincodeView(): GetZoneFromPincodeViewParam;
+    /** @returns {GetZonesFromApplicationIdViewParam} */
+    static getZonesFromApplicationIdView(): GetZonesFromApplicationIdViewParam;
+    /** @returns {UpdateApplicationServiceabilityParam} */
+    static updateApplicationServiceability(): UpdateApplicationServiceabilityParam;
+    /** @returns {UpdatePincodeAuditHistoryParam} */
+    static updatePincodeAuditHistory(): UpdatePincodeAuditHistoryParam;
+    /** @returns {UpdatePincodeBulkViewParam} */
+    static updatePincodeBulkView(): UpdatePincodeBulkViewParam;
+    /** @returns {UpdatePincodeCoDListingParam} */
+    static updatePincodeCoDListing(): UpdatePincodeCoDListingParam;
+    /** @returns {UpdatePincodeMopViewParam} */
+    static updatePincodeMopView(): UpdatePincodeMopViewParam;
+    /** @returns {UpdateSelfShipParam} */
+    static updateSelfShip(): UpdateSelfShipParam;
+    /** @returns {UpsertDpApplicationRulesParam} */
+    static upsertDpApplicationRules(): UpsertDpApplicationRulesParam;
 }
+declare namespace ServiceabilityPlatformApplicationValidator {
+    export { AddAppDpParam, DeleteAppDpParam, GetApplicationServiceabilityParam, GetDpApplicationRulesParam, GetSelfShipParam, GetZoneFromPincodeViewParam, GetZonesFromApplicationIdViewParam, UpdateApplicationServiceabilityParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateSelfShipParam, UpsertDpApplicationRulesParam };
+}
+type AddAppDpParam = {
+    body: ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest;
+};
+type DeleteAppDpParam = {
+    /**
+     * - A `courier_partner_id` is a unique
+     * identifier of a particular delivery partner.
+     */
+    courierPartnerId: number;
+};
+type GetZoneFromPincodeViewParam = {
+    body: ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest;
+};
+type GetZonesFromApplicationIdViewParam = {
+    /**
+     * - Index of the item to start returning with
+     */
+    pageNo?: number;
+    /**
+     * - Determines the items to be displayed in a page
+     */
+    pageSize?: number;
+    /**
+     * - List of zones to query for
+     */
+    zoneId?: string[];
+    /**
+     * - Search with name as a free text
+     */
+    q?: string;
+};
+type UpdateApplicationServiceabilityParam = {
+    body: ServiceabilityPlatformModel.ServiceabilityPayloadSchema;
+};
+type UpdatePincodeAuditHistoryParam = {
+    body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest;
+};
+type UpdatePincodeBulkViewParam = {
+    body: ServiceabilityPlatformModel.PincodeMopBulkData;
+};
+type UpdatePincodeCoDListingParam = {
+    body: ServiceabilityPlatformModel.PincodeCodStatusListingRequest;
+};
+type UpdatePincodeMopViewParam = {
+    body: ServiceabilityPlatformModel.PincodeMopData;
+};
+type UpdateSelfShipParam = {
+    body: ServiceabilityPlatformModel.SelfShipResponse;
+};
+type UpsertDpApplicationRulesParam = {
+    body: ServiceabilityPlatformModel.DPApplicationRuleRequest;
+};
+type GetApplicationServiceabilityParam = any;
+type GetDpApplicationRulesParam = any;
+type GetSelfShipParam = any;
+import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js

@@ -1,37 +1,110 @@
 const Joi = require("joi");
 
-const ServiceabilityModel = require("./ServiceabilityPlatformModel");
-class ServiceabilityValidator {
+const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
+
+/**
+ * @typedef AddAppDpParam
+ * @property {ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest} body
+ */
+
+/**
+ * @typedef DeleteAppDpParam
+ * @property {number} courierPartnerId - A `courier_partner_id` is a unique
+ *   identifier of a particular delivery partner.
+ */
+
+/** @typedef GetApplicationServiceabilityParam */
+
+/** @typedef GetDpApplicationRulesParam */
+
+/** @typedef GetSelfShipParam */
+
+/**
+ * @typedef GetZoneFromPincodeViewParam
+ * @property {ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest} body
+ */
+
+/**
+ * @typedef GetZonesFromApplicationIdViewParam
+ * @property {number} [pageNo] - Index of the item to start returning with
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
+ * @property {string[]} [zoneId] - List of zones to query for
+ * @property {string} [q] - Search with name as a free text
+ */
+
+/**
+ * @typedef UpdateApplicationServiceabilityParam
+ * @property {ServiceabilityPlatformModel.ServiceabilityPayloadSchema} body
+ */
+
+/**
+ * @typedef UpdatePincodeAuditHistoryParam
+ * @property {ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest} body
+ */
+
+/**
+ * @typedef UpdatePincodeBulkViewParam
+ * @property {ServiceabilityPlatformModel.PincodeMopBulkData} body
+ */
+
+/**
+ * @typedef UpdatePincodeCoDListingParam
+ * @property {ServiceabilityPlatformModel.PincodeCodStatusListingRequest} body
+ */
+
+/**
+ * @typedef UpdatePincodeMopViewParam
+ * @property {ServiceabilityPlatformModel.PincodeMopData} body
+ */
+
+/**
+ * @typedef UpdateSelfShipParam
+ * @property {ServiceabilityPlatformModel.SelfShipResponse} body
+ */
+
+/**
+ * @typedef UpsertDpApplicationRulesParam
+ * @property {ServiceabilityPlatformModel.DPApplicationRuleRequest} body
+ */
+
+class ServiceabilityPlatformApplicationValidator {
+  /** @returns {AddAppDpParam} */
   static addAppDp() {
     return Joi.object({
-      body: ServiceabilityModel.ApplicationCompanyDpViewRequest().required(),
+      body: ServiceabilityPlatformModel.ApplicationCompanyDpViewRequest().required(),
     }).required();
   }
 
+  /** @returns {DeleteAppDpParam} */
   static deleteAppDp() {
     return Joi.object({
       courierPartnerId: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {GetApplicationServiceabilityParam} */
   static getApplicationServiceability() {
     return Joi.object({}).required();
   }
 
-  static getApplicationServiceabilitySelfShipment() {
+  /** @returns {GetDpApplicationRulesParam} */
+  static getDpApplicationRules() {
     return Joi.object({}).required();
   }
 
-  static getDpApplicationRules() {
+  /** @returns {GetSelfShipParam} */
+  static getSelfShip() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetZoneFromPincodeViewParam} */
   static getZoneFromPincodeView() {
     return Joi.object({
-      body: ServiceabilityModel.GetZoneFromPincodeViewRequest().required(),
+      body: ServiceabilityPlatformModel.GetZoneFromPincodeViewRequest().required(),
     }).required();
   }
 
+  /** @returns {GetZonesFromApplicationIdViewParam} */
   static getZonesFromApplicationIdView() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -41,41 +114,54 @@ class ServiceabilityValidator {
     }).required();
   }
 
-  static patchApplicationServiceabilitySelfShipment() {
+  /** @returns {UpdateApplicationServiceabilityParam} */
+  static updateApplicationServiceability() {
     return Joi.object({
-      body: ServiceabilityModel.SelfShipResponse().required(),
+      body: ServiceabilityPlatformModel.ServiceabilityPayloadSchema().required(),
     }).required();
   }
 
+  /** @returns {UpdatePincodeAuditHistoryParam} */
   static updatePincodeAuditHistory() {
     return Joi.object({
-      body: ServiceabilityModel.PincodeMopUpdateAuditHistoryRequest().required(),
+      body: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdatePincodeBulkViewParam} */
   static updatePincodeBulkView() {
     return Joi.object({
-      body: ServiceabilityModel.PincodeMopBulkData().required(),
+      body: ServiceabilityPlatformModel.PincodeMopBulkData().required(),
     }).required();
   }
 
+  /** @returns {UpdatePincodeCoDListingParam} */
   static updatePincodeCoDListing() {
     return Joi.object({
-      body: ServiceabilityModel.PincodeCodStatusListingRequest().required(),
+      body: ServiceabilityPlatformModel.PincodeCodStatusListingRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdatePincodeMopViewParam} */
   static updatePincodeMopView() {
     return Joi.object({
-      body: ServiceabilityModel.PincodeMopData().required(),
+      body: ServiceabilityPlatformModel.PincodeMopData().required(),
+    }).required();
+  }
+
+  /** @returns {UpdateSelfShipParam} */
+  static updateSelfShip() {
+    return Joi.object({
+      body: ServiceabilityPlatformModel.SelfShipResponse().required(),
     }).required();
   }
 
+  /** @returns {UpsertDpApplicationRulesParam} */
   static upsertDpApplicationRules() {
     return Joi.object({
-      body: ServiceabilityModel.DPApplicationRuleRequest().required(),
+      body: ServiceabilityPlatformModel.DPApplicationRuleRequest().required(),
     }).required();
   }
 }
 
-module.exports = ServiceabilityValidator;
+module.exports = ServiceabilityPlatformApplicationValidator;